Get Using GET 1

Get Using GET 1

Get an Execution by id

Request
URI
GET
http://cava-s-182-041.eng.vmware.com//codestream/api/executions/{id}
COPY
Path Parameters
string
id
Required

The ID of the Execution

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

string
queryParams
Optional

queryParams

Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with Execution

Returns Execution of type(s) */* 
{
    "_createTimeInMicros": 1568625938000000,
    "_createdBy": "exampleuser",
    "_durationInMicros": 0,
    "_executedBy": "string",
    "_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "_nested": false,
    "_pipelineLink": "string",
    "_requestTimeInMicros": 0,
    "_rollback": false,
    "_source": "string",
    "_updateTimeInMicros": 1568625938000000,
    "_updatedBy": "exampleuser",
    "comments": "string",
    "createdAt": "2019-09-16 09:25:38.065065+00",
    "createdBy": "exampleuser",
    "description": "string",
    "icon": "string",
    "id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "index": 0,
    "name": "My-Name",
    "notifications": [
        {
            "eventGroup": "COMPLETED",
            "jiraResponse": {
                "ID": "VRCS-23",
                "link": "/link/to/Jira/issue/VRCS-23"
            },
            "providerType": "Email/Slack/Jira",
            "responseCode": 200,
            "responseMessage": 200,
            "stage": "string",
            "success": true,
            "task": "string"
        }
    ],
    "project": "My-Project",
    "reason": "string",
    "stageOrder": [
        "string"
    ],
    "starred": {
        "input": {
            "input": "commitId"
        },
        "output": {
            "output": "owner"
        }
    },
    "status": "string",
    "statusMessage": "string",
    "tags": [
        {
            "key": "env",
            "value": "dev"
        }
    ],
    "updatedAt": "2019-09-16 09:25:38.065065+00",
    "updatedBy": "exampleuser",
    "version": "v1",
    "workspaceResults": [
        {
            "logs": [
                "string"
            ],
            "status": "COMPLETED",
            "step": "GIT_CLONE"
        }
    ]
}
integer As int64 As int64
_createTimeInMicros
Optional

This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds

string
_createdBy
Optional

This field is provided for backward compatibility. Contains the same value as the 'createdBy' field

integer As int64 As int64
_durationInMicros
Optional

_durationInMicros

string
_executedBy
Optional

_executedBy

object
_inputMeta
Optional

_inputMeta

string
_link
Optional

Partial URL that provides details of the resource.

boolean
_nested
Optional

_nested

object
_outputMeta
Optional

_outputMeta

string
_pipelineLink
Optional

_pipelineLink

integer As int64 As int64
_requestTimeInMicros
Optional

_requestTimeInMicros

boolean
_rollback
Optional

_rollback

string
_source
Optional

_source

integer As int64 As int64
_updateTimeInMicros
Optional

This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds

string
_updatedBy
Optional

This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field

string
comments
Optional

comments

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 with time zone

string
createdBy
Optional

The user that created this entity

string
description
Required

A human-friendly description.

string
icon
Optional

icon

string
id
Optional

The id of this resource.

integer As int64 As int64
index
Optional

index

object
input
Optional

input

string
name
Required

A human-friendly name used as an identifier in APIs that support this option

array of Notification
notifications
Optional

notifications

object
output
Optional

output

string
project
Optional

The project this entity belongs to.

string
reason
Optional

reason

array of string
stageOrder
Optional

stageOrder

object
stages
Optional

stages

Pipeline_StarredProperty
starred
Optional

starred

string
status
Optional

status

Possible values are : NOT_STARTED, STARTED, RUNNING, CANCELING, WAITING, RESUMING, PAUSING, PAUSED, CANCELED, COMPLETED, FAILED, SKIPPED, QUEUED, FAILED_CONTINUE, ROLLING_BACK, ROLLBACK_FAILED, PREPARING_WORKSPACE, ROLLBACK_COMPLETED,
string
statusMessage
Optional

statusMessage

array of string
tags
Optional

A set of tag keys and optional values that were set on on the resource.

string
updatedAt
Optional

Date when the entity was last updated. The date is in ISO 8601 with time zone.

string
updatedBy
Optional

The user that last updated this entity

string
version
Optional

Version of the resource.

array of WorkspaceResult
workspaceResults
Optional

workspaceResults


401

Unauthorized Request

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

500

Server Error

Operation doesn't return any data structure

On This Page
Executions Operations
DELETE
Delete Using DELETE 10
DELETE
Delete Using DELETE 3
GET
Get All Using GET 1
GET
Get All Using GET 4
GET
Get Using GET 1
GET
Get Using GET 4
POST
Modify Execution Using POST
PATCH
Modify Patch User Operation Using PATCH
POST
Modify Post User Operation Using POST