FRfrisbii
action

Get action by handle

get/v1/action/{handle}

Request

  • Base URL
    https://rule-engine-api.frisbii.com
  • URL
    https://rule-engine-api.frisbii.com/v1/action/{handle}
  • Auth
    HTTP basic

Path parameters

handlestring required

Response

Successful operation

idstring

Action id

state'new' | 'success' | 'failure' | 'retrying' | 'nothing_to_do'

State of the action

createdstring date-time

Action created timestamp

actionstring required

Action type

entity_idstring

The ID (handle) of the product on which the action is performed.

entity_typestring

Type of the entity on which the action is performed.

additional_actionsResponseActionDto[] circular

Example response

{
  "id": "action_1234567890",
  "state": "new",
  "created": "2021-09-01T12:00:00Z",
  "action": "add_addon_to_subscription",
  "schedule": {
    "event_type": "subscription_contract_period_renewed"
  },
  "entity_id": "sub-0001",
  "entity_type": "subscription"
}

Changes

No recorded changes to this operation across all 1 revision of this API.