Get Batch Results Link
GET
/api/v1/batches/{batch__id}/results_link
Parameters
Path Parameters
batch__id
required
Batch Id
string format: uuid
Query Parameters
id
Id
Filter jobs by their unique ids
Array<string>
Filter jobs by their unique ids
start_date
Start Date
Filter jobs that started on or after this date
string format: date-time
Filter jobs that started on or after this date
end_date
End Date
Filter jobs that ended on or before this date
string format: date-time
Filter jobs that ended on or before this date
Responses
200
Successful Response
NonPaginatedResponse[ProducedBatchResultLinkResponse]
Represents a response with either a list of items or a single item in a single page.
Generic Parameters:
- A
(TypeVar): The type bound to this class, which can be a single BaseModel,
a list of BaseModels, or None.
Usage:
- To respond with an unpaginated list of FooResponse
items
from an API endpoint, ensure that your function
returns NonPaginatedResponse[List[FooResponse]]
.
- To respond with a single `FooResponse` item from an API endpoint,
make sure that your function returns `NonPaginatedResponse[FooResponse]`
and that Python recognizes it.
object
data
ProducedBatchResultLinkResponse
Response for batch results link
object
results_links
required
Results Links
object
key
additional properties
string
errors
required
Errors
object
key
additional properties
string
422
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string