Pipelines

Pipelines
Pipelines

A list of Pipeline instances.

JSON Example
{
    "count": 0,
    "documents": {
        "documents": {
            "_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",
                        "headers": {
                            "headers": "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"
            ],
            "stages": {
                "stages": {
                    "description": "Image Publish Stage",
                    "tags": [
                        "Tag1",
                        "Tag2"
                    ],
                    "taskOrder": [
                        "Task1",
                        "Task0"
                    ],
                    "tasks": {
                        "Task1": {
                            "type": "REST",
                            "ignoreFailure": false,
                            "preCondition": "",
                            "input": {
                                "headers": {
                                    "Accept": "application/json",
                                    "Content-Type": "application/json"
                                },
                                "action": "get",
                                "url": "https://www.vmware.com"
                            }
                        }
                    }
                }
            },
            "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"
            }
        }
    },
    "links": [
        "string"
    ],
    "totalCount": 0
}
integer As int64 As int64
count
Optional

Number of resources within the current page.

object
documents
Optional

Details of the queried resources.

array of string
links
Optional

Partial URLs representing the links to the queried resources.

integer As int64 As int64
totalCount
Optional

Number of resources across all pages.