projects/{projectId}/issue-attribute-mappings
Retrieves information about the issue custom attributes (custom fields) that are assigned to issue categories and issue types.
We do not currently support adding custom fields to issues. For information about adding custom fields to issues categories and types, see the help documentation.
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.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/construction/issues/v1/projects/:projectId/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. |
x-ads-region string | The region to which your request should be routed. If not set, the request is routed automatically but may incur a small latency increase.
Possible values: For the full list of supported regions, see the Regions page. |
Request
URI Parameters
projectId string: UUID | The ID of the project.
Use the Data Management API to retrieve the project ID. For more information, see the Retrieve a Project ID tutorial. You need to convert the project ID into a project ID for the ACC API by removing the “b." prefix. For example, a project ID of b.a4be0c34a-4ab7 translates to a project ID of a4be0c34a-4ab7. |
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 created at the specified date and time, 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:
For more details, see JSON API Filtering. |
filter[updatedAt] datetime: ISO 8601 | Retrieves items that were last updated at the specified date and time, 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:
For more details, see JSON API Filtering. |
filter[deletedAt] datetime: ISO 8601 | Retrieves types that were deleted at the specified date and time, 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:
To include non-deleted items in the response, add 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 (project, type, or subtype). Separate multiple values with commas. For example: filter[mappedItemId]=18ee5858-cbf1-451a-a525-7c6ff8156775 . Note that this does not retrieve inherited custom attribute mappings or custom attribute mappings of descendants. |
Response
HTTP Status Code Summary
200 OK | List of issue attribute mappings |
400 Bad Request | Invalid input |
403 Forbidden | Unauthorized |
404 Not Found | Project not found |
500 Internal Server Error | Internal server error |
Response
Body Structure (200)
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. |
attributeDefinitionId string: UUID | The ID of the custom attribute definition. |
containerId string: UUID | Not relevant |
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. |
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/construction/issues/v1/projects/:projectId/issue-attribute-mappings' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 10,
"offset": 100,
"totalResults": 25
},
"results": [
{
"id": "1110f111-6c54-4b01-90e6-d701748f1111",
"attributeDefinitionId": "1110f111-6c54-4b01-90e6-d701748f1333",
"containerId": "2220f222-6c54-4b01-90e6-d701748f0222",
"mappedItemType": "issueType",
"mappedItemId": "2220f222-6c54-4b01-90e6-d701748f0222",
"order": 2,
"permittedActions": [
"delete"
],
"permittedAttributes": [
""
],
"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"
}
]
}