Request

Response

    Get Change Orders for File
    GET

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

    Retrieves the change orders that are driving the specified file.

    Resource Information

    Method and URI
    GET
    /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/files/{id}/change-orders
    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 (master ID) used to group all versions of a file. Different versions of a file have different version (iteration) IDs but share the same master ID.

    Request

    Query String Parameters

    option[includeClosedECOs]
    boolean
    true: Include change orders with closed or cancelled state.

    false: (Default) Skip change orders with closed or cancelled state.

    option[extendedModels]
    boolean
    true: The response will include additional detailed information for each entity. Examples include:
    • For folders (getFolders), it will return FolderExtended instead of Folder, which includes additional information such as the parent folder.
    • For file versions (getFileVersions), it will return FileVersionExtended instead of FileVersion, which includes extra details like the checkout user ID.
    • For change orders (getChangeOrders), it will return ChangeOrderExtended instead of ChangeOrder, which provides further information such as the list of assignees.
    • For property definitions (getPropertyDefinitions), it will return PropertyDefinitionExtended instead of PropertyDefinition, which includes extra details like list values.

    false: (Default) The response will include basic information for each entity.

    option[propDefIds]
    string
    The properties to include in the response. Provide a comma-separated list of property definition IDs (for example, 1,2,3) or pass all to return every property.
    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 orders 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.
    404
    Not Found
    The requested resource was not found.

    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
    An array of change orders.
    oneOf
    array:oneOf
    Change Order
    object
    Contains core change order metadata and properties returned by the API.
    id
    string
    The unique identifier (master ID) of this Change Order.
    url
    string
    The relative URL to access this object.
    name
    string
    The descriptive name of this Change Order. This value is the Change Order number.
    createDate
    datetime: ISO 8601
    The date and time when the Change Order was created.
    number
    string
    The Change Order number. Numbers are generated based on the configured numbering scheme.
    title
    string
    The title of the Change Order.
    description
    string
    The description of the Change Order.
    approveDeadline
    datetime: ISO 8601
    The date and time by which the Change Order must be approved.
    lastModifiedDate
    datetime: ISO 8601
    The date and time when the Change Order was last modified.
    lastModifiedUserId
    string
    The unique identifier of the user who last modified the Change Order.
    closeDate
    datetime: ISO 8601
    The date and time when the Change Order was closed.
    lastTouchedDate
    datetime: ISO 8601
    The date and time when the Change Order was last touched (modified or interacted with).
    entityType
    string
    The type of entity represented by this Change Order.
    numberOfAttachments
    number
    The number of file attachments on this Change Order.
    properties
    array: object
    An array of property values for this Change Order.
    propertyDefinitionId
    string
    The unique identifier of the property definition that this value belongs to.
    definition
    object
    Contains server-side metadata for a Vault property definition, including datatype and naming.
    id
    string
    The unique identifier of the property definition.
    url
    string
    The relative URL to access this object.
    displayName
    string
    The display name of this property definition.
    systemName
    string
    The system name of this property definition.
    dataType
    enum:string
    The underlying data type stored for values of this property. Possible values: String, Numeric, Bool, DateTime, Image
    active
    boolean
    Indicates whether this property definition is active.

    true: This property definition is active.

    false: This property definition is inactive.

    isSystem
    boolean
    Indicates whether this property definition is a built-in system property.

    true: This is a system property.

    false: This is a user-defined property.

    initialValue
    string
    The default value applied to entities that do not have an existing value for this property definition.
    value
    string
    The property value associated with the entity for the referenced property definition.
    state
    string
    The name of the Change Order’s lifecycle state.
    stateColor
    number
    The color of the state.
    isReadOnly
    boolean
    Indicates whether the Change Order is currently locked.

    true: The Change Order is locked.

    false: The Change Order is not locked.

    assignees
    array: object
    id
    string
    A unique number that the Vault uses to reference the user.
    name
    string
    The login name of the user.
    email
    string
    The email address of the user.
    authTypes
    enum:string
    Specifies which account directory backs the sign-in record. Possible values:
    • ActiveDirectory - Account is linked to Active Directory.
    • Vault - Account is native to Vault.
    • Autodesk - Account is linked to Autodesk ID.
    systemName
    string
    The internal system name of the user.
    createDate
    datetime: ISO 8601
    The date that the user was created.
    isActive
    boolean
    Indicates whether this user is active.

    true: The user is active.

    false: The user is inactive.

    url
    string
    The relative URL to access this object.
    Change Order
    object
    Contains core change order metadata and properties returned by the API.
    id
    string
    The unique identifier (master ID) of this Change Order.
    url
    string
    The relative URL to access this object.
    name
    string
    The descriptive name of this Change Order. This value is the Change Order number.
    createDate
    datetime: ISO 8601
    The date and time when the Change Order was created.
    number
    string
    The Change Order number. Numbers are generated based on the configured numbering scheme.
    title
    string
    The title of the Change Order.
    description
    string
    The description of the Change Order.
    approveDeadline
    datetime: ISO 8601
    The date and time by which the Change Order must be approved.
    lastModifiedDate
    datetime: ISO 8601
    The date and time when the Change Order was last modified.
    lastModifiedUserId
    string
    The unique identifier of the user who last modified the Change Order.
    closeDate
    datetime: ISO 8601
    The date and time when the Change Order was closed.
    lastTouchedDate
    datetime: ISO 8601
    The date and time when the Change Order was last touched (modified or interacted with).
    entityType
    string
    The type of entity represented by this Change Order.
    numberOfAttachments
    number
    The number of file attachments on this Change Order.
    properties
    array: object
    An array of property values for this Change Order.
    propertyDefinitionId
    string
    The unique identifier of the property definition that this value belongs to.
    definition
    object
    Contains server-side metadata for a Vault property definition, including datatype and naming.
    id
    string
    The unique identifier of the property definition.
    url
    string
    The relative URL to access this object.
    displayName
    string
    The display name of this property definition.
    systemName
    string
    The system name of this property definition.
    dataType
    enum:string
    The underlying data type stored for values of this property. Possible values: String, Numeric, Bool, DateTime, Image
    active
    boolean
    Indicates whether this property definition is active.

    true: This property definition is active.

    false: This property definition is inactive.

    isSystem
    boolean
    Indicates whether this property definition is a built-in system property.

    true: This is a system property.

    false: This is a user-defined property.

    initialValue
    string
    The default value applied to entities that do not have an existing value for this property definition.
    value
    string
    The property value associated with the entity for the referenced property definition.
    state
    string
    The name of the Change Order’s lifecycle state.
    stateColor
    number
    The color of the state.
    isReadOnly
    boolean
    Indicates whether the Change Order is currently locked.

    true: The Change Order is locked.

    false: The Change Order is not locked.

    included
    object
    Contains additional resources included with the change order results.
    propertyDefinition
    object
    *
    object
    Contains server-side metadata for a Vault property definition, including datatype and naming.
    id
    string
    The unique identifier of the property definition.
    url
    all of
    The relative URL to access this property definition.
    0
    string
    The relative URL to access this object.
    displayName
    string
    The display name of this property definition.
    systemName
    string
    The system name of this property definition.
    dataType
    enum:string
    The underlying data type stored for values of this property. Possible values: String, Numeric, Bool, DateTime, Image
    active
    boolean
    Indicates whether this property definition is active.

    true: This property definition is active.

    false: This property definition is inactive.

    isSystem
    boolean
    Indicates whether this property definition is a built-in system property.

    true: This is a system property.

    false: This is a user-defined property.

    initialValue
    string
    The default value applied to entities that do not have an existing value for this property definition.

    Example

    This example illustrates how to get the change orders associated with a file.

    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/files/27/change-orders' \
      -X 'GET' \
      -H 'Accept: application/json'\
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
    

    Response

    {
      "pagination": {
        "limit": 1000,
        "totalResults": 1,
        "indexingStatus": "NA"
      },
      "results": [
        {
          "name": "ECO-000002",
          "id": "49",
          "number": "ECO-000002",
          "title": "",
          "description": "",
          "approveDeadline": "2024-10-22T07:10:29.503Z",
          "lastModifiedDate": "2024-10-22T07:10:39.34Z",
          "lastModifiedUserId": "65",
          "closeDate": "0001-01-01T00:00:00Z",
          "lastTouchedDate": "2024-10-22T07:10:39.34Z",
          "state": "Create",
          "stateColor": -1973932,
          "numberOfAttachments": "0",
          "isReadOnly": false,
          "entityType": "ChangeOrder",
          "url": "/AutodeskDM/Services/api/vault/v2/vaults/117/change-orders/49"
        }
      ]
    }
    
    Show More