Get All Documents for Record

Gets the documents associated with the specified record.

Resource Information

Scope	records Deprecated scope name: get_record_documents
App Type	All
Authorization Type	Access token
URI	/v4/records/{recordId}/documents?fields={fields}&lang={lang}
HTTP Method	GET
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
fields	string	No	�	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
lang	String	No	�	Indicates the language applied.	7.3.2
recordId	string	Yes	Get All Records Search Records Get My Records	The unique ID associated with a record.	7.3.2

Response Information

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.2
result.category	result.category{}	The document category. The list of category options varies depending on the document group.	7.3.2
result.category.text	string	The localized display text.	7.3.2
result.category.value	string	The value for the specified parameter.	7.3.2
result.deletable	result.deletable{}	Contains permission assignments for deleting documents.	7.3.2
result.deletable.contactAllowed	boolean	Indicates whether or not the permission is given to a contact.	7.3.2
result.deletable.deleteAllowed	boolean	Indicates whether or not the permission to delete a document is allowed.	7.3.2
result.deletable.downloadAllowed	boolean	Indicates whether or not the permission to download a document is allowed.	7.3.2
result.deletable.licensendProfessionalAllowed	boolean	Indicates whether or not the permission is given to a licensed professional.	7.3.2
result.deletable.licenseTypeRules[]	String	A string array containing the types of licensed professionals who are given the permission.	7.3.2
result.deletable.ownerAllowed	boolean	Indicates whether or not the permission is given to an owner.	7.3.2
result.deletable.recordCreatorAllowed	boolean	Indicates whether or not the permission is given to a record creator.	7.3.2
result.deletable.registeredUserAllowed	boolean	Indicates whether or not the permission is given to a registered public user.	7.3.2
result.deletable.titleViewAllowed	boolean	Indicates whether or not the permission to view a document name is allowed.	7.3.2
result.deletable.uploadAllowed	boolean	Indicates whether or not the permission to upload a document is allowed.	7.3.2
result.department	string	The name of the department where the inspector works.	7.3.2
result.description	string	The description of the record or item.	7.3.2
result.downloadable	result.downloadable{}	Contains permission assignments for downloading documents.	7.3.2
result.downloadable.contactAllowed	boolean	Indicates whether or not the permission is given to a contact.	7.3.2
result.downloadable.deleteAllowed	boolean	Indicates whether or not the permission to delete a document is allowed.	7.3.2
result.downloadable.downloadAllowed	boolean	Indicates whether or not the permission to download a document is allowed.	7.3.2
result.downloadable.licensendProfessionalAllowed	boolean	Indicates whether or not the permission is given to a licensed professional.	7.3.2
result.downloadable.licenseTypeRules[]	String	A string array containing the types of licensed professionals who are given the permission.	7.3.2
result.downloadable.ownerAllowed	boolean	Indicates whether or not the permission is given to an owner.	7.3.2
result.downloadable.recordCreatorAllowed	boolean	Indicates whether or not the permission is given to a record creator.	7.3.2
result.downloadable.registeredUserAllowed	boolean	Indicates whether or not the permission is given to a registered public user.	7.3.2
result.downloadable.titleViewAllowed	boolean	Indicates whether or not the permission to view a document name is allowed.	7.3.2
result.downloadable.uploadAllowed	boolean	Indicates whether or not the permission to upload a document is allowed.	7.3.2
result.entityId	string	The unique ID of the entity or record.	7.3.2
result.entityType	string	The type of entity.	7.3.2
result.fileName	string	The name of the file as it displays in the source location.	7.3.2
result.group	result.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.text	string	The localized display text.	7.3.2
result.group.value	string	The value for the specified parameter.	7.3.2
result.id	long	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.modifiedBy	string	The user account that last modified the document.	7.3.2
result.modifiedDate	dateTime	The date the document was last modified.	7.3.2
result.serviceProviderCode	string	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
result.size	double	The file size of the document.	7.3.2
result.source	string	The name for your agency's electronic document management system.	7.3.2
result.status	result.status{}	The documet status.	7.3.2
result.status.text	string	The localized display text.	7.3.2
result.status.value	string	The value for the specified parameter.	7.3.2
result.statusDate	dateTime	The date when the current status changed.	7.3.2
result.titleViewable	result.titleViewable{}	Contains permission assignments for viewing document names.	7.3.2
result.titleViewable.contactAllowed	boolean	Indicates whether or not the permission is given to a contact.	7.3.2
result.titleViewable.deleteAllowed	boolean	Indicates whether or not the permission to delete a document is allowed.	7.3.2
result.titleViewable.downloadAllowed	boolean	Indicates whether or not the permission to download a document is allowed.	7.3.2
result.titleViewable.licensendProfessionalAllowed	boolean	Indicates whether or not the permission is given to a licensed professional.	7.3.2
result.titleViewable.licenseTypeRules[]	String	A string array containing the types of licensed professionals who are given the permission.	7.3.2
result.titleViewable.ownerAllowed	boolean	Indicates whether or not the permission is given to an owner.	7.3.2
result.titleViewable.recordCreatorAllowed	boolean	Indicates whether or not the permission is given to a record creator.	7.3.2
result.titleViewable.registeredUserAllowed	boolean	Indicates whether or not the permission is given to a registered public user.	7.3.2
result.titleViewable.titleViewAllowed	boolean	Indicates whether or not the permission to view a document name is allowed.	7.3.2
result.titleViewable.uploadAllowed	boolean	Indicates whether or not the permission to upload a document is allowed.	7.3.2
result.type	string	The document type.	7.3.2
result.uploadedBy	string	The user who uploaded the document to the record.	7.3.2
result.uploadedDate	dateTime	The date when the document was uploaded to the record.	7.3.2
result.virtualFolders	string	This is the virtual folder for storing the attachment. With virtual folders you can organize uploaded attachments in groups	7.3.2
status	integer	The record status.	7.3.3