Update Custom Tables for Checklist Item

Updates a custom table for the specified checklist item.

Resource Information

Scopeinspections

Deprecated scope name:   update_inspection_checklist_item_customtables

App TypeAgency
Authorization TypeAccess token
URI /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables?lang={lang}&fields={fields}
HTTP MethodPUT
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
langStringNo Indicates the language applied.7.3.2
[]arrayYes Array containing the custom table(s).7.3.2
idstringYes The unique identifier for the custom table to be modified or added.7.3.2
rows[]rows{}No Contains the table rows.7.3.2
rows.actionstringYesadd | update | delete Specifies whether to add, update, or delete the custom table row.7.3.2
rows.fieldsrows.fields{}Yes Contains fields and their attributes. Required only if adding or modifying a row.7.3.2
rows.fields.<customType>stringYes A 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
rows.idstringYes The unique identifier for the custom field. Required only if modifying or deleting a row.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.codestringA code identifying an associated item7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.isSuccessbooleanIndicates whether or not the operation on the item is successful. 7.3.2
result.messagestringA text message related to the operation.7.3.2
statusintegerThe record status.7.3.2