requests.resolveRequest

POST

/v1/requests/{requestId}

curl --request POST \
  --url https://example.com/v1/requests/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "commandKey": "example", "expected": 1, "decision": "allow", "scope": "once", "reason": "example", "rule": "example" }'

Saves one decision and returns its execution receipt. The workflow sends the result to the Chat.

Authorizations

• token
• session

Parameters

Path Parameters

requestId

required

string

>= 1 characters <= 128 characters

Request Body^required

Media typeapplication/json

object

commandKey

required

string

>= 1 characters <= 128 characters

expected

required

integer

<= 9007199254740991

decision

required

string

Allowed values: allow deny

scope

string

Allowed values: once chat lifetime

reason

string

<= 2000 characters

rule

string

>= 1 characters <= 4000 characters

Responses

202

Success

Media typeapplication/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

BotInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: BotInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "BotInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | ExecutionForbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: ExecutionForbidden

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "Forbidden"
}

404

BotNotFound | ExecutionNotFound | RequestNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: BotNotFound

bot

required

string

object

object

_tag

required

string

Allowed values: ExecutionNotFound

id

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: RequestNotFound

request

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "BotNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending | BotConflict | ExecutionConflict | ExecutionKeyConflict | RequestConflict

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

object

object

_tag

required

string

Allowed values: BotConflict

message

required

string

object

object

_tag

required

string

Allowed values: ExecutionConflict

id

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ExecutionKeyConflict

object

object

_tag

required

string

Allowed values: RequestConflict

message

required

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

BotStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: BotStorageUnavailable

object

object

_tag

required

string

Allowed values: ExecutionUnavailable

errorId

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "PolicyUnavailable"
}