Methods
Common Methods
Recommended Headers
| Header | Value |
|---|---|
| Accept | application/json |
| Content-Type | application/json |
Common Endpoints
Get Entity by ID
GET https://api.dotykacka.cz/v2/clouds/:cloudId/:entity/:entityId
Get a single entity identified by its ID.
Path Parameters
| Name | Type | Description |
|---|---|---|
| cloudId | integer | ID of the cloud. |
| entity | string | Name of the entity type, f.e. "suppliers". |
| entityId | integer | ID of the entity to get. |
Header Parameters
| Name | Type | Description |
|---|---|---|
| Authorization | string | Bearer accessToken |
| If-None-Match | string | ETag to return results only if changed. |
Responses
Filter&Sort Entities
GET https://api.dotykacka.cz/v2/clouds/:cloudId/:entity
Get a custom-sorted paginated list of entities matching the filter criteria. Without applying a filter over deleted, only non-deleted entities are output.
Path Parameters
| Name | Type | Description |
|---|---|---|
| cloudId | integer | ID of the cloud. |
| entity | string | Name of the entity type, f.e. "suppliers". |
Header Parameters
| Name | Type | Description |
|---|---|---|
| Authorization | string | Bearer accessToken |
| If-None-Match | string | ETag to return results only if changed. |
Query Parameters
| Name | Type | Description |
|---|---|---|
| filter | string | Filter conditions. |
| sort | string | Sort parameter. |
| page | integer | Page to start with. |
| limit | integer | Page size (100 records maximum) |
Responses
Update an Entity
PATCH https://api.dotykacka.cz/v2/clouds/:cloudId/:entity/:entityId
Update a single entity identified by its ID.
Path Parameters
| Name | Type | Description |
|---|---|---|
| cloudId | integer | ID of the cloud. |
| entity | string | Name of the entity type, f.e. "suppliers". |
| entityId | integer | ID of the entity to update. |
Header Parameters
| Name | Type | Description |
|---|---|---|
| Authorization | string | Bearer accessToken |
| If-Match | string | ETag to update only if not changed. |
Responses
Create New Entities
POST https://api.dotykacka.cz/v2/clouds/:cloudId/:entity
Create a list of new entities.
Path Parameters
| Name | Type | Description |
|---|---|---|
| cloudId | integer | ID of the cloud. |
| entity | string | Name of the entity type, f.e. "suppliers". |
Header Parameters
| Name | Type | Description |
|---|---|---|
| Authorization | string | Bearer accessToken |
Responses
Replace Single Entity
PUT https://api.dotykacka.cz/v2/clouds/:cloudId/:entity/:entityId
Replace a single entity identified by its ID.
Path Parameters
| Name | Type | Description |
|---|---|---|
| cloudId | integer | ID of the cloud. |
| entity | string | Name of the entity type, f.e. "suppliers". |
| entityId | integer | ID of the entity to replace. |
Header Parameters
| Name | Type | Description |
|---|---|---|
| Authorization | string | Bearer accessToken |
| If-Match | string | ETag required when updating an entity. ETag ignored when inserting new entity. |
Responses
Replace Many Entities
PUT https://api.dotykacka.cz/v2/clouds/:cloudId/:entity
Replace a list of entities.
Path Parameters
| Name | Type | Description |
|---|---|---|
| cloudId | integer | ID of the cloud. |
| entity | string | Name of the entity type, f.e. "suppliers". |
Header Parameters
| Name | Type | Description |
|---|---|---|
| Authorization | string | Bearer accessToken |
| If-Match | string | ETag required when updating at least a single entity. ETag ignored when inserting new entities only. |
Responses
Delete an Entity
DELETE https://api.dotykacka.cz/v2/clouds/:cloudId/:entity/:entityId
Delete a single entity identified by its ID.
Path Parameters
| Name | Type | Description |
|---|---|---|
| cloudId | string | ID of the cloud. |
| entity | string | Name of the entity type, f.e. "suppliers". |
| entityId | string | ID of the entity to delete. |
Header Parameters
| Name | Type | Description |
|---|---|---|
| Authorization | string | Bearer accessToken |
| If-Match | string | ETag ignored (temporarily) when deleting an entity. |
Responses
{ "name": "Cake's name", "recipe": "Cake's recipe name", "cake": "Binary cake"}
{ "message": "Ain't no cake like that."}
Options
OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/:entity
Path Parameters
| Name | Type | Description |
|---|---|---|
| cloudId | integer | ID of the cloud. |
| entity | string | Name of the entity type, f.e. "suppliers". |
Header Parameters
| Name | Type | Description |
|---|---|---|
| Authorization | string | Bearer accessToken |
Responses
Options with Entity ID
OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/:entity/:entityId
Path Parameters
| Name | Type | Description |
|---|---|---|
| cloudId | integer | ID of the cloud. |
| entity | string | Name of the entity type, f.e. "suppliers". |
| entityId | integer | ID of the entity to get the options for. |
Header Parameters
| Name | Type | Description |
|---|---|---|
| Authorization | string | Bearer accessToken |
Responses