Documents

Name	App Type	Scope	Auth Type	Resource URI	Civic Platform version
Download Document	All	documents	Access token	GET /v4/documents/{documentId}/download	7.3.3.2
Get Image Document Thumbnail	All	documents	Access token	GET /v4/documents/{documentId}/thumbnail	7.3.2
Get Documents	All	documents	Access token	GET /v4/documents/{documentIds}	7.3.2
Update Document	Agency	documents	Access token	PUT /v4/documents/{documentId}	7.3.3

Records/Documents

Name	App Type	Scope	Auth Type	Resource URI	Civic Platform version
Create Record Documents	All	records	Access token	POST /v4/records/{recordId}/documents	7.3.2
Delete Record Documents	All	records	Access token	DELETE /v4/records/{recordId}/documents/{documentIds}	7.3.2
Get All Document Categories for Record	All	records	Access token	GET /v4/records/{recordId}/documentCategories	7.3.2
Get All Documents for Record	All	records	Access token	GET /v4/records/{recordId}/documents	7.3.2

Inspections/Documents

Name	App Type	Scope	Auth Type	Resource URI	Civic Platform version
Create Inspection Documents	All	inspections	Access token	POST /v4/inspections/{inspectionId}/documents	7.3.2
Delete Inspection Documents	Agency	inspections	Access token	DELETE /v4/inspections/{inspectionId}/documents/{ids}	7.3.2
Get All Documents for Inspection	All	inspections	Access token	GET /v4/inspections/{inspectionId}/documents	7.3.2

Overview:

Documents

A document is any external file, including document files and image files.

Documents can be organized into "virtual folders", which belong to virtual folder groups. Virtual folder groups are configured as Standard Choices in Automation. A folder group can be associated with a record type.

Example Use Case

A user can attach a document to a checklist item that contains additional items that are related to the checklist item. The user can also choose to assign the attached document a virtual folder associated with the inspection.