launch_batch_run
/entities/{entity_id}/records/batch-runsA service principal's credential, or a person's access token, AgentFlow's own or an installed app's. A service principal's effective permissions are its role permissions intersected with the credential's scopes.
In: header
Path Parameters
Entity id
uuidHeader Parameters
A key of 1 to 255 printable ASCII characters. Repeating this request with the same key returns the original outcome instead of performing it again. A UUID is recommended.
1 <= length <= 255Request Body
application/json
workflow_id or action_id, a target of ids or query, and params
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08/records/batch-runs" \ -H "Content-Type: application/json" \ -d '{ "target": { "ids": [ "6e0346a3-e54d-40e3-9779-4ba1e707e35b" ], "kind": "ids" } }'{ "action_id": "52d6fa12-2c88-46da-984a-4cc821c7837a", "arity": "single", "created_at": "2019-08-24T14:15:22Z", "entity_id": "8161163a-f227-466f-bc01-090a01e80165", "failure_code": "string", "failure_detail": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "record_action_launch": null, "requester_credential_id": "7a0b2aa6-b882-418f-a387-b05452d6a614", "status": "pending", "version_id": "9e94c502-ca41-4342-a7f7-af96b444512c", "workflow_id": "03e70e31-d7a4-4401-a629-6a4b6096cdfe"}