Get All Custom Forms for Checklist Item

Returns an array of custom forms associated with the specified record contact. Each custom form consists of custom field name-and-value pairs.

Resource Information

Scopeinspections

Deprecated scope name:   get_inspection_checklist_item_customforms

App TypeAgency
Authorization TypeAccess token
URI /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms?lang={lang}&fields={fields}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
checklistIdlongYes Get All Inspection Checklists Get All Checklists for Inspection The unique ID associated with the checklist.7.3.2
checklistItemIdlongYes Get All Checklist Items for Checklist The unique ID associated with the checklist item.7.3.2
fieldsstringNo Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.7.3.2
inspectionIdlongYes Get All Inspections Search Inspections The unique ID associated with the inspection.7.3.2
langStringNo Indicates the language applied.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.<customType>stringA custom field name and value pair. For example in JSON, "My Custom Field": "My Custom Value". The custom field name and its data type are defined in Automation custom forms or custom tables. For a Text field, the maximum length is 256. For a Number field, any numeric form is allowed, including negative numbers. For a Date field, the format is MM/dd/yyyy. For a Time field, the format is hh:mm. For a TextArea field, the maximum length is 4000 characters, and allows line return characters. For a DropdownList field, the dropdown list values are in the options[] array. For a CheckBox field, the (case-sensitive) valid values are "UNCHECKED" and "CHECKED". For a Radio(Y/N) field, the(case-sensitive) valid values are "Yes" and "No". 7.3.2
statusintegerThe record status.7.3.3