Request

Response

    Get All Property Definitions
    GET

    vaults/{vaultId}/property-definitions

    Retrieves all property definitions in the specified Knowledge Vault.

    Resource Information

    Method and URI
    GET
    /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/property-definitions
    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 a three-legged access token obtained via an Authorization Code flow or a Secure Service Account (SSA) flow.

    The SSA flow is designed for headless server-to-server operations. While it functions like a two-legged flow (no user interaction), it is classified as three-legged because it preserves user context.

    * Required

    Request

    URI Parameters

    vaultId
    string
    The unique identifier of a Knowledge Vault.

    Request

    Query String Parameters

    filter[entityClassId]
    string
    The entity class identifier to filter by. Allowed values are FILE, FLDR, ITEM, and CO. If null or empty, property definitions for all entity classes are returned.
    filter[systemNames]
    string
    A filter that includes only property definitions matching the specified system names. Provide a comma-separated list of system names.
    filter[propDefIds]
    string
    A filter that includes only property definitions matching the specified IDs. Provide a comma-separated list of property definition IDs.
    option[extendedModels]
    boolean
    true: The response will include additional detailed information for each entity. Examples include:
    • For folders (getFolders), it will return FolderExtended instead of Folder, which includes additional information such as the parent folder.
    • For file versions (getFileVersions), it will return FileVersionExtended instead of FileVersion, which includes extra details like the checkout user ID.
    • For change orders (getChangeOrders), it will return ChangeOrderExtended instead of ChangeOrder, which provides further information such as the list of assignees.
    • For property definitions (getPropertyDefinitions), it will return PropertyDefinitionExtended instead of PropertyDefinition, which includes extra details like list values.

    false: (Default) The response will include basic information for each entity.

    option[includeBOMAssociationProperty]
    boolean
    true: Include BOM Association Property definitions.

    false: (Default) Exclude BOM Association Property definitions.

    limit
    int
    The maximum number of results to return per page. Defaults to 100.

    The hard upper bound is controlled by the Page size configuration setting, which an administrator can update through ADMS (Global Setting -> Page size configuration).

    cursorState
    string
    The cursor token used to fetch the next page of results. Pass the value returned in pagination.nextUrl from the previous response to continue paging.

    Response

    HTTP Status Code Summary

    200
    OK
    The list of property definitions was successfully retrieved.
    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.

    Response

    Body Structure (200)

    Expand all
    pagination
    object
    Contains pagination metadata for navigating through large result sets.
    limit
    int
    The maximum number of results that can be returned in this response. The actual number of results may be fewer due to filtering, data availability, or other constraints. This reflects the limit value applied by the server, which may differ from the requested limit.
    totalResults
    int
    The total number of results available across all pages that match the query criteria, regardless of pagination limits.
    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. Possible values:
    • IndexingComplete - All properties and content have been indexed.
    • IndexingProperties - File properties are currently being indexed.
    • IndexingContent - File content is currently being indexed.
    • NA - Not applicable as data not retrieved from index.

    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.

    nextUrl
    string
    The URL used to retrieve the next page of results. The URL includes an embedded cursor token for the subsequent call. When null or absent, this is the final page. Note that a page may be empty but still include a next page URL. Continue paging until this attribute is null or absent.
    results
    array
    An array of property definitions.
    oneOf
    array:oneOf
    Property Definition
    object
    Contains server-side metadata for a Vault property definition, including datatype and naming.
    id
    string
    The unique identifier of the property definition.
    url
    string
    The relative URL to access this object.
    displayName
    string
    The display name of this property definition.
    systemName
    string
    The system name of this property definition.
    dataType
    enum:string
    The underlying data type stored for values of this property. Possible values: String, Numeric, Bool, DateTime, Image
    active
    boolean
    Indicates whether this property definition is active.

    true: This property definition is active.

    false: This property definition is inactive.

    isSystem
    boolean
    Indicates whether this property definition is a built-in system property.

    true: This is a system property.

    false: This is a user-defined property.

    initialValue
    string
    The default value applied to entities that do not have an existing value for this property definition.
    Property Definition
    object
    Contains server-side metadata for a Vault property definition, including datatype and naming.
    listValues
    array: string
    An array of possible values for properties based on this property definition.
    id
    string
    The unique identifier of the property definition.
    url
    string
    The relative URL to access this object.
    displayName
    string
    The display name of this property definition.
    systemName
    string
    The system name of this property definition.
    dataType
    enum:string
    The underlying data type stored for values of this property. Possible values: String, Numeric, Bool, DateTime, Image
    active
    boolean
    Indicates whether this property definition is active.

    true: This property definition is active.

    false: This property definition is inactive.

    isSystem
    boolean
    Indicates whether this property definition is a built-in system property.

    true: This is a system property.

    false: This is a user-defined property.

    initialValue
    string
    The default value applied to entities that do not have an existing value for this property definition.

    Example

    This example illustrates how to get all property definitions, with a limit of 2.

    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/property-definitions?limit=2' \
      -X 'GET' \
      -H 'Accept: application/json'\
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
    

    Response

    {
      "pagination": {
        "limit": 2,
        "totalResults": 108,
        "nextUrl": "/AutodeskDM/Services/api/vault/v2/vaults/117/property-definitions?limit=2&cursorState=SQBkAEMAdQByAHMAbwByAC0AdgAxADoAMgA_",
        "indexingStatus": "NA"
      },
      "results": [
        {
          "id": "1",
          "displayName": "Classification",
          "systemName": "Classification",
          "dataType": "String",
          "isSystem": true,
          "active": true,
          "url": "/AutodeskDM/Services/api/vault/v2/vaults/117/property-definitions/1"
        },
        {
          "id": "2",
          "displayName": "Version",
          "systemName": "VersionNumber",
          "dataType": "Numeric",
          "isSystem": true,
          "active": true,
          "url": "/AutodeskDM/Services/api/vault/v2/vaults/117/property-definitions/2"
        }
      ]
    }
    
    Show More