HTTP - Management
Release a block versionBeta
Created by s.horan, last updated 11 Mar 2021
Releasing a block version is an action that marks the block version as being ready for production use. This is a workflow action typically performed by the developer(s) producing the block. Releasing a block version moves it's workflow status from Draft to Released and sets the version number to a major release. Once a block version is released then it can be selected to be used within a Renderer for use within a live website.
POST/api/management/projects/{projectId}/blocks/{blockId}/actions
Parameters
| Name | Parameter type | Type | Description | Example | Required |
|---|---|---|---|---|---|
| projectId | path | string | The project identifier found in the project overview screen of the management console | movieDb | true |
| blockId | path | string | The block identifier | movie-listing | true |
Example
Release version 2 of the movie-listing block
Accept: application/json
POST: /api/management/projects/movieDb/blocks/movie-listing/actions
{
"type": "release",
"data": {
"version": "0.9"
}
}Remarks
If the version specified is not the latest version or the version is already a released version, then a validation error will be returned.
Responses
| HTTP status code | Reason | Model |
|---|---|---|
| 202 | Accepted | Block version |
| 401 | Unauthorized | Error |
| 404 | Project not found | Error |
| 422 | Validation error | Error |
| 500 | Internal server error | Error |