Patch Using PATCH

Patch Using PATCH

Update a Pipeline with the given id

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

The ID of the Pipeline

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
PipelinePatchRequest of type(s) application/json
Optional
{
    "description": "My description for the Pipeline",
    "enabled": true,
    "name": "My name",
    "tags": [
        {
            "key": "env",
            "value": "dev"
        }
    ]
}
string
description
Optional

A human-friendly description for the Pipeline.

boolean
enabled
Optional

Indicates if the Pipeline is in enabled state.

string
name
Optional

A human-friendly name used as an identifier for the Pipeline.

array of string
tags
Optional

A set of tag keys and optional values that need to be set on the Pipeline.

Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with the updated Pipeline

Returns Pipeline of type(s) */*
{
    "_createTimeInMicros": 1568625938000000,
    "_createdBy": "exampleuser",
    "_inputMeta": {
        "test": {
            "description": "test-value",
            "mandatory": false
        }
    },
    "_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "_updateTimeInMicros": 1568625938000000,
    "_updatedBy": "exampleuser",
    "_warnings": [
        {
            "classType": "Pipeline",
            "message": {
                "containerName": "vrcsPipeline.DEV for a stage",
                "fieldName": "inputProperties.jobName.value",
                "level": "SEVERE/WARNING/INFO",
                "message": "Validation successful"
            },
            "success": false
        }
    ],
    "concurrency": 10,
    "createdAt": "2019-09-16 09:25:38.065065+00",
    "createdBy": "exampleuser",
    "description": "string",
    "enabled": true,
    "icon": "tools,,is-success is-solid",
    "id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "input": [
        {
            "ip": "10.5.23.84",
            "script": "testScript.sh"
        }
    ],
    "name": "My-Name",
    "notifications": {
        "email": [
            {
                "to": [
                    "[email protected]"
                ],
                "subject": "Pipeline execution notification",
                "body": "pipeline-execution-1234",
                "event": "SUCCESS",
                "endpoint": "Codestream-Default-Email"
            }
        ],
        "jira": [
            {
                "assignee": "[email protected]",
                "description": "Details about the issue being reported",
                "endpoint": "string",
                "event": "string",
                "issuetype": "Bug/Story",
                "project": "VRCS",
                "stage": "string",
                "summary": "Pipeline-1 execution failed",
                "task": "string"
            }
        ],
        "webhook": [
            {
                "action": "POST/PUT/PATCH",
                "endpoint": "string",
                "event": "string",
                "payload": {
                    "text": "executionId",
                    "username": "[email protected]"
                },
                "stage": "string",
                "task": "string",
                "url": "string"
            }
        ]
    },
    "options": [
        "DOCKER_TRIGGER"
    ],
    "output": [
        {
            "deployedMachineIP": "10.108.35.54",
            "result": "true"
        }
    ],
    "project": "My-Project",
    "rollbacks": [
        {
            "stage": "Deploy to Prod",
            "task": "Deploy",
            "name": "Undo Deployment",
            "inputs": {}
        }
    ],
    "stageOrder": [
        "AcquireToken",
        "Upgrade",
        "E2E"
    ],
    "starred": {
        "input": {
            "input": "commitId"
        },
        "output": {
            "output": "owner"
        }
    },
    "tags": [
        {
            "key": "env",
            "value": "dev"
        }
    ],
    "updatedAt": "2019-09-16 09:25:38.065065+00",
    "updatedBy": "exampleuser",
    "version": "v1",
    "workspace": {
        "autoCloneForTrigger": true,
        "cache": [
            "/root/.m2",
            "/temp/"
        ],
        "endpoint": "string",
        "image": "fedora:latest",
        "path": "/usr/administrator/",
        "registry": "Docker Trusted Registry"
    }
}
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

object
_inputMeta
Optional

Additional information about Input Properties

string
_link
Optional

Partial URL that provides details of the resource.

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

_warnings
Optional

Contains any warnings that result from failed validations of any Pipeline fields

integer As int32 As int32
concurrency
Optional

Number of Executions of the Pipeline that can run concurrently.

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.

boolean
enabled
Optional

Indicates if the Pipeline is in enabled state.

string
icon
Optional

String description of the icon used for this Pipeline.

string
id
Optional

The id of this resource.

object
input
Optional

Map representing the Input properties for the Pipeline.

string
name
Required

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

notifications
Optional

notifications

array of string
options
Optional

Represents the different options to trigger a Pipeline. Selecting an option auto injects the Input properties needed to execute a Pipeline with that trigger.

object
output
Optional

Map representing the Output properties for the Pipeline.

string
project
Optional

The project this entity belongs to.

rollbacks
Optional

Represents the various Rollback Configurations for the Pipeline

array of string
stageOrder
Optional

Represents the order in which Stages will be executed.

object
stages
Optional

Map representing the details of the various Stages of the Pipeline.

starred
Optional

starred

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.

workspace
Optional

workspace


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