Get Step Consoles

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Gets step consoles belonging to a particular step.

Security: Requires bearer token as authentication header and the token used needs to be of a valid user.

Usage: GET api/v1/steps/{stepId}/consoles

Consumes: application/json

URL Parameters:

Parameter

Data Type

Description

Required/Optional

stepId

Integer

Id of the step.

Required

Query Parameters:

Parameter

Data Type

Description

Required/Optional

limit

Integer

A limit on the number of consoles returned.

Optional

skip

Integer

A cursor for use in pagination. This parameter defines the number of consoles skipped.

Optional

fetchAll

Boolean

If the caller is a super user, ignores if the maximum number of consoles has been exceeded. Does not return a console log object if there are no logs, and does not group logs.

Optional

download

Boolean

Downloads the step consoles as a text file.

Optional

sortBy

String

The stepConsole properties by which to sort the results. Expects a comma separated list of sorters. Ignored if download is true.

Optional

sortOrder

Integer

A sort order based on the sortBy defined. If '1', sorts the list in ascending order. If '-1', sorts the list in descending order. Ignored if download is true.

Optional

Produces: application/json

Sample Usage:

GET api/v1/steps/3/consoles

{
    "root": [
        {
            "consoleId": "3bd3303a-1c33-45fc-849a-38e7097918b2",
            "isSuccess": null,
            "isShown": true,
            "parentConsoleId": "root",
            "stepId": 3,
            "pipelineId": 3,
            "timestamp": 1612940807666334,
            "timestampEndedAt": null,
            "type": "grp",
            "message": "Step skipped",
            "createdAt": "2021-02-10T07:06:47.724Z",
            "updatedAt": "2021-02-10T07:06:47.725Z"
        },
        {
            "consoleId": "3bd3303a-1c33-45fc-849a-38e7097918b2",
            "isSuccess": false,
            "isShown": true,
            "parentConsoleId": "root",
            "stepId": 3,
            "pipelineId": 3,
            "timestamp": 1612940807668168,
            "timestampEndedAt": 1612940807668171,
            "type": "grp",
            "message": "Step skipped",
            "createdAt": "2021-02-10T07:06:47.730Z",
            "updatedAt": "2021-02-10T07:06:47.730Z"
        }
    ],
    "3bd3303a-1c33-45fc-849a-38e7097918b2": [
        {
            "consoleId": "26b01962-2b9c-4b08-943d-32e48195510c",
            "isSuccess": null,
            "isShown": true,
            "parentConsoleId": "3bd3303a-1c33-45fc-849a-38e7097918b2",
            "stepId": 3,
            "pipelineId": 3,
            "timestamp": 1612940807667063,
            "timestampEndedAt": null,
            "type": "cmd",
            "message": "Info",
            "createdAt": "2021-02-10T07:06:47.733Z",
            "updatedAt": "2021-02-10T07:06:47.733Z"
        },
        {
            "consoleId": "26b01962-2b9c-4b08-943d-32e48195510c",
            "isSuccess": false,
            "isShown": false,
            "parentConsoleId": "3bd3303a-1c33-45fc-849a-38e7097918b2",
            "stepId": 3,
            "pipelineId": 3,
            "timestamp": 1612940807667678,
            "timestampEndedAt": 1612940807667688,
            "type": "cmd",
            "message": "Info",
            "createdAt": "2021-02-10T07:06:47.737Z",
            "updatedAt": "2021-02-10T07:06:47.737Z"
        }
    ],
    "26b01962-2b9c-4b08-943d-32e48195510c": [
        {
            "consoleId": "67d96fe8-41c0-4cea-908b-ab7e905a393e",
            "isSuccess": null,
            "isShown": true,
            "parentConsoleId": "26b01962-2b9c-4b08-943d-32e48195510c",
            "stepId": 3,
            "pipelineId": 3,
            "timestamp": 1612940807667567,
            "timestampEndedAt": null,
            "type": "msg",
            "message": "Skipping step as it has unsuccessful dependencies.",
            "createdAt": "2021-02-10T07:06:47.737Z",
            "updatedAt": "2021-02-10T07:06:47.737Z"
        }
    ]
}

Response Codes:

200: Success