Get a Change Order
GET
vaults/{vaultId}/change-orders/{id}
Retrieves a change order by its ID.
Resource Information
| Method and URI | GET /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/change-orders/{id} |
| 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. |
Response
HTTP Status Code Summary
| 200 OK | The change order 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 change order was not found in this Knowledge Vault. Verify the vaultId and change order id URI parameters, then try again. |
Response
Body Structure (200)
Expand all
| 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.
|
| isSystem boolean | Indicates whether this property definition is a built-in system 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.
|
Example
This example illustrates how to get a specific change order by ID.
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/49' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
Response
{
"name": "ECO-000002",
"id": "49",
"assignees": [
{
"id": "6",
"name": "CAD Admin",
"email": "markus.koechl@autodesk.com",
"authTypes": "Vault",
"createDate": "2013-10-25T12:21:22.323Z",
"isActive": true,
"url": "/AutodeskDM/Services/api/vault/v2/users/6"
},
{
"id": "65",
"name": "TestAccount",
"email": "VaultAPITest@outlook.com",
"authTypes": "Vault, Autodesk",
"createDate": "2024-06-27T06:29:20.183Z",
"isActive": true,
"url": "/AutodeskDM/Services/api/vault/v2/users/65"
}
],
"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,
"properties": [
{
"propertyDefinitionId": "74",
"value": 0.0,
"definition": {
"id": "74",
"displayName": "Number of Items",
"systemName": "NumItems",
"dataType": "Numeric",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/property-definitions/74"
}
},
{
"propertyDefinitionId": "11",
"value": "2024-10-22T07:10:39.34Z",
"definition": {
"id": "11",
"displayName": "Date Modified",
"systemName": "ModDate",
"dataType": "DateTime",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/property-definitions/11"
}
},
......
],
"entityType": "ChangeOrder",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/change-orders/49"
}
Show More