Description: Gets a collection of pipelineSteps entities. Filter criteria can be supplied via query string parameters.
Security: Requires a valid user
Usage: GET api/v1/pipelineSteps
Consumes: application/json
Query Parameters:
Parameter | Data Type | Description |
---|---|---|
| Boolean | A filter on the list based on the |
| Integer | Comma separated list of numeric project ids |
| String | Comma separated list of project names |
| Integer | Comma separated list of numeric pipeline source ids |
| Integer | Comma separated list of numeric pipeline step ids |
| Boolean | A filter on the list based on the |
| String | A date type entry to get previously deleted pipelineSteps. |
| Integer | Comma separated list of numeric pipeline ids. |
| String | Comma separated list of numeric typeCodes. |
| String | Optional. Sort the steps in the execution order. NoteRequires NoteIn the case of parallel steps, this is the anticipated order and it can differ with the available node capacity. When there is insufficient node capacity to run all parallel steps, any one of the steps can be queued randomly unless priority is defined in the pipeline YAML. |
Request Parameters: Ignored
Produces: application/json
Sample Usage:
[ { "ymlConfigPropertyBag": { "integrations": [ { "name": "s_bitbucketServer" } ], "environmentVariables": { "normal": {} } }, "yml": { "name": "api_PipelineSteps", "type": "Bash", "configuration": { "integrations": [ { "name": "s_bitbucketServer" } ] }, }, "id": 8, "name": "api_PipelineSteps", "typeCode": 2007, "latestStepId": null, "projectId": 1, "pipelineSourceId": 6, "pipelineId": 5, "isDeleted": false, "deletedAt": null, "isConsistent": true, "isStale": false, "staleAt": null, "isPaused": false, "createdBy": "1", "updatedBy": "1", "createdAt": "2019-12-10T08:42:09.317Z", "updatedAt": "2019-12-10T08:42:09.404Z" }, { "ymlConfigPropertyBag": null, "ymlExecPropertyBag": null, "yml": { "name": "in_trigger_step", "type": "bash" }, "id": 9, "name": "my_step", "typeCode": 2007, "latestStepId": null, "projectId": 1, "pipelineSourceId": 6, "pipelineId": 5, "isDeleted": false, "deletedAt": null, "isConsistent": false, "isStale": false, "staleAt": null, "isPaused": false, "createdBy": "3", "updatedBy": "3", "createdAt": "2019-12-10T08:42:09.742Z", "updatedAt": "2019-12-10T08:42:09.742Z" } ]
Response Codes:
200: Success