Branch
Branch schema
id integer?
Branch ID - cannot be null in PUT/PATCH methods
📶 EQUALS,ENUM 🔽 NONE
_cloudId integer
Cloud ID
🔽 NONE
created timestamp?
Branch created date and time
📶 EQUALS, ENUM, NUMBER 🔽 BOTH
deleted boolean
Branch deleted - cannot be true in POST/PUT/PATCH methods
📶 EQUALS, ENUM 🔽 BOTH
display boolean
Branch displayed
📶 EQUALS, ENUM 🔽 BOTH
features long
Branch features
📶 BITS 🔽 NONE
flags short
Branch flags
📶 BITS 🔽 NONE
name string(100)
Branch name
🔽 NONE
versionDate timestamp?
Last modification date and time
📶 EQUALS, ENUM, NUMBER 🔽 BOTH
Branch response
{
"_cloudId": <integer>,
"created": <timestamp>,
"deleted": <boolean>,
"display": <boolean>,
"features": <long>,
"flags": <short>,
"id": <integer>,
"name": <string>,
"versionDate": <timestamp>
}
Branch flags
| Bit | Name |
|---|---|
| 0 | SUBSTITUTING_BRANCH |
| 1 | REPLACED_BRANCH |
| 8 | HIDE_STOCK |
| 9 | HIDE_PRICES |
| 10 | FREE_LICENSE |
Get branches
GET https://api.dotykacka.cz/v2/clouds/:cloudId/branches
Path Parameters
| Name | Type | Description |
|---|---|---|
| cloudId* | integer |
Header Parameters
| Name | Type | Description |
|---|---|---|
| If-None-Match | string | ETag to return results only if changed. |
| Authorization* | string | Bearer accessToken |
Query Parameters
| Name | Type | Description |
|---|---|---|
| page | integer | |
| limit | integer | |
| filter | string | |
| sort | string |
Responses
{
// Response
}
{
// Response
}
Get branch
GET https://api.dotykacka.cz/v2/clouds/:cloudId/branches/:branchId
Path Parameters
| Name | Type | Description |
|---|---|---|
| cloudId* | integer | |
| branchId* | integer |
Header Parameters
| Name | Type | Description |
|---|---|---|
| If-None-Match | string | Add ETag to return results only if changed. |
| Authorization* | string | Bearer accessToken |
Responses
{
// Response
}
{
// Response
}
See the General section for more information.