Jump to

• Request
• Response

Get metadata document for the specific document version

get

/oitt/api/v1/documents/{documentKey}/versions/{documentVersion}/metadataDocument

The operation returns metadata document for given document version and document key.

Permissions

This operation is only available to users who have the METADATA_DOCUMENT_READ and DOCUMENT_TRACE permissions. Users can view only metadata document of the documents associated with trading partners that are implicit or explicit viewers. Founder users can view all the metadata documents.

Request

Path Parameters

• documentKey(required): string
  A key that uniquely identifies the document.
• documentVersion(required): string
  Version of a document identified by some document key.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Metadata document has been successfully retrieved.

Body ()

Root Schema : Metadata Document

Type: object

Title: Metadata Document

403 Response

The user doesn't have permission to view the document.

404 Response

The document doesn't exist.

Back to Top