Where did this come from? Trace a statement line, a posting or an entry back to its document
const url = 'https://example.com/v1/entities/example/provenance';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/v1/entities/example/provenanceParameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The entity this path is relative to
The entity this path is relative to
Query Parameters
Section titled “Query Parameters”Responses
Section titled “Responses”Successful Response
The answer to “where did this come from?”: the actual document, or nothing.
For a statement line, the answer is the document it was read off. For a posting or an entry, it is the
lines behind it, and so their documents. A subject this entity does not hold is a 404; an empty lines
list means the subject exists but nothing links it to a document yet.
object
object
One statement line traced back to the document it was read off.
object
Signed integer micro-units (millionths) as a base-10 string; never a JSON number.
The original document as a reader sees it: what identifies it, and whether it can be opened here.
There is deliberately no blob_path (removed in issue 0007): a server-local path is no use to a reviewer
and discloses where the service keeps files. storage says instead whether the bytes are available:
stored means GET /documents/{id}/content will hand them over, external means only
external_ref exists and the document is held elsewhere.
object
Signed integer micro-units (millionths) as a base-10 string; never a JSON number.
object
object
The original document as a reader sees it: what identifies it, and whether it can be opened here.
There is deliberately no blob_path (removed in issue 0007): a server-local path is no use to a reviewer
and discloses where the service keeps files. storage says instead whether the bytes are available:
stored means GET /documents/{id}/content will hand them over, external means only
external_ref exists and the document is held elsewhere.
object
Example
{ "lines": [ { "amount_micros": "-12000000", "allocations": [ { "amount_micros": "-12000000" } ] } ]}Bad Request
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Unauthorized
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Forbidden
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Not Found
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Conflict
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Precondition Failed
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Unprocessable Content
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Internal Server Error
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Service Unavailable
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}