Skip to main content

Cookie control banner

Necessary Cookies
These cookies are necessary for this website to function correctly. They are set when you perform certain actions on the site, such as creating an account, logging in, changing your privacy preferences or submitting a form. You can block these cookies in your browser, but this will stop parts of the site from working properly.
Functional Cookies
These cookies allow the website to provide extra functionality and more personalised experiences. They may be set by us or by third party providers whose services we have added to our pages. If you choose not to allow these cookies, these services may not work correctly.
Analytical Cookies
These cookies record anonymous data on how visitors use our website to help us monitor how well our website works. This data includes how many people have looked at specific pages, how long visitors stay on the site, and what devices they use. We use this data to identify changes that we could make to improve your experience and make our website more efficient.
Marketing Cookies
We set some cookies so you are shown more relevant marketing content. These include cookies from third-party advertising networks to show you different adverts on their services if you have previously visited our site. If you choose not to allow these cookies, you may experience less relevant advertising on other sites.
Browse Documentation
HTTP - Management

Block versionBeta

Created by s.horan, last updated 23 Mar 2021

A block version represents an incrementally pushed instance of a block.

Properties

NameData typeData formatDescriptionExample
idstringThe block identifier as a unique string. Can contain alphanumeric characters and hyphens.movie-listing
projectIdstringThe project identifier found in the project overview screen of the management consolemovieDb
imageobject[...]The docker image repository details
image.uristringURIThe image repository uri
image.tagstringThe image tag name
sourceobjectThe source control commit details
source.branchstringThe source control branch name
source.providerstringThe name of your source control provider. Can be one of the following gitHub, gitLab, bitbucket, gitHubSelfHosted, gitLabSelfHosted, bitbucketSelfHosted
source.repositoryUrlstringThe HTTP URL for your source code repositoryhttps://github.com/moviedb/movie-listing.git
source.commit.idstringThe source control commit identifier
source.commit.messagestringThe source control commit message
source.commit.datetimedatetimeThe date and time of the commit in UTC
source.commit.authorEmailstringThe email address of the user who authored the change
source.commit.committerEmailstringThe email address of the user who committed the change
source.commit.commitUrlstringURIAn auto-generated URL which points to the commit details page for the current commit
source.commit.comparisonUrlstringURIAn auto-generated URL which points to the page showing a comparison between the current and previous commits
staticPathsstring[...]A list of paths which contain static resources. i.e. images, JavaScrip and CSSimage-gallery
endpointsobject[...]The endpoints exposed by this block version
endpoints[].idstringThe endpoint identifier as a unique string. Can contain alphanumeric characters and hyphens.
endpoints[].pathstringURIThe path to the invocable endpoint/movie-listing
endpoints[].typestringThe type of endpoint, either pagelet or layout
versionobjectThe block version version info
version.pushedBystringThe username of the person who pushed the block version
version.pusheddatetimeThe date/time of when the block version was pushed
version.releasedBystringThe username of the person who released the block version. If the block has not yet been released the value will be null.
version.releaseddatetimeThe date and time of when the block version was released. If the block has not yet been released the value will be null.
version.markedBrokenBystringThe username of the person who declared the block version as broken. If the block has not been marked broken the value will be null.
version.markedBrokendatetimeThe date and time of when the block was marked as broken. If the block has not been marked as broken the value will be null.
version.versionNonumberintegerThe version number of the block version
version.madeLiveBystringThe username of the person who made the block version live. If the block has not yet been made live the value will be null.
version.madeLivedatetimeThe date and time of when the block version was made live. If the block has not yet been made live the value will be null.
statusstring[...]The statuses which apply to the current block version
status.brokenbooleanWhether the block has been marked as broken
status.deploymentstringThe block version deployment status
status.runningstringThe block version running status
status.workflowstringThe block version workflow status

Example

JSON
{ "id": "movie-listing", "projectId": "movieDb", "image": { "uri": "moviedb/movie-listing", "tag": "81e13d08" }, "source": { "branch": "main", "provider": "github", "repositoryUrl": "https://github.com/moviedb/movie-listing.git", "commit": { "id": "81e13d08", "message": "Displays the main listing for movies on the movie example site", "datetime": "2021-03-09T18:05:10Z", "authorEmail": "m.scorsese@film.com", "committerEmail": "m.scorsese@film.com", "commitUrl": "https://github.com/moviedb/movie-listing/-/commit/81e13d08", "comparisonUrl": "https://github.com/moviedb/movie-listing/-/commit/cc6b2a33...81e13d08" } }, "staticPaths": [ "static", "image-gallery" ], "endpoints": [ { "id": "movieListing", "path": "/movieListing", "type": "pagelet" }, { "id": "movieRecord", "path": "/movieRecord", "type": "pagelet" }, { "id": "ratingTemplate", "path": "/ratingtemplate", "type": "layout" } ], "version": { "pushedBy": "m.scorsese@film.com", "pushed": "2021-03-09T18:05:10Z", "releasedBy": "sikeliaProductions", "released": "2021-03-10T10:15:12.19Z", "markedBrokenBy": null, "markedBroken": null, "versionNo": "6.0", "madeLiveBy": null, "madeLive": null }, "status": { "broken": false, "deployment": "Deployed", "running": "Available", "workflow": "Draft" } }