Get Pipelines Steps

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

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

includeDeleted

Boolean

A filter on the list based on the isDeleted property. Default is false.

projectIds

Integer

Comma separated list of numeric project ids

names

String

Comma separated list of project names

pipelineSourceIds

Integer

Comma separated list of numeric pipeline source ids

pipelineStepIds

Integer

Comma separated list of numeric pipeline step ids

isDeleted

Boolean

A filter on the list based on the includeDeleted property. If includeDeleted is true, this is ignored.

deletedBefore

String

A date type entry to get previously deleted pipelineSteps.

pipelineIds

Integer

Comma separated list of numeric pipeline ids.

typeCodes

String

Comma separated list of numeric typeCodes.

sortByDependency

String

Optional. Sort the steps in the execution order.

Note

Requires projectId parameter.

Note

In 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.Breaking Your Pipelines into StepsBash

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