Create Checklist Item Documents

Saves the document for the specified checklist item.

Resource Information

Scopeinspections

Deprecated scope name:   create_inspection_checklist_item_document

App TypeAgency
Authorization TypeAccess token
URI /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checklistItemId}/documents?lang={lang}&userId={userId}&password={password}
HTTP MethodPOST
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
categorystringNo The document category. The list of category options varies depending on the document group.7.3.2
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
groupstringNo The group query parameter.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
passwordstringNo The password related to the operation.7.3.2
userIdstringNo The users login ID for the Accela Civic Platform, created by agency administrators.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.3