Get All Checklists for Inspection

Gets the checklists for the specified inspection.

Resource Information

Scopeinspections

Deprecated scope name:   get_inspection_checklists

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

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
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.checklistAssociationresult.checklistAssociation{}The information associated with the checklist.7.3.2
result.checklistDescstringThe description text.7.3.2
result.checklistStatusstringThe status of the checklist7.3.2
result.customIdstringAn 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
result.defaultOrderBystringThe field by which the checklist items are ordered by default.7.3.2
result.entityTypestringThe type of entity.7.3.2
result.groupstringThe inspection checklist group.7.3.2
result.guideTyperesult.guideType{}The inspection guidesheet type7.3.2
result.guideType.textstringThe localized display text.7.3.2
result.guideType.valuestringThe value for the specified parameter.7.3.2
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.inspectionIdstringThe unique ID associated with the inspection.7.3.2
result.isRequiredstringIndicates whether or not the information is required. 7.3.2
result.items[]result.items{}Contains the checklist items for this checklist.7.3.2
result.items.checkliststringThe name of a checklist.7.3.2
result.items.checklistIdlongThe unique ID associated with the checklist.7.3.2
result.items.checklistItemresult.items.checklistItem{}An item in the checklist.7.3.2
result.items.checklistItem.textstringThe localized display text.7.3.2
result.items.checklistItem.valuestringThe value for the specified parameter.7.3.2
result.items.commentresult.items.comment{}Comments or notes about the current context.7.3.2
result.items.comment.textstringThe localized display text.7.3.2
result.items.comment.valuestringThe value for the specified parameter.7.3.2
result.items.customIdstringAn 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
result.items.displayOrderlongThe order of the item in comparison to the other items.7.3.2
result.items.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.items.isCriticalstringIndicates whether or not the checklist item is critical.7.3.2
result.items.isMajorViolationstringIndicates whether or not the checklist item is a major violation.7.3.2
result.items.scorelongThe score for a checklist or checklist item.7.3.2
result.items.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.items.statusresult.items.status{}The checklist item status.7.3.2
result.items.status.textstringThe localized display text.7.3.2
result.items.status.valuestringThe value for the specified parameter.7.3.2
result.recordIdresult.recordId{}The unique ID associated with a record.7.3.2
result.recordId.customIdstringAn 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
result.recordId.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.recordId.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.recordId.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
result.recordId.valuestringThe value for the specified parameter.7.3.2
result.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
statusintegerThe record status.7.3.3