Execute By Name Using POST

Execute a Pipeline based on the given project and name

Request

URI

POST

http://cava-s-182-041.eng.vmware.com//codestream/api/pipelines/{project}/{name}/executions

COPY

Path Parameters

string

name

Required

The name of the Pipeline

string

project

Required

The project the Pipeline belongs to

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

Request Body

ExecutionRequest of type(s) application/json

Optional

{
    "comments": "string",
    "executionId": "string",
    "executionLink": "string",
    "source": "string",
    "tags": [
        "string"
    ]
}

string

comments

Optional

comments

string

executionId

Optional

executionId

string

executionLink

Optional

executionLink

object

input

Optional

input

string

source

Optional

source

array of string

tags

Authentication

This operation uses the following authentication methods.

Authorization

Responses

200

'Success' with the created execution response

Returns ExecutionResponse of type(s) */*

{
    "executionId": "b80254a7-fcff-4918-ad88-501d08096337",
    "executionIndex": 3,
    "executionLink": "/codestream/api/executions/b80254a7-fcff-4918-ad88-501d08096337"
}

string

executionId

Optional

Id of the Execution.

integer As int64 As int64

executionIndex

Optional

Index of the Execution.

string

executionLink

Optional

Link of the Execution.

202

Accepted

Returns ExecutionResponse of type(s) */*

{
    "executionId": "b80254a7-fcff-4918-ad88-501d08096337",
    "executionIndex": 3,
    "executionLink": "/codestream/api/executions/b80254a7-fcff-4918-ad88-501d08096337"
}

string

executionId

Optional

Id of the Execution.

integer As int64 As int64

executionIndex

Optional

Index of the Execution.

string

executionLink

Optional

Link of the Execution.