executions.decide

POST

/v1/executions/{executionId}/decisions

const url = 'https://example.com/v1/executions/example/decisions';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"commandKey":"example","decisionId":"example","answer":"allow"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v1/executions/example/decisions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "commandKey": "example", "decisionId": "example", "answer": "allow" }'

Authorizations

token
session

Parameters

Path Parameters

executionId

required

string

>= 1 characters <= 128 characters

Request Body^required

application/json

object

commandKey

required

string

>= 1 characters <= 128 characters

decisionId

required

string

>= 1 characters <= 128 characters

answer

required

string

Allowed values: allow deny retry stop

Responses

200

Success

application/json

object

executionId

required

string

>= 1 characters <= 128 characters

commandKey

required

string

>= 1 characters <= 128 characters

sequence

required

integer

<= 9007199254740991

Example ^generated

{
  "executionId": "example",
  "commandKey": "example",
  "sequence": 1
}

400

OrganizationRequired

application/json

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "OrganizationRequired"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

ExecutionForbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionForbidden

Example

{
  "_tag": "ExecutionForbidden"
}

404

ExecutionNotFound

application/json

object

_tag

required

string

Allowed values: ExecutionNotFound

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionNotFound"
}

409

ExecutionConflict | ExecutionKeyConflict

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ExecutionConflict

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionConflict"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ExecutionUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionUnavailable

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionUnavailable"
}

executions.decide

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

Example generated

400

Example

401

Example

403

Example

404

Example

409

Example

429

Example

503

Example

Request Body^required

Example ^generated