28 Nov 2024
Form Name is exposed, new value type for table and more FAQ about Forms API
In this blog, we make a few notes about Forms API of Autodesk Construction Cloud (ACC). Some are newly added. Some are frequently asked questions.
Form Name
Form instance uses the name of template in the past. Now you can specify custom name. The endpoints of creating form or modifying form supports name in the request param. If the specified value is null or empty, it defaults to the form’s template name.
The following endpoints add name in the response:
New Value Type ((uidVal) for Worklog Column
In current document of API PUT values:batch-update, numberVal, textVal and timespanVal are available with table value of web form. One new value type uidVal was introduced for the columns of company or role. The id values come from Admin API such as GET project companies. The below is one demo payload when adding or editing a row of worklog table with the column company. We will update document accordingly(ticket FORMS-15133 to track)
{
"tabularValues": [{
"id": "41f54008-02b3-4bcb-b287-139a60a7e8e",
"table": "worklogEntries",
"columns": [
{
"columnName": "companyId",
"uidVal": "50468fac-4a40-45e3-a5c8-e8056b5d17df"
},
{
"columnName": "roleId",
"uidVal": "c5ba99b7-182d-4572-b340-d3c10a8f7923"
},
{
"columnName": "headcount",
"numberVal": 2335
}
]
}
]
}Discarded Form
It was a legacy design that Discarded forms were available with API. Now it is not supported. It is consistent to the UI behavior. From the use scenario perspective, the discard option is available for forms that you definitely wouldn’t need to view again, or ones that were created by mistake or duplicates. If the forms potentially need to be pulled back up, the recommendation is Archiving. Archived indicates such status.
Form Template
The Forms API has not supported to create template or modify template. We have wish at the internal tickets # ACSFR-4685 and # FORMS-14126 with this wish.
Update Fields of PDF Form
PUT values:batch-updat supports web form only. Currently, to edit the fields of pdf form, you would have to take advantage of other tools of 3rd party. In addition, there is not yet API to replace pdf form. This means, to create a pdf version that has new values, the workflow will count on manual replacing in ACC UI. We have the wish to ask for replacing pdf by API (ticket is # FORMS-13695)
Form Activities
No API yet with Forms API. There is one wish to ask for extracting form activities with Data Connector API (ticket is ACSFR-3469)