HTTP - Management

Block version

Created by s.horan, last modified by zengenti on 17 Jan 2023

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

Properties

Name	Data type	Data format	Description	Example
id	string		The block identifier as a unique string. Can contain alphanumeric characters and hyphens.	movie-listing
projectId	string		The project identifier found in the project overview screen of the management console	movieDb
image	object[...]		The docker image repository details
image.uri	string	URI	The image repository uri
image.tag	string		The image tag name
source	object		The source control commit details
source.branch	string		The source control branch name
source.provider	string		The name of your source control provider. Can be one of the following gitHub, gitLab, bitbucket, gitHubSelfHosted, gitLabSelfHosted, bitbucketSelfHosted
source.repositoryUrl	string		The HTTP URL for your source code repository	https://github.com/moviedb/movie-listing.git
source.commit.id	string		The source control commit identifier
source.commit.message	string		The source control commit message
source.commit.datetime	datetime		The date and time of the commit in UTC
source.commit.authorEmail	string		The email address of the user who authored the change
source.commit.committerEmail	string		The email address of the user who committed the change
source.commit.commitUrl	string	URI	An auto-generated URL which points to the commit details page for the current commit
source.commit.comparisonUrl	string	URI	An auto-generated URL which points to the page showing a comparison between the current and previous commits
staticPaths	string[...]		A list of paths which contain static resources. i.e. images, JavaScrip and CSS	image-gallery
endpoints	object[...]		The endpoints exposed by this block version
endpoints[].id	string		The endpoint identifier as a unique string. Can contain alphanumeric characters and hyphens.
endpoints[].path	string	URI	The path to the invocable endpoint	/movie-listing
endpoints[].type	string		The type of endpoint, either pagelet or layout
version	object		The block version version info
version.pushedBy	string		The username of the person who pushed the block version
version.pushed	datetime		The date/time of when the block version was pushed
version.releasedBy	string		The username of the person who released the block version. If the block has not yet been released the value will be null.
version.released	datetime		The date and time of when the block version was released. If the block has not yet been released the value will be null.
version.markedBrokenBy	string		The 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.markedBroken	datetime		The 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.versionNo	number	integer	The version number of the block version
version.madeLiveBy	string		The 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.madeLive	datetime		The 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.
status	string[...]		The statuses which apply to the current block version
status.broken	boolean		Whether the block has been marked as broken
status.deployment	string		The block version deployment status
status.running	string		The block version running status
status.workflow	string		The 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"
    }
}