...
Parameter | Type | Required | Description |
---|---|---|---|
snapshotId | URL | Yes | Path parameter for the snapshot Id which is used to return a snapshot |
releaseId | URL | Yes | Path parameter for the release Id which contains the snapshot that will be returned |
gateName | Query | No | If given, environmentExecutions will only be returned if gateName is present in one of them. All environmentExecutions that have been run will be returned. This will indicate that a gate matching that name was already passed, or is currently waiting for a schedule or approval. |
stepName | Query | No | If given, environmentExecutions will only be returned if stepName is present in one of them. All environmentExecutions that have been run will be returned. This will indicate that a step matching that name was already passed, or is currently running. |
environmentId | Query | No | If given, environmentExecutions will be filtered to only this environment. This filter is done before filtering for gate and step names. If a gate or step name is passed in with this parameter, that gate or step must be present in this stage or the environmentExecutions array will always come back containing 0 elements. |
Response
Snapshot Execution JSON objects can having the following attributes:
Attribute | Type | Description | snapshotId||
---|---|---|---|---|
pipelineExecutionId | Long | The | idId of the | snapshotPipeline Execution |
snapshotName snapshotId | StringLong | The name id of the snapshot, which is generated based on the time of creationsnapshotStatus | ||
pipelineExecutionStatus | String | The status of the snapshotPipeline Execution. Possible values are:
| ||
description | String | The description of the snapshot | ||
snapshotVersions | List<SnapshotVersionPojo> | The version information about the projects/packages contained within this snapshot |
| ||
pipelineEnvironmentStatuses | Array of pipelineEnvironmentStatus | An array of stages (environments) in the order that they appear on the pipeline definition page. |
Elements of pipelineEnvironmentStatus have the following attributes:
Attribute | Type | Description | ||
---|---|---|---|---|
projectIdenvironmentId | Long | The id of the project | ||
projectStreamId | Long | The id of the Stream which the project/package was built from | ||
projectVersionId | Long | The version id of the project | ||
packageName this environment (stage) | ||||
environmentCode | String | The code of this environment (stage) e.g. DEV | ||
stageExecutionStatus | String | The status of the Stage Execution. Possible values are: RUNNING_GATES - Waiting for a gate to complete | ||
environmentName | String | snapshotVersionStatus | String | The name of the package (partial deployment projects only) |
requestAllFiles | Boolean | Whether or not the project includes all files (partial deployment projects only) | ||
this environment (stage) e.g. Dev | ||||
currentGateName | String | The name of the gate currently being processed, or null if not currently waiting on a gate. It is possible that the next action will be to wait on a gate but that it hasn't begun to wait yet. | ||
currentStepName | String | The name of the step currently being processed, or null if not currently running a step. It is possible that the next action will be to perform a step but that it hasn't begun yet. It is possible that multiple steps are currently being run. This will still return one result. It is possible that all the child steps of a parent step have completed but that the thread that is processing step execution hasn't noticed yet. In this case the parent step will be returned even though all its children are complete. In a few moments the next step will be returned instead. | ||
stageExecutionId | Long | The Id of the stageExecution | ||
stepExecutions | Array of stepExecution | An array of steps in the order that they appear on the pipeline definition stage details page. The json object was flattened so groups and parent and child steps are easier to parse. | ||
environmentSortOrder | Integer | The order of the environment in the pipeline definition | ||
gateExecutions | Array of gateExecution | An array of gates in the order that they appear on the pipeline definition stage details page. |
Elements of stepExecution have the following attributes:
Attribute | Type | Description |
---|---|---|
stepName | Long | The id of this environment (stage) |
stepType | String | The code of this environment (stage) e.g. DEV |
stepStatus | String | PRECOND_SKIPPED RUNNING FAILED ABORTED SUCCESSFUL |
stepDescription | String | The description of the step |
waitDuration | Long | The wait time of a wait step |
roleName | String | The role associated to the step |
cronExpression | String | The cron expression in a scheduled step |
wait_till_date | Timestamp | The wait until date of a wait step |
stepOrder | Float | The order of the step in the stage |
Response Codes
HTTP Code | Description |
---|---|
200 | Snapshot Execution was found and returned |
400 | Bad request (Snapshot wasn't in given releaseId) |
401 | Unauthorized (User may not be signed in or user may not have read access to this release) |
500 | Unexpected internal server error |
Example
If a snapshot in our database had an id of 10005 10401 and releaseId of 14321 10201 and a GET request was sent to http://host:port/flexdeploy/rest/v1/releases/1432110201/snapshot/1000510401/execution
A Snapshot Execution JSON object will be returned with snapshot execution information:
Code Block | language | js|
---|---|---|
| ||
{ "pipelineExecutionId": 10404, "snapshotId": 10401, "pipelineExecutionStatus": "RUNNING", "pipelineEnvironmentStatuses": [ { "environmentId": 11701, "environmentCode": "E", "stageExecutionStatus": "SUCCESSFUL", "environmentName": "e", "currentGateName": null, "currentStepName": null, "stageExecutionId": 10405, "stepExecutions": [ { "stepName": "asdfasdf", "stepType": "STAGE_DEPLOY_ALL_STEP", "stepStatus": "SUCCESSFUL", "stepDescription": null, "waitDuration": null, "roleName": null, "cronExpression": null, "wait_till_date": null, "stepOrder": 1 } ], "environmentSortOrder": 1, "gateExecutions": [ { "gateName": "asdf", "gateType": "STAGE_EXT_APPROVAL_GATE", "gateStatus": "SUCCESSFUL", "gateDescription": null, "cronExpression": null, "roleName": null, "gateOrder": 1 }, { "gateName": "qwewerq", "gateType": "STAGE_SCHEDULED_GATE", "gateStatus": "SUCCESSFUL", "gateDescription": "qwerqwerqwerqwerqwer", "cronExpression": "* * 12 * * ?", "roleName": "asdfasdfasdf", "gateOrder": 2 }, { "gateName": "arraswer", "gateType": "STAGE_APPROVAL_GATE", "gateStatus": "SUCCESSFUL", "gateDescription": "asdferasdf", "cronExpression": null, "roleName": null, "gateOrder": 3 } ], }, { "environmentId": 11112, "environmentCode": "D", "stageExecutionStatus": "SUCCESSFUL", "environmentName": "d", "currentGateName": null, "currentStepName": null, "stageExecutionId": 10411, "stepExecutions": [ { "stepName": "s", "stepType": "STAGE_DEPLOY_ALL_STEP", "stepStatus": "SUCCESSFUL", "stepDescription": null, "waitDuration": null, "roleName": null, "cronExpression": null, "wait_till_date": null, "stepOrder": 1 }, { "stepName": "d22", "stepType": "STAGE_DEPLOY_ALL_STEP", "stepStatus": "SUCCESSFUL", "stepDescription": null, "waitDuration": null, "roleName": null, "cronExpression": null, "wait_till_date": null, "stepOrder": 2 }, { "stepName": "ggg", "stepType": "STAGE_GROUP_STEP", "stepStatus": "SUCCESSFUL", "stepDescription": null, "waitDuration": null, "roleName": null, "cronExpression": null, "wait_till_date": null, "stepOrder": 2 }, { "stepName": "d2", "stepType": "STAGE_DEPLOY_ALL_STEP", "stepStatus": "SUCCESSFUL", "stepDescription": null, "waitDuration": null, "roleName": null, "cronExpression": null, "wait_till_date": null, "stepOrder": 2.1 }, { "stepName": "test1", "stepType": "STAGE_TEST_ALL_STEP", "stepStatus": "SUCCESSFUL", "stepDescription": null, "waitDuration": null, "roleName": null, "cronExpression": null, "wait_till_date": null, "stepOrder": 3 } ], "environmentSortOrder": 2, "gateExecutions": [], }, { "environmentId": 11703, "environmentCode": "G", "stageExecutionStatus": "RUNNING_STEPS", "environmentName": "g", "currentGateName": null, "currentStepName": null, "stageExecutionId": 10420, "stepExecutions": [ { "stepName": "44321", "stepType": "STAGE_WAIT_STEP", "stepStatus": "SCHEDULED", "stepDescription": null, "waitDuration": null, "roleName": null, "cronExpression": null, "wait_till_date": 1550699280000, "stepOrder": 1 }, { "stepName": "1234", "stepType": "STAGE_WAIT_STEP", "stepStatus": "SCHEDULED", "stepDescription": null, "waitDuration": 1234, "roleName": null, "cronExpression": null, "wait_till_date": null, "stepOrder": 1 } ], "environmentSortOrder": 3, "gateExecutions": [ { "gateName": "test", "gateType": "STAGE_TEST_GATE", "gateStatus": "SUCCESSFUL", "gateDescription": null, "cronExpression": null, "roleName": "asdfasdftest", "gateOrder": 1 } ], } ], } |