API ReferenceConsignments
Get a consignment document
GET
/supply-chain/data-space/consignments/{consignmentId}/documents/{documentId}Authorization
jwtBearerAuthScheme AuthorizationBearer <token>
In: header
Path Parameters
consignmentId*string
The identifier of the consignment the document belongs to.
documentId*string
The identifier of the document to retrieve.
Query Parameters
scope?string
The scope of the read: own (a document of the caller's own consignment), shared
(only a document another organisation shared with the caller) or all (the union).
Defaults to all.
Value in
- "own"
- "shared"
- "all"
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/supply-chain/data-space/consignments/CONS-001/documents/INV-1234"{ "id": "string", "documentId": "string", "documentCode": "string", "documentType": "string", "documentRevision": 0, "metadata": { "encodingFormat": "string", "blobSize": 0, "fileExtension": "string" }, "href": "string", "history": [ { "id": "string", "documentRevision": 0, "href": "string" } ]}{ "name": "GeneralError", "message": "errorMessage", "properties": { "foo": "bar" }}{ "name": "UnauthorizedError", "message": "errorMessage"}{ "name": "InternalServerError", "message": "errorMessage"}Returns a single document attached to a consignment. Your own store resolves first; if it does not know the document, the lookup continues among the ones partners shared about that consignment.
A shared document's href points at the providing organisation's node.