GetActionExecutionLog Method

Description

Returns some or all of the activity log from one action execution.

On success, the response of this method will return the activity log in the response body as plain text. It will not be a JSON body. Headers will be included to help retrieve subsequent portions of the activity log.

HTTP Request

GET https://api.skeddly.com/api/ActionExecutions/<id>/Log

URL Parameters

id

The ID of the action execution.

Type: string

Required: Yes

Query Parameters

marker

Omiting this value will retrieve the beginning of the log. Specifying this parameter will retrieve the next portion of the activity log. Markers specified should be those returned from a previous call.

Type: string

Required: No

Response Headers

Some headers will be included to indicate continuation of the log in a later call.

X-Skeddly-More

Indicates whether the log is complete or if there is more to retrieve.

Possible values:

  • none - The log is complete.

  • more - There is more log to retrieve. The next portion can be retrieved immediately.

  • more-later - There is no more log to retrieve now, but the action is still executing, so there will be more later. The next portion can be retrieved later. Delay 1 or 2 minutes then try retrieving the next portion.

X-Skeddly-Next-Marker

Indicates the marker value to include in a subsequent call to retrieve the next portion of the log.

Type: string

Response Body

The response body will contain the activity log in plain text.

Examples

Sample 1: Getting the first portion of a log

Sample Request

This requests omits the marker parameter from the request. This indicates to retrieve the first portion of the log.

GET /api/ActionExecutions/ae-00000001/Log HTTP/1.1
Host: api.skeddly.com
Authorization: AccessKey <api key>

Sample Response

This response specifies more to show that more log can be downloaded immediately. The next marker is also included to be used to retrieve the next portion.

Content-Type: plain/text
X-Skeddly-More: more
X-Skeddly-Next-Marker: marker1

D:2020-07-13 12:00 Log Starts
D:2020-07-13 12:00 Line 1
D:2020-07-13 12:00 Line 2

Sample 2: Getting the next portion of a log

Sample Request

This requests includes the marker parameter from the previous request. This indicates to retrieve the next portion of the log.

GET /api/ActionExecutions/ae-00000001/Log?marker=marker1 HTTP/1.1
Host: api.skeddly.com
Authorization: AccessKey <api key>

Sample Response

This response specifies more to show that there is still more log portions to retrieve. The next marker is included.

Content-Type: plain/text
X-Skeddly-More: more
X-Skeddly-Next-Marker: marker2

D:2020-07-13 12:00 Log Continues
D:2020-07-13 12:00 Line 3
D:2020-07-13 12:00 Line 4

Last updated