Note

Details

See Application-Level Profile Semantics (ALPS)

Curl request

$ curl 'http://skylar.livingfire.de/api/profile/notes' -i -X GET

Create

A POST request will create a Note.

Curl request

$ curl 'http://skylar.livingfire.de/api/notes' -i -X POST \
    -H 'Content-Type: application/hal+json' \
    -d '{
  "id" : null,
  "uuid" : "2d8b978f-e659-43c5-96b5-563ab7164fd5",
  "logstash" : "2017-04-01T00:00:00+02:00",
  "description" : "2018-04-01 started job - Java Application Developer",
  "url" : "http://www.google.de/javaDeveloper"
}'

HTTP response

HTTP/1.1 201 Created
Location: http://skylar.livingfire.de/api/notes/3

Retrieve

A GET request will retrieve a Note.

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

url

String

a URL like https://www.youtube.com/

_links

Object

Links to other resources

Curl request

$ curl 'http://skylar.livingfire.de/api/notes/3' -i -X GET

HTTP response

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

{
  "uuid" : "2d8b978f-e659-43c5-96b5-563ab7164fd5",
  "logstash" : "2017-04-01T00:00:00+02:00",
  "description" : "2018-04-01 started job - Java Application Developer",
  "url" : "http://www.google.de/javaDeveloper",
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/notes/3"
    },
    "note" : {
      "href" : "http://skylar.livingfire.de/api/notes/3"
    }
  }
}
Relation Description

self

Canonical link for this resource

note

This Note

Update

A PATCH request will update a Note.

Curl request

$ curl 'http://skylar.livingfire.de/api/notes/3' -i -X PATCH \
    -H 'Content-Type: application/hal+json' \
    -d '{
  "description" : "2018-04-01 started job - Java Application Developer"
}'

HTTP response

HTTP/1.1 204 No Content

Delete

A DELETE request will delete a Note.

Curl request

$ curl 'http://skylar.livingfire.de/api/notes/3' -i -X DELETE \
    -H 'Content-Type: application/hal+json'

HTTP response

HTTP/1.1 204 No Content

Details

See Application-Level Profile Semantics (ALPS)

Curl request
$ curl 'http://skylar.livingfire.de/api/notes/search' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 511

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

findByUuid

A GET request will retrieve a Note.

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

url

String

a URL like https://www.youtube.com/

_links

Object

Links to other resources
Curl request
$ curl 'http://skylar.livingfire.de/api/notes/search/findByUuid?uuid=2d8b978f-e659-43c5-96b5-563ab7164fd5' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 395

{
  "uuid" : "2d8b978f-e659-43c5-96b5-563ab7164fd5",
  "logstash" : "2017-04-01T00:00:00+02:00",
  "description" : "2018-04-01 started job - Java Application Developer",
  "url" : "http://www.google.de/javaDeveloper",
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/notes/3"
    },
    "note" : {
      "href" : "http://skylar.livingfire.de/api/notes/3"
    }
  }
}
Relation Description

self

Canonical link for this resource

note

This Note

findByDescription

A GET request will retrieve a array of Note.

Request parameters
Parameter Description

description

Description or name
Response fields
Path Type Description

_embedded.notes

Array

An array of Note

_links

Object

Links to other resources
Curl request
$ curl 'http://skylar.livingfire.de/api/notes/search/findByDescription?description=2018-04-01+started+job+-+Java+Application+Developer' -i -X GET
HTTP response
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 612

{
  "_embedded" : {
    "notes" : [ {
      "uuid" : "2d8b978f-e659-43c5-96b5-563ab7164fd5",
      "logstash" : "2017-04-01T00:00:00+02:00",
      "description" : "2018-04-01 started job - Java Application Developer",
      "url" : "http://www.google.de/javaDeveloper",
      "_links" : {
        "self" : {
          "href" : "http://skylar.livingfire.de/api/notes/3"
        },
        "note" : {
          "href" : "http://skylar.livingfire.de/api/notes/3"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/notes/search/findByDescription"
    }
  }
}
Relation Description

self

Canonical link for this resource

Notes

Listing

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

Response fields

Path Type Description

_embedded.notes

Array

An array of Note

_links

Object

Notes to other resources

page

Object

paging information

Curl request

$ curl 'http://skylar.livingfire.de/api/notes' -i -X GET

HTTP response

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

{
  "_embedded" : {
    "notes" : [ {
      "uuid" : "2d8b978f-e659-43c5-96b5-563ab7164fd5",
      "logstash" : "2017-04-01T00:00:00+02:00",
      "description" : "2018-04-01 started job - Java Application Developer",
      "url" : "http://www.google.de/javaDeveloper",
      "_links" : {
        "self" : {
          "href" : "http://skylar.livingfire.de/api/notes/3"
        },
        "note" : {
          "href" : "http://skylar.livingfire.de/api/notes/3"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://skylar.livingfire.de/api/notes{?page,size,sort}",
      "templated" : true
    },
    "profile" : {
      "href" : "http://skylar.livingfire.de/api/profile/notes"
    },
    "search" : {
      "href" : "http://skylar.livingfire.de/api/notes/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