Api¶
-
POST
/{category}
¶ Add new resource in defined category.
- Parameters
category (string) –
# Brief
Resource category.
- Request JSON Object
data.attributes.brief (string) – # Brief Optional brief description of the resource.
data.attributes.data[] (string) –
data.attributes.description (string) – # Brief Optional long description of the resource.
data.attributes.filename (string) – # Brief Optional filename. This attribute can be used for example to export the resource into file which name is defined by this attribute-
data.attributes.groups[] (string) –
data.attributes.languages[] (string) –
data.attributes.links[] (string) –
data.attributes.name (string) – # Brief Optional name for the resource.
data.attributes.source (string) – # Brief Optional external source for the resource.”
data.attributes.tags[] (string) –
data.attributes.versions[] (string) –
data.type (string) – (required)
- Status Codes
201 Created – Resource created
400 Bad Request – Request not syntactically correct
403 Forbidden – Using client generated ID is not supported
500 Internal Server Error – Internal server error
- Response JSON Object
data[].attributes.brief (string) – # Brief Optional brief description of the resource.
data[].attributes.category (string) – # Brief Automatically assigned resource category.
data[].attributes.created (string) – # Brief Automatically generated UTC timestamp when the resource is created. The time is defined with RFC 3339 profile of the ISO 8601 specification.
data[].attributes.data[] (string) –
data[].attributes.description (string) – # Brief Optional long description of the resource.
data[].attributes.digest (string) – # Brief Automatically assigned message digest that uniquely identifies the resource.
data[].attributes.filename (string) – # Brief Optional filename. This attribute can be used for example to export the resource into file which name is defined by this attribute-
data[].attributes.groups[] (string) –
data[].attributes.languages[] (string) –
data[].attributes.links[] (string) –
data[].attributes.name (string) – # Brief Optional name for the resource.
data[].attributes.source (string) – # Brief Optional external source for the resource.”
data[].attributes.tags[] (string) –
data[].attributes.updated (string) – # Brief Automatically generated UTC timestamp for the latest update. The time is defined with RFC 3339 profile of the ISO 8601 specification.
data[].attributes.uuid (string) – # Brief Automatically assigned UUID for the resource.
data[].attributes.versions[] (string) –
data[].id (string) –
data[].type (string) – (required)
-
GET
/{category}
¶ Search resource
- Parameters
category (string) –
# Brief
Resource category.
- Query Parameters
sall (array) –
# Brief
Search given keywords.
stag (array) –
# Brief
Limit search to resources that have any of the given tags.
sgrp (array) –
# Brief
Limit search to resources that are in any of the given groups.
digest (array) –
# Brief
Limit search to resources that are have given digest.
uuid (array) –
# Brief
Limit search to resources that are have given uuid.
filter (string) –
# Brief
Filter search results with a regexp.
limit (string) –
# Brief
Limit resources in search result.
fields (array) –
# Brief
Limit fields that are returned in result list.
sort (string) –
# Brief
Sort based on defined field.
offset (string) –
# Brief
Offset from the beginning of the search results.
- Status Codes
200 OK – OK
400 Bad Request – Request not syntactically correct
404 Not Found – Resource not found
500 Internal Server Error – Internal server error
- Response JSON Object
data[].attributes.brief (string) – # Brief Optional brief description of the resource.
data[].attributes.category (string) – # Brief Automatically assigned resource category.
data[].attributes.created (string) – # Brief Automatically generated UTC timestamp when the resource is created. The time is defined with RFC 3339 profile of the ISO 8601 specification.
data[].attributes.data[] (string) –
data[].attributes.description (string) – # Brief Optional long description of the resource.
data[].attributes.digest (string) – # Brief Automatically assigned message digest that uniquely identifies the resource.
data[].attributes.filename (string) – # Brief Optional filename. This attribute can be used for example to export the resource into file which name is defined by this attribute-
data[].attributes.groups[] (string) –
data[].attributes.languages[] (string) –
data[].attributes.links[] (string) –
data[].attributes.name (string) – # Brief Optional name for the resource.
data[].attributes.source (string) – # Brief Optional external source for the resource.”
data[].attributes.tags[] (string) –
data[].attributes.updated (string) – # Brief Automatically generated UTC timestamp for the latest update. The time is defined with RFC 3339 profile of the ISO 8601 specification.
data[].attributes.uuid (string) – # Brief Automatically assigned UUID for the resource.
data[].attributes.versions[] (string) –
data[].id (string) –
data[].type (string) – (required)
links.first (string) – Pagination link to first page. (required)
links.last (string) – Pagination link to last page. (required)
links.next (string) – Pagination link to next page.
links.prev (string) – Pagination link to previous page.
links.self (string) – Pagination link to this page. (required)
meta.count (string) – Number of resources in the data object. (required)
meta.limit (string) – The search limit used in request. (required)
meta.offset (string) – The search offset used in request. (required)
meta.total (string) – Total number of search results without limit being applied. (required)
-
POST
/{category}/{id}
¶ Override POST with PUT, PATCH or DELETE
- Parameters
category (string) –
# Brief
Resource category.
id (string) –
# Brief
Resource identity that can be either digest or UUID. Partial identities are allowed but they may result multiple matching resources which is an error. The
id
path parameter must uniquely identify the requested resource.Even though the code supports digest and partial identities, it is recommended to use full length UUID. The full length UUID remains the same for whole life time of the resource. The digest will change when the resource attributes change.
- Request JSON Object
data.attributes.brief (string) – # Brief Optional brief description of the resource.
data.attributes.data[] (string) –
data.attributes.description (string) – # Brief Optional long description of the resource.
data.attributes.filename (string) – # Brief Optional filename. This attribute can be used for example to export the resource into file which name is defined by this attribute-
data.attributes.groups[] (string) –
data.attributes.languages[] (string) –
data.attributes.links[] (string) –
data.attributes.name (string) – # Brief Optional name for the resource.
data.attributes.source (string) – # Brief Optional external source for the resource.”
data.attributes.tags[] (string) –
data.attributes.versions[] (string) –
data.type (string) – (required)
- Status Codes
200 OK – OK
204 No Content – Resource deleted
400 Bad Request – Request not syntactically correct
403 Forbidden – Using client generated ID is not supported
404 Not Found – Resource not found
500 Internal Server Error – Internal server error
- Request Headers
X-HTTP-Method-Override –
# Brief
Override POST method with PUT, PATCH or DELETE.
- Response JSON Object
data.attributes.brief (string) – # Brief Optional brief description of the resource.
data.attributes.category (string) – # Brief Automatically assigned resource category.
data.attributes.created (string) – # Brief Automatically generated UTC timestamp when the resource is created. The time is defined with RFC 3339 profile of the ISO 8601 specification.
data.attributes.data[] (string) –
data.attributes.description (string) – # Brief Optional long description of the resource.
data.attributes.digest (string) – # Brief Automatically assigned message digest that uniquely identifies the resource.
data.attributes.filename (string) – # Brief Optional filename. This attribute can be used for example to export the resource into file which name is defined by this attribute-
data.attributes.groups[] (string) –
data.attributes.languages[] (string) –
data.attributes.links[] (string) –
data.attributes.name (string) – # Brief Optional name for the resource.
data.attributes.source (string) – # Brief Optional external source for the resource.”
data.attributes.tags[] (string) –
data.attributes.updated (string) – # Brief Automatically generated UTC timestamp for the latest update. The time is defined with RFC 3339 profile of the ISO 8601 specification.
data.attributes.uuid (string) – # Brief Automatically assigned UUID for the resource.
data.attributes.versions[] (string) –
data.id (string) –
data.type (string) – (required)
link.self (string) – Link pointing to resource.
-
PUT
/{category}/{id}
¶ Update defined resource based on given identity.
- Parameters
category (string) –
# Brief
Resource category.
id (string) –
# Brief
Resource identity that can be either digest or UUID. Partial identities are allowed but they may result multiple matching resources which is an error. The
id
path parameter must uniquely identify the requested resource.Even though the code supports digest and partial identities, it is recommended to use full length UUID. The full length UUID remains the same for whole life time of the resource. The digest will change when the resource attributes change.
- Request JSON Object
data.attributes.brief (string) – # Brief Optional brief description of the resource.
data.attributes.data[] (string) –
data.attributes.description (string) – # Brief Optional long description of the resource.
data.attributes.filename (string) – # Brief Optional filename. This attribute can be used for example to export the resource into file which name is defined by this attribute-
data.attributes.groups[] (string) –
data.attributes.languages[] (string) –
data.attributes.links[] (string) –
data.attributes.name (string) – # Brief Optional name for the resource.
data.attributes.source (string) – # Brief Optional external source for the resource.”
data.attributes.tags[] (string) –
data.attributes.versions[] (string) –
data.type (string) – (required)
- Status Codes
200 OK – OK
400 Bad Request – Request not syntactically correct
403 Forbidden – Using client generated ID is not supported
404 Not Found – Resource not found
500 Internal Server Error – Internal server error
- Response JSON Object
data.attributes.brief (string) – # Brief Optional brief description of the resource.
data.attributes.category (string) – # Brief Automatically assigned resource category.
data.attributes.created (string) – # Brief Automatically generated UTC timestamp when the resource is created. The time is defined with RFC 3339 profile of the ISO 8601 specification.
data.attributes.data[] (string) –
data.attributes.description (string) – # Brief Optional long description of the resource.
data.attributes.digest (string) – # Brief Automatically assigned message digest that uniquely identifies the resource.
data.attributes.filename (string) – # Brief Optional filename. This attribute can be used for example to export the resource into file which name is defined by this attribute-
data.attributes.groups[] (string) –
data.attributes.languages[] (string) –
data.attributes.links[] (string) –
data.attributes.name (string) – # Brief Optional name for the resource.
data.attributes.source (string) – # Brief Optional external source for the resource.”
data.attributes.tags[] (string) –
data.attributes.updated (string) – # Brief Automatically generated UTC timestamp for the latest update. The time is defined with RFC 3339 profile of the ISO 8601 specification.
data.attributes.uuid (string) – # Brief Automatically assigned UUID for the resource.
data.attributes.versions[] (string) –
data.id (string) –
data.type (string) – (required)
link.self (string) – Link pointing to resource.
-
PATCH
/{category}/{id}
¶ Update defined resource based on given identity.
- Parameters
category (string) –
# Brief
Resource category.
id (string) –
# Brief
Resource identity that can be either digest or UUID. Partial identities are allowed but they may result multiple matching resources which is an error. The
id
path parameter must uniquely identify the requested resource.Even though the code supports digest and partial identities, it is recommended to use full length UUID. The full length UUID remains the same for whole life time of the resource. The digest will change when the resource attributes change.
- Request JSON Object
data.attributes.brief (string) – # Brief Optional brief description of the resource.
data.attributes.data[] (string) –
data.attributes.description (string) – # Brief Optional long description of the resource.
data.attributes.filename (string) – # Brief Optional filename. This attribute can be used for example to export the resource into file which name is defined by this attribute-
data.attributes.groups[] (string) –
data.attributes.languages[] (string) –
data.attributes.links[] (string) –
data.attributes.name (string) – # Brief Optional name for the resource.
data.attributes.source (string) – # Brief Optional external source for the resource.”
data.attributes.tags[] (string) –
data.attributes.versions[] (string) –
data.type (string) – (required)
- Status Codes
200 OK – OK
400 Bad Request – Request not syntactically correct
403 Forbidden – Using client generated ID is not supported
404 Not Found – Resource not found
500 Internal Server Error – Internal server error
- Response JSON Object
data.attributes.brief (string) – # Brief Optional brief description of the resource.
data.attributes.category (string) – # Brief Automatically assigned resource category.
data.attributes.created (string) – # Brief Automatically generated UTC timestamp when the resource is created. The time is defined with RFC 3339 profile of the ISO 8601 specification.
data.attributes.data[] (string) –
data.attributes.description (string) – # Brief Optional long description of the resource.
data.attributes.digest (string) – # Brief Automatically assigned message digest that uniquely identifies the resource.
data.attributes.filename (string) – # Brief Optional filename. This attribute can be used for example to export the resource into file which name is defined by this attribute-
data.attributes.groups[] (string) –
data.attributes.languages[] (string) –
data.attributes.links[] (string) –
data.attributes.name (string) – # Brief Optional name for the resource.
data.attributes.source (string) – # Brief Optional external source for the resource.”
data.attributes.tags[] (string) –
data.attributes.updated (string) – # Brief Automatically generated UTC timestamp for the latest update. The time is defined with RFC 3339 profile of the ISO 8601 specification.
data.attributes.uuid (string) – # Brief Automatically assigned UUID for the resource.
data.attributes.versions[] (string) –
data.id (string) –
data.type (string) – (required)
link.self (string) – Link pointing to resource.
-
GET
/{category}/{id}
¶ Search defined resource based on given identity.
- Parameters
category (string) –
# Brief
Resource category.
id (string) –
# Brief
Resource identity that can be either digest or UUID. Partial identities are allowed but they may result multiple matching resources which is an error. The
id
path parameter must uniquely identify the requested resource.Even though the code supports digest and partial identities, it is recommended to use full length UUID. The full length UUID remains the same for whole life time of the resource. The digest will change when the resource attributes change.
- Status Codes
200 OK – OK
400 Bad Request – Request not syntactically correct
404 Not Found – Resource not found
500 Internal Server Error – Internal server error
- Response JSON Object
data.attributes.brief (string) – # Brief Optional brief description of the resource.
data.attributes.category (string) – # Brief Automatically assigned resource category.
data.attributes.created (string) – # Brief Automatically generated UTC timestamp when the resource is created. The time is defined with RFC 3339 profile of the ISO 8601 specification.
data.attributes.data[] (string) –
data.attributes.description (string) – # Brief Optional long description of the resource.
data.attributes.digest (string) – # Brief Automatically assigned message digest that uniquely identifies the resource.
data.attributes.filename (string) – # Brief Optional filename. This attribute can be used for example to export the resource into file which name is defined by this attribute-
data.attributes.groups[] (string) –
data.attributes.languages[] (string) –
data.attributes.links[] (string) –
data.attributes.name (string) – # Brief Optional name for the resource.
data.attributes.source (string) – # Brief Optional external source for the resource.”
data.attributes.tags[] (string) –
data.attributes.updated (string) – # Brief Automatically generated UTC timestamp for the latest update. The time is defined with RFC 3339 profile of the ISO 8601 specification.
data.attributes.uuid (string) – # Brief Automatically assigned UUID for the resource.
data.attributes.versions[] (string) –
data.id (string) –
data.type (string) – (required)
link.self (string) – Link pointing to resource.
-
DELETE
/{category}/{id}
¶ Delete defined resource based on given identity.
- Parameters
category (string) –
# Brief
Resource category.
id (string) –
# Brief
Resource identity that can be either digest or UUID. Partial identities are allowed but they may result multiple matching resources which is an error. The
id
path parameter must uniquely identify the requested resource.Even though the code supports digest and partial identities, it is recommended to use full length UUID. The full length UUID remains the same for whole life time of the resource. The digest will change when the resource attributes change.
- Status Codes
204 No Content – Resource deleted
400 Bad Request – Request not syntactically correct
404 Not Found – Resource not found
409 Conflict – More than one resource found
500 Internal Server Error – Internal server error
-
GET
/{category}{id}{field}
¶ Get resource attribute.
- Parameters
category (string) –
# Brief
Resource category.
id (string) –
# Brief
Resource identity that can be either digest or UUID. Partial identities are allowed but they may result multiple matching resources which is an error. The
id
path parameter must uniquely identify the requested resource.Even though the code supports digest and partial identities, it is recommended to use full length UUID. The full length UUID remains the same for whole life time of the resource. The digest will change when the resource attributes change.
field (string) –
# Brief
Resource field.
- Query Parameters
sall (array) –
# Brief
Search given keywords.
stag (array) –
# Brief
Limit search to resources that have any of the given tags.
sgrp (array) –
# Brief
Limit search to resources that are in any of the given groups.
digest (array) –
# Brief
Limit search to resources that are have given digest.
uuid (array) –
# Brief
Limit search to resources that are have given uuid.
filter (string) –
# Brief
Filter search results with a regexp.
limit (string) –
# Brief
Limit resources in search result.
fields (array) –
# Brief
Limit fields that are returned in result list.
sort (string) –
# Brief
Sort based on defined field.
offset (string) –
# Brief
Offset from the beginning of the search results.
- Status Codes
200 OK – OK
400 Bad Request – Request not syntactically correct
404 Not Found – Resource not found
500 Internal Server Error – Internal server error
- Response JSON Object
data.attributes.brief (string) – # Brief Optional brief description of the resource.
data.attributes.category (string) – # Brief Automatically assigned resource category.
data.attributes.created (string) – # Brief Automatically generated UTC timestamp when the resource is created. The time is defined with RFC 3339 profile of the ISO 8601 specification.
data.attributes.data[] (string) –
data.attributes.description (string) – # Brief Optional long description of the resource.
data.attributes.digest (string) – # Brief Automatically assigned message digest that uniquely identifies the resource.
data.attributes.filename (string) – # Brief Optional filename. This attribute can be used for example to export the resource into file which name is defined by this attribute-
data.attributes.groups[] (string) –
data.attributes.languages[] (string) –
data.attributes.links[] (string) –
data.attributes.name (string) – # Brief Optional name for the resource.
data.attributes.source (string) – # Brief Optional external source for the resource.”
data.attributes.tags[] (string) –
data.attributes.updated (string) – # Brief Automatically generated UTC timestamp for the latest update. The time is defined with RFC 3339 profile of the ISO 8601 specification.
data.attributes.uuid (string) – # Brief Automatically assigned UUID for the resource.
data.attributes.versions[] (string) –
data.id (string) –
data.type (string) – (required)
link.self (string) – Link pointing to resource.
Get unique tags.
- Query Parameters
scat (array) –
# Brief
Limit search to resources in defined categories.
sall (array) –
# Brief
Search given keywords.
stag (array) –
# Brief
Limit search to resources that have any of the given tags.
sgrp (array) –
# Brief
Limit search to resources that are in any of the given groups.
- Status Codes
200 OK – OK
400 Bad Request – Request not syntactically correct
404 Not Found – Resource not found
500 Internal Server Error – Internal server error
- Response JSON Object
data.type (string) – (required)
-
GET
/groups
¶ Get unique groups.
- Query Parameters
scat (array) –
# Brief
Limit search to resources in defined categories.
sall (array) –
# Brief
Search given keywords.
stag (array) –
# Brief
Limit search to resources that have any of the given tags.
sgrp (array) –
# Brief
Limit search to resources that are in any of the given groups.
- Status Codes
200 OK – OK
400 Bad Request – Request not syntactically correct
404 Not Found – Resource not found
500 Internal Server Error – Internal server error
- Response JSON Object
data.type (string) – (required)
-
GET
/
¶ Get server hello.
- Status Codes
200 OK – OK
- Response JSON Object
meta.docs (string) – Location of the public documentation. (required)
meta.homepage (string) – Server homepage. (required)
meta.openapi (string) – OpenAPI specification. (required)
meta.version (string) – Server version. (required)