Step Functions

Step Functions

This method cancels a state machine execution

This method cancels a state machine execution

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

stateMachineName
required
string

The name of the state machine

executionId
required
string

The execution ID

Responses
200The state machine was cancelled successfully
400The request was not valid
401Unauthorized
403Forbidden
404State machine was not found
429The state machine could not be started because an instance is already running
500An internal server error occured.
delete/stepFunctions/{tenantId}/{stateMachineName}/{executionId}
Request samples
curl -i -X DELETE \
  https://system.api.756794052567.rhythmsoftware.com/stepFunctions/:tenantId/:stateMachineName/:executionId \
  -H 'Authorization: YOUR_API_KEY_HERE'

Gets the current state of an execution

Gets the current state of an execution

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

executionArn
required
string
Responses
200The execution
400The request was not valid
401Unauthorized
403Forbidden
404State machine was not found
429The state machine could not be started because an instance is already running
500An internal server error occured.
get/stepFunctions/{tenantId}/describe/{executionArn}
Request samples
curl -i -X GET \
  https://system.api.756794052567.rhythmsoftware.com/stepFunctions/:tenantId/describe/:executionArn \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "executionArn": "string",
  • "input": "string",
  • "output": { },
  • "start_date": "2019-08-24T14:15:22Z",
  • "stateMachineArn": "string",
  • "status": "RUNNING",
  • "stop_date": "2019-08-24T14:15:22Z"
}

Gets the current state of an execution

Gets the current state of an execution

Request
path Parameters
tenantId
required
string

The id of the tenant being accessed

executionArn
required
string
Responses
200The execution
400The request was not valid
401Unauthorized
403Forbidden
404State machine was not found
429The state machine could not be started because an instance is already running
500An internal server error occured.
get/stepFunctions/{tenantId}/public/describe/{executionArn}
Request samples
curl -i -X GET \
  https://system.api.756794052567.rhythmsoftware.com/stepFunctions/:tenantId/public/describe/:executionArn
Response samples
application/json
{
  • "executionArn": "string",
  • "input": "string",
  • "output": { },
  • "start_date": "2019-08-24T14:15:22Z",
  • "stateMachineArn": "string",
  • "status": "RUNNING",
  • "stop_date": "2019-08-24T14:15:22Z"
}