Retrieve Entity Properties
This article demonstrates ways to fetch entity properties currently supported by Vault Data API.
Example 1: When properties for single entity resource is requested
When requesting endpoints for a single entity like Get a file version , the response will always include all the properties of the requested entity. This behavior can’t be controlled by the user.
Request
curl -v 'https://test.vg.autodesk.com/AutodeskDM/Services/api/vault/v2/vaults/117/file-versions/43' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IlU3c0dGRldUTzlBekNhSzBqZURRM2dQZXBURVdWN2VhIn0.eyJzY29wZSI6WyJkYXRhOnJlYWQiXSwiY2xpZW50X2lkIjoiRjZEbjh5cGVtMWo4UDZzVXo4SVgzcG1Tc09BOTlHVVQiLCJpc3MiOiJodHRwczovL2RldmVsb3Blci5hcGkuYXV0b2Rlc2suY29tIiwiYXVkIjoiaHR0cHM6Ly9hdXRvZGVzay5jb20iLCJqdGkiOiJUaDZMbWVLdzN2c0ZxSTNPR0hrUmhxUG9rTXJnR1RPanhjUW1hQXlRS2RnU1VTbzV5cEY5dTZqekM4UmwwVnNBIiwidXNlcmlkIjoiM1hWU0w3MkpMMlU1IiwiZXhwIjoxNjY5ODY5MDQ1fQ.diknPiZfHDSmgl3iPuQgXMZQhCRBVQGyvj3e0GCRQtSUjE5pVnm6a7PnGJwcrvnsaV7wrNOGi_dPDcQW_pYyrQV925kKtV4GYLLrrf639s0wpdlj7nHJGPgy_oRu4pFTSBtj5qW6i3hIaujtVtzLc9DtvKAWYPRSq-_j9niibM1TrLc_6mrIse-jtQP6qkmWj7IzZPxgX947_4rYW06-Vzb4Yyu1VlmGs7A1koUPMIp2N4RUTGzUyM1z9xszqQHZBkznKRVZVJOkzO6kHyAFWr3ksYgRNdGU2zY_x_OTe3MW4uBfLgQTw-Eo5xsc7a87xvX7vSDfl14ctwwE8lMnBw'
Response
{
"name": "Assembly2.iam",
"id": "43",
"checkoutUser": {
"id": "65",
"name": "TestAccount",
"authTypes": 0,
"createDate": "0001-01-01T00:00:00Z",
"isActive": false,
"url": "/AutodeskDM/Services/api/vault/v2/users/65"
},
"state": "",
"stateColor": 0,
"revision": "",
"category": "Base",
"categoryColor": -2302756,
"lastModifiedDate": "2024-10-17T19:17:40.043Z",
"isCheckedOut": true,
"hasVisualizationAttachment": true,
"size": 237568,
"isCloaked": false,
"checkinDate": "0001-01-01T00:00:00Z",
"checkoutDate": "2024-10-17T19:23:18.383Z",
"checkoutUserName": "TestAccount",
"isHidden": false,
"isReadOnly": false,
"parentFolderId": "2",
"file": {
"id": "37",
"entityType": "File",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/files/37"
},
"parent": {
"name": "ColinTest",
"id": "2",
"fullName": "$/ColinTest",
"category": "Folder",
"categoryColor": -2302756,
"stateColor": 0,
"subfolderCount": 0,
"isLibrary": false,
"isCloaked": false,
"isReadOnly": false,
"createDate": "2024-10-11T07:04:11.723Z",
"createUserName": "TestAccount",
"entityType": "Folder",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/folders/2"
},
"isOnSite": true,
"createDate": "2024-10-17T19:17:49.8Z",
"createUserName": "TestAccount",
"properties": [
{
"propertyDefinitionId": "82",
"value": false,
"definition": {
"id": "82",
"displayName": "Has Markup",
"systemName": "HasMarkup",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/property-definitions/82"
}
},
{
"propertyDefinitionId": "5",
"value": "2024-10-17T19:17:49.8Z",
"definition": {
"id": "5",
"displayName": "Date Version Created",
"systemName": "DateVersionCreated",
"dataType": "DateTime",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/property-definitions/5"
}
},
......
],
"classification": "None",
"visualizationAttachmentStatus": "NotSyncronized",
"version": 3,
"entityType": "FileVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/file-versions/43"
}
In this example, the properties
field contains all the properties of the requested entity.
Example 2: When entity collection resource is requested and include all properties
Most of the Entity collections endpoints like Get file versions , Get item versions ,etc. support the option[propDefIds]
query parameter. When this parameter is set to ‘all’, the response will include all the properties of the requested entities.
Request
curl -v 'https://test.vg.autodesk.com/AutodeskDM/Services/api/vault/v2/vaults/101/file-versions?limit=2&option[propDefIds]=all' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IlU3c0dGRldUTzlBekNhSzBqZURRM2dQZXBURVdWN2VhIn0.eyJzY29wZSI6WyJkYXRhOnJlYWQiXSwiY2xpZW50X2lkIjoiRjZEbjh5cGVtMWo4UDZzVXo4SVgzcG1Tc09BOTlHVVQiLCJpc3MiOiJodHRwczovL2RldmVsb3Blci5hcGkuYXV0b2Rlc2suY29tIiwiYXVkIjoiaHR0cHM6Ly9hdXRvZGVzay5jb20iLCJqdGkiOiJUaDZMbWVLdzN2c0ZxSTNPR0hrUmhxUG9rTXJnR1RPanhjUW1hQXlRS2RnU1VTbzV5cEY5dTZqekM4UmwwVnNBIiwidXNlcmlkIjoiM1hWU0w3MkpMMlU1IiwiZXhwIjoxNjY5ODY5MDQ1fQ.diknPiZfHDSmgl3iPuQgXMZQhCRBVQGyvj3e0GCRQtSUjE5pVnm6a7PnGJwcrvnsaV7wrNOGi_dPDcQW_pYyrQV925kKtV4GYLLrrf639s0wpdlj7nHJGPgy_oRu4pFTSBtj5qW6i3hIaujtVtzLc9DtvKAWYPRSq-_j9niibM1TrLc_6mrIse-jtQP6qkmWj7IzZPxgX947_4rYW06-Vzb4Yyu1VlmGs7A1koUPMIp2N4RUTGzUyM1z9xszqQHZBkznKRVZVJOkzO6kHyAFWr3ksYgRNdGU2zY_x_OTe3MW4uBfLgQTw-Eo5xsc7a87xvX7vSDfl14ctwwE8lMnBw'
Response
{
"pagination": {
"limit": 2,
"totalResults": 8132,
"nextUrl": "/AutodeskDM/Services/api/vault/v2/vaults/101/file-versions?limit=2&option%5bpropDefIds%5d=all&cursorState=PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTE2Ij8%2bDQo8UHJvcGVydGllcz4NCiAgPFBhaXIgTm09IkVudGl0eUlkIiBWYWw9IiAmI3gxOyYjeDA7JiN4MDsmI3gwOyYjeDA7JiN4MDsmI3gwOyYjeDg7LV4iIC8%2bDQo8L1Byb3BlcnRpZXM%2b",
"indexingStatus": "IndexingComplete"
},
"results": [
{
"name": "test.test",
"id": "136928",
"state": "",
"stateColor": 0,
"revision": "",
"category": "Default",
"categoryColor": -1,
"lastModifiedDate": "2024-10-03T16:17:13.847Z",
"isCheckedOut": false,
"hasVisualizationAttachment": false,
"size": 144243296,
"isCloaked": false,
"checkinDate": "2024-10-23T08:57:46.957Z",
"isHidden": false,
"isReadOnly": false,
"parentFolderId": "1",
"file": {
"id": "136927",
"entityType": "File",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/files/136927"
},
"isOnSite": true,
"createDate": "2024-10-23T08:57:46.957Z",
"createUserName": "Administrator",
"properties": [
{
"propertyDefinitionId": "259",
"value": false
},
{
"propertyDefinitionId": "5",
"value": "2024-10-23T08:57:46.957Z"
},
{
"propertyDefinitionId": "40",
"value": false
},
{
"propertyDefinitionId": "260",
"value": false
},
{
"propertyDefinitionId": "29",
"value": "$"
},
{
"propertyDefinitionId": "6",
"value": "Administrator"
},
{
"propertyDefinitionId": "54",
"value": true
},
{
"propertyDefinitionId": "41",
"value": "Default"
},
{
"propertyDefinitionId": "43",
"value": -1.0
},
{
"propertyDefinitionId": "2",
"value": 1.0
},
{
"propertyDefinitionId": "3",
"value": ""
},
{
"propertyDefinitionId": "218",
"value": false
},
{
"propertyDefinitionId": "1",
"value": "None"
},
{
"propertyDefinitionId": "19",
"value": false
},
{
"propertyDefinitionId": "20",
"value": true
},
{
"propertyDefinitionId": "9",
"value": "test.test"
},
{
"propertyDefinitionId": "30",
"value": "test.test"
},
{
"propertyDefinitionId": "8",
"value": "2024-10-23T08:57:46.957Z"
},
{
"propertyDefinitionId": "10",
"value": "test.test"
},
{
"propertyDefinitionId": "11",
"value": "2024-10-03T16:17:13.847Z"
},
{
"propertyDefinitionId": "23",
"value": "None"
},
{
"propertyDefinitionId": "12",
"value": 144243296.0
},
{
"propertyDefinitionId": "33",
"value": "test"
},
{
"propertyDefinitionId": "4",
"value": 0.0
},
{
"propertyDefinitionId": "13",
"value": false
},
{
"propertyDefinitionId": "14",
"value": true
},
{
"propertyDefinitionId": "36",
"value": false
},
{
"propertyDefinitionId": "37",
"value": false
},
{
"propertyDefinitionId": "34",
"value": 0.0
},
{
"propertyDefinitionId": "35",
"value": 0.0
},
{
"propertyDefinitionId": "27",
"value": "Other Files"
},
{
"propertyDefinitionId": "24",
"value": "Administrator"
},
{
"propertyDefinitionId": "25",
"value": "2024-10-23T08:57:46.957Z"
},
{
"propertyDefinitionId": "21",
"value": false
},
{
"propertyDefinitionId": "42",
"value": "Default"
},
{
"propertyDefinitionId": "44",
"value": -1.0
},
{
"propertyDefinitionId": "15",
"value": ""
},
{
"propertyDefinitionId": "16",
"value": ""
},
{
"propertyDefinitionId": "17",
"value": ""
},
{
"propertyDefinitionId": "18",
"value": ""
},
{
"propertyDefinitionId": "22",
"value": ""
},
{
"propertyDefinitionId": "28",
"value": ""
},
{
"propertyDefinitionId": "38",
"value": ""
},
{
"propertyDefinitionId": "39",
"value": ""
},
{
"propertyDefinitionId": "45",
"value": ""
},
{
"propertyDefinitionId": "46",
"value": ""
},
{
"propertyDefinitionId": "47",
"value": ""
},
{
"propertyDefinitionId": "48",
"value": ""
},
{
"propertyDefinitionId": "49",
"value": ""
},
{
"propertyDefinitionId": "50",
"value": ""
},
{
"propertyDefinitionId": "51",
"value": ""
},
{
"propertyDefinitionId": "212",
"value": ""
},
{
"propertyDefinitionId": "237",
"value": ""
},
{
"propertyDefinitionId": "238",
"value": ""
},
{
"propertyDefinitionId": "239",
"value": ""
},
{
"propertyDefinitionId": "240",
"value": ""
},
{
"propertyDefinitionId": "241",
"value": ""
},
{
"propertyDefinitionId": "250",
"value": ""
},
{
"propertyDefinitionId": "251",
"value": ""
}
],
"classification": "None",
"visualizationAttachmentStatus": "None",
"version": 1,
"entityType": "FileVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/file-versions/136928"
},
{
"name": "03-einr-lay_20240619.dwg.dwf",
"id": "136926",
"state": "",
"stateColor": 0,
"revision": "",
"category": "Default",
"categoryColor": -1,
"lastModifiedDate": "2024-10-08T07:12:09.64Z",
"isCheckedOut": false,
"hasVisualizationAttachment": false,
"size": 15559827,
"isCloaked": false,
"checkinDate": "2024-10-08T07:12:56.61Z",
"isHidden": false,
"isReadOnly": false,
"parentFolderId": "25551",
"file": {
"id": "136925",
"entityType": "File",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/files/136925"
},
"isOnSite": true,
"createDate": "2024-10-08T07:12:56.61Z",
"createUserName": "Administrator",
"properties": [
{
"propertyDefinitionId": "259",
"value": false
},
{
"propertyDefinitionId": "5",
"value": "2024-10-08T07:12:56.61Z"
},
{
"propertyDefinitionId": "40",
"value": false
},
{
"propertyDefinitionId": "260",
"value": false
},
{
"propertyDefinitionId": "29",
"value": "$/xDMS"
},
{
"propertyDefinitionId": "6",
"value": "Administrator"
},
{
"propertyDefinitionId": "54",
"value": true
},
{
"propertyDefinitionId": "41",
"value": "Default"
},
{
"propertyDefinitionId": "43",
"value": -1.0
},
{
"propertyDefinitionId": "2",
"value": 1.0
},
{
"propertyDefinitionId": "3",
"value": ""
},
{
"propertyDefinitionId": "218",
"value": false
},
{
"propertyDefinitionId": "1",
"value": "None"
},
{
"propertyDefinitionId": "19",
"value": false
},
{
"propertyDefinitionId": "20",
"value": true
},
{
"propertyDefinitionId": "9",
"value": "03-einr-lay_20240619.dwg.dwf"
},
{
"propertyDefinitionId": "30",
"value": "03-einr-lay_20240619.dwg.dwf"
},
{
"propertyDefinitionId": "8",
"value": "2024-10-08T07:12:56.61Z"
},
{
"propertyDefinitionId": "10",
"value": "03-einr-lay_20240619.dwg.dwf"
},
{
"propertyDefinitionId": "11",
"value": "2024-10-08T07:12:09.64Z"
},
{
"propertyDefinitionId": "23",
"value": "None"
},
{
"propertyDefinitionId": "12",
"value": 15559827.0
},
{
"propertyDefinitionId": "33",
"value": "dwf"
},
{
"propertyDefinitionId": "4",
"value": 0.0
},
{
"propertyDefinitionId": "13",
"value": false
},
{
"propertyDefinitionId": "14",
"value": true
},
{
"propertyDefinitionId": "36",
"value": false
},
{
"propertyDefinitionId": "37",
"value": false
},
{
"propertyDefinitionId": "34",
"value": 0.0
},
{
"propertyDefinitionId": "35",
"value": 0.0
},
{
"propertyDefinitionId": "24",
"value": "Administrator"
},
{
"propertyDefinitionId": "25",
"value": "2024-10-08T07:12:56.61Z"
},
{
"propertyDefinitionId": "21",
"value": false
},
{
"propertyDefinitionId": "42",
"value": "Default"
},
{
"propertyDefinitionId": "44",
"value": -1.0
},
{
"propertyDefinitionId": "15",
"value": ""
},
{
"propertyDefinitionId": "16",
"value": ""
},
{
"propertyDefinitionId": "17",
"value": ""
},
{
"propertyDefinitionId": "18",
"value": ""
},
{
"propertyDefinitionId": "22",
"value": ""
},
{
"propertyDefinitionId": "27",
"value": ""
},
{
"propertyDefinitionId": "28",
"value": ""
},
{
"propertyDefinitionId": "38",
"value": ""
},
{
"propertyDefinitionId": "39",
"value": ""
},
{
"propertyDefinitionId": "45",
"value": ""
},
{
"propertyDefinitionId": "46",
"value": ""
},
{
"propertyDefinitionId": "47",
"value": ""
},
{
"propertyDefinitionId": "48",
"value": ""
},
{
"propertyDefinitionId": "49",
"value": ""
},
{
"propertyDefinitionId": "50",
"value": ""
},
{
"propertyDefinitionId": "51",
"value": ""
},
{
"propertyDefinitionId": "212",
"value": ""
},
{
"propertyDefinitionId": "237",
"value": ""
},
{
"propertyDefinitionId": "238",
"value": ""
},
{
"propertyDefinitionId": "239",
"value": ""
},
{
"propertyDefinitionId": "240",
"value": ""
},
{
"propertyDefinitionId": "241",
"value": ""
},
{
"propertyDefinitionId": "250",
"value": ""
},
{
"propertyDefinitionId": "251",
"value": ""
}
],
"classification": "None",
"visualizationAttachmentStatus": "None",
"version": 1,
"entityType": "FileVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/file-versions/136926"
}
],
"included": {
"folder": {
"1": {
"name": "$",
"id": "1",
"fullName": "$",
"categoryColor": -1,
"stateColor": 0,
"subfolderCount": 11,
"isLibrary": false,
"isCloaked": false,
"isReadOnly": false,
"createDate": "2018-03-05T15:23:55.06Z",
"createUserName": "Administrator",
"entityType": "Folder",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/folders/1"
},
"25551": {
"name": "xDMS",
"id": "25551",
"fullName": "$/xDMS",
"category": "Folder",
"categoryColor": -1,
"stateColor": 0,
"subfolderCount": 1,
"isLibrary": false,
"isCloaked": false,
"isReadOnly": false,
"createDate": "2019-01-07T17:38:42.28Z",
"createUserName": "CAD Admin",
"entityType": "Folder",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/folders/25551"
}
},
"propertyDefinition": {
"259": {
"id": "259",
"displayName": "Has Markup",
"systemName": "HasMarkup",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/259"
},
"5": {
"id": "5",
"displayName": "Date Version Created",
"systemName": "DateVersionCreated",
"dataType": "DateTime",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/5"
},
"40": {
"id": "40",
"displayName": "Obsolete",
"systemName": "Obsolete",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/40"
},
"260": {
"id": "260",
"displayName": "Has Markup (Historical)",
"systemName": "HasMarkup(Ver)",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/260"
},
"29": {
"id": "29",
"displayName": "Folder Path",
"systemName": "FolderPath",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/29"
},
"6": {
"id": "6",
"displayName": "Created By",
"systemName": "CreateUserName",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/6"
},
"54": {
"id": "54",
"displayName": "File Replicated",
"systemName": "FileReplicated",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/54"
},
"41": {
"id": "41",
"displayName": "Category Name",
"systemName": "CategoryName",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/41"
},
"43": {
"id": "43",
"displayName": "Category Glyph",
"systemName": "CategoryGlyph",
"dataType": "Numeric",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/43"
},
"2": {
"id": "2",
"displayName": "Version",
"systemName": "VersionNumber",
"dataType": "Numeric",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/2"
},
"3": {
"id": "3",
"displayName": "Comment",
"systemName": "Comment",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/3"
},
"218": {
"id": "218",
"displayName": "Has Parent Relationship",
"systemName": "HasParentRelationship",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/218"
},
"1": {
"id": "1",
"displayName": "Classification",
"systemName": "Classification",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/1"
},
"19": {
"id": "19",
"displayName": "Hidden",
"systemName": "Hidden",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/19"
},
"20": {
"id": "20",
"displayName": "Latest Version",
"systemName": "LatestVersion",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/20"
},
"9": {
"id": "9",
"displayName": "File Name",
"systemName": "ClientFileName",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/9"
},
"30": {
"id": "30",
"displayName": "Name",
"systemName": "Name",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/30"
},
"8": {
"id": "8",
"displayName": "Checked In",
"systemName": "CheckInDate",
"dataType": "DateTime",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/8"
},
"10": {
"id": "10",
"displayName": "File Name (Historical)",
"systemName": "ClientFileName(Ver)",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/10"
},
"11": {
"id": "11",
"displayName": "Date Modified",
"systemName": "ModDate",
"dataType": "DateTime",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/11"
},
"23": {
"id": "23",
"displayName": "Visualization Attachment",
"systemName": "VisualizationAttachment",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/23"
},
"12": {
"id": "12",
"displayName": "File Size",
"systemName": "FileSize",
"dataType": "Numeric",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/12"
},
"33": {
"id": "33",
"displayName": "File Extension",
"systemName": "Extension",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/33"
},
"4": {
"id": "4",
"displayName": "Number of Attachments",
"systemName": "NumManualAttachments",
"dataType": "Numeric",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/4"
},
"13": {
"id": "13",
"displayName": "Linked to Item",
"systemName": "ItemLinked",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/13"
},
"14": {
"id": "14",
"displayName": "Item Assignable",
"systemName": "ItemAssignable",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/14"
},
"36": {
"id": "36",
"displayName": "Latest Released Revision",
"systemName": "LatestReleasedRevision",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/36"
},
"37": {
"id": "37",
"displayName": "Released Revision",
"systemName": "ReleasedRevision",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/37"
},
"34": {
"id": "34",
"displayName": "Property Compliance",
"systemName": "Compliance",
"dataType": "Numeric",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/34"
},
"35": {
"id": "35",
"displayName": "Property Compliance (Historical)",
"systemName": "Compliance(Ver)",
"dataType": "Numeric",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/35"
},
"27": {
"id": "27",
"displayName": "Provider",
"systemName": "Provider",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/27"
},
"24": {
"id": "24",
"displayName": "Originator",
"systemName": "Originator",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/24"
},
"25": {
"id": "25",
"displayName": "Original Create Date",
"systemName": "OrigCreateDate",
"dataType": "DateTime",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/25"
},
"21": {
"id": "21",
"displayName": "Controlled By Change Order",
"systemName": "ControlledByChangeOrder",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/21"
},
"42": {
"id": "42",
"displayName": "Category Name (Historical)",
"systemName": "CategoryName(Ver)",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/42"
},
"44": {
"id": "44",
"displayName": "Category Glyph (Historical)",
"systemName": "CategoryGlyph(Ver)",
"dataType": "Numeric",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/44"
},
"15": {
"id": "15",
"displayName": "Checked Out Local Spec",
"systemName": "CheckoutLocalSpec",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/15"
},
"16": {
"id": "16",
"displayName": "Checked Out Machine",
"systemName": "CheckoutMachine",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/16"
},
"17": {
"id": "17",
"displayName": "Checked Out",
"systemName": "CheckoutDate",
"dataType": "DateTime",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/17"
},
"18": {
"id": "18",
"displayName": "Checked Out By",
"systemName": "CheckoutUserName",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/18"
},
"22": {
"id": "22",
"displayName": "Change Order State",
"systemName": "ChangeOrderState",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/22"
},
"28": {
"id": "28",
"displayName": "iLogicRuleStatus",
"systemName": "iLogicRuleStatus",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/28"
},
"38": {
"id": "38",
"displayName": "Initial Release Date",
"systemName": "InitReleaseDate",
"dataType": "DateTime",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/38"
},
"39": {
"id": "39",
"displayName": "Initial Approver",
"systemName": "InitApprover",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/39"
},
"45": {
"id": "45",
"displayName": "Lifecycle Definition",
"systemName": "LifeCycleDefinition",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/45"
},
"46": {
"id": "46",
"displayName": "Lifecycle Definition (Historical)",
"systemName": "LifeCycleDefinition(Ver)",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/46"
},
"47": {
"id": "47",
"displayName": "State",
"systemName": "State",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/47"
},
"48": {
"id": "48",
"displayName": "State (Historical)",
"systemName": "State(Ver)",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/48"
},
"49": {
"id": "49",
"displayName": "Revision Scheme",
"systemName": "RevisionDefinition",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/49"
},
"50": {
"id": "50",
"displayName": "Revision Scheme (Historical)",
"systemName": "RevisionDefinition(Ver)",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/50"
},
"51": {
"id": "51",
"displayName": "Revision",
"systemName": "Revision",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/51"
},
"212": {
"id": "212",
"displayName": "Has Drawing",
"systemName": "HasDrawing",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/212"
},
"237": {
"id": "237",
"displayName": "Has Model State",
"systemName": "HasModelState",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/237"
},
"238": {
"id": "238",
"displayName": "Is Table Driven",
"systemName": "IsTableDriven",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/238"
},
"239": {
"id": "239",
"displayName": "Is True Model State",
"systemName": "IsTrueModelState",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/239"
},
"240": {
"id": "240",
"displayName": "Latest Released Date",
"systemName": "LatestReleaseDate",
"dataType": "DateTime",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/240"
},
"241": {
"id": "241",
"displayName": "Latest Approver",
"systemName": "LatestApprover",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/241"
},
"250": {
"id": "250",
"displayName": "State Glyph",
"systemName": "StateGlyph",
"dataType": "Numeric",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/250"
},
"251": {
"id": "251",
"displayName": "State Glyph (Historical)",
"systemName": "StateGlyph(Ver)",
"dataType": "Numeric",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/251"
}
}
}
}
Example 3: When entity collection resource is requested and include subset of properties
Most of the Entity collections endpoints like Get file versions , Get item versions ,etc. support the option[propDefIds]
query parameter. To get the subset of properties in the response, pass the option[propDefIds]
query parameter with the comma separated list of propDefIds. This will enforce the response to include only the properties that are specified in the option[propDefIds]
query parameter.
For example: If the response should include only properties viz. 'Folder Path' and 'IsControlledByChangeOrder'
for the entities in the collection, first step is to determine the propDefIds of these. This could be achieved by invoking Get all property definitions endpoint to get all propDefs and then filter them to determine propDefIds we are interested. In this example, the propDefIds comes out to be 29 and 21
.
Request
curl -v 'https://test.vg.autodesk.com/AutodeskDM/Services/api/vault/v2/vaults/101/file-versions?limit=2&option[propDefIds]=21,29' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IlU3c0dGRldUTzlBekNhSzBqZURRM2dQZXBURVdWN2VhIn0.eyJzY29wZSI6WyJkYXRhOnJlYWQiXSwiY2xpZW50X2lkIjoiRjZEbjh5cGVtMWo4UDZzVXo4SVgzcG1Tc09BOTlHVVQiLCJpc3MiOiJodHRwczovL2RldmVsb3Blci5hcGkuYXV0b2Rlc2suY29tIiwiYXVkIjoiaHR0cHM6Ly9hdXRvZGVzay5jb20iLCJqdGkiOiJUaDZMbWVLdzN2c0ZxSTNPR0hrUmhxUG9rTXJnR1RPanhjUW1hQXlRS2RnU1VTbzV5cEY5dTZqekM4UmwwVnNBIiwidXNlcmlkIjoiM1hWU0w3MkpMMlU1IiwiZXhwIjoxNjY5ODY5MDQ1fQ.diknPiZfHDSmgl3iPuQgXMZQhCRBVQGyvj3e0GCRQtSUjE5pVnm6a7PnGJwcrvnsaV7wrNOGi_dPDcQW_pYyrQV925kKtV4GYLLrrf639s0wpdlj7nHJGPgy_oRu4pFTSBtj5qW6i3hIaujtVtzLc9DtvKAWYPRSq-_j9niibM1TrLc_6mrIse-jtQP6qkmWj7IzZPxgX947_4rYW06-Vzb4Yyu1VlmGs7A1koUPMIp2N4RUTGzUyM1z9xszqQHZBkznKRVZVJOkzO6kHyAFWr3ksYgRNdGU2zY_x_OTe3MW4uBfLgQTw-Eo5xsc7a87xvX7vSDfl14ctwwE8lMnBw'
Response
{
"pagination": {
"limit": 2,
"totalResults": 8132,
"nextUrl": "/AutodeskDM/Services/api/vault/v2/vaults/101/file-versions?limit=2&option[propDefIds]=21,29&cursorState=PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTE2Ij8%2bDQo8UHJvcGVydGllcz4NCiAgPFBhaXIgTm09IkVudGl0eUlkIiBWYWw9IiAmI3gxOyYjeDA7JiN4MDsmI3gwOyYjeDA7JiN4MDsmI3gwOyYjeDg7LV4iIC8%2bDQo8L1Byb3BlcnRpZXM%2b",
"indexingStatus": "IndexingComplete"
},
"results": [
{
"name": "test.test",
"id": "136928",
"state": "",
"stateColor": 0,
"revision": "",
"category": "Default",
"categoryColor": -1,
"lastModifiedDate": "2024-10-03T16:17:13.847Z",
"isCheckedOut": false,
"hasVisualizationAttachment": false,
"size": 144243296,
"isCloaked": false,
"checkinDate": "2024-10-23T08:57:46.957Z",
"isHidden": false,
"isReadOnly": false,
"parentFolderId": "1",
"file": {
"id": "136927",
"entityType": "File",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/files/136927"
},
"isOnSite": true,
"createDate": "2024-10-23T08:57:46.957Z",
"createUserName": "Administrator",
"properties": [
{
"propertyDefinitionId": "29",
"value": "$"
},
{
"propertyDefinitionId": "21",
"value": false
}
],
"classification": "None",
"visualizationAttachmentStatus": "None",
"version": 1,
"entityType": "FileVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/file-versions/136928"
},
{
"name": "03-einr-lay_20240619.dwg.dwf",
"id": "136926",
"state": "",
"stateColor": 0,
"revision": "",
"category": "Default",
"categoryColor": -1,
"lastModifiedDate": "2024-10-08T07:12:09.64Z",
"isCheckedOut": false,
"hasVisualizationAttachment": false,
"size": 15559827,
"isCloaked": false,
"checkinDate": "2024-10-08T07:12:56.61Z",
"isHidden": false,
"isReadOnly": false,
"parentFolderId": "25551",
"file": {
"id": "136925",
"entityType": "File",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/files/136925"
},
"isOnSite": true,
"createDate": "2024-10-08T07:12:56.61Z",
"createUserName": "Administrator",
"properties": [
{
"propertyDefinitionId": "29",
"value": "$/xDMS"
},
{
"propertyDefinitionId": "21",
"value": false
}
],
"classification": "None",
"visualizationAttachmentStatus": "None",
"version": 1,
"entityType": "FileVersion",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/file-versions/136926"
}
],
"included": {
"folder": {
"1": {
"name": "$",
"id": "1",
"fullName": "$",
"categoryColor": -1,
"stateColor": 0,
"subfolderCount": 11,
"isLibrary": false,
"isCloaked": false,
"isReadOnly": false,
"createDate": "2018-03-05T15:23:55.06Z",
"createUserName": "Administrator",
"entityType": "Folder",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/folders/1"
},
"25551": {
"name": "xDMS",
"id": "25551",
"fullName": "$/xDMS",
"category": "Folder",
"categoryColor": -1,
"stateColor": 0,
"subfolderCount": 1,
"isLibrary": false,
"isCloaked": false,
"isReadOnly": false,
"createDate": "2019-01-07T17:38:42.28Z",
"createUserName": "CAD Admin",
"entityType": "Folder",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/folders/25551"
}
},
"propertyDefinition": {
"29": {
"id": "29",
"displayName": "Folder Path",
"systemName": "FolderPath",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/29"
},
"21": {
"id": "21",
"displayName": "Controlled By Change Order",
"systemName": "ControlledByChangeOrder",
"dataType": "Bool",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101/property-definitions/21"
}
}
}
}