Request

Response

    Attribute Definitions
    GET

    v1/containers/{containerId}/properties

    Lists all the attribute definitions created to define custom attributes for a given module.

    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/properties
    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[name]
    string
    		Returns only items with the specified name. For example, filter[name]=Labor.

    Max length: 255

    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.

    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
    		Unique identifier (UUID) of the attribute definition.
    name
    string
    		Name of a attribute definition.

    Max length: 1024

    type
    enum:string
    		Type of the attribute definition. Possible values: text, multiline, richtext, options, boolean, integer, percent, currency, number, datetime
    defaultValue
    string,null
    		Default value of the attribute definition.
    position
    number
    		The position of the attribute definition as displayed in BIM 360 Cost Management.
    category
    string
    		Not relevant
    defaultVisibility
    boolean
    		A true/false flag to indicate whether this attribute should be shown in the BIM 360 Cost Management or generated documents by default.
    builtIn
    boolean
    		A true/false flag to indicate whether this is a pre-defined attribute or not.
    componentTemplateId
    string,null
    		Custom attribute belongs to the component template
    options
    array: string,object
    		List of items for an options type attribute.

    Example

    Success

    Request

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

    Response

    [
  {
    "id": "229d3420-9481-11e8-87fb-215990a8aeb3",
    "name": "Scope",
    "type": "text",
    "defaultValue": "tbd",
    "position": 0,
    "category": "pco",
    "defaultVisibility": false,
    "builtIn": true,
    "componentTemplateId": "229d3420-9481-11e8-87fb-215990a8aeb3",
    "options": [
      "Back Charge"
    ]
  }
]
    Show More