Get Steplet Consoles

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Gets steplet consoles belonging to a particular steplet.

Security: Requires a valid user

Usage: GET api/v1/steplets/{stepletId}/consoles

Consumes: application/json

URL Parameters:

Parameter

Data Type

Description

Required/Optional

stepletId

Integer

Id of the steplet for which console is being requested.

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, including the step consoles as well as the steplet.

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": "1c8f1272-f6cb-49fe-b0a8-1da200c1ea1a",
            "isSuccess": null,
            "isShown": true,
            "parentConsoleId": "root",
            "stepletId": 1,
            "pipelineId": 3,
            "timestamp": 1612940706379471,
            "timestampEndedAt": null,
            "type": "grp",
            "message": "Queuing step",
            "createdAt": "2021-02-10T07:05:06.407Z",
            "updatedAt": "2021-02-10T07:05:06.407Z"
        },
        {
            "consoleId": "1c8f1272-f6cb-49fe-b0a8-1da200c1ea1a",
            "isSuccess": true,
            "isShown": true,
            "parentConsoleId": "root",
            "stepletId": 1,
            "pipelineId": 3,
            "timestamp": 1612940706381850,
            "timestampEndedAt": 1612940706381853,
            "type": "grp",
            "message": "Queuing step",
            "createdAt": "2021-02-10T07:05:06.414Z",
            "updatedAt": "2021-02-10T07:05:06.414Z"
        },
}

Response Codes:

200: Success