Versions Compared

Old Version 15

changes.mady.by.user Eleanor Tesoro

Saved on

compared with

New Version Current

changes.mady.by.user Eleanor Tesoro

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

This page is no longer maintained (). For the most current information, go to https://docs.snaplogic.com/public-apis/get-runtime-org.html.

Redirect
filename
locationhttps://docs.snaplogic.com/public-apis/get-runtime-org.html

GET /runtime/{org}

Overview

This API returns information about Task runs pipeline executions that match the specified filters.

Prerequisites

  • Read access to the requested assets

Request

Appsplus panel macro confluence macro
data{"features":["rounded"],"title":"","titleColor":"#FFFFFF","titleColorBG":"#0052CC","titleSize":16,"titleBold":false,"titleItalic":false,"titleUnderline":false,"link":"","linkIcon":false,"linkTab":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#dedede","borderColor":"#4C9AFF","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}

GET https://{pod_path}/api/1/rest/public/runtime/{org}?{query_parameters}

Path Parameters

Key

Description

pod_path

Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

org

Required. The name of the SnapLogic Org.

Query Parameters

If a timespan is not set, this API returns information about Task runs within the last hour.

Key

Type

Description

plex_label

string

Returns information about Task runs pipeline executions for the specified Snaplex.

cc_label

string

Returns information about Task runs pipeline executions for the specified CC label (JCC node’s hostname).

pipe_name

string

Returns information about Task runs for the specified Pipelinepipeline execution.

user_id

string

Returns information about Task runs pipeline executions triggered by the specified user.

state

string

Returns information about Task runs pipeline executions in the specified state.

Valid values:

  • Queued – Task Pipeline is queued for processing; all Tasks Pipelines start in this state.

  • NoUpdate – Intermediate state at startup.

  • Prepared – Task Pipeline has been prepared.

  • Started – Task Pipeline has started running.

  • Completed – Task Pipeline has completed successfully.

  • Failing – Task Pipeline encountered an error and is waiting for Snaps to complete execution before moving to the Failed state.

  • Failed – Task Pipeline failed.

  • Stopped – Task Pipeline was stopped either by the user or by the system, as indicated by the "stopper" key.

  • Stopping – Task Pipeline is stopping.

  • Suspending – Resumable Task Pipeline encountered an error and is storing its state.

  • Suspended – Resumable Task Pipeline encountered an error and is suspended.

  • Resuming – Resumable Task Pipeline is loading its state and will resume execution where it left off.

Default: Started

invoker

string

Returns information about Task runs pipeline executions that were invoked in the specified way.

Valid values:

  • triggered – Triggered Taskspipeline executions

  • scheduled – Scheduled Taskspipeline executions

  • always_on – Ultra Taskspipeline executions

  • manual – User-triggered Taskspipeline executions

Default: scheduled

project_path

string

Returns information about Task runs pipeline executions for the specified project.

Allowed formats:

  • /{org}/projects/{project_name}

  • /{org}/shared

last_hours

integer

Returns information about Task runs pipeline executions within the specified number of hours, counting backward from the current time.

Valid values: 1 through 1080 hours (45 days)

Default: 1

start

integer

Returns information about Task runs pipeline executions since the specified time. Provide time as Unix time in milliseconds.

end

integer

Returns information about Task runs pipeline executions before the specified time. Provide time as Unix time in milliseconds.

limit

integer

Returns no more than the specified number of results. You can use limit and offset for pagination.

Valid values: 1 through 1,000

Default: 10

offset

integer

Returns a subset of the results starting at this 0-based index. You can use limit and offset for pagination.

Default: 0

Request Header

Specify Basic for authorization and application/json for content type.

Appsplus panel macro confluence macro
data{"features":["rounded"],"title":"","titleColor":"#FFFFFF","titleColorBG":"#0052CC","titleSize":16,"titleBold":false,"titleItalic":false,"titleUnderline":false,"link":"","linkIcon":false,"linkTab":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#dedede","borderColor":"#4C9AFF","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}

Authorization: Basic {your_encoded_security_credentials}

Content-Type: application/json

Request Body

None.

Response

Response Header

Key

Description

X-SL-StatusCode

Status code indicating the results of the request.

Learn more: HTTP Status Code Registry

Response Body

The results include only the Task runs pipeline executions that you have permissions to view. Org Admins can view all Task runspipeline executions.

Code Block
{
  "response_map": {
    "entries": [ ... ],
    "total": ...,
    "limit": ...,
    "offset": ...
  },
  "http_status_code": 200
}

Key

Type

Description

entries

array

An array of Objects objects containing information metadata about each Task runpipeline execution.

total

integer

The total number of results available.

limit

integer

The number of results returned.

offset

integer

The index of the first result returned.

...