Get all Knowledge Vaults
GET
vaults
Get the list of all knowledge vaults on the server without logging in.
Resource Information
Method and URI | GET /AutodeskDM/Services/api/vault/v2/vaults |
Authentication Context | No security required |
Required OAuth Scopes | No scopes required |
Data Format | JSON |
Request
Query String Parameters
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 vaults. |
403 Forbidden | Unauthorized |
Response
Body Structure (200)
Expand all
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: object | |
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 all vaults.
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' \
-X 'GET' \
-H 'Accept: application/json'
Response
{
"pagination": {
"limit": 1000,
"totalResults": 2,
"indexingStatus": "NA"
},
"results": [
{
"id": "101",
"name": "PDMC-Sample",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/101"
},
{
"id": "117",
"name": "Vault",
"url": "/AutodeskDM/Services/api/vault/v2/vaults/117"
}
]
}
Show More