Get a folder
GET
vaults/{vaultId}/folders/{id}
Get the folder object with the given Id
Resource Information
Method and URI | GET /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/folders/{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 folder. If the id is ‘root’, return root folder object. |
Response
HTTP Status Code Summary
200 OK | The request succeeded. The response contains the folder. |
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
id string | Get the unique identifier for this folder |
url string | The relative URL to access this object. |
name string | Get the descriptive name for this Folder. This is always the Folder Name without the full path. |
fullName string | Get the full vault path for this folder (ie. $/Folder1) |
createDate string | Get the date and time that the folder was created. |
createUserName string | Get the name of the user who created this folder. |
category string | Get the category that is assigned to this folder |
categoryColor number | Category color |
state string | The name of the life cycle state for the current folder |
stateColor number | The color of the state. |
subfolderCount number | Get the number of immediate child folders. |
children string | |
isLibrary boolean | Get whether or not this folder is a library folder |
isReadOnly boolean | Get whether this folder can be modified by the logged in user. |
isCloaked boolean | Get if this folder is cloaked. A cloaked object is one that the caller does not have permissions to view. |
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 |
Example
This example illustrates how to get a folder 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/folders/2' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
Response
{
"name": "ColinTest",
"id": "2",
"parent": {
"name": "$",
"id": "1",
"fullName": "$",
"categoryColor": -1,
"stateColor": 0,
"subfolderCount": 1,
"isLibrary": false,
"isCloaked": false,
"isReadOnly": false,
"createDate": "2024-10-11T06:59:09.53Z",
"createUserName": "Administrator",
"entityType": "Folder",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/folders/1"
},
"parentFolderId": "1",
"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",
"properties": [
{
"propertyDefinitionId": "6",
"value": "TestAccount",
"definition": {
"id": "6",
"displayName": "Created By",
"systemName": "CreateUserName",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/property-definitions/6"
}
},
{
"propertyDefinitionId": "7",
"value": "2024-10-11T07:04:11.723Z",
"definition": {
"id": "7",
"displayName": "Create Date",
"systemName": "CreateDate",
"dataType": "DateTime",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/property-definitions/7"
}
},
......
],
"entityType": "Folder",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117/folders/2"
}
Show More