POST/containers/documents/query
Operation containers.documentLanes.query
Description
Lists the documents linked into up to 32 containers, each lane with its own watermark and page size (500 rows in total). Each lane needs read access to its container; a lane that fails reports its own failure while the others still list, and only the container's absence is reported as container_not_found.
Authentication
Requires a signed-in session: the client sends its session token as a bearer token in the Authorization header.
Request body
application/jsonListContainerDocumentLanesRequest
Up to 32 container lanes to list documents for, each with its own watermark and page size (500 rows in total).
1 field
laneslist of objectrequired- 1 to 32 items
4 fields
containerIdstringrequired- lowercase UUID v4
laneIdstringrequired- 1 to 64 characters
limitintegeroptional- 1 to 500
watermarkobjectrequirednullable2 fields
idstringrequired- not empty
updatedAtstringrequired- not empty
Responses
200 OK
application/jsonobject
1 field
resultslist of one of: object, objectrequired- 1 to 32 items
- object
2 fields
laneIdstringrequired- 1 to 64 characters
- object
2 fields
failureobjectrequired3 fields
codestringoptional- always
container_not_found
- always
errorstringrequired- not empty
statusnumberrequired- one of
403,404,409
- one of
laneIdstringrequired- 1 to 64 characters
Other responses
| Status | Meaning | Body |
|---|---|---|
| 400 | Bad Request |
|
| 401 | Unauthorized |
|
| 500 | Internal Server Error |
|
| 503 | Service Unavailable |
|
Additional rules
The server also enforces these rules, which the schema above cannot express.
Container document-lane request lane ids must be unique.
Container document-lane request page limits must total at most 500.
Container document-lane response lane ids must be unique.