containers/{containerId}/issue-attribute-mappings

Retrieves information about the issue custom attributes that are assigned to issue categories and issue types.

Note that by default, this endpoint only retrieves custom attributes that were directly assigned to the issue category or issue type. It does not retrieve inherited custom attributes.

Note that this endpoint is ONLY compatible with BIM 360 projects. It is not compatible with Autodesk Construction Cloud (ACC) projects. For more information about compatibility between between BIM 360 and ACC, see the Compatibility section.

Resource Information

Method and URI	GET https://developer.api.autodesk.com/issues/v2/containers/:containerId/issue-attribute-mappings
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.

* Required

Request

URI Parameters

containerId string	The ID of the container. Each project is assigned to a container that stores all the issues for the project. Use the Data Management API to retrieve the container ID. For more information, see the Retrieve Issues Container ID tutorial.

containerId

string

The ID of the container.

Each project is assigned to a container that stores all the issues for the project.

Use the Data Management API to retrieve the container ID. For more information, see the Retrieve Issues Container ID tutorial.

Request

Query String Parameters

limit int	The number of custom attribute mappings to return in the response payload. For example, `limit=2`. Acceptable values: `1-200`. Default value: `200`.
offset int	The number of custom attribute mappings you want to begin retrieving results from.
filter[createdAt] datetime: ISO 8601	Retrieves items that were last created at the specified date and time range, in one of the following URL-encoded formats: YYYY-MM-DDThh:mm:ss.sz or YYYY-MM-DD. Separate multiple values with commas. We support the following filtering options: Date range: e.g., `2022-03-02..2022-03-03` or `2022-02-28T22:00:00.000Z..2022-03-28T22:00:00.000Z` Specific day: e.g., `2022-03-02` or `2022-02-28T22:00:00.000Z` Specific start date: e.g., `2022-03-02..` or `2022-02-28T22:00:00.000Z..` Specific end date: e.g., `..2022-03-02` or `..2022-02-28T22:00:00.000Z` For more details, see JSON API Filtering.
filter[updatedAt] datetime: ISO 8601	Retrieves items that were last updated at the specified date and time range, in one of the following URL-encoded formats: YYYY-MM-DDThh:mm:ss.sz or YYYY-MM-DD. Separate multiple values with commas. We support the following filtering options: Date range: e.g., `2022-03-02..2022-03-03` or `2022-02-28T22:00:00.000Z..2022-03-28T22:00:00.000Z` Specific day: e.g., `2022-03-02` or `2022-02-28T22:00:00.000Z` Specific start date: e.g., `2022-03-02..` or `2022-02-28T22:00:00.000Z..` Specific end date: e.g., `..2022-03-02` or `..2022-02-28T22:00:00.000Z` For more details, see JSON API Filtering.
filter[deletedAt] datetime: ISO 8601	Retrieves items that were last deleted at the specified date and time range, in one of the following URL-encoded formats: YYYY-MM-DDThh:mm:ss.sz or YYYY-MM-DD. Separate multiple values with commas. We support the following filtering options: Date range: e.g., `2022-03-02..2022-03-03` or `2022-02-28T22:00:00.000Z..2022-03-28T22:00:00.000Z` Specific day: e.g., `2022-03-02` or `2022-02-28T22:00:00.000Z` Specific start date: e.g., `2022-03-02..` or `2022-02-28T22:00:00.000Z..` Specific end date: e.g., `..2022-03-02` or `..2022-02-28T22:00:00.000Z` To include non-deleted items in the response, add `null` to the filter: `filter[deletedAt]=null,YYYY-MM-DDThh:mm:ss.sz..YYYY-MM-DDThh:mm:ss.sz`. For more details, see JSON API Filtering.
filter[attributeDefinitionId] string	Retrieves issue custom attribute mappings associated with the specified issue custom attribute definitions. Separate multiple values with commas. For example: `filter[attributeDefinitionId]=18ee5858-cbf1-451a-a525-7c6ff8156775`.
filter[mappedItemId] string	Retrieves issue custom attribute mappings associated with the specified items (container, type, or subtype). Separate multiple values with commas. For example: `filter[mappedItemId]=18ee5858-cbf1-451a-a525-7c6ff8156775`.
filter[isRequired] string	Retrieves issue custom attribute mappings associated with custom attributes that are either required or not required. Possible values: `true`, `false`. For example: `filter[isRequired]=true`.

Response

HTTP Status Code Summary

200 OK	List of issue attribute mappings
400 Bad Request	Invalid input
401 Unauthorized	The supplied Authorization header was not valid. Verify Authentication and try again
403 Forbidden	The request was successfully validated but permission is not granted
404 Not Found	Container not found

Response

Body Structure (200)

Expand all

pagination object	The pagination object.
limit int	The number of items per page.
offset int	The page number that the results begin from.
totalResults int	The number of items in the response.
results array: object	A list of issue attribute mappings.
id string: UUID	The ID of the custom attribute mapping.
containerId string: UUID	The ID of the container.
attributeDefinitionId string: UUID	The ID of the custom attribute definition.
mappedItemType enum:string	The type of item the custom attribute is mapped to. Possible values: `issueType` - this corresponds to `Issue Category` in the UI. `issueSubtype` - this corresponds to `Issue Type` in the UI. Note that `issueSubtype`'s inherit `issueType`'s.
mappedItemId string: UUID	The ID of the item (type, or subtype) the custom attribute is mapped to.
order int	The order that the custom attributes were mapped to the item (type, subtype). This is only relevant to non-inherited mappings.
isRequired boolean	Not relevant
permittedActions array: string	Not relevant
permittedAttributes array: string	Not relevant
createdAt datetime: ISO 8601	The date and time the custom attribute mapping was created, in the following format: YYYY-MM-DDThh:mm:ss.sz.
createdBy string	The Autodesk ID of the user who created the custom attribute mapping.
updatedAt datetime: ISO 8601	The last date and time the custom attribute mapping was updated, in the following format: YYYY-MM-DDThh:mm:ss.sz.
updatedBy string	The Autodesk ID of the user who last updated the custom attribute mapping.
deletedAt datetime: ISO 8601	The date and time the custom attribute mapping was deleted, in the following format: YYYY-MM-DDThh:mm:ss.sz.
deletedBy string	The Autodesk ID of the user who deleted the custom attribute mapping.

Example

List of issue attribute mappings

Request

curl -v 'https://developer.api.autodesk.com/issues/v2/containers/a5f49f04-59bb-477c-97e6-6833cb50bdac/issue-attribute-mappings?filter[attributeDefinitionId]=18ee5858-cbf1-451a-a525-7c6ff8156775&filter[mappedItemId]=18ee5858-cbf1-451a-a525-7c6ff81567aa&filter[isRequired]=true' \
  -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'

Response

{
  "pagination": {
    "limit": 10,
    "offset": 100,
    "totalResults": 25
  },
  "results": [
    {
      "id": "1110f111-6c54-4b01-90e6-d701748f1111",
      "containerId": "2220f222-6c54-4b01-90e6-d701748f0222",
      "attributeDefinitionId": "1110f111-6c54-4b01-90e6-d701748f1333",
      "mappedItemType": "issueType",
      "mappedItemId": "2220f222-6c54-4b01-90e6-d701748f0222",
      "order": 2,
      "isRequired": false,
      "permittedActions": [
        "delete"
      ],
      "permittedAttributes": [
        "isRequired"
      ],
      "createdAt": "2018-07-22T15:05:58.033Z",
      "createdBy": "A3RGM375QTZ7",
      "updatedAt": "2018-07-22T15:05:58.033Z",
      "updatedBy": "A3RGM375QTZ7",
      "deletedAt": "2018-07-22T15:05:58.033Z",
      "deletedBy": "A3RGM375QTZ7"
    }
  ]
}
Show More

Request

Response

Jump To

containers/{containerId}/issue-attribute-mappings

Resource Information

Request

Headers

Request

URI Parameters

Request

Query String Parameters

Response

HTTP Status Code Summary

Response

Body Structure (200)

Example

Request

Response