List document fragments
GET/pipelines/:pipeline_id/documents/:document_id/fragments
Returns one page of the fragments of one document version, in the order of the fragments within the version. The version is the latest version of the document, or the latest version created at or before as_of, including an expired version. The fragment text is included in page_content only when the request sets contents=true.
Permissions. Read and execute on the pipeline.
Documents, versions and fragments describes fragments, and API conventions describes pagination.
Request
Responses
- 200
- 400
- 401
- 404
- 500
The body is one page of fragments in the list envelope. page_content is present only with contents=true.
A query parameter is invalid: as_of lies outside the range of valid timestamps (Invalid version), order_by names another field (Invalid order_by parameter) or the pagination parameters conflict (Pagination error).
The authentication headers are missing or invalid, or the API key is inactive or expired. Errors lists the messages.
No pipeline with this identifier exists or the key lacks read and execute permission on the pipeline (Pipeline with id <id> not found), or the pipeline has no version of the document created at or before as_of (Document with id <id> not found).
The text of a fragment could not be decrypted (Decryption error). Only a request with contents=true decrypts text.