Menu
Amazon WorkDocs
API Reference (API Version 2016-05-01)

DescribeComments

List all the comments for the specified document version.

Request Syntax

GET /api/v1/documents/DocumentId/versions/VersionId/comments?limit=Limit&marker=Marker HTTP/1.1
Authentication: AuthenticationToken

URI Request Parameters

The request requires the following URI parameters.

AuthenticationToken

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

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+-.@]+

Limit

The maximum number of items to return.

Valid Range: Minimum value of 1. Maximum value of 999.

Marker

The marker for the next set of results. This marker was received from a previous call.

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

Pattern: [\u0000-\u00FF]+

VersionId

The ID of the document version.

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

Pattern: [\w+-.@]+

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "Comments": [ 
      { 
         "CommentId": "string",
         "Contributor": { 
            "CreatedTimestamp": number,
            "EmailAddress": "string",
            "GivenName": "string",
            "Id": "string",
            "Locale": "string",
            "ModifiedTimestamp": number,
            "OrganizationId": "string",
            "RecycleBinFolderId": "string",
            "RootFolderId": "string",
            "Status": "string",
            "Storage": { 
               "StorageRule": { 
                  "StorageAllocatedInBytes": number,
                  "StorageType": "string"
               },
               "StorageUtilizedInBytes": number
            },
            "Surname": "string",
            "TimeZoneId": "string",
            "Type": "string",
            "Username": "string"
         },
         "CreatedTimestamp": number,
         "ParentId": "string",
         "RecipientId": "string",
         "Status": "string",
         "Text": "string",
         "ThreadId": "string",
         "Visibility": "string"
      }
   ],
   "Marker": "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.

Comments

The list of comments for the specified document version.

Type: Array of Comment objects

Marker

The marker for the next set of results. This marker was received from a previous call.

Type: String

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

Pattern: [\u0000-\u00FF]+

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

ProhibitedStateException

The specified document version is not in the INITIALIZED state.

HTTP Status Code: 409

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: