ListData
Details
Curl request
$ curl 'http://skylar.livingfire.de/api/profile/listdatas' -i -X GET
Create
A POST
request will create a ListData.
Curl request
$ curl 'http://skylar.livingfire.de/api/listdatas' -i -X POST \
-H 'Content-Type: application/hal+json' \
-d '{
"id" : null,
"uuid" : "dc06c6d1-39d9-4869-8628-938dd0fa0375",
"logstash" : "2017-04-01T00:00:01Z",
"description" : "beautiful weather and good run",
"group" : "running",
"entryDate" : "2019-01-28T15:08:11.752Z",
"dimension" : "distance",
"unit" : "km",
"value" : "13",
"relationDimensionHasDimension" : null
}'
HTTP response
HTTP/1.1 201 Created
Location: http://skylar.livingfire.de/api/listdatas/2
Retrieve
A GET
request will retrieve a ListData.
Response fields
Path | Type | Description |
---|---|---|
|
|
|
|
|
ISO 8601 date with TimeZone UTC in format "yyyy-MM-dd’T’HH:mm:ssZ" e.g. 2017-04-01T00:00:00Z |
|
|
Description or name |
|
|
Name of a dimension in a matrix. E.g. distance, time, x, y, z, … |
|
|
The group this value belongs to. This can be thougt of a as a another dimension in a matrix |
|
|
creation date |
|
|
a unit of measurement like km, s, ccm |
|
|
Value like 42, 3.1415, 'Hello World!' |
|
|
Links to other resources |
Curl request
$ curl 'http://skylar.livingfire.de/api/listdatas/2' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 601
{
"uuid" : "dc06c6d1-39d9-4869-8628-938dd0fa0375",
"logstash" : "2017-04-01T00:00:01Z",
"description" : "beautiful weather and good run",
"group" : "running",
"entryDate" : "2019-01-28T15:08:11.752Z",
"dimension" : "distance",
"unit" : "km",
"value" : "13",
"_links" : {
"self" : {
"href" : "http://skylar.livingfire.de/api/listdatas/2"
},
"listdata" : {
"href" : "http://skylar.livingfire.de/api/listdatas/2"
},
"relationDimensionHasDimension" : {
"href" : "http://skylar.livingfire.de/api/listdatas/2/relationDimensionHasDimension"
}
}
}
Update
A PATCH
request will update a ListData.
Curl request
$ curl 'http://skylar.livingfire.de/api/listdatas/2' -i -X PATCH \
-H 'Content-Type: application/hal+json' \
-d '{
"description" : "bad rain on run"
}'
HTTP response
HTTP/1.1 204 No Content
Delete
A DELETE
request will delete a ListData.
Curl request
$ curl 'http://skylar.livingfire.de/api/listdatas/2' -i -X DELETE \
-H 'Content-Type: application/hal+json'
HTTP response
HTTP/1.1 204 No Content
Search
Details
Curl request
$ curl 'http://skylar.livingfire.de/api/listdatas/search' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 835
{
"_links" : {
"findByUuid" : {
"href" : "http://skylar.livingfire.de/api/listdatas/search/findByUuid{?uuid}",
"templated" : true
},
"findByDescription" : {
"href" : "http://skylar.livingfire.de/api/listdatas/search/findByDescription{?description}",
"templated" : true
},
"findByGroupAndDimension" : {
"href" : "http://skylar.livingfire.de/api/listdatas/search/findByGroupAndDimension{?group,dimension}",
"templated" : true
},
"groupDimension" : {
"href" : "http://skylar.livingfire.de/api/listdatas/search/groupDimension"
},
"findByGroup" : {
"href" : "http://skylar.livingfire.de/api/listdatas/search/findByGroup{?group}",
"templated" : true
},
"self" : {
"href" : "http://skylar.livingfire.de/api/listdatas/search"
}
}
}
findByUuid
A GET
request will retrieve a ListData.
Request parameters
Parameter | Description |
---|---|
|
Response fields
Path | Type | Description |
---|---|---|
|
|
|
|
|
ISO 8601 date with TimeZone UTC in format "yyyy-MM-dd’T’HH:mm:ssZ" e.g. 2017-04-01T00:00:00Z |
|
|
Description or name |
|
|
Name of a dimension in a matrix. E.g. distance, time, x, y, z, … |
|
|
The group this value belongs to. This can be thougt of a as a another dimension in a matrix |
|
|
creation date |
|
|
a unit of measurement like km, s, ccm |
|
|
Value like 42, 3.1415, 'Hello World!' |
|
|
Links to other resources |
Curl request
$ curl 'http://skylar.livingfire.de/api/listdatas/search/findByUuid?uuid=dc06c6d1-39d9-4869-8628-938dd0fa0375' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 586
{
"uuid" : "dc06c6d1-39d9-4869-8628-938dd0fa0375",
"logstash" : "2017-04-01T00:00:01Z",
"description" : "bad rain on run",
"group" : "running",
"entryDate" : "2019-01-28T15:08:11.752Z",
"dimension" : "distance",
"unit" : "km",
"value" : "13",
"_links" : {
"self" : {
"href" : "http://skylar.livingfire.de/api/listdatas/2"
},
"listdata" : {
"href" : "http://skylar.livingfire.de/api/listdatas/2"
},
"relationDimensionHasDimension" : {
"href" : "http://skylar.livingfire.de/api/listdatas/2/relationDimensionHasDimension"
}
}
}
findByDescription
A GET
request will retrieve a array of ListData.
Request parameters
Parameter | Description |
---|---|
|
Description or name |
Response fields
Path | Type | Description |
---|---|---|
|
|
An array of ListData |
|
|
Links to other resources |
Curl request
$ curl 'http://skylar.livingfire.de/api/listdatas/search/findByDescription?description=beautiful+weather+and+good+run' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 172
{
"_embedded" : {
"listdatas" : [ ]
},
"_links" : {
"self" : {
"href" : "http://skylar.livingfire.de/api/listdatas/search/findByDescription"
}
}
}
Links
Relation | Description |
---|---|
|
Canonical link for this resource |
ListDatas
Listing
A GET
request will retrieve a paginated view of all Setting.
Response fields
Path | Type | Description |
---|---|---|
|
|
An array of Setting |
|
|
Links to other resources |
|
|
Curl request
$ curl 'http://skylar.livingfire.de/api/settings' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1007
{
"_embedded" : {
"settings" : [ {
"uuid" : "85f4fb14-8493-4ceb-945d-cdbd4f239cb9",
"logstash" : "2017-04-01T00:00:00+02:00",
"description" : "en",
"dimension" : "ttsLanguage",
"_links" : {
"self" : {
"href" : "http://skylar.livingfire.de/api/settings/4"
},
"setting" : {
"href" : "http://skylar.livingfire.de/api/settings/4"
},
"relationDimensionHasDimension" : {
"href" : "http://skylar.livingfire.de/api/settings/4/relationDimensionHasDimension"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "http://skylar.livingfire.de/api/settings{?page,size,sort}",
"templated" : true
},
"profile" : {
"href" : "http://skylar.livingfire.de/api/profile/settings"
},
"search" : {
"href" : "http://skylar.livingfire.de/api/settings/search"
}
},
"page" : {
"size" : 20,
"totalElements" : 1,
"totalPages" : 1,
"number" : 0
}
}
Links
Relation | Description |
---|---|
|
Canonical link for this resource |
|
|
|
Canonical link to search resources |