Get Operation Descriptor
GET /v2/ipaas/operations/{operation_kind}/describe
Required scopes
ipaas:operations:read
Tokens missing any required scope return 401 scope_missing.
See Auth & Scopes for issuance.
Operation
| Operation ID | getOperationDescriptor |
| Tags | Catalog |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| operation_kind * | path | string |
Responses
200
OK
object
| Field | Type | Description |
|---|---|---|
| kind * | string | |
| category | string | |
| summary * | string | |
| idempotency_mode * | enum (2) | naturalkeyed |
| failure_mode * | enum (2) | partial_oktransactional |
| bulk_threshold | integer | |
| execution_mode | enum (2) | syncasync |
| required_scopes * | string[] | |
| rate_limit_class | string | |
| input_schema * | object | JSON Schema |
| output_schema * | object | |
| notes | string |
Example request
GET https://api.digitalonboarding.com/v2/ipaas/operations/{operation_kind}/describe
Authorization: Bearer <partner-token>