Get a change order
GET
vaults/{vaultId}/change-orders/{id}
Get 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 obtained via a three-legged OAuth flow. |
* Required
Request
URI Parameters
vaultId string | The unique identifier of a vault. |
id string | The unique identifier of a change order. |
Response
HTTP Status Code Summary
200 OK | The request succeeded. The response contains the change order. |
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 | Change order does not exist |
Response
Body Structure (200)
Expand all
id string | Master Id of this Change Order. The Master Id uniquely identifies this Change Order object |
url string | The relative URL to access this object. |
name string | The descriptive name for this Change Order.The Change Order Number will be used here. |
createDate string | The date and time the Change Order was created |
number string | The Change Order number. Numbers are generated based on the Numbering Scheme. |
title string | The title of the Change Order |
description string | The description of the Change Order. |
approveDeadline string | The date and time when the Change Order needs to be approved by. |
lastModifiedDate string | The last time that the Change Order was modified. |
lastModifiedUserId string | |
closeDate string | |
lastTouchedDate string | the last time that the Change Order was modified. |
entityType string | |
numberOfAttachments number | Number of File Attachments |
properties array: object | |
propertyDefinitionId string | Unique identifier for a server-based property definition |
definition object | Property definition object. |
id string | Get the unique identifier for a server-based property definition |
url string | The relative URL to access this object. |
displayName string | Get or sets the Display name for this Property Definition |
systemName string | Get the System Name for this Property Definition. |
dataType enum:string | The value defined in SQL database.
Possible values: String , Numeric , Bool , DateTime , Image |
active boolean | Get or sets whether this Property Definition is Active. |
isSystem boolean | Get whether or not this is a System Property (as opposed to an userDefined property) |
initialValue string | Default Value that will be applied to entities that do not have an existing value associated with this PropertyDefinition |
value string | The property value associated with the entity and PropertyDefinition |
state string | Get the name of the Change Order State. |
stateColor number | The color of the state. |
isReadOnly boolean | Get if 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