Get Template Dispatch Batch Status
Perform Get Template Dispatch Batch Status through Brightree.
brightree_get_template_dispatch_batch_statusreadbrightree
Inputs
- Job Id
job_idexpressionOptional literal value or workflow expression.
Outputs
successSuccessjob_idJob Iddispatcher_statusDispatcher Statusdispatcher_finishedDispatcher Finishedtotal_ordersTotal OrderssettledSettledcompletedCompletedfailedFailedskippedSkippedin_flightIn Flightnot_startedNot Startedis_completeIs Completecompleted_order_keysCompleted Order Keysfailed_order_keysFailed Order Keysskipped_order_keysSkipped Order Keysin_flight_order_keysIn Flight Order Keysnot_started_order_keysNot Started Order KeysmessageMessageerrorError
Output schema completeness: best_effort_declared
Safety
- External effect
- read
- Confirmation recommended
- No
- Retry safe
- Yes
- Dry run supported
- No
Schemas
These schemas are first-pass authoring guidance. Runtime validation remains authoritative.
Input schema
{
"type": "object",
"properties": {
"job_id": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"error": {},
"failed": {},
"job_id": {},
"message": {},
"settled": {},
"skipped": {},
"success": {},
"completed": {},
"in_flight": {},
"is_complete": {},
"not_started": {},
"total_orders": {},
"dispatcher_status": {},
"failed_order_keys": {},
"skipped_order_keys": {},
"dispatcher_finished": {},
"completed_order_keys": {},
"in_flight_order_keys": {},
"not_started_order_keys": {}
},
"additionalProperties": true
}