projects/{projectId}/issue-attribute-definitions
Retrieves information about issue custom attributes (custom fields) for a project, including the custom attribute title, description and type.
For example, the possible values for a dropdown list, the IDs, the names and whether the attribute is visible.
Note that custom attributes are known as custom fields in the ACC UI.
For information about creating issue custom attributes for a project, see the help documentation.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/construction/issues/v1/projects/:projectId/issue-attribute-definitions |
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 definitions to return in the response payload. For example, limit=2 . Acceptable values: 1-200 . Default value: 200 . |
offset int | The number of custom attribute definitions 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[dataType] enum:string | Retrieves issue custom attribute definitions with the specified data type. Possible values: list (this corresponds to dropdown in the UI), text , paragraph , numeric . For example, filter[dataType]=text,numeric . |
Response
HTTP Status Code Summary
200 OK | List of issue attribute definitions |
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 definitions (custom fields). |
id string: UUID | The ID of the custom attribute. |
containerId string: UUID | Not relevant |
title string | The title of the custom attribute.
Max length: 100 |
description string | The description of the custom attribute.
Max length: 500 |
dataType enum:string | The type of custom attribute. Possible values: list , text , paragraph , numeric . |
metadata object | The metadata object; only relevant for list custom attributes. |
list object | The list object. |
options array: object | The options object. |
id string: UUID | The id of the list option. |
value string | The value of the list item. |
permittedActions array: string | Not relevant |
permittedAttributes array: string | Not relevant |
createdAt datetime: ISO 8601 | The date and time the custom attribute 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. |
updatedAt datetime: ISO 8601 | The last date and time the custom attribute 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. |
deletedAt datetime: ISO 8601 | The date and time the custom attribute 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. |
Example
List of issue attribute definitions
Request
curl -v 'https://developer.api.autodesk.com/construction/issues/v1/projects/:projectId/issue-attribute-definitions' \
-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",
"title": "Velocity",
"description": "How long will it take for this issue to be resolved.",
"dataType": "list",
"metadata": {
"list": {
"options": [
{
"id": "802b87e0-60f6-4b1b-9cdf-37b53c731f17",
"value": "option a"
},
{
"id": "999b77e0-60f6-4b1b-9cdf-37b53c431f22",
"value": "option b"
}
]
}
},
"permittedActions": [
"edit"
],
"permittedAttributes": [
"title"
],
"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"
}
]
}