Code Stream API Data Structures
State object representing an about page that includes api versioning information
{
"latestApiVersion": "string",
"supportedApis": [
{
"apiVersion": "string",
"deprecationPolicy": {
"deprecatedAt": "string",
"description": "string",
"expiresAt": "string"
},
"documentationLink": "string"
}
]
}The latest version of the API in yyyy-MM-dd format (UTC).
A collection of all currently supported api versions.
{
"apiVersion": "string",
"deprecationPolicy": {
"deprecatedAt": "string",
"description": "string",
"expiresAt": "string"
},
"documentationLink": "string"
}The version of the API in yyyy-MM-dd format (UTC).
The link to the documentation of this api version
{
"deprecatedAt": "string",
"description": "string",
"expiresAt": "string"
}The date the api was deprecated in yyyy-MM-dd format (UTC). Could be empty if the api is not deprecated.
A free text description that contains information about why this api is deprecated and how to migrate to a newer version.
The date the api support will be dropped in yyyy-MM-dd format (UTC). The api may still be available for use after that date but this is not guaranteed.
Certificates are represented in cryptographic hash algorithms (such as SHA-256 and SHA-1). Used during Endpoint creation.
{
"SHA-1": "F38585A104F37726CFCCE5CEE223ED63A18F54DC",
"SHA-256": "1E47299CCE0081B73FC6AEA3FD35BA2309A033A858EDD518789477C20C910CA4"
}String representing the SHA-1 encoding of the Certificate.
String representing the SHA-256 encoding of the Certificate.
Holding body of the Certificate.
{
"commonName": "vmware.com",
"organization": "VMware Inc.",
"serialNumber": 2.7896956101890133e+38
}A human-friendly name used as an identifier for the holding body.
Name of the organisation.
Unique ID given to the issued organization.
{
"commonName": "vmware.com",
"organization": "VMware Inc."
}A human-friendly name used as an identifier for the holding body.
Name of the organisation.
Describes the validity of the Certificate in terms of dates.
{
"beginsOn": 1541116800000,
"expiresOn": 1924991999000
}A UNIX timestamp in microseconds represnting when the validaty of the Certificate begins.
A UNIX timestamp in microseconds represnting when the validaty of the Certificate expires.
Represents a Custom Integration.
{
"_createTimeInMicros": 1568625938000000,
"_createdBy": "exampleuser",
"_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"_updateTimeInMicros": 1568625938000000,
"_updatedBy": "exampleuser",
"changeLog": "Modified input property.",
"createdAt": "2019-09-16 09:25:38.065065+00",
"createdBy": "exampleuser",
"description": "string",
"id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"name": "My-Name",
"parentId": "1abd1fd6-ae2c-459c-ab75-8c595631a11f",
"project": "My-Project",
"status": "NONE/RELEASED/DEPRECATED",
"updatedAt": "2019-09-16 09:25:38.065065+00",
"updatedBy": "exampleuser",
"version": "v1",
"yaml": "---\nruntime: \"nodejs\"\ncode: |\n var context = require(\"./context.js\")\n var start = Date.now();\n var message = context.getInput(\"message\");\n console.log(\"starting timer is good \" + message);\n \n setTimeout(function() {\n var millis = Date.now() - start;\n console.log(\"seconds elapsed = \" + Math.floor(millis/1000));\n context.setOutput(\"time\", millis);\n }, 2000);\ninputProperties:\n - name: message\n type: text\n title: Message\n placeHolder: Time\n defaultValue: \n bindable: true\n labelInfo: true\n labelMessage: What is time\n \noutputProperties:\n - name: time\n type: label\n title: Time"
}This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'createdBy' field
Partial URL that provides details of the resource.
This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field
Changes from the previous version.
Date when the entity was created. The date is in ISO 8601 with time zone
The user that created this entity
A human-friendly description.
The id of this resource.
A human-friendly name used as an identifier in APIs that support this option
The id of the parent of this resource.
The project this entity belongs to.
Release status of the Custom Integration
Date when the entity was last updated. The date is in ISO 8601 with time zone.
The user that last updated this entity
Version of the resource.
YAML describing Custom integration details.
Custom Integration specification.
{
"description": "string",
"name": "My-Name",
"project": "My-Project",
"yaml": "---\nruntime: \"nodejs\"\ncode: |\n var context = require(\"./context.js\")\n var start = Date.now();\n var message = context.getInput(\"message\");\n console.log(\"starting timer is good \" + message);\n \n setTimeout(function() {\n var millis = Date.now() - start;\n console.log(\"seconds elapsed = \" + Math.floor(millis/1000));\n context.setOutput(\"time\", millis);\n }, 2000);\ninputProperties:\n - name: message\n type: text\n title: Message\n placeHolder: Time\n defaultValue: \n bindable: true\n labelInfo: true\n labelMessage: What is time\n \noutputProperties:\n - name: time\n type: label\n title: Time"
}A human-friendly description.
A human-friendly name used as an identifier in APIs that support this option
The project this entity belongs to.
YAML describing Custom integration details.
List of Custom Integration instances.
{
"count": "integer",
"links": [
"string"
],
"totalCount": "integer"
}Number of resources within the current page.
Details of the queried resources.
Partial URLs representing the links to the queried resources.
Number of resources across all pages.
Docker Registry Event details.
{
"_createTimeInMicros": 1568625938000000,
"_createdBy": "exampleuser",
"_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"_updateTimeInMicros": 1568625938000000,
"_updatedBy": "exampleuser",
"createdAt": "2019-09-16 09:25:38.065065+00",
"createdBy": "exampleuser",
"description": "string",
"executionIndex": 2,
"executionLink": "codestream/api/execution/sdscfvefw34rfrdsvdsat43erwfdf",
"executionStatus": "STARTED",
"id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"imageName": "fedora",
"message": "Invalid Oauth Refresh token. Verify webhook configuration.",
"name": "My-Name",
"owner": "username",
"pipeline": "MyPipeline",
"project": "My-Project",
"repo": "MyRepository",
"repoNamespace": "MyNamespace",
"tag": "latest",
"timeStampInMicros": "2019-09-18T07:38:25.907+0000",
"updatedAt": "2019-09-16 09:25:38.065065+00",
"updatedBy": "exampleuser",
"version": "v1"
}This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'createdBy' field
Partial URL that provides details of the resource.
This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field
Date when the entity was created. The date is in ISO 8601 with time zone
The user that created this entity
A human-friendly description.
Pipeline execution index.
Pipeline execution link.
Pipeline execution status.
The id of this resource.
Name of the image.
Message is populated when an error occurs.
A human-friendly name used as an identifier in APIs that support this option
Owner Name who triggered the event.
Pipeline to be executed when event is triggered.
The project this entity belongs to.
RepoName corresponding to the event.
Namespace inside the Docker Repository.
Tag name associated with the image.
Commit Time for the event.
Date when the entity was last updated. The date is in ISO 8601 with time zone.
The user that last updated this entity
Version of the resource.
List of Docker Registry Events.
{
"count": "integer",
"links": [
"string"
],
"totalCount": "integer"
}Number of resources within the current page.
Details of the queried resources.
Partial URLs representing the links to the queried resources.
Number of resources across all pages.
Docker Registry Webhook details.
{
"_createTimeInMicros": 1568625938000000,
"_createdBy": "exampleuser",
"_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"_updateTimeInMicros": 1568625938000000,
"_updatedBy": "exampleuser",
"createdAt": "2019-09-16 09:25:38.065065+00",
"createdBy": "exampleuser",
"description": "string",
"enabled": true,
"endpoint": "Docker Endpoint",
"externalListenerLink": "codestream/api/registry-webhooks/sdscfvefw34rfrdsvdsat43erwfdf",
"id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"imageNameRegExPattern": "admin/wordpress",
"input": [
{
"ip": "10.5.23.84",
"script": "testScript.sh"
}
],
"name": "My-Name",
"pipeline": "DemoPipeline",
"project": "My-Project",
"refreshToken": "cKNNVCSHijnaxlrfnVsxUYr6wM2g5Bg11tfnotmWb9XdA5kpUCvI2ubJojTIGp9g",
"repoName": "MyRepository",
"secretToken": "dvcdefrffsdvdfvfdgfdvbfdbvrefg3ff=",
"serverType": "DockerHub/Docker_Trusted_Registry",
"slug": "docker-webhook",
"tagNamePattern": "tag1",
"updatedAt": "2019-09-16 09:25:38.065065+00",
"updatedBy": "exampleuser",
"version": "v1"
}This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'createdBy' field
Partial URL that provides details of the resource.
This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field
Date when the entity was created. The date is in ISO 8601 with time zone
The user that created this entity
A human-friendly description.
Indicates whether Docker webhook is enabled or not.
Name of the Docker Endpoint.
Docker webhook listener link.
The id of this resource.
If provided then the pipeline execution is triggered only when the given image name regex matches the image name in the received payload.
Pipeline execution input properties.
A human-friendly name used as an identifier in APIs that support this option
Pipeline name which is meant to be triggered when a docker event occur.
The project this entity belongs to.
This token is used to authenticate when calling VMware Cloud Services APIs. These tokens are scoped within the organization.
Docker Repo Name.
Secret token to validate received payloads.
Docker server type.
Docker webhook name.
If provided then the pipeline execution is triggered only when the given tag name regex matches the tag name(s) in the received payload.
Date when the entity was last updated. The date is in ISO 8601 with time zone.
The user that last updated this entity
Version of the resource.
Docker Registry Webhook specification.
{
"description": "It is a docker saas webhook",
"enabled": true,
"endpoint": "Dcocker-SaaS",
"externalListenerLink": "/codestream/api/registry-webhook-listeners/412aa461-6d46-47d6-af93-152bb0d88682",
"imageNameRegExPattern": "admin/wordpress",
"input": {
"test": {
"description": "test-value",
"mandatory": false
}
},
"name": "My-Name",
"pipeline": "CD-Pipeline",
"project": "My-Project",
"refreshToken": "I5FLA8iQhlZwoos6OL3goKciAF5e",
"repoName": "codestream",
"secretToken": "DSkUyJJ8KA8rOSk=Ci",
"serverType": "DockerHub/Docker_Trusted_Registry",
"slug": "docker-webhook",
"tagNamePattern": "tag1"
}Docker webhook description.
Indicates whether Docker webhook is enabled or not.
Docker endpoint.
Docker webhook listener link.
If provided then the pipeline execution is triggered only when the given image name regex matches the image name in the received payload.
Pipeline Execution input properties.
A human-friendly name used as an identifier in APIs that support this option
Pipeline name which is meant to be triggered when a docker event occur.
The project this entity belongs to.
Codestream API token.
Docker Repo Name.
Secret token to validate received payloads.
Docker server type.
Docker webhook name.
If provided then the pipeline execution is triggered only when the given tag name regex matches the tag name(s) in the received payload.
Docker Registry Webhook Patch details.
{
"enabled": true
}Indicates whether Docker webhook is enabled or not.
List of Docker Registry Webhooks.
{
"count": "integer",
"links": [
"string"
],
"totalCount": "integer"
}Number of resources within the current page.
Details of the queried resources.
Partial URLs representing the links to the queried resources.
Number of resources across all pages.
Represents an Email Event configuration.
{
"body": "Pipeline-1 execution was successful",
"endpoint": "string",
"event": "string",
"stage": "string",
"subject": "Pipeline-1 execution notification",
"task": "string",
"to": [
"[email protected]",
"[email protected]"
]
}Email Body.
endpoint
event
stage
Subject for the email notification.
task
List of Email IDs of the recipients.
An Endpoint is an instance of a DevOps application that connects to Code Stream to provide data for your Pipelines to run, such as a data source, repository, or notification system. Endpoints can be cloud-based or on-premises.
{
"_createTimeInMicros": 1568625938000000,
"_createdBy": "exampleuser",
"_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"_updateTimeInMicros": 1568625938000000,
"_updatedBy": "exampleuser",
"createdAt": "2019-09-16 09:25:38.065065+00",
"createdBy": "exampleuser",
"description": "string",
"id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"isRestricted": "boolean",
"name": "My-Name",
"project": "My-Project",
"type": "jenkins",
"updatedAt": "2019-09-16 09:25:38.065065+00",
"updatedBy": "exampleuser",
"version": "v1"
}This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'createdBy' field
Partial URL that provides details of the resource.
This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field
Date when the entity was created. The date is in ISO 8601 with time zone
The user that created this entity
A human-friendly description.
The id of this resource.
This type of Endpoint can be created, updated or deleted by admin only. If a restricted Endpoint is consumed in a Pipeline, and that Pipeline is executed by a non-admin user, then the execution will fail at the task which is consuming this restricted Endpoint. Only admin can then resume this Pipeline to make it progress.
A human-friendly name used as an identifier in APIs that support this option
The project this entity belongs to.
Endpoint specific properties.
The type of this Endpoint instance.
Date when the entity was last updated. The date is in ISO 8601 with time zone.
The user that last updated this entity
Stores the vaidation errors.
Version of the resource.
Represents the complete SSL Certificate information of a FQDN.
{
"fingerprints": {
"SHA-1": "F38585A104F37726CFCCE5CEE223ED63A18F54DC",
"SHA-256": "1E47299CCE0081B73FC6AEA3FD35BA2309A033A858EDD518789477C20C910CA4"
},
"issuedBy": {
"commonName": "vmware.com",
"organization": "VMware Inc."
},
"issuedTo": {
"commonName": "vmware.com",
"organization": "VMware Inc.",
"serialNumber": 2.7896956101890133e+38
},
"periodOfValidity": {
"beginsOn": 1541116800000,
"expiresOn": 1924991999000
}
}EndpointCertificateChain is a tree of SSL Certificates.
{
"certificates": [
{
"fingerprints": {
"SHA-1": "F38585A104F37726CFCCE5CEE223ED63A18F54DC",
"SHA-256": "1E47299CCE0081B73FC6AEA3FD35BA2309A033A858EDD518789477C20C910CA4"
},
"issuedBy": {
"commonName": "vmware.com",
"organization": "VMware Inc."
},
"issuedTo": {
"commonName": "vmware.com",
"organization": "VMware Inc.",
"serialNumber": 2.7896956101890133e+38
},
"periodOfValidity": {
"beginsOn": 1541116800000,
"expiresOn": 1924991999000
}
}
]
}An Endpoint is an instance of a DevOps application that connects to Code Stream to provide data for your Pipelines to run, such as a data source, repository, or notification system. Endpoints can be cloud-based or on-premises.
{
"description": "string",
"isRestricted": "boolean",
"name": "My-Name",
"project": "My-Project",
"type": "jenkins"
}A human-friendly description.
This type of Endpoint can be created, updated or deleted by admin only. If a restricted Endpoint is consumed in a pipeline, and that pipeline is executed by a non-admin user, then the execution will fail at the task which is consuming this restricted Endpoint. Only admin can then resume this pipeline to make it progress.
A human-friendly name used as an identifier in APIs that support this option
The project this entity belongs to.
Endpoint specific properties
The type of this Endpoint instance.
Endpoint validation specification
{
"description": "string",
"id": "string",
"isRestricted": "boolean",
"name": "My-Name",
"project": "My-Project",
"type": "jenkins"
}A human-friendly description.
id of the endpoint, if already present
This type of Endpoint can be created, updated or deleted by admin only. If a restricted Endpoint is consumed in a pipeline, and that pipeline is executed by a non-admin user, then the execution will fail at the task which is consuming this restricted Endpoint. Only admin can then resume this pipeline to make it progress.
A human-friendly name used as an identifier in APIs that support this option
The project this entity belongs to.
Endpoint specific properties
The type of this Endpoint instance.
{
"count": "integer",
"links": [
"string"
],
"totalCount": "integer"
}Number of resources within the current page.
Details of the queried resources.
Partial URLs representing the links to the queried resources.
Number of resources across all pages.
Execution
{
"_createTimeInMicros": 1568625938000000,
"_createdBy": "exampleuser",
"_durationInMicros": "integer",
"_executedBy": "string",
"_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"_nested": "boolean",
"_pipelineLink": "string",
"_requestTimeInMicros": "integer",
"_rollback": "boolean",
"_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": "integer",
"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"
}
]
}This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'createdBy' field
_durationInMicros
_executedBy
_inputMeta
Partial URL that provides details of the resource.
_nested
_outputMeta
_pipelineLink
_requestTimeInMicros
_rollback
_source
This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field
comments
Date when the entity was created. The date is in ISO 8601 with time zone
The user that created this entity
A human-friendly description.
icon
The id of this resource.
index
input
A human-friendly name used as an identifier in APIs that support this option
output
The project this entity belongs to.
reason
stageOrder
stages
status
statusMessage
A set of tag keys and optional values that were set on on the resource.
Date when the entity was last updated. The date is in ISO 8601 with time zone.
The user that last updated this entity
Version of the resource.
Request body for acting on an Execution.
{
"reason": "Pipeline cancelled due to infra issues.",
"tags": [
{
"key": "env",
"value": "dev"
}
]
}Reason for performing the action on the given Execution.
A set of tag keys and optional values that were set on on the resource.
Execution Request for a pipeline
{
"comments": "string",
"executionId": "string",
"executionLink": "string",
"source": "string",
"tags": [
"string"
]
}comments
executionId
executionLink
input
source
tags
Represents the response object for when a Pipeline is executed.
{
"executionId": "b80254a7-fcff-4918-ad88-501d08096337",
"executionIndex": 3,
"executionLink": "/codestream/api/executions/b80254a7-fcff-4918-ad88-501d08096337"
}Id of the Execution.
Index of the Execution.
Link of the Execution.
A list of Pipeline Executions.
{
"count": "integer",
"links": [
"string"
],
"totalCount": "integer"
}Number of resources within the current page.
Details of the queried resources.
Partial URLs representing the links to the queried resources.
Number of resources across all pages.
Contains all the details of a Gerrit Event.
{
"_createTimeInMicros": 1568625938000000,
"_createdBy": "exampleuser",
"_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"_updateTimeInMicros": 1568625938000000,
"_updatedBy": "exampleuser",
"actionTaken": "Verified +1",
"branch": "master",
"changeNumber": 18823,
"createdAt": "2019-09-16 09:25:38.065065+00",
"createdBy": "exampleuser",
"createdOn": "2019-09-18T07:38:25.907+0000",
"description": "string",
"executionIndex": 1,
"executionLink": "/codestream/api/executions/08c20cb8-17b6-4d9c-9f15-c77cf4913bc5",
"executionStatus": "STARTED",
"gerritProject": "TestGerritProject",
"id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"listener": "Demo-Listener",
"message": "Execution Completed",
"name": "My-Name",
"owner": "Dummy User",
"patchSetNumber": 32,
"pipeline": "DemoPipeline",
"project": "My-Project",
"properties": {
"GERRIT_BRANCH": "master",
"GERRIT_EVENT_CREATED_ON": "1568792304",
"GERRIT_PATCHSET_REVISION": "8a3edf15d36d0fe8026ffefbd58bafdb77b4ab80",
"GERRIT_HOST": "gerrit.eng.vmware.com",
"GERRIT_CHANGE_OWNER_EMAIL": "[email protected]",
"GERRIT_EVENT_ACCOUNT_NAME": "Demo User",
"GERRIT_CHANGE_URL": "https://gerrit.eng.vmware.com/18868",
"GERRIT_PATCHSET_UPLOADER_EMAIL": "[email protected]",
"GERRIT_EVENT_TYPE": "patchset-created",
"GERRIT_PROJECT": "TestProjectForCodestream",
"GERRIT_PATCHSET_UPLOADER_USERNAME": "demouser",
"GERRIT_CHANGE_FILELIST": "[/COMMIT_MSG, file.txt]",
"GERRIT_CHANGE_NUMBER": "18868",
"GERRIT_SCHEME": "ssh",
"GERRIT_PATCHSET_UPLOADER": "Demo User [email protected]",
"GERRIT_URL": "http://gerrit.eng.vmware.com:8080",
"GERRIT_PORT": "29418",
"GERRIT_REFSPEC": "refs/changes/68/18868/32",
"GERRIT_PATCHSET_UPLOADER_NAME": "Demo User",
"GERRIT_CHANGE_OWNER": "Demo User \n [email protected]",
"GERRIT_CHANGE_COMMIT_MESSAGE": "1sdfsf\n\nChange-Id: I522eab3b678dedd68dad3e2c04d3cccc0eb9fa00\n",
"GERRIT_NAME": "gerrit-listener",
"GERRIT_TOPIC": "branch",
"GERRIT_CHANGE_SUBJECT": "1sdfsf",
"GERRIT_EVENT_ACCOUNT_USERNAME": "demouser",
"GERRIT_CHANGE_OWNER_USERNAME": "demouser",
"GERRIT_EVENT_ACCOUNT": "Demo User \n [email protected]",
"GERRIT_CHANGE_ID": "I522eab3b678dedd68dad3e2c04d3cccc0eb9fa00",
"GERRIT_VERSION": "Not supported",
"GERRIT_EVENT_ACCOUNT_EMAIL": "[email protected]",
"GERRIT_PATCHSET_NUMBER": "32",
"GERRIT_CHANGE_OWNER_NAME": "Demo User"
},
"subject": "Demo Commit Message",
"trigger": "Demo-Trigger",
"triggerType": "AUTOMATIC",
"type": "patchset-created",
"updatedAt": "2019-09-16 09:25:38.065065+00",
"updatedBy": "exampleuser",
"version": "v1"
}This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'createdBy' field
Partial URL that provides details of the resource.
This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field
Verified Label value along with the action posted to the gerrit server.
Gerrit Project branch on which the change has happened.
Gerrit ChangeSet Number provided by Gerrit Server in the event.
Date when the entity was created. The date is in ISO 8601 with time zone
The user that created this entity
Date and time on which this event is created.
A human-friendly description.
Index of the Execution.
Link of the execution.
Indicates the current status of the Execution.
Gerrit Project on which the change has happened.
The id of this resource.
Name of the Gerrit Listener which contains details of the Gerrit Server which has sent this event.
This includes detailed message regarding state of the execution.
A human-friendly name used as an identifier in APIs that support this option
Name and Email details of ChangeSet Owner.
Patch number of the ChangeSet provided by Gerrit Server in the event.
Name of the pipeline which got triggered.
The project this entity belongs to.
Map containing all ChangeSet related details.
Contains the commit message.
Name of the Gerrit Trigger which contains the configuration leading to this event.
Indicates whether it was a manual trigger or not.
Type of the gerrit event.
Date when the entity was last updated. The date is in ISO 8601 with time zone.
The user that last updated this entity
Version of the resource.
A list of Gerrit Event instances.
{
"count": "integer",
"links": [
"string"
],
"totalCount": "integer"
}Number of resources within the current page.
Details of the queried resources.
Partial URLs representing the links to the queried resources.
Number of resources across all pages.
A Gerrit Listener streams for events on the Gerrit server.
{
"_createTimeInMicros": 1568625938000000,
"_createdBy": "exampleuser",
"_expiresAt": "2019-09-16 09:25:38.065065+00",
"_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"_reason": "Validation Failed due to invalid credentials",
"_updateTimeInMicros": 1568625938000000,
"_updatedBy": "exampleuser",
"apiToken": "cKNNVCSHijnaxlrfnVsxUYr6wM2g5Bg11tfnotmWb9XdA5kpUCvI2ubJojTIGp9g",
"connected": true,
"createdAt": "2019-09-16 09:25:38.065065+00",
"createdBy": "exampleuser",
"description": "string",
"endpoint": "Gerrit-Endpoint",
"id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"name": "My-Name",
"project": "My-Project",
"updatedAt": "2019-09-16 09:25:38.065065+00",
"updatedBy": "exampleuser",
"version": "v1"
}This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'createdBy' field
Date when the API token will expire.
Partial URL that provides details of the resource.
Contains reasons for validation failure.
This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field
This token is used to authenticate when calling VMware Cloud Services APIs. These tokens are scoped within the organization.
Indicates whether the connection with the Gerrit Server to start receiving events is created or not.
Date when the entity was created. The date is in ISO 8601 with time zone
The user that created this entity
A human-friendly description.
The name of the Gerrit Endpoint.
The id of this resource.
A human-friendly name used as an identifier in APIs that support this option
The project this entity belongs to.
Date when the entity was last updated. The date is in ISO 8601 with time zone.
The user that last updated this entity
Version of the resource.
Contains the flag to connect or disconnect a Gerrit Listener.
{
"connected": true
}Connect/Disconnect a Gerrit Listener.
A Gerrit Listener streams for events on the Gerrit server.
{
"apiToken": "cKNNVCSHijnaxlrfnVsxUYr6wM2g5Bg11tfnotmWb9XdA5kpUCvI2ubJojTIGp9g",
"connected": true,
"description": "string",
"endpoint": "Gerrit-Endpoint",
"name": "My-Name",
"project": "My-Project"
}This token is used to authenticate when calling VMware Cloud Services APIs. These tokens are scoped within the organization.
Indicates whether the connection with the Gerrit Server to start receiving events is created or not.
A human-friendly description.
The name of the Gerrit Endpoint.
A human-friendly name used as an identifier in APIs that support this option
The project this entity belongs to.
A list of Gerrit Listener instances.
{
"count": "integer",
"links": [
"string"
],
"totalCount": "integer"
}Number of resources within the current page.
Details of the queried resources.
Partial URLs representing the links to the queried resources.
Number of resources across all pages.
Gerrit Manual Trigger feature is used to simulate an event corresponding to a change-id and match it against a Gerrit Trigger configuration to trigger pipeline(s) manually.
{
"changeId": "I522eab3b678dedd68dad3e2c04d3cccc0eb9fa00",
"project": "Gerrit-Trigger-Project",
"trigger": "Gerrit-Trigger"
}The ChangeSet Id corresponding to which the manual trigger has to be performed.
The tango project to which Gerrit Trigger belongs to.
Name of the Gerrit Trigger for which event has to be analysed.
The configurations of a Gerrit Trigger decides which pipeline is required to be triggered depending on kind of event received.
{
"_createTimeInMicros": 1568625938000000,
"_createdBy": "exampleuser",
"_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"_updateTimeInMicros": 1568625938000000,
"_updatedBy": "exampleuser",
"branch": "master",
"configurations": [
{
"pipeline": "rest_pipeline",
"input": {},
"eventType": "change-merged",
"failureComment": "Pipeline Execution Failed",
"successComment": "Pipeline Execution Successful"
},
{
"pipeline": "rest_pipeline",
"input": {},
"eventType": "patchset-created",
"verifiedLabel": "Verified",
"failureComment": "Pipeline Failed",
"successComment": "Pipeline Completed"
}
],
"createdAt": "2019-09-16 09:25:38.065065+00",
"createdBy": "exampleuser",
"description": "string",
"enabled": true,
"exclusions": [
{
"type": "PLAIN",
"value": "example.txt"
}
],
"gerritProject": "TestGerritProject",
"id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"inclusions": [
{
"type": "PLAIN",
"value": "example.txt"
}
],
"listener": "Gerrit-Listener",
"name": "My-Name",
"prioritizeExclusion": true,
"project": "My-Project",
"updatedAt": "2019-09-16 09:25:38.065065+00",
"updatedBy": "exampleuser",
"version": "v1"
}This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'createdBy' field
Partial URL that provides details of the resource.
This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field
Gerrit Project Branch on which the change has to be monitored.
The configuration of an Gerrit Event.
Date when the entity was created. The date is in ISO 8601 with time zone
The user that created this entity
A human-friendly description.
Indicates that this trigger will be addressed on receiving respective events.
Provide file exclusions as conditions for the trigger.
Gerrit Project which is to be monitored for the change.
The id of this resource.
Provide file inclusions as conditions for the trigger.
Gerrit Listener which will receive the events for this trigger.
A human-friendly name used as an identifier in APIs that support this option
Prioritize Exclusion ensures that Pipelines are not triggered even if any of the files in a commit match the specified files in the exclusion paths or regex.
The project this entity belongs to.
Date when the entity was last updated. The date is in ISO 8601 with time zone.
The user that last updated this entity
Version of the resource.
Contains the flag to enable or disable a Gerrit Trigger.
{
"enabled": true
}Enable/Disable a Gerrit Trigger.
The configurations of a Gerrit Trigger decides which pipeline is required to be triggered depending on kind of event received.
{
"branch": "master",
"configurations": [
{
"pipeline": "rest_pipeline",
"input": {},
"eventType": "change-merged",
"failureComment": "Pipeline Execution Failed",
"successComment": "Pipeline Execution Successful"
},
{
"pipeline": "rest_pipeline",
"input": {},
"eventType": "patchset-created",
"verifiedLabel": "Verified",
"failureComment": "Pipeline Failed",
"successComment": "Pipeline Completed"
}
],
"description": "string",
"enabled": true,
"exclusions": [
{
"type": "PLAIN",
"value": "example.txt"
}
],
"gerritProject": "TestGerritProject",
"inclusions": [
{
"type": "PLAIN",
"value": "example.txt"
}
],
"listener": "Gerrit-Listener",
"name": "My-Name",
"prioritizeExclusion": true,
"project": "My-Project"
}Gerrit Project Branch on which the change has to be monitored.
The configuration of an Gerrit Event.
A human-friendly description.
Indicates that this trigger will be addressed on receiving respective events.
Provide file exclusions as conditions for the trigger.
Gerrit Project which is to be monitored for the change.
Provide file inclusions as conditions for the trigger.
Gerrit Listener which will receive the events for this trigger.
A human-friendly name used as an identifier in APIs that support this option
Prioritize Exclusion ensures that pipelines are not triggered even if any of the files in a commit match the specified files in the exclusion paths or regex.
The project this entity belongs to.
{
"eventType": "patchset-created",
"failureComment": "Pipeline Execution Failed",
"input": [
{
"ip": "10.5.23.84",
"script": "testScript.sh"
}
],
"pipeline": "DemoPipeline",
"successComment": "Pipeline Execution Completed",
"verifiedLabel": "Verified +1"
}Type of the gerrit event.
Comment to be posted to the ChangeSet on execution termination.
Map representing the Input properties for the Pipeline.
Pipeline that needs to be triggered on receiving this event.
Comment to be posted to the ChangeSet on execution termination.
The label to be posted on Gerrit Server to perform actions.
{
"type": "PLAIN",
"value": "example.txt"
}Identifies the type of File Filter, that can be REGEX or PLAIN.
The value can be either plain text or a regex.
{
"eventType": "patchset-created",
"failureComment": "Pipeline Execution Failed",
"input": [
{
"ip": "10.5.23.84",
"script": "testScript.sh"
}
],
"pipeline": "DemoPipeline",
"successComment": "Pipeline Execution Completed",
"verifiedLabel": "Verified +1"
}Type of the gerrit event.
Comment to be posted to the ChangeSet on execution termination.
Map representing the Input properties for the Pipeline.
Pipeline that needs to be triggered on receiving this event.
Comment to be posted to the ChangeSet on execution termination.
The label to be posted on Gerrit Server to perform actions.
A list of Gerrit Trigger instances.
{
"count": "integer",
"links": [
"string"
],
"totalCount": "integer"
}Number of resources within the current page.
Details of the queried resources.
Partial URLs representing the links to the queried resources.
Number of resources across all pages.
Git Event Model.
{
"_createTimeInMicros": 1568625938000000,
"_createdBy": "exampleuser",
"_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"_updateTimeInMicros": 1568625938000000,
"_updatedBy": "exampleuser",
"commitId": "dvdsasfvaesvvffvgfbrrgeaerfare34fdgrt43",
"createdAt": "2019-09-16 09:25:38.065065+00",
"createdBy": "exampleuser",
"description": "string",
"executionIndex": 2,
"executionLink": "/codestream/api/executions/08c20cb8-17b6-4d9c-9f15-c77cf4913bc5",
"executionStatus": "STARTED",
"httpURL": "https://<git-server-url>/<username>/<repo-name>",
"id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"message": "Invalid Oauth Refresh token. Verify webhook configuration.",
"name": "My-Name",
"owner": "Demo User",
"pipeline": "Demo Pipeline",
"project": "My-Project",
"repo": "MyRepository",
"serverURL": {
"absolute": "boolean",
"authority": "string",
"fragment": "string",
"host": "string",
"opaque": "boolean",
"path": "string",
"port": "integer",
"query": "string",
"rawAuthority": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"rawSchemeSpecificPart": "string",
"rawUserInfo": "string",
"scheme": "string",
"schemeSpecificPart": "string",
"userInfo": "string"
},
"serverWebhookId": "dvcsdweivcioekcxjhwiu4jd823idjekx",
"subject": "Updating codestream-service.yaml",
"targetBranch": "master",
"timeStampInMicros": "2019-09-18T07:38:25.907+0000",
"updatedAt": "2019-09-16 09:25:38.065065+00",
"updatedBy": "exampleuser",
"version": "v1"
}This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'createdBy' field
Partial URL that provides details of the resource.
This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field
CommitId of the event triggered.
Date when the entity was created. The date is in ISO 8601 with time zone
The user that created this entity
A human-friendly description.
Pipeline execution index.
Pipeline execution link.
Pipeline execution status.
Url of the Git Repository.
The id of this resource.
Message is populated when an error occurs.
A human-friendly name used as an identifier in APIs that support this option
Owner Name who triggered the event.
Pipeline to be executed when event is triggered.
The project this entity belongs to.
RepoName corresponding to the event.
Git webhook id.
Subject for the commit.
Branch name for which event is triggered.
Commit Time for the event.
Date when the entity was last updated. The date is in ISO 8601 with time zone.
The user that last updated this entity
Version of the resource.
A list of Git Event instances.
{
"count": "integer",
"links": [
"string"
],
"totalCount": "integer"
}Number of resources within the current page.
Details of the queried resources.
Partial URLs representing the links to the queried resources.
Number of resources across all pages.
Git Webhook details.
{
"_createTimeInMicros": 1568625938000000,
"_createdBy": "exampleuser",
"_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"_updateTimeInMicros": 1568625938000000,
"_updatedBy": "exampleuser",
"branchName": "master",
"createdAt": "2019-09-16 09:25:38.065065+00",
"createdBy": "exampleuser",
"delayTimeInMins": 2,
"description": "string",
"endpoint": "GitHub-SaaS",
"eventCategory": "PUSH",
"exclusions": [
{
"type": "PLAIN",
"value": "example.txt"
}
],
"externalListenerLink": "codestream/api/git-webhook-listeners/173f5ed5-2197-4975-b782-a8679b2e4cd3",
"id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"inclusions": [
{
"type": "PLAIN",
"value": "example.txt"
}
],
"input": {
"test": {
"description": "test-value",
"mandatory": false
}
},
"name": "My-Name",
"pipeline": "Git-Pipeline",
"prioritizeExclusion": true,
"project": "My-Project",
"refreshToken": "I5FLA8iQhlZwoos6OL3goKciAF5e",
"repoName": "codestream",
"secretToken": "DSkUyJJ8KA8rOSk=Ci",
"serverType": "GITHUB/GITLAB/BITBUCKET",
"serverWebhookId": 192837465,
"updatedAt": "2019-09-16 09:25:38.065065+00",
"updatedBy": "exampleuser",
"version": "v1"
}This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'createdBy' field
Partial URL that provides details of the resource.
This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field
Branch name for which the webhook has been configured.
Date when the entity was created. The date is in ISO 8601 with time zone
The user that created this entity
Delay time after which the Pipeline Execution is triggered.
A human-friendly description.
Git endpoint.
Git event type.
Provide file exclusions as conditions for the trigger.
Git webhook listener link.
The id of this resource.
Provide file inclusions as conditions for the trigger.
Pipeline Execution input properties.
A human-friendly name used as an identifier in APIs that support this option
Pipeline name which is meant to be triggered when a git event occur.
Prioritize Exclusion ensures that pipelines are not triggered even if any ” + “of the files in a commit match the specified files in the exclusion paths or regex.
The project this entity belongs to.
Codestream API token.
Repo name for which the webhook has been configured.
Secret token to validate received payloads.
Git Server Type.
Git webhook id.
Date when the entity was last updated. The date is in ISO 8601 with time zone.
The user that last updated this entity
Version of the resource.
Git Webhook specification.
{
"branchName": "master",
"delayTimeInMins": 2,
"description": "string",
"endpoint": "GitHub-SaaS",
"eventCategory": "PUSH",
"exclusions": [
{
"type": "PLAIN",
"value": "example.txt"
}
],
"externalListenerLink": "codestream/api/git-webhook-listeners/173f5ed5-2197-4975-b782-a8679b2e4cd3",
"inclusions": [
{
"type": "PLAIN",
"value": "example.txt"
}
],
"input": {
"test": {
"description": "test-value",
"mandatory": false
}
},
"name": "My-Name",
"pipeline": "CICD-Pipeline",
"prioritizeExclusion": true,
"project": "My-Project",
"refreshToken": "I5FLA8iQhlZwoos6OL3goKciAF5e",
"repoName": "Codestream",
"secretToken": "DSkUyJJ8KA8rOSk=Ci",
"serverType": "GITHUB/GITLAB/BITBUCKET",
"serverWebhookId": "serverWebhookId\": \"12678345"
}Branch name for which the webhook has been configured.
Delay time after which the pipeline execution is triggered.
A human-friendly description.
Git endpoint.
Git event type.
Provide file exclusions as conditions for the trigger.
Git webhook listener link.
Provide file inclusions as conditions for the trigger.
Pipeline Execution input properties.
A human-friendly name used as an identifier in APIs that support this option
Pipeline name which is meant to be triggered when a git event occur.
Prioritize Exclusion ensures that pipelines are not triggered even if any ” + “of the files in a commit match the specified files in the exclusion paths or regex.
The project this entity belongs to.
Codestream API token.
Repo name for which the webhook has been configured.
Secret token to validate received payloads.
Git Server Type.
Git webhook id.
{
"type": "PLAIN",
"value": "example.txt"
}Identifies the type of File Filter, that can be REGEX or PLAIN.
The value can be either plain text or a regex.
A list of Git Webhook instances.
{
"count": "integer",
"links": [
"string"
],
"totalCount": "integer"
}Number of resources within the current page.
Details of the queried resources.
Partial URLs representing the links to the queried resources.
Number of resources across all pages.
Represents a Jira Event configuration.
{
"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"
}User to whom the Jira will be assigned.
Description for the Jira ticket.
endpoint
event
Jira Issue Type.
Jira Project Name.
stage
Summary for the Jira ticket.
task
Gerrit Manual Trigger response acknowledges the success or failure and in case of success, it lists the the pipelines which got triggered.
{
"message": "Manual Trigger Successful",
"pipelinesTriggered": [
"Pipeline-1",
"Pipeline-2"
]
}Message to acknowledge success or failure of action.
List of pipeline which got manually triggered.
Notifications are ways to communicate with your teams and let them know the status of your Pipelines in Code Stream.
{
"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"
}The event on which this Notification is triggered.
Only for Jira. Contains the Jira issue ID for creating a ticket.
Mode of transmission of this Notification.
Only for Jira/Webhook. Specifies any HTTP response code received from any REST calls related to the Notification.
Only for Jira/Webhook. Specifies any HTTP response message received from any REST calls related to the Notification.
Stage that this Notification belongs to.
Flag that represents if the Notification was successfully posted or not.
Task that this Notification belongs to.
Represents collection of different Event configurations.
{
"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"
}
]
}List of webhook events configured as part of notification.
A pipeline is a continuous integration and delivery model of your software release process, from your source code, through testing, to production. It includes a sequence of stages with tasks that represent the activities in your software release cycle. Your software application flows from one stage to the next through the pipeline.
{
"_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": "boolean"
}
],
"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"
}
}This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'createdBy' field
Additional information about Input Properties
Partial URL that provides details of the resource.
This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field
Contains any warnings that result from failed validations of any Pipeline fields
Number of Executions of the Pipeline that can run concurrently.
Date when the entity was created. The date is in ISO 8601 with time zone
The user that created this entity
A human-friendly description.
Indicates if the Pipeline is in enabled state.
String description of the icon used for this Pipeline.
The id of this resource.
Map representing the Input properties for the Pipeline.
A human-friendly name used as an identifier in APIs that support this option
Represents the different options to trigger a Pipeline. Selecting an option auto injects the Input properties needed to execute a Pipeline with that trigger.
Map representing the Output properties for the Pipeline.
The project this entity belongs to.
Represents the various Rollback Configurations for the Pipeline
Represents the order in which Stages will be executed.
Map representing the details of the various Stages of the Pipeline.
A set of tag keys and optional values that were set on on the resource.
Date when the entity was last updated. The date is in ISO 8601 with time zone.
The user that last updated this entity
Version of the resource.
Patch Request for a Pipeline
{
"description": "My description for the Pipeline",
"enabled": true,
"name": "My name",
"tags": [
{
"key": "env",
"value": "dev"
}
]
}A human-friendly description for the Pipeline.
Indicates if the Pipeline is in enabled state.
A human-friendly name used as an identifier for the Pipeline.
A set of tag keys and optional values that need to be set on the Pipeline.
Pipeline Specification
{
"_inputMeta": {
"test": {
"description": "test-value",
"mandatory": false
}
},
"concurrency": 10,
"description": "string",
"enabled": true,
"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"
}
],
"workspace": {
"autoCloneForTrigger": true,
"cache": [
"/root/.m2",
"/temp/"
],
"endpoint": "string",
"image": "fedora:latest",
"path": "/usr/administrator/",
"registry": "Docker Trusted Registry"
}
}Additional information about Input Properties
Number of Executions of the Pipeline that can run concurrently.
A human-friendly description.
Indicates if the Pipeline is in enabled state.
Map representing the Input properties for the Pipeline.
A human-friendly name used as an identifier in APIs that support this option
Represents the different options to trigger a Pipeline. Selecting an option auto injects the Input properties needed to execute a Pipeline with that trigger.
Map representing the Output properties for the Pipeline.
The project this entity belongs to.
Represents the various Rollback Configurations for the Pipeline
Represents the order in which Stages will be executed.
Map representing the details of the various Stages of the Pipeline.
A set of tag keys and optional values that were set on on the resource.
Represents properties that user can favourite or 'star' for convenience.
{
"input": {
"input": "commitId"
},
"output": {
"output": "owner"
}
}Contains the starred input parameter
Contains the starred output parameter
A list of Pipeline instances.
{
"count": "integer",
"links": [
"string"
],
"totalCount": "integer"
}Number of resources within the current page.
Details of the queried resources.
Partial URLs representing the links to the queried resources.
Number of resources across all pages.
Model for input/output properties.
{
"description": "Repo Url"
}Description for the input/output property.
Model represents a Rollback configuration.
{
"inputs": {
"test": {
"description": "test-value",
"mandatory": false
}
},
"name": "Rolback-Pipeline",
"stage": "Dev-Stage",
"task": "Publish-Image-Task"
}Map representing the Input properties for the Rollback Pipeline.
Rollback Pipeline name.
Stage name for which the rollback pipeline is configured.
Task name for which the rollback pipeline is configured.
Represents the response after rolling back a Stage or Task.
{
"_link": "/codestream/api/executions/b80254a7-fcff-4918-ad88-501d08096337",
"index": 4,
"name": "My-Rolled-Back-Pipeline",
"output": [
{
"key": "env",
"value": "dev"
}
],
"status": "COMPLETED",
"statusMessage": "Executing Stage0"
}Execution link of the rollback Pipeline.
Execution index of the rollback Pipeline.
Name of the rollback Pipeline.
Output properties of a rollback Pipeline.
Execution status of a rollback Pipeline.
Execution status message of a rollback Pipeline.
Request object for actions such as cloning.
{
"description": "cloned entity",
"name": "Pipeline-1",
"requestType": "CLONE"
}Description for the cloned entity.
Name field for the cloned entity.
Action to be performed on the service.
Data type for the Stage.
{
"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"
}
}
}
}Stage description.
Tags are useful for ease in searching, grouping or filtering.
Order in which tasks will be executed.
Map representing details of various tasks present in the stage.
Contains Stage Execution details.
{
"_durationInMicros": 1568625938000000,
"_endTime": 1568625938000000,
"_startTime": 1568625938000000,
"id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"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"
}
],
"rollbackConfiguration": {
"inputs": {
"test": {
"description": "test-value",
"mandatory": false
}
},
"name": "Rolback-Pipeline",
"stage": "Dev-Stage",
"task": "Publish-Image-Task"
},
"rollbackResponse": {
"_link": "/codestream/api/executions/b80254a7-fcff-4918-ad88-501d08096337",
"index": 4,
"name": "My-Rolled-Back-Pipeline",
"output": [
{
"key": "env",
"value": "dev"
}
],
"status": "COMPLETED",
"statusMessage": "Executing Stage0"
},
"status": "COMPLETED",
"statusMessage": "Executing Stage0",
"taskOrder": [
"string"
]
}Execution duration of the Stage Execution (in micros).
End time of the Stage Execution (in micros)..
Start time of the Stage Execution (in micros)..
The id of this Stage.
A human-friendly name used as an identifier For the Stage.
Execution status of the Stage Execution.
Execution status message of the Stage Execution.
Ordering of the various Tasks within the Stage.
Represents the various Tasks in the Stage.
Represents the individual Tasks in a Pipeline.
{
"endpoints": [
{
"deployedMachineIP": "10.108.35.54",
"result": "true"
}
],
"ignoreFailure": true,
"input": [
{
"ip": "10.5.23.84",
"script": "testScript.sh"
}
],
"preCondition": "${input.buildNumber} != '100'",
"tags": [
{
"key": "env",
"value": "dev"
}
],
"type": "jenkins"
}Map representing the Output properties for the Task.
Ignores the failure of the Task execution if set to true, and continues with the Pipeline execution.
Map representing the Input properties for the Task.
The Task is executed only if this field evaluates to true.
A set of tag keys and optional values that were set on on the resource.
Type of the Task.
Contains Task Execution details.
{
"_durationInMicros": 1568625938000000,
"_endTime": 1568625938000000,
"_startTime": 1568625938000000,
"failureMessage": "string",
"id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c~0.0",
"ignoreFailure": true,
"input": [
{
"ip": "10.5.23.84",
"script": "testScript.sh"
}
],
"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"
}
],
"output": [
{
"deployedMachineIP": "10.108.35.54",
"result": "true"
}
],
"preCondition": "${input.buildNumber} != '100'",
"rollbackConfiguration": {
"inputs": {
"test": {
"description": "test-value",
"mandatory": false
}
},
"name": "Rolback-Pipeline",
"stage": "Dev-Stage",
"task": "Publish-Image-Task"
},
"rollbackResponse": {
"_link": "/codestream/api/executions/b80254a7-fcff-4918-ad88-501d08096337",
"index": 4,
"name": "My-Rolled-Back-Pipeline",
"output": [
{
"key": "env",
"value": "dev"
}
],
"status": "COMPLETED",
"statusMessage": "Executing Stage0"
},
"status": "COMPLETED",
"statusMessage": "Executing Task0",
"type": "jenkins"
}Execution duration of the Task Execution (in micros).
End time of the Task Execution (in micros)..
Start time of the Task Execution (in micros)..
Endpoints that the Task refers to.
Failure message associated with a 'FAILED' task.
The id of this Task.
Ignores the failure of the Task execution if set to true, and continues with the Pipeline execution.
Map representing the Input properties for the Task.
A human-friendly name used as an identifier For the Task.
Map representing the Output properties for the Task.
The Task is executed only if this field evaluates to true.
Execution status of the Task Execution.
Execution status message of the Task Execution.
Type of the Task.
{
"duration": "integer",
"status": "COMPLETED",
"statusMessage": "Failed to connect to jenkins server endpoint"
}time taken for the Tile execution to finish.
Output properties from the Tile execution.
Status of the Tile execution.
Status message of the Tile execution.
Contains information about a Tile.
{
"displayName": "Kubernetes",
"inputProperties": {
"cloudProxyId": {
"type": "String",
"description": "",
"mandatory": false
},
"fingerprint": {
"type": "String",
"description": "",
"mandatory": false
}
},
"outputProperties": {
"isFailed": {
"type": "String",
"description": "",
"mandatory": false
},
"buildUrlId": {
"type": "String",
"description": "",
"mandatory": false
}
},
"tileId": "k8s"
}Tile name.
Task input properties.
Task output properties.
Unique Id associated with the tile.
A list of Tile instances.
{
"tiles": [
{
"displayName": "Kubernetes",
"inputProperties": {
"cloudProxyId": {
"type": "String",
"description": "",
"mandatory": false
},
"fingerprint": {
"type": "String",
"description": "",
"mandatory": false
}
},
"outputProperties": {
"isFailed": {
"type": "String",
"description": "",
"mandatory": false
},
"buildUrlId": {
"type": "String",
"description": "",
"mandatory": false
}
},
"tileId": "k8s"
}
]
}{
"absolute": "boolean",
"authority": "string",
"fragment": "string",
"host": "string",
"opaque": "boolean",
"path": "string",
"port": "integer",
"query": "string",
"rawAuthority": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"rawSchemeSpecificPart": "string",
"rawUserInfo": "string",
"scheme": "string",
"schemeSpecificPart": "string",
"userInfo": "string"
}absolute
authority
fragment
host
opaque
path
port
query
rawAuthority
rawFragment
rawPath
rawQuery
rawSchemeSpecificPart
rawUserInfo
scheme
schemeSpecificPart
userInfo
{
"approverGroups": [
"string"
],
"approvers": [
"string"
],
"changeLog": "string",
"comments": "string",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"endpoint": "string",
"executionId": "string",
"executionIndex": "integer",
"expirationInDays": "integer",
"expirationInSeconds": "integer",
"expiresOnInMicros": "integer",
"id": "string",
"index": "string",
"message": "string",
"name": "string",
"orgId": "string",
"parentId": "string",
"pipeline": "string",
"pipelineId": "string",
"projectId": "string",
"requestedBy": "string",
"requestedOnInMicros": "integer",
"respondedBy": "string",
"respondedByEmail": "string",
"respondedOnInMicros": "integer",
"responderRoles": [
"string"
],
"resumeCount": "integer",
"sendemail": "boolean",
"stageKey": "string",
"status": "string",
"summary": "string",
"tags": [
"string"
],
"taskExecutionId": "string",
"taskKey": "string",
"updatedAt": "string",
"updatedBy": "string",
"version": "string"
}approverGroups
approvers
changeLog
comments
createdAt
createdBy
description
endpoint
executionId
executionIndex
expirationInDays
expirationInSeconds
expiresOnInMicros
id
index
message
name
orgId
parentId
pipeline
pipelineId
projectId
requestedBy
requestedOnInMicros
respondedBy
respondedByEmail
respondedOnInMicros
responderRoles
resumeCount
sendemail
stageKey
status
summary
tags
taskExecutionId
taskKey
updatedAt
updatedBy
version
User operation response.
{
"responseMessage": "Approved on Monday.",
"status": "Approved"
}The response message which the responder would like to give.
The status of this entity.
UserOperation details.
{
"_createTimeInMicros": 1568625938000000,
"_createdBy": "exampleuser",
"_expiresOnInMicros": 1569216876209000,
"_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"_requestedOnInMicros": 1568957676209000,
"_updateTimeInMicros": 1568625938000000,
"_updatedBy": "exampleuser",
"approvers": [
"string"
],
"createdAt": "2019-09-16 09:25:38.065065+00",
"createdBy": "exampleuser",
"description": "string",
"endpoint": "My-email-endpoint",
"executionId": "19e2d2c3-41b6-4bc0-9f27-b3f935d25366",
"executionIndex": 8,
"executionLink": "/codestream/api/executions/c1c08fc4-0bef-46fa-b5d2-c8aa10d18f6e",
"expirationInDays": 3,
"id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"index": "45b4d8",
"name": "My-Name",
"pipelineId": "6f6b006b-7fec-4684-9200-21a4a782c82b",
"pipelineName": "My-Pipeline",
"project": "My-Project",
"requestedBy": "fritz",
"respondedBy": "fritz",
"responseMessage": "Approved on Monday",
"sendemail": true,
"status": "Approved",
"summary": "To be approved only by admin",
"updatedAt": "2019-09-16 09:25:38.065065+00",
"updatedBy": "exampleuser",
"version": "v1"
}This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'createdBy' field
The time in micros when it would expire.
Partial URL that provides details of the resource.
The time in micros when the request was made.
This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field
The list of approver emails who can approve it.
Date when the entity was created. The date is in ISO 8601 with time zone
The user that created this entity
A human-friendly description.
The email Endpoint to be used if the sendemail is set to true.
The Execution id of the Pipeline Execution consisting of this task.
The index of the Pipeline Execution in which the entity is present.
The Execution link of the Pipeline Execution consisting of this task.
The time in days after which this entity would expire.
The id of this resource.
The index of the entity.
A human-friendly name used as an identifier in APIs that support this option
The id of the Pipeline consisting of this task.
The name of the Pipeline this task is configured in.
The project this entity belongs to.
The user who requested this.
The user who responded to this approval.
The response message which the responder would like to give.
The flag to determine if an email has to be sent.
The status of this entity.
The summary of this entity.
Date when the entity was last updated. The date is in ISO 8601 with time zone.
The user that last updated this entity
Version of the resource.
UserOperations details.
{
"count": "integer",
"links": [
"string"
],
"totalCount": "integer"
}Number of resources within the current page.
Details of the queried resources.
Partial URLs representing the links to the queried resources.
Number of resources across all pages.
Model used for validation responses.
{
"containerName": "vrcsPipeline.DEV for a stage",
"fieldName": "inputProperties.jobName.value",
"level": "SEVERE/WARNING/INFO",
"message": "Validation successful"
}Name of pipeline / stage / name in the hierarchy where they belong to.
Field in the input which is causing validation to fail in the deeper JSON.
Message level.
Validation message.
Model used for validation responses.
{
"classType": "Pipeline",
"message": {
"containerName": "vrcsPipeline.DEV for a stage",
"fieldName": "inputProperties.jobName.value",
"level": "SEVERE/WARNING/INFO",
"message": "Validation successful"
},
"success": "boolean"
}Class which will be validated.
Indicates whether validation was successful or not.
A Variable is used to store re-usable/sensitive strings within Code Stream in an encrypted format so as to be able to consume in other areas like Endpoint, Pipeline, Task or Stage etc.
{
"_createTimeInMicros": 1568625938000000,
"_createdBy": "exampleuser",
"_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"_updateTimeInMicros": 1568625938000000,
"_updatedBy": "exampleuser",
"createdAt": "2019-09-16 09:25:38.065065+00",
"createdBy": "exampleuser",
"description": "string",
"id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"name": "My-Name",
"project": "My-Project",
"type": "REGULAR",
"updatedAt": "2019-09-16 09:25:38.065065+00",
"updatedBy": "exampleuser",
"version": "v1"
}This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'createdBy' field
Partial URL that provides details of the resource.
This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field
Date when the entity was created. The date is in ISO 8601 with time zone
The user that created this entity
A human-friendly description.
The id of this resource.
A human-friendly name used as an identifier in APIs that support this option
The project this entity belongs to.
The type of this Variable. Ex: REGULAR / SECRET / RESTRICTED
Date when the entity was last updated. The date is in ISO 8601 with time zone.
The user that last updated this entity
The value for this Variable.
Version of the resource.
A Variable is used to store re-usable/sensitive strings within Code Stream in an encrypted format so as to be able to consume in other areas like Endpoint, Pipeline, Task or Stage etc.
{
"description": "string",
"name": "My-Name",
"project": "My-Project",
"type": "REGULAR",
"value": "my-value"
}A human-friendly description.
A human-friendly name used as an identifier in APIs that support this option
The project this entity belongs to.
The type of this Variable. Ex: REGULAR / SECRET / RESTRICTED
The value for this Variable.
A list of Variable instances
{
"count": "integer",
"links": [
"string"
],
"totalCount": "integer"
}Number of resources within the current page.
Details of the queried resources.
Partial URLs representing the links to the queried resources.
Number of resources across all pages.
Request object for version of a Custom Integration.
{
"changeLog": "Modified API signatures.",
"description": "This is the latest version.",
"version": "v1"
}Changelog describing the changes between this and previous versions.
Description of the version.
Version of the Custom Integration.
Represents a Webhook Event configuration.
{
"action": "POST/PUT/PATCH",
"endpoint": "string",
"event": "string",
"payload": {
"text": "executionId",
"username": "[email protected]"
},
"stage": "string",
"task": "string",
"url": "string"
}Action Type.
endpoint
event
The headers required to perform HTTP action on the provided url.
Payload to be sent to the webhook.
stage
task
WebhookURL to send payload.
Model which contains details about container and host for executing continuous integration tasks.
{
"autoCloneForTrigger": true,
"cache": [
"/root/.m2",
"/temp/"
],
"endpoint": "string",
"image": "fedora:latest",
"path": "/usr/administrator/",
"registry": "Docker Trusted Registry"
}Indicates that git clone will be performed automatically.
List of paths to store artifacts and logs.
Name of the endpoint is docker.
Image to create CI container.
Working directory for executing commands.
Name of the docker registry.
{
"logs": [
"string"
],
"status": "COMPLETED",
"step": "GIT_CLONE"
}Logs for the executing step.
Status of the Git clone/creating a container for the Workspace.
The current step for Git clone/creating a container for the Workspace.