Get a Knowledge Vault
GET
vaults/{id}
Retrieves a Knowledge Vault by its ID.
Resource Information
| Method and URI | GET /AutodeskDM/Services/api/vault/v2/vaults/{id} |
| Authentication Context | No security required |
| Required OAuth Scopes | No scopes required |
| Data Format | JSON |
Request
URI Parameters
| id string | The unique identifier of a Knowledge Vault. |
Response
HTTP Status Code Summary
| 200 OK | The Knowledge Vault details were successfully retrieved. |
| 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 Knowledge Vault was not found. Verify the id URI parameter and try again. |
Response
Body Structure (200)
| name string | The name of the Knowledge Vault. This is also the name of the database. |
| id string | A unique identifier for the Knowledge Vault. |
| url string | The relative URL to access this object. |
Example
This example illustrates how to get vault by its 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/101' \
-X 'GET' \
-H 'Accept: application/json'
Response
{
"id": "101",
"name": "PDMC-Sample",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101"
}