Table of Contents

GetDocumentById

Retrieves a document by its unique identifier. The contents are (optionally) returned as a Base-64 encoded property.

Tip

You can download the document directly by using the Download Command.

Definition

Route: /documents/{document_id}
Method: GET
OperationId: GetDocumentById

Permissions

The caller must be a member of one of the following groups:

  • client:admin
  • documents:manager
  • documents:viewer

Request

Headers

Name Description Notes
accept The expected format of the response application/json
osg-client-id The unique identifier assigned to your organization
client_customer_id The unique identifier assigned to your client
correlation_id The unique identifier for correlation

Parameters

Name Type Description
document_id string The unique identifier of the document
Tip

When retrieving a document that was generated using the ./communications/send endpoint, the documentId is the CommunicationId property of the SendCommunicationCommandResult.

Responses

Success

Status Description Body
200 The request was successful. GetDocumentByIdResult

Failures

Status Description Body
400 The request was invalid. None
401 The request was not authorized. None
403 The request was not allowed. None
404 The document was not found. None
Default An unexpected error occurred. None

Schema

GetDocumentByIdResult

{
  "document": "Object::DocumentSummary",
  "result": "Object::A"
}
Document

The document that was requested. The contents may or may not be populated depending on the options provided to the operation.

Result