Skip to content
System
/
/
Gets the current state of...

Gets the current state of an execution

Request

Gets the current state of an execution

Path
tenantIdstringrequired

The id of the tenant being accessed

executionArnstringrequired
curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/system/system-v1/stepFunctions/{tenantId}/public/describe/{executionArn}'

Responses

The execution

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
executionArnstring(Executionarn)

The execution ARN

inputstring(Input)

The input to the execution

outputobject(Output)

The ouptut of the execution

start_datestring, (date-time)(Start Date)

When the execution started

stateMachineArnstring(Statemachinearn)

The arn of the state machine being run

statusstring(Status)

The status

Enum:"ABORTED""FAILED""RUNNING""SUBMITTED""SUCCEEDED""TIMED_OUT"
stop_datestring, (date-time)(Stop Date)

The date the execution stopped

Response
{
  "executionArn": "string",
  "input": "string",
  "output": {},
  "start_date": "2019-08-24T14:15:22Z",
  "stateMachineArn": "string",
  "status": "ABORTED",
  "stop_date": "2019-08-24T14:15:22Z"
}