Api

POST /{category}

Add new resource in defined category.

Parameters:

• category (string) –

  # Brief

  Resource category.

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

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 defined tags.

• sgrp (array) –

  # Brief

  Limit search to resources that are in defined 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 result with given 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

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.

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.

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.

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

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.

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

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.

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

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.

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.

• field (string) –

  # Brief

  Resource field.

Query Parameters:  

• sall (array) –

  # Brief

  Search given keywords.

• stag (array) –

  # Brief

  Limit search to resources that have defined tags.

• sgrp (array) –

  # Brief

  Limit search to resources that are in defined 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 result with given 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

GET /

Server hello

Status Codes:

• 200 OK – OK