Request

Response

    Get Change Order Comments
    GET

    vaults/{vaultId}/change-orders/{id}/comments

    Retrieves comments for a given change order ID.

    Resource Information

    Method and URI
    GET
    /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/change-orders/{id}/comments
    Authentication Context
    User context required
    Required OAuth Scopes
    No scopes required
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is a three-legged access token obtained via an Authorization Code flow or a Secure Service Account (SSA) flow.

    The SSA flow is designed for headless server-to-server operations. While it functions like a two-legged flow (no user interaction), it is classified as three-legged because it preserves user context.

    * Required

    Request

    URI Parameters

    vaultId
    string
    The unique identifier of a Knowledge Vault.
    id
    string
    The unique identifier of a change order.

    Request

    Query String Parameters

    limit
    int
    The maximum number of results to return per page. Defaults to 100.

    The hard upper bound is controlled by the Page size configuration setting, which an administrator can update through ADMS (Global Setting -> Page size configuration).

    cursorState
    string
    The cursor token used to fetch the next page of results. Pass the value returned in pagination.nextUrl from the previous response to continue paging.

    Response

    HTTP Status Code Summary

    200
    OK
    The list of change order comments was successfully retrieved.
    400
    Bad Request
    The server was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request.
    401
    Unauthorized
    The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again.
    403
    Forbidden
    The request was successfully validated but lacking the required permissions. Verify your credentials and permissions before you send this request again.

    Response

    Body Structure (200)

    Expand all
    pagination
    object
    Contains pagination metadata for navigating through large result sets.
    limit
    int
    The maximum number of results that can be returned in this response. The actual number of results may be fewer due to filtering, data availability, or other constraints. This reflects the limit value applied by the server, which may differ from the requested limit.
    totalResults
    int
    The total number of results available across all pages that match the query criteria, regardless of pagination limits.
    indexingStatus
    enum:string
    Indicates the current status of the indexing engine. This status helps users understand whether the indexing operation is complete or still in progress. This is particularly important for customers with large datasets, as indexing can take a considerable amount of time to complete. Possible values:
    • IndexingComplete - All properties and content have been indexed.
    • IndexingProperties - File properties are currently being indexed.
    • IndexingContent - File content is currently being indexed.
    • NA - Not applicable as data not retrieved from index.

    Note: When the status is either ‘IndexingProperties’ or ‘IndexingContent’, the search results are incomplete because the indexes are still being created. Complete search results will be available once fully indexed.

    nextUrl
    string
    The URL used to retrieve the next page of results. The URL includes an embedded cursor token for the subsequent call. When null or absent, this is the final page. Note that a page may be empty but still include a next page URL. Continue paging until this attribute is null or absent.
    results
    array: object
    An array of change order comments.
    id
    string
    The unique identifier of the comment.
    url
    string
    The relative URL to access this object.
    subject
    string
    The subject line of the comment.
    message
    string
    The message body of the comment.
    createDate
    datetime: ISO 8601
    The date and time when the comment was created.
    createUserName
    string
    The user name of the comment author.
    state
    string
    The current state of the comment.
    numberOfAttachments
    number
    The number of attachments on the comment.
    replies
    array: object
    An array of reply comments.
    id
    string
    The unique identifier of the comment.
    url
    string
    The relative URL to access this object.
    subject
    string
    The subject line of the comment.
    message
    string
    The message body of the comment.
    createDate
    datetime: ISO 8601
    The date and time when the comment was created.
    createUserName
    string
    The user name of the comment author.
    state
    string
    The current state of the comment.
    numberOfAttachments
    number
    The number of attachments on the comment.
    replies
    array: object
    An array of reply comments.
    parent
    object
    The parent comment node for this comment.
    parent
    object
    Contains a parent or reply node referenced from an ECOComment. This schema mirrors the fields of ECOComment and exists separately to break the recursive replies and parent reference cycle in OpenAPI.
    id
    string
    The unique identifier of the comment.
    url
    string
    The relative URL to access this object.
    subject
    string
    The subject line of the comment.
    message
    string
    The message body of the comment.
    createDate
    datetime: ISO 8601
    The date and time when the comment was created.
    createUserName
    string
    The user name of the comment author.
    state
    string
    The current state of the comment.
    numberOfAttachments
    number
    The number of attachments on the comment.
    replies
    array: object
    An array of reply comments.
    parent
    object
    The parent comment node for this comment.

    Example

    This example illustrates how to get all comments of a change order.

    Note: {VaultServerAddress} is used as a placeholder in the example(s) and could represent one of the following:

    • Vault Server IP address or hostname. Ex: http://10.41.110.49.
    • Vault Gateway URL if gateway is configured. Ex: https://test.vg.autodesk.com.

    Request

    curl -v '{VaultServerAddress}/AutodeskDM/Services/api/vault/v2/vaults/117/change-orders/62/comments' \
      -X 'GET' \
      -H 'Accept: application/json'\
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
    

    Response

    {
      "pagination": {
        "limit": 1000,
        "totalResults": 1,
        "indexingStatus": "NA"
      },
      "results": [
        {
          "id": "64",
          "replies": [],
          "state": "Create",
          "numberOfAttachments": 0,
          "subject": "Test Comment",
          "message": "This is the first comment",
          "createDate": "2024-10-22T09:01:52.653Z",
          "createUserName": "TestAccount",
          "entityType": "ECOComment",
          "url": "/AutodeskDM/Services/api/vault/v2/vaults/117/eco-comments/64"
        }
      ]
    }
    
    Show More