Request

Response

    Get All External Sync Tasks
    GET

    vaults/{vaultId}/ext-sync-tasks

    Retrieves all external sync tasks. External sync tasks are used to synchronize data between Vault and external systems.

    Resource Information

    Method and URI
    GET
    /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/ext-sync-tasks
    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[entityIds]
    string
    Filter by multiple entity IDs. Provide entity IDs separated by newlines.
    filter[entityId]
    string
    A filter that returns only external sync tasks whose entity ID exactly matches the specified value.
    filter[entityId]-starts
    string
    A filter that returns only external sync tasks whose entity ID begins with the specified string.
    filter[workflowType]
    string
    A filter that returns only external sync tasks whose workflow type exactly matches the specified value.
    filter[workflowType]-starts
    string
    A filter that returns only external sync tasks whose workflow type begins with the specified string.
    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 external sync tasks 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: object
    An array of external sync tasks.
    id
    string
    A unique identifier for the external sync task.
    vaultId
    int
    The unique identifier of the Knowledge Vault this task belongs to.
    userId
    int
    The ID of the user who created this task.
    createDate
    datetime: ISO 8601
    The date and time when the task was created.
    params
    object
    A dictionary of parameters that provides metadata about the external sync task. It mainly carries extra key-value data used to pass business-related additional information along the task execution chain.
    *
    string
    status
    enum:string
    The status of the external sync task. Possible values:
    • Ready - The task is ready to be processed.
    • Running - The task is currently being processed.
    • Success - The task has completed successfully.
    • Failure - The task has failed.
    • Suspended - The task has been suspended.
    entityId
    string
    The ID of the entity (file, item, etc.) being synchronized.
    entityClassId
    string
    The class ID of the entity being synchronized. The value should be from EntityClass, e.g., FILE, ITEM, CO.
    configId
    string
    The ID of the external sync configuration being used. This value comes from the key of GET /vaults/{vaultId}/vault-options/ext-sync-configs response.
    workflowType
    string
    The type of workflow for this sync task. This value comes from the selected configuration content returned by GET /vaults/{vaultId}/vault-options/ext-sync-configs.
    description
    string
    A description of the external sync task.
    executeImmediately
    boolean
    Indicates whether to notify the agent immediately when the task is created.

    true: Notify the agent immediately when the task is created.

    false: Do not notify the agent immediately when the task is created.

    predecessorTaskId
    string
    The ID of the predecessor task that must complete before this task can run.
    url
    string
    The relative URL to access this object.

    Example

    This example illustrates how to get external sync tasks with filters.

    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/9/ext-sync-tasks?filter[workflowtype]=Adsk.UploadItem&limit=100' \
      -X 'GET' \
      -H 'Accept: application/json'\
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'
    

    Response

    {
      "pagination": {
        "limit": 100,
        "totalResults": 3,
        "indexingStatus": "NA"
      },
      "results": [
        {
          "id": "226",
          "vaultId": 9,
          "userId": 2,
          "createDate": "2026-03-20T07:32:03.213Z",
          "params": {
            "entityClassId": "ITEM",
            "entityId": "127",
            "extSyncConfigId": "Adsk.Vault.ExternalSyncTask.FusionManage",
            "workflowType": "Adsk.UploadItem"
          },
          "status": "Failure",
          "entityId": "127",
          "entityClassId": "ITEM",
          "configId": "Adsk.Vault.ExternalSyncTask.FusionManage",
          "workflowType": "Adsk.UploadItem",
          "description": "Sync to Fusion Manage (1000007)",
          "url": "/AutodeskDM/Services/api/vault/v2/vaults/9/ext-sync-tasks/226"
        },
        {
          "id": "233",
          "vaultId": 9,
          "userId": 2,
          "createDate": "2026-03-20T07:39:19.99Z",
          "params": {
            "entityClassId": "ITEM",
            "entityId": "119",
            "extSyncConfigId": "Adsk.Vault.ExternalSyncTask.FusionManage",
            "workflowType": "Adsk.UploadItem"
          },
          "status": "Failure",
          "entityId": "119",
          "entityClassId": "ITEM",
          "configId": "Adsk.Vault.ExternalSyncTask.FusionManage",
          "workflowType": "Adsk.UploadItem",
          "description": "Sync to Fusion Manage (1000007)",
          "url": "/AutodeskDM/Services/api/vault/v2/vaults/9/ext-sync-tasks/233"
        },
        {
          "id": "237",
          "vaultId": 9,
          "userId": 2,
          "createDate": "2026-03-21T01:43:03.443Z",
          "params": {
            "entityClassId": "ITEM",
            "entityId": "121",
            "extSyncConfigId": "Adsk.Vault.ExternalSyncTask.FusionManage",
            "workflowType": "Adsk.UploadItem"
          },
          "status": "Running",
          "entityId": "121",
          "entityClassId": "ITEM",
          "configId": "Adsk.Vault.ExternalSyncTask.FusionManage",
          "workflowType": "Adsk.UploadItem",
          "description": "Sync to Fusion Manage (1000023)",
          "url": "/AutodeskDM/Services/api/vault/v2/vaults/9/ext-sync-tasks/237"
        }
      ]
    }
    
    Show More