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{}NoThe information associated with the checklist.7.3.2
checklistDescstringNoThe description text.7.3.2
checklistStatusstringNo Get Inspection Checklist Statuses Get All Statuses for Checklist Item The status of the checklist7.3.2
customIdstringNoAn 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
defaultOrderBystringNoThe field by which the checklist items are ordered by default.7.3.2
entityTypestringNoThe type of entity.7.3.2
groupstringNoThe inspection checklist group.7.3.2
guideTypeguideType{}NoThe inspection guidesheet type7.3.2
guideType.textstringNoThe localized display text.7.3.2
guideType.valuestringNoThe value for the specified parameter.7.3.2
idlongNoThe 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{}NoContains the checklist items for this checklist.7.3.2
items.checkliststringNoThe 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{}NoAn item in the checklist.7.3.2
items.checklistItem.textstringNoThe localized display text.7.3.2
items.checklistItem.valuestringNoThe value for the specified parameter.7.3.2
items.commentitems.comment{}NoComments or notes about the current context.7.3.2
items.comment.textstringNoThe localized display text.7.3.2
items.comment.valuestringNoThe value for the specified parameter.7.3.2
items.customIdstringNoAn 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.displayOrderlongNoThe order of the item in comparison to the other items.7.3.2
items.idlongNoThe 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.scorelongNoThe score for a checklist or checklist item.7.3.2
items.serviceProviderCodestringNoThe 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.textstringNoThe localized display text.7.3.2
items.status.valuestringNoThe 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.customIdstringNoAn 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.idstringNoThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
recordId.serviceProviderCodestringNoThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
recordId.trackingIdlongNoThe application tracking number (IVR tracking number).7.3.2
recordId.valuestringNoThe value for the specified parameter.7.3.2
serviceProviderCodestringNoThe 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
langStringNoIndicates 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