Create Inspection Checklist

Creates a checklist for the specified inspections.

Resource Information

Scopeinspections

Deprecated scope name:   create_inspection_checklists

App TypeAgency
Authorization TypeAccess token
URI /v4/inspections/{inspectionId}/checklists?lang={lang}
HTTP MethodPOST
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
checklistAssociationchecklistAssociation{}No�The information associated with the checklist.7.3.2
checklistDescstringNo�The description text.7.3.2
checklistStatusstringNo Get Inspection Checklist Statuses Get All Statuses for Checklist Item The status of the checklist7.3.2
customIdstringNo�An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.7.3.2
defaultOrderBystringNo�The field by which the checklist items are ordered by default.7.3.2
entityTypestringNo�The type of entity.7.3.2
groupstringNo�The inspection checklist group.7.3.2
guideTypeguideType{}No�The inspection guidesheet type7.3.2
guideType.textstringNo�The localized display text.7.3.2
guideType.valuestringNo�The value for the specified parameter.7.3.2
idlongNo�The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
inspectionIdstringNo Get All Inspections Search Inspections The unique ID associated with the inspection.7.3.2
isRequiredstringNoY | NIndicates whether or not the information is required. 7.3.2
items[]items{}No�Contains the checklist items for this checklist.7.3.2
items.checkliststringNo�The name of a checklist.7.3.2
items.checklistIdlongNo Get All Inspection Checklists Get All Checklists for Inspection The unique ID associated with the checklist.7.3.2
items.checklistItemitems.checklistItem{}No�An item in the checklist.7.3.2
items.checklistItem.textstringNo�The localized display text.7.3.2
items.checklistItem.valuestringNo�The value for the specified parameter.7.3.2
items.commentitems.comment{}No�Comments or notes about the current context.7.3.2
items.comment.textstringNo�The localized display text.7.3.2
items.comment.valuestringNo�The value for the specified parameter.7.3.2
items.customIdstringNo�An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.7.3.2
items.displayOrderlongNo�The order of the item in comparison to the other items.7.3.2
items.idlongNo�The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
items.isCriticalstringNoY | NIndicates whether or not the checklist item is critical.7.3.2
items.isMajorViolationstringNoY | NIndicates whether or not the checklist item is a major violation.7.3.2
items.scorelongNo�The score for a checklist or checklist item.7.3.2
items.serviceProviderCodestringNo�The unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
items.statusitems.status{}No Get Inspection Checklist Statuses The checklist item status.7.3.2
items.status.textstringNo�The localized display text.7.3.2
items.status.valuestringNo�The value for the specified parameter.7.3.2
recordIdrecordId{}No Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2
recordId.customIdstringNo�An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.7.3.2
recordId.idstringNo�The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
recordId.serviceProviderCodestringNo�The unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
recordId.trackingIdlongNo�The application tracking number (IVR tracking number).7.3.2
recordId.valuestringNo�The value for the specified parameter.7.3.2
serviceProviderCodestringNo�The unique agency identifier, the system assigns, on the Accela Civic Platform.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.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