vaults/{vaultId}/change-orders
Get list of change orders based on a set of conditions. E.g. /vaults/{vaultId}/change-orders?filter[state]=open&filter[assignees]=1,2,3,4
Note that [assignees] is an additional filter that does not exists in property definitions.
Resource Information
Method and URI | GET /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/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 obtained via a three-legged OAuth flow. |
Request
URI Parameters
vaultId string | The unique identifier of a vault. |
Request
Query String Parameters
q string | The value to use for the search. Based on ‘SearchContent’ option, this parameter will either search across all properties or across all properties and content. Ex: q=Assembly, all objects that contain ‘Assembly’ within their properties will be returned. |
filter[State] string | Search filter to include only change orders that match state property. e.g. filter[state]=open |
filter[assignees] string | Search filter to include only change orders that assignees user list can perform. ex: filter[assignees]=1,2,3,4 |
filter[openCOsOnly] boolean | true : Include only open change orders.
|
option[extendedModels] boolean | true : The response will include additional detailed information for each entity. Examples include:
|
option[propDefIds] string | The properties that need to be returned. property ids separated by ‘,’, e.g. ‘1,2,3’ ‘all’ means return all properties. |
sort string | Specifies sorting criteria for search results. Supports multi-sort and accepted values for sort-order: asc, desc. Ex: sort = Revision desc,Name asc |
limit int | Specifies the number of results to return per page. Maximum limit is controlled by “Page size conifguration” setting which could be updated using ADMS (“Global Setting” -> “Page size conifguration”). |
cursorState string | Indicates the state of the cursor for pagination. Use this parameter to navigate through paged results |
Response
HTTP Status Code Summary
200 OK | The request succeeded. The response contains the list of change orders. |
401 Unauthorized | Ticket Invalid |
403 Forbidden | Unauthorized |
Response
Body Structure (200)
pagination object | Cursor-based pagination object. |
limit int | Limit requested for the current search |
totalResults int | Number of total hits. If this value is larger than the objects returned, then multiple searches will have to be performed to get the complete result set. |
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.
The statuses include:
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.
Possible values: |
nextUrl string | Used to continue a search if the results are too large for a single call. Url has bookmark string embedded for subsequent calls on that search |
results array | |
oneOf array:oneOf | |
Change Order object | change order object |
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. |
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 object | The type of account to retrieve. Allowed values are ActiveDirectory, Vault, and Autodesk.
Possible values: ActiveDirectory , Vault , Autodesk |
systemName string | |
createDate datetime: ISO 8601 | The date that the user was created. |
isActive string | Is the user active |
url string | The relative URL to access this object. |
Change Order object | change order object |
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. |
included object | |
propertyDefinition object | |
* 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 |
Example
This example illustrates how to get all change orders.
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' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
Response
{
"pagination": {
"limit": 1000,
"totalResults": 2,
"indexingStatus": "IndexingComplete"
},
"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"
},
{
"name": "ECO-000001",
"id": "47",
"number": "ECO-000001",
"title": "",
"description": "",
"approveDeadline": "2024-10-22T07:08:35.467Z",
"lastModifiedDate": "2024-10-22T08:46:43.77Z",
"lastModifiedUserId": "65",
"closeDate": "0001-01-01T00:00:00Z",
"lastTouchedDate": "2024-10-22T08:46:43.77Z",
"state": "Create",
"stateColor": -1973932,
"numberOfAttachments": "1",
"isReadOnly": false,
"entityType": "ChangeOrder",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/change-orders/47"
}
]
}