Request

Response

    Get a job
    GET

    vaults/{vaultId}/jobs/{id}

    Get job by its Id

    Resource Information
    Method and URI
    GET
     /AutodeskDM/Services/api/vault/v2/vaults/{vaultId}/jobs/{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 job.

    Response

    HTTP Status Code Summary
    200
    OK
    		The request succeeded. The response contains the job.
    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
    id
    string
    		A unique identifier for the job.
    jobType
    string
    		The job type.
    priority
    number
    		The priority of the job. A lower number means a higher priority. 1 is the lowest possible number.
    description
    string
    		A description of the job.
    url
    string
    		The relative URL to access this object.
    params
    object
    		An array of parameters which provide metadata about the job.
    *
    string
    status
    object
    		The status of the job:
    • Ready - The job is ready to be run.
    • Running - The job is currently running.
    • Success - The job has completed successfully.
    • Failure - The job has failed.

    Possible values: Ready, Running, Success, Failure

    isOnSite
    string
    		In a multi-site environment, this property tells if the file is on the local site.

    Example

    This example illustrates the retrieval of a job 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/3/jobs/50202' \
  -X 'GET' \
  -H 'Content-Type: application/json'\
  -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a...'

    Response

    {
  "id": "50202",
  "jobType": "Autodesk.Vault.DWF.Create.iam",
  "description": "DWF Create: 144001000-001.iam",
  "params": {
      "fileVersionId": "11462"
  },
  "priority": 10,
  "status": 0,
  "isOnSite": true,
  "url": "/AutodeskDM/Services/api/vault/v2/vaults/3/jobs/50202"
}
    Show More