Get batch agreement by id
GET/v2/agreement-batches/:id
Get batch agreement by id
Request
Path Parameters
id stringrequired
Batch id
Responses
- 200
- 401
- 403
OK
- application/json
- Schema
- Example (from schema)
Schema
id uuid
Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
status BatchStatus (string)
Possible values: [IN_PROGRESS
, PROCESSED
, FAILED
]
batch_name string
Name of the batch
processed int32
Number of processed items in the batch
total int32
Total number of items in the batch
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "IN_PROGRESS",
"batch_name": "string",
"processed": 0,
"total": 0
}
Not Authorized
Not Allowed
Loading...