Get a link
GET
vaults/{vaultId}/links/{id}
Get the link object by Id.
Resource Information
Method and URI | GET /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/links/{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 link. |
Response
HTTP Status Code Summary
200 OK | The request succeeded. The response contains the link. |
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
name string | |
id string | Get the unique identifier for this link object |
createDate string | |
createUserName string | |
entityType string | |
url string | The relative URL to access this object. |
toEntity object | A generic entity object with all supported fields. |
id string | A unique identifier for the object |
name string | Name of the entity |
fullName string | The full vault path if Entity is a folder |
number string | |
category string | Category information about this entity |
categoryColor number | Category color |
entityType string | |
version number | Version number if entity is an Iteration object |
createDate string | Tells the date and time that this version of the entity was created in the Vault. |
lastModifiedDate string | |
revision string | Revision information about this entity. |
state string | The name of the life cycle state for the entity |
stateColor number | The color of the state. |
parentFolderId string | |
parent object | folder object |
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 |
isCheckedOut boolean | |
createUserName string | |
checkinDate string | |
checkoutDate string | |
size number | |
url string | The relative URL to access this object. |
hasVisualizationAttachment boolean | |
checkoutUserName string | |
isLibrary boolean | |
isReadOnly boolean | |
isCloaked boolean | |
file object | |
id string | File MasterId |
url string | The relative URL to access this object. |
versionType enum:string | An enumerated value that specifies the type of version to retrieve.
Possible values: None , Latest , LatestReleased |
fileVersion object | file version basic object. |
id string | File IterationId |
name string | The name of the file. This value applies to all versions of the file |
category string | Category information about this file |
categoryColor number | Category color |
classification enum:string | The classification of the file.
Possible values: None , DesignVisualization , DesignDocument , ConfigurationMember , ConfigurationFactory , ElectricalProject , DesignSubstitute , DesignRepresentation , DesignPresentation |
entityType string | |
version number | The version of the file. A file that has just been added to the Vault, will have 1 as its VerNum |
createDate string | Tells the date and time that this version of the file was created in the Vault. For the first version of a file, this date will match CkInDate. For later versions, this value will have the time when the previous version was checked out. |
lastModifiedDate string | The last modified date of the file. This value is set by the client that uploaded the file. |
revision string | Revision information about this file. |
state string | The name of the life cycle state for the current file |
stateColor number | The color of the state. |
parentFolderId string | FolderId of the parent the current file resides in |
file object | |
parent object | folder object |
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 |
isCheckedOut boolean | If true, then the latest version of this file is in the checked-out state |
createUserName string | The Name of the user who checked-in or uploaded this file. |
checkinDate string | The date and time that the file was checked in. This property is only valid if isCheckedOut is false. |
checkoutDate string | The date and time that the file was last checked out |
checkoutUserName string | User that has the file checked out |
size number | The size, in bytes, of the file. This property is only valid if CheckedOut is false. |
url string | The relative URL to access this object. |
hasVisualizationAttachment boolean | Flag to determine if valid VizAttachmentStatus (Not None) |
visualizationAttachmentStatus enum:string | The design visualization attachment status of the file.
Possible values: None , Syncronized , NotSyncronized , UserVerified , Legacy |
isReadOnly boolean | |
isCloaked boolean | Get if this file is cloaked. A cloaked object is one that the caller does not have permissions to view |
isOnSite boolean | Gets whether or not the file is on the local site (in a multi-site environment). This value will always be true on a single-site environment. |
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 |
checkoutUser object | User 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. |
item object | Item object. |
id string | MasterId of the item |
url string | The relative URL to access this object. |
versionType enum:string | An enumerated value that specifies the type of version to retrieve.
Possible values: None , Latest , LatestReleased |
itemVersion object | The unique identifier for the object. |
id string | Item Iteration Id |
url string | The relative URL to access this object. |
number string | The Item number. |
version number | The version number, which is a sequential number given to each version. For example, if this value is 5, then the object is the 5th version. |
revision string | The display value for the revision. |
comment string | |
title string | The display title. |
state string | Life cycle state of the item |
stateColor number | |
name string | |
category string | Category assigned to the item |
categoryColor number | |
entityType string | |
isReadOnly boolean | |
isCloaked boolean | If true, the logged-in user is restricted from seeing this item. |
isLatestObsolete boolean | Flag to check if an latest Item’s version is obsolete |
item object | |
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 |
subfolderCount number | |
children string | |
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 |
fromEntity object | folder object |
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 link 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/links/11045' \
-X 'GET' \
-H 'Accept: application/json'\
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
Response
{
"name": "b",
"id": "11045",
"fromEntity": {
"name": "a",
"id": "11041",
"fullName": "$/ROOT 20240321-171709 LinkPropertiesTests/a",
"category": "Folder",
"categoryColor": -1,
"stateColor": 0,
"subfolderCount": 2,
"isLibrary": false,
"isCloaked": false,
"isReadOnly": false,
"createDate": "2024-03-21T09:17:09.73Z",
"createUserName": "Administrator",
"properties": [
{
"propertyDefinitionId": "56",
"value": 0.0,
"definition": {
"id": "56",
"displayName": "Property Compliance",
"systemName": "Compliance",
"dataType": "Numeric",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/1/property-definitions/56"
}
},
{
"propertyDefinitionId": "63",
"value": "Folder",
"definition": {
"id": "63",
"displayName": "Category Name",
"systemName": "CategoryName",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/1/property-definitions/63"
}
},
......
],
"entityType": "Folder",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/1/folders/11041"
},
"toEntity": {
"name": "b",
"id": "11042",
"parent": {
"name": "a",
"id": "11041",
"fullName": "$/ROOT 20240321-171709 LinkPropertiesTests/a",
"category": "Folder",
"categoryColor": -1,
"stateColor": 0,
"subfolderCount": 2,
"isLibrary": false,
"isCloaked": false,
"isReadOnly": false,
"createDate": "2024-03-21T09:17:09.73Z",
"createUserName": "Administrator",
"entityType": "Folder",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/1/folders/11041"
},
"parentFolderId": "11041",
"fullName": "$/ROOT 20240321-171709 LinkPropertiesTests/a/b",
"category": "Folder",
"categoryColor": -1,
"stateColor": 0,
"subfolderCount": 1,
"isLibrary": false,
"isCloaked": false,
"isReadOnly": false,
"createDate": "2024-03-21T09:17:09.76Z",
"createUserName": "Administrator",
"properties": [
{
"propertyDefinitionId": "56",
"value": 0.0,
"definition": {
"id": "56",
"displayName": "Property Compliance",
"systemName": "Compliance",
"dataType": "Numeric",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/1/property-definitions/56"
}
},
{
"propertyDefinitionId": "63",
"value": "Folder",
"definition": {
"id": "63",
"displayName": "Category Name",
"systemName": "CategoryName",
"dataType": "String",
"isSystem": true,
"active": true,
"url": "/AutodeskDM/Services/api/vault/v2/vaults/1/property-definitions/63"
}
},
......
],
"entityType": "Folder",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/1/folders/11042"
},
"createDate": "2024-03-21T09:17:09.76Z",
"createUserName": "Administrator",
"entityType": "Link",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/1/links/11045"
}
Show More