Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetDocument

Important

Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs.

Retrieves details of a document.

Request Syntax


GET /api/v1/documents/DocumentId?includeCustomMetadata=IncludeCustomMetadata HTTP/1.1
Authentication: AuthenticationToken

URI Request Parameters

The request uses the following URI parameters.

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Length Constraints: Minimum length of 1. Maximum length of 8199.

DocumentId

The ID of the document.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+-.@]+

Required: Yes

IncludeCustomMetadata

Set this to TRUE to include custom metadata in the response.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CustomMetadata": { 
      "string" : "string" 
   },
   "Metadata": { 
      "CreatedTimestamp": number,
      "CreatorId": "string",
      "Id": "string",
      "Labels": [ "string" ],
      "LatestVersionMetadata": { 
         "ContentCreatedTimestamp": number,
         "ContentModifiedTimestamp": number,
         "ContentType": "string",
         "CreatedTimestamp": number,
         "CreatorId": "string",
         "Id": "string",
         "ModifiedTimestamp": number,
         "Name": "string",
         "Signature": "string",
         "Size": number,
         "Source": { 
            "string" : "string" 
         },
         "Status": "string",
         "Thumbnail": { 
            "string" : "string" 
         }
      },
      "ModifiedTimestamp": number,
      "ParentFolderId": "string",
      "ResourceState": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CustomMetadata

The custom metadata on the document.

Type: String to string map

Map Entries: Maximum number of 8 items.

Key Length Constraints: Minimum length of 1. Maximum length of 56.

Key Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*

Value Length Constraints: Minimum length of 1. Maximum length of 256.

Value Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*

Metadata

The metadata details of the document.

Type: DocumentMetadata object

Errors

For information about the errors that are common to all actions, see Common Errors.

EntityNotExistsException

The resource does not exist.

HTTP Status Code: 404

FailedDependencyException

The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.

HTTP Status Code: 424

InvalidArgumentException

The pagination marker or limit fields are not valid.

HTTP Status Code: 400

InvalidPasswordException

The password is invalid.

HTTP Status Code: 401

ServiceUnavailableException

One or more of the dependencies is unavailable.

HTTP Status Code: 503

UnauthorizedOperationException

The operation is not permitted.

HTTP Status Code: 403

UnauthorizedResourceAccessException

The caller does not have access to perform the action on the resource.

HTTP Status Code: 404