Update Document

Updates the specified document.

Resource Information

Scope documents

Deprecated scope name:   update_document
App Type Agency
Authorization Type Access token
URI /v4/documents/{documentId}?lang={lang}
HTTP Method PUT
Automation Version(s) 7.3.3

Request Information

Field or Parameter Type Required Values Description Automation Version
documentId string Yes   The document ID. 7.3.2
department string No Get All Departments The name of the department assigned with the document. 7.3.2
description string No   The description of the document. 7.3.2
status status{} No   The documet status. 7.3.2
status.text string No   The localized display text. 7.3.2
status.value string No   The value for the specified parameter. 7.3.2
lang String No   Indicates the language applied. 7.3.2

Response Information

Field Type Description Automation Version
result result{}   7.3.2
result.deletable result.deletable{} Contains permission assignments for deleting documents. 7.3.2
result.deletable.citizenRoles[] String A string array containing the citizen roles who are given the permission. Possible values are: registeredUser, licensedProfessional, owner,contact, citizenUser, recordCreator 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.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.citizenRoles[] String A string array containing the citizen roles who are given the permission. Possible values are: registeredUser, licensedProfessional, owner,contact, citizenUser, recordCreator 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.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.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. Valid values are the configured standard choice values for EDMS. 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.citizenRoles[] String A string array containing the citizen roles who are given the permission. Possible values are: registeredUser, licensedProfessional, owner,contact, citizenUser, recordCreator 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.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 request status. 7.3.2