Methods

Common Methods

Recommended Headers

Header

Value

Accept

application/json

Content-Type

application/json

Common Endpoints

get
Get Entity by ID

https://api.dotykacka.cz/v2/clouds/:cloudId/:entity/:entityId
Get a single entity identified by its ID.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
entity
required
string
Name of the entity type, f.e. "suppliers".
entityId
required
integer
ID of the entity to get.
Headers
Authorization
required
string
Bearer accessToken
If-None-Match
optional
string
ETag to return results only if changed.
Response
200: OK

get
Filter&Sort Entities

https://api.dotykacka.cz/v2/clouds/:cloudId/:entity
Get a custom-sorted paginated list of entities matching the filter criteria.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
entity
required
string
Name of the entity type, f.e. "suppliers".
Headers
Authorization
required
string
Bearer accessToken
If-None-Match
optional
string
ETag to return results only if changed.
Query Parameters
filter
optional
string
Filter conditions.
sort
optional
string
Sort parameter.
page
optional
integer
Page to start with.
limit
optional
integer
Page size (100 records maximum)
Response
200: OK

patch
Update an Entity

https://api.dotykacka.cz/v2/clouds/:cloudId/:entity/:entityId
Update a single entity identified by its ID.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
entity
required
string
Name of the entity type, f.e. "suppliers".
entityId
required
integer
ID of the entity to update.
Headers
Authorization
required
string
Bearer accessToken
If-Match
required
string
ETag to update only if not changed.
Response
200: OK

post
Create New Entities

https://api.dotykacka.cz/v2/clouds/:cloudId/:entity
Create a list of new entities.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
entity
required
string
Name of the entity type, f.e. "suppliers".
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK

put
Replace Single Entity

https://api.dotykacka.cz/v2/clouds/:cloudId/:entity/:entityId
Replace a single entity identified by its ID.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
entity
required
string
Name of the entity type, f.e. "suppliers".
entityId
required
integer
ID of the entity to replace.
Headers
Authorization
required
string
Bearer accessToken
If-Match
required
string
ETag required when updating an entity. ETag ignored when inserting new entity.
Response
200: OK

put
Replace Many Entities

https://api.dotykacka.cz/v2/clouds/:cloudId/:entity
Replace a list of entities.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
entity
required
string
Name of the entity type, f.e. "suppliers".
Headers
Authorization
required
string
Bearer accessToken
If-Match
required
string
ETag required when updating at least a single entity. ETag ignored when inserting new entities only.
Response
200: OK

delete
Delete an Entity

https://api.dotykacka.cz/v2/clouds/:cloudId/:entity/:entityId
Delete a single entity identified by its ID.
Request
Response
Request
Path Parameters
cloudId
required
string
ID of the cloud.
entity
required
string
Name of the entity type, f.e. "suppliers".
entityId
required
string
ID of the entity to delete.
Headers
Authorization
required
string
Bearer accessToken
If-Match
required
string
ETag ignored (temporarily) when deleting an entity.
Response
200: OK
Cake successfully retrieved.
{ "name": "Cake's name", "recipe": "Cake's recipe name", "cake": "Binary cake"}
404: Not Found
Could not find a cake matching this query.
{ "message": "Ain't no cake like that."}

options
Options

https://api.dotykacka.cz/v2/clouds/:cloudId/:entity
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
entity
required
string
Name of the entity type, f.e. "suppliers".
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK

options
Options with Entity ID

https://api.dotykacka.cz/v2/clouds/:cloudId/:entity/:entityId
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
entity
required
string
Name of the entity type, f.e. "suppliers".
entityId
required
integer
ID of the entity to get the options for.
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK