Get All Using GET 1
Get all Executions with specified paging and filter parameters.
Request
URI
GET
https://{api_host}/codestream/api/executions
COPY
Query Parameters
string
$filter
Optional
To list with OData like filter
string
$orderby
Optional
Constraints:
default: name desc
Order by attribute
string
$skip
Optional
Constraints:
default: 0
To skip 'n' Executions for listing
string
$top
Optional
Constraints:
default: 25
To list top 'n' Executions for listing
string
page
Optional
Constraints:
default: 0
To select 'n'th page for listing
string
apiVersion
Optional
The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about
Responses
200
'Success' with the requested Executions
Returns
Executions
of type(s)
*/*
{
"count": 0,
"documents": {
"documents": {
"_createTimeInMicros": 1568625938000000,
"_createdBy": "exampleuser",
"_durationInMicros": 0,
"_executedBy": "string",
"_inputMeta": {
"_inputMeta": {
"description": "Repo Url"
}
},
"_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
"_nested": false,
"_outputMeta": {
"_outputMeta": {
"description": "Repo Url"
}
},
"_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,
"input": {},
"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": {},
"project": "My-Project",
"reason": "string",
"stageOrder": [
"string"
],
"stages": {
"stages": {
"_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"
],
"tasks": {
"tasks": {
"_durationInMicros": 1568625938000000,
"_endTime": 1568625938000000,
"_startTime": 1568625938000000,
"endpoints": {
"endpoints": "string"
},
"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"
}
}
}
},
"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"
}
]
}
},
"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.
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
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/codestream/api/executions