Get All Documents for Inspection

Gets a list of documents for the specified inspection.

Resource Information

Scopeinspections

Deprecated scope name:   get_inspection_documents

App TypeAll
Authorization TypeAccess token
URI /v4/inspections/{inspectionId}/documents?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.categoryresult.category{}The document category. The list of category options varies depending on the document group.7.3.2
result.category.textstringThe localized display text.7.3.2
result.category.valuestringThe value for the specified parameter.7.3.2
result.deletableresult.deletable{}Contains permission assignments for deleting documents.7.3.2
result.deletable.contactAllowedbooleanIndicates whether or not the permission is given to a contact.7.3.2
result.deletable.deleteAllowedbooleanIndicates whether or not the permission to delete a document is allowed.7.3.2
result.deletable.downloadAllowedbooleanIndicates whether or not the permission to download a document is allowed.7.3.2
result.deletable.licensendProfessionalAllowedbooleanIndicates whether or not the permission is given to a licensed professional.7.3.2
result.deletable.licenseTypeRules[]StringA string array containing the types of licensed professionals who are given the permission.7.3.2
result.deletable.ownerAllowedbooleanIndicates whether or not the permission is given to an owner.7.3.2
result.deletable.recordCreatorAllowedbooleanIndicates whether or not the permission is given to a record creator.7.3.2
result.deletable.registeredUserAllowedbooleanIndicates whether or not the permission is given to a registered public user.7.3.2
result.deletable.titleViewAllowedbooleanIndicates whether or not the permission to view a document name is allowed.7.3.2
result.deletable.uploadAllowedbooleanIndicates whether or not the permission to upload a document is allowed.7.3.2
result.departmentstringThe name of the department where the inspector works. 7.3.2
result.descriptionstringThe description of the record or item.7.3.2
result.downloadableresult.downloadable{}Contains permission assignments for downloading documents.7.3.2
result.downloadable.contactAllowedbooleanIndicates whether or not the permission is given to a contact.7.3.2
result.downloadable.deleteAllowedbooleanIndicates whether or not the permission to delete a document is allowed.7.3.2
result.downloadable.downloadAllowedbooleanIndicates whether or not the permission to download a document is allowed.7.3.2
result.downloadable.licensendProfessionalAllowedbooleanIndicates whether or not the permission is given to a licensed professional.7.3.2
result.downloadable.licenseTypeRules[]StringA string array containing the types of licensed professionals who are given the permission.7.3.2
result.downloadable.ownerAllowedbooleanIndicates whether or not the permission is given to an owner.7.3.2
result.downloadable.recordCreatorAllowedbooleanIndicates whether or not the permission is given to a record creator.7.3.2
result.downloadable.registeredUserAllowedbooleanIndicates whether or not the permission is given to a registered public user.7.3.2
result.downloadable.titleViewAllowedbooleanIndicates whether or not the permission to view a document name is allowed.7.3.2
result.downloadable.uploadAllowedbooleanIndicates whether or not the permission to upload a document is allowed.7.3.2
result.entityIdstringThe unique ID of the entity or record.7.3.2
result.entityTypestringThe type of entity.7.3.2
result.fileNamestringThe name of the file as it displays in the source location.7.3.2
result.groupresult.group{}The document group which allows agencies to organize the different types of documents that users might need to add to certain applications.7.3.2
result.group.textstringThe localized display text.7.3.2
result.group.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.modifiedBystringThe user account that last modified the document.7.3.2
result.modifiedDatedateTimeThe date the document was last modified.7.3.2
result.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.sizedoubleThe file size of the document. 7.3.2
result.sourcestringThe name for your agency's electronic document management system.7.3.2
result.statusresult.status{}The documet status.7.3.2
result.status.textstringThe localized display text.7.3.2
result.status.valuestringThe value for the specified parameter.7.3.2
result.statusDatedateTimeThe date when the current status changed.7.3.2
result.titleViewableresult.titleViewable{}Contains permission assignments for viewing document names.7.3.2
result.titleViewable.contactAllowedbooleanIndicates whether or not the permission is given to a contact.7.3.2
result.titleViewable.deleteAllowedbooleanIndicates whether or not the permission to delete a document is allowed.7.3.2
result.titleViewable.downloadAllowedbooleanIndicates whether or not the permission to download a document is allowed.7.3.2
result.titleViewable.licensendProfessionalAllowedbooleanIndicates whether or not the permission is given to a licensed professional.7.3.2
result.titleViewable.licenseTypeRules[]StringA string array containing the types of licensed professionals who are given the permission.7.3.2
result.titleViewable.ownerAllowedbooleanIndicates whether or not the permission is given to an owner.7.3.2
result.titleViewable.recordCreatorAllowedbooleanIndicates whether or not the permission is given to a record creator.7.3.2
result.titleViewable.registeredUserAllowedbooleanIndicates whether or not the permission is given to a registered public user.7.3.2
result.titleViewable.titleViewAllowedbooleanIndicates whether or not the permission to view a document name is allowed.7.3.2
result.titleViewable.uploadAllowedbooleanIndicates whether or not the permission to upload a document is allowed.7.3.2
result.typestringThe document type.7.3.2
result.uploadedBystringThe user who uploaded the document to the record.7.3.2
result.uploadedDatedateTimeThe date when the document was uploaded to the record.7.3.2
result.virtualFoldersstringThis is the virtual folder for storing the attachment. With virtual folders you can organize uploaded attachments in groups7.3.2
statusintegerThe record status.7.3.3