Setting

Details

Curl request

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

Create

A POST request will create a Setting.

Curl request

$ curl 'http://skylar.livingfire.de/api/settings' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -d '{
  "id" : null,
  "uuid" : "d0341c85-7233-45fa-a27e-2af57e9f1108",
  "logstash" : "2017-04-01T00:00:00+02:00",
  "description" : "de",
  "dimension" : "ttsLanguage",
  "relationDimensionHasDimension" : null
}'

HTTP response

HTTP/1.1 201 Created
Location: http://skylar.livingfire.de/api/settings/7

Retrieve

A GET request will retrieve a Setting.

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, …​

_links

Object

Links to other resources

Curl request

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

HTTP response

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

{
  "uuid" : "d0341c85-7233-45fa-a27e-2af57e9f1108",
  "logstash" : "2017-04-01T00:00:00+02:00",
  "description" : "de",
  "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"
    }
  }
}
Relation Description

self

Canonical link for this resource

setting

This Setting

relationDimensionHasDimension

Relation Dimension

Update

A PATCH request will update a Setting.

Curl request

$ curl 'http://skylar.livingfire.de/api/settings/7' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -d '{
  "description" : "en"
}'

HTTP response

HTTP/1.1 204 No Content

Delete

A DELETE request will delete a Setting.

Curl request

$ curl 'http://skylar.livingfire.de/api/settings/7' -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/settings/search' -i
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 555

{
  "_links" : {
    "findByDescription" : {
      "href" : "http://skylar.livingfire.de/api/settings/search/findByDescription{?description}",
      "templated" : true
    },
    "findByDimension" : {
      "href" : "http://skylar.livingfire.de/api/settings/search/findByDimension{?dimension}",
      "templated" : true
    },
    "findByUuid" : {
      "href" : "http://skylar.livingfire.de/api/settings/search/findByUuid{?uuid}",
      "templated" : true
    },
    "self" : {
      "href" : "http://skylar.livingfire.de/api/settings/search"
    }
  }
}

findByUuid

A GET request will retrieve a Setting.

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, …​

_links

Object

Links to other resources

Curl request
$ curl 'http://skylar.livingfire.de/api/settings/search/findByUuid?uuid=d0341c85-7233-45fa-a27e-2af57e9f1108' -i
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 475

{
  "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"
    }
  }
}
Relation Description

self

Canonical link for this resource

setting

This Setting

relationDimensionHasDimension

Relation Dimension

findByDescription

A GET request will retrieve a array of Setting.

Request parameters
Parameter Description

description

Description or name

Response fields
Path Type Description

_embedded.settings

Array

An array of Setting

_links

Object

Links to other resources

Curl request
$ curl 'http://skylar.livingfire.de/api/settings/search/findByDescription?description=de' -i
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 170

{
  "_embedded" : {
    "settings" : [ ]
  },
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/settings/search/findByDescription"
    }
  }
}
Relation Description

self

Canonical link for this resource

Settings

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