MngGetWorkflowRule

Returns one workflow rule by id.

Access

Manager sessions: SESSION_MANAGER, SESSION_ADMIN, SESSION_DEALER, SESSION_CRM_MANAGER, SESSION_CRM_ADMIN.

Request Parameters

Name	Type	Required	Description
id	int	Yes	Workflow rule id

Request

{
  "command": "MngGetWorkflowRule",
  "extID": "1",
  "data": {
    "id": 1
  }
}

Response Data

{
  "rule": {
    "id": 1,
    "brand": "brand-a",
    "code": "large_deposit_sof",
    "name": "Large Deposit Source Of Funds",
    "scope": 2,
    "status": 0,
    "priority": 100,
    "trigger": "deposit.created",
    "conditions": [],
    "actions": [],
    "stop_processing": 0,
    "created_time": 1778160000,
    "updated_time": 1778160000,
    "unavailable_actions": [
      { "index": 0, "type": "mailer.send_template", "reason": "provider_not_registered" }
    ]
  }
}

unavailable_actions lists actions of the rule that will not run right now; it is empty when every action is available. The same field is returned in the rule object of MngAddWorkflowRule and MngUpdateWorkflowRule.

Field	Type	Description
index	int	Position of the action in actions, from 0
type	string	Action code
reason	string	provider_not_registered — the provider listed in [workflow] providers is offline; action_missing — no server action and no registered provider action has this code

An action with provider_not_registered stays in the rule and can be saved unchanged; runs fail at it until the provider registers again. See Workflow provider actions.