Request

Response

    Attachments
    GET

    v1/containers/{containerId}/attachments

    Retrieves all of the attachments associated with an item such as a budget, contract, or cost item. You can also retrieve certain nested resources related to the returned attachments.

    Note that this endpoint is compatible with both BIM 360 and Autodesk Construction Cloud (ACC) projects.

    Resource Information

    Method and URI
    GET
    https://developer.api.autodesk.com/cost/v1/containers/:containerId/attachments
    Authentication Context
    user context required
    Required OAuth Scopes
    data:read
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is obtained via a three-legged OAuth flow.
    region
    string
    The region where the project data resides, to which this request is routed.

    This header is optional because the request is automatically routed to a target region based on the project ID or container ID. Using the header, though, can save lookup time on each API call. For information about verifying the region the data resides in, see the Working with BIM 360 Services in Different Regions section on the API Basics page.

    Possible values: EMEA, US. For the full list of supported regions, see the Regions page.

    * Required

    Request

    URI Parameters

    containerId
    string: UUID
    The ID of the cost container for the project. Each project is assigned a container that stores all of the cost data for the project.

    To find the container ID, see the Retrieve a Cost Container ID tutorial.

    In ACC projects, the container ID is the same as the project ID. To obtain a project ID, use GET projects.

    Request

    Query String Parameters

    filter[associationId]
    array: string: uuid
    The ID of the object is associated. For example, the ID of a budget, contract, or cost item. Separate multiple IDs with commas. For example, filter[associationId]=id1,id2.
    filter[associationType]
    string
    The type of the item associated to. Possible values Budget, Contract, CostItem, FormDefinition, Payment, BudgetPayment, Expense, ExpenseItem. For example, filter[associationType]=Budget.
    filter[lastModifiedSince]
    string
    Returns only items that were modified since the specified date and time, in ISO 8601 format. For example, filter[lastModifiedSince]=2020-03-01T13:00:00Z.
    include
    array: string
    A list of the nested resources related to the attachment to include in the response. For example, include=complianceRequirement returns compliance documents related to each attachment. Possible values: complianceRequirement.

    Response

    HTTP Status Code Summary

    200
    OK
    Success
    400
    Bad Request
    The parameters are invalid.
    401
    Unauthorized
    The provided bearer token is invalid.
    403
    Forbidden
    Forbidden. The user or service represented by the bearer token does not have permission to perform this operation.
    404
    Not Found
    The resource or endpoint cannot be found.
    409
    Conflict
    The request could not be completed due to a conflict with the current state of the resource.
    429
    Too Many Requests
    Rate limit exceeded. Retry your request after a few minutes.
    500
    Internal Server Error
    An unexpected error occurred on the server.
    503
    Service Unavailable
    Service unavailable.

    Response

    Body Structure (200)

    id
    string: UUID
    The unique auto-generated identifier of the attachment.
    folderId
    string: UUID
    The unique identifier (UUID) of the folder named attachment-folder where the attachment is stored. This ID is automatically retrieved by the backend and returned in the response.
    urn
    string
    The object version URN of the attachment in the Autodesk Data Management service.
    pdfOssUrn
    string,null
    Not relevant
    pdfUrn
    string,null
    Not relevant
    type
    enum:string
    The type of attachment. Possible values:

    Upload: is a locally uploaded file.

    DocsFile is a file referenced from BIM 360 Docs.

    Reference is a file referenced form report.

    Document is for document generation.

    Max length: 64

    name
    string
    The name of the attachment.

    Max length: 1024

    replaceIfExists
    boolean
    Determines whether an existing attachment with a matching name should be replaced.
    status
    string
    The status of the attachment.

    Max length: 1024

    associationId
    string: UUID
    The object ID of the item associated with the actions, such as a budget, contract, or cost item.
    associationType
    enum:string
    The type of item to which it is associated. Possible values: Budget, Contract, CostItem, FormInstance, and Payment, MainContract, BudgetPayment, Expense, ExpenseItem, OCO, SCO, DistributionItem in the coming release.
    createdAt
    datetime: ISO 8601
    The date and time that the item was created, in ISO 8601 format.
    updatedAt
    datetime: ISO 8601
    The date and time that the item was last updated, in ISO 8601 format.

    Example

    Success

    Request

    curl -v 'https://developer.api.autodesk.com/cost/v1/containers/e94b9bc8-1775-4d76-9b1d-c613e120ccff/attachments?filter[associationType]=Budget&filter[lastModifiedSince]=2020-03-01T13:00:00Z' \
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
    

    Response

    [
      {
        "id": "F2D2ED17-C763-465B-8FAB-251C5A35D42F",
        "folderId": "8E34872D-A56F-4096-B675-476F50F4EF51",
        "urn": "urn:adsk.wipprod:fs.file:vf.PMbRnoPZR2mKDhau2uw4SQ?version=1",
        "pdfOssUrn": "urn:adsk.wipprod:fs.file:vf.PMbRnoPZR2mKDhau2uw4SQ?version=1",
        "pdfUrn": "urn:adsk.wipprod:fs.file:vf.PMbRnoPZR2mKDhau2uw4SQ?version=1",
        "type": "Upload",
        "name": "Architecture",
        "replaceIfExists": true,
        "status": "Pending",
        "associationId": "EDC42DF6-277A-436A-A50D-EF57F35E1248",
        "associationType": "Budget",
        "createdAt": "2019-01-06T01:24:22.678Z",
        "updatedAt": "2019-09-05T01:00:12.989Z"
      }
    ]
    
    Show More