ListData

Details

Curl request

$ curl 'http://skylar.livingfire.de/api/profile/listdatas' -i

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" : 1523712562.595000000,
  "dimension" : "distance",
  "unit" : "km",
  "value" : "13",
  "relationDimensionHasDimension" : null
}'

HTTP response

HTTP/1.1 201 Created
Location: http://skylar.livingfire.de/api/listdatas/5

Retrieve

A GET request will retrieve a ListData.

Response fields

Path Type Description

uuid

String

Java UUID

logstash

String

ISO 8601 date with TimeZone UTC in format "yyyy-MM-dd’T’HH:mm:ssZ" e.g. 2017-04-01T00:00:00Z

description

String

Description or name

dimension

String

Name of a dimension in a matrix. E.g. distance, time, x, y, z, …​

group

String

The group this value belongs to. This can be thougt of a as a another dimension in a matrix

entryDate

String

creation date

unit

String

a unit of measurement like km, s, ccm

value

String

Value like 42, 3.1415, 'Hello World!'

_links

Object

Links to other resources

Curl request

$ curl 'http://skylar.livingfire.de/api/listdatas/5' -i

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" : "2018-04-14T13:29:22.595Z",
  "dimension" : "distance",
  "unit" : "km",
  "value" : "13",
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/listdatas/5"
    },
    "listdata" : {
      "href" : "http://skylar.livingfire.de/api/listdatas/5"
    },
    "relationDimensionHasDimension" : {
      "href" : "http://skylar.livingfire.de/api/listdatas/5/relationDimensionHasDimension"
    }
  }
}
Relation Description

self

Canonical link for this resource

listdata

This ListData

relationDimensionHasDimension

Relation Dimension

Update

A PATCH request will update a ListData.

Curl request

$ curl 'http://skylar.livingfire.de/api/listdatas/5' -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/5' -i -X DELETE \
    -H 'Content-Type: application/hal+json'

HTTP response

HTTP/1.1 204 No Content

Details

Curl request
$ curl 'http://skylar.livingfire.de/api/listdatas/search' -i
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
    },
    "findByGroup" : {
      "href" : "http://skylar.livingfire.de/api/listdatas/search/findByGroup{?group}",
      "templated" : true
    },
    "groupDimension" : {
      "href" : "http://skylar.livingfire.de/api/listdatas/search/groupDimension"
    },
    "self" : {
      "href" : "http://skylar.livingfire.de/api/listdatas/search"
    }
  }
}

findByUuid

A GET request will retrieve a ListData.

Request parameters
Parameter Description

uuid

Java UUID

Response fields
Path Type Description

uuid

String

Java UUID

logstash

String

ISO 8601 date with TimeZone UTC in format "yyyy-MM-dd’T’HH:mm:ssZ" e.g. 2017-04-01T00:00:00Z

description

String

Description or name

dimension

String

Name of a dimension in a matrix. E.g. distance, time, x, y, z, …​

group

String

The group this value belongs to. This can be thougt of a as a another dimension in a matrix

entryDate

String

creation date

unit

String

a unit of measurement like km, s, ccm

value

String

Value like 42, 3.1415, 'Hello World!'

_links

Object

Links to other resources

Curl request
$ curl 'http://skylar.livingfire.de/api/listdatas/search/findByUuid?uuid=dc06c6d1-39d9-4869-8628-938dd0fa0375' -i
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" : "2018-04-14T13:29:22.595Z",
  "dimension" : "distance",
  "unit" : "km",
  "value" : "13",
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/listdatas/5"
    },
    "listdata" : {
      "href" : "http://skylar.livingfire.de/api/listdatas/5"
    },
    "relationDimensionHasDimension" : {
      "href" : "http://skylar.livingfire.de/api/listdatas/5/relationDimensionHasDimension"
    }
  }
}
Relation Description

self

Canonical link for this resource

listdata

This ListData

relationDimensionHasDimension

Relation Dimension

findByDescription

A GET request will retrieve a array of ListData.

Request parameters
Parameter Description

description

Description or name

Response fields
Path Type Description

_embedded.listdatas

Array

An array of ListData

_links

Object

Links to other resources

Curl request
$ curl 'http://skylar.livingfire.de/api/listdatas/search/findByDescription?description=beautiful+weather+and+good+run' -i
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"
    }
  }
}
Relation Description

self

Canonical link for this resource

ListDatas

Listing

A GET request will retrieve a paginated view of all Setting.

Response fields

Path Type Description

_embedded.settings

Array

An array of Setting

_links

Object

Links to other resources

page

Object

paging information

Curl request

$ curl 'http://skylar.livingfire.de/api/settings' -i

HTTP response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1007

{
  "_embedded" : {
    "settings" : [ {
      "uuid" : "d0341c85-7233-45fa-a27e-2af57e9f1108",
      "logstash" : "2017-04-01T00:00:00+02:00",
      "description" : "en",
      "dimension" : "ttsLanguage",
      "_links" : {
        "self" : {
          "href" : "http://skylar.livingfire.de/api/settings/7"
        },
        "setting" : {
          "href" : "http://skylar.livingfire.de/api/settings/7"
        },
        "relationDimensionHasDimension" : {
          "href" : "http://skylar.livingfire.de/api/settings/7/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
  }
}
Relation Description

self

Canonical link for this resource

profile

The Application-Level Profile Semantics (ALPS)

search

Canonical link to search resources