HTTP - Management
BlockBeta
Created by s.horan, last updated 12 Mar 2021
The block resource contains an overview of a block along with a list of all available branches.
Properties
| Name | Data type | Data format | Description | Example |
|---|---|---|---|---|
| id | string | The block identifier. It must begin with a letter and only contain lowercase alphanumeric characters and hyphen separators | movie-listing | |
| description | string | The description of the block | ||
| liveVersion | number | integer | The version number of the last version made live | |
| madeLive | datetime | datetime | The last time the block was made live | |
| versionsSinceLive | number | integer | A count of versions created since the block was last made live | |
| projectId | string | The project identifier found in the project overview screen of the management console | movieDb | |
| branches | object[...] | An array of branches which are available for the block | ||
| branches.id | string | The name of the branch | main |
Example
JSON
[
{
"id": "movie-listing",
"description": "Displays the main listing for movies on the movie example site",
"liveVersion": 4,
"versionsSinceLive": 2,
"madeLive": "2021-03-02T11:16:01.408Z",
"projectId": "movieDb",
"branches": [
{
"id": "main"
}
]
}
]