Request

Response

    Get Download URLs
    GET

    downloads

    Returns one-time short-lived download URLs to download Outputs. The Outputs are specified by the client provided outputIds query string parameter.

    Resource Information

    Method and URI
    GET
    https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/downloads
    Authentication Context
    user context required
    Required OAuth Scopes
    data:read data:write data:create account:read
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is obtained via a three-legged OAuth flow.
    * Required

    Request

    Query String Parameters

    accessType*
    enum:string
    The type of integration or service used to determine access context. Possible values: ACC, BIM360, FUSION, CONTENTCATALOG, BRIDGE, PUBLIC
    accessId*
    string
    A composite string of identifiers that define the access scope for the given access type.
    outputIds*
    array: string: uuid
    * Required

    Response

    HTTP Status Code Summary

    200
    OK
    The URLs to download Outputs were retrieved successfully.
    400
    Bad Request
    The server could not process your request. It is likely due to incorrect formatting or missing information. The response body may indicate what is wrong. Please review and resubmit your request.
    401
    Unauthorized
    The supplied authorization header was invalid or the token scope was not acceptable. Verify your authentication credentials and try again.
    403
    Forbidden
    The request was valid but lacked the necessary permissions. Verify your credentials and permissions before sending the request again.
    429
    Too Many Requests
    The server has received too many requests within the allowed time window. Please wait before retrying.
    500
    Internal Server Error
    An unexpected error occurred on the server. Please try again later.

    Response

    Body Structure (200)

    Expand all
    results
    array: object
    accessType
    enum:string
    The type of integration or service used to determine access context. Possible values: ACC, BIM360, FUSION, CONTENTCATALOG, BRIDGE, PUBLIC
    accessId
    string
    A composite string of identifiers that define the access scope for the given access type.
    outputId
    string: UUID
    The unique identifier of Output.
    downloadUrl
    string
    The one-time short lived signed URL to download the file.
    size
    int
    The size of the file in bytes.

    Example

    The URLs to download Outputs were retrieved successfully.

    Request

    curl -v 'https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/downloads?accessType=ACC&accessId=12345678-1234-1234-1234-1234567890ab|urn:adsk.wipstg:fs.folder:co.ObAD7BpLXdKZiXK_OSJBow' \
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
    

    Response

    {
      "results": [
        {
          "accessType": "ACC",
          "accessId": "",
          "outputId": "",
          "downloadUrl": "",
          "size": ""
        }
      ]
    }
    
    Show More