Skip to content
docstack-ocr

List Batch Jobs Endpoint

GET
/v1/batches/{batch_id}/jobs
 
curl --request GET \
  --url 'http://localhost:8080/v1/batches/example/jobs?include_deleted=false&limit=200&offset=0'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
batch_id
required
Batch Id
string

Query Parameters

Section titled “Query Parameters ”
status
Any of:
string
include_deleted
Include Deleted
boolean
limit
Limit
integer
default: 200 >= 1 <= 500
offset
Offset
integer
0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
Response List Batch Jobs Endpoint V1 Batches Batch Id Jobs Get
object
key
additional properties
any
Example generated
{}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}