Skip to main content
PUT
Order Docket Exhibit

Authorizations

X-API-Key
string
header
required

Headers

Idempotency-Key
string | null

An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked Idempotent-Replayed: true, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.

Prefer
string | null

Request execution preference (RFC 7240). Use respond-async for asynchronous execution, wait=N to specify a synchronous timeout hint in seconds, or priority=low to route the task to the low-priority queue.

Example:

"respond-async"

Path Parameters

docket_exhibit_id
string<uuid>
required

The unique identifier of the docket exhibit to fetch documents for.

Example:

"0be74582-6f94-4558-9c87-e801bf08b740"

Query Parameters

from_court
boolean
default:true

Whether to fetch the document directly from the court. Defaults to True as all cached versions will already be available.

Response

Successful Response

Represents a docket exhibit state.

id
string<uuid>
required

ID of the docket exhibit document request

docket_exhibit_id
string<uuid>
required

ID of the docket exhibit the search was performed for

state
enum<string>
required

State of the document search request

Available options:
PENDING,
EXECUTING,
COMPLETED,
FAILED,
CANCELLED
idempotency_key
string | null

The Idempotency-Key header the request that created this resource carried, if any.