System

/

/

This method cancels a state machine execution

System (v1-2025-04-18)

The System API is different from the other Rhythm apps because it is not focused on a specific area of association management. Instead, this API provides endpoints that are useful across all the other areas of the platform. It is most commonly used to execute Queries which may combine data points from several apps.

Download OpenAPI description

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/system/system-v1/

https://system.api.rhythmsoftware.com/

Queries

Queries

Operations

Step Functions

Step Functions

Operations

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}/describe/{executionArn}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

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

application/json

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

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

application/json

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

This method cancels a state machine execution

Request

This method cancels a state machine execution

Path

tenantIdstringrequired

The id of the tenant being accessed

stateMachineNamestringrequired

The name of the state machine

executionIdstringrequired

The execution ID

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/system/system-v1/stepFunctions/{tenantId}/{stateMachineName}/{executionId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The state machine was cancelled successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring