Get Batch Operation Descriptor
GET /v2/batch/operation-kinds/{kind}
Required scopes
batch:operations:read
Tokens missing any required scope return 401 scope_missing.
See Auth & Scopes for issuance.
Operation
| Operation ID | getBatchOperationDescriptor |
| Tags | Batch |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| kind * | path | string |
Responses
200
OK
object
| Field | Type | Description |
|---|---|---|
| operation * | schema | |
| summary | string | |
| idempotency_mode * | enum (2) | naturalkeyed |
| failure_mode * | enum (2) | partial_oktransactional |
| required_scopes * | string[] | |
| accepted_source_kinds * | enum (4)[] | |
| input_row_schema * | object | JSON Schema for per-row input |
| params_schema * | object | |
| result_schema * | object | |
| replayable_modes | enum (2)[] | |
| ipaas_equivalent | string |
Example request
GET https://api.digitalonboarding.com/v2/batch/operation-kinds/{kind}
Authorization: Bearer <partner-token>