Attach Document Report

Attaches a document report to the specified record. A third party document review application can use the Attach Document Report to send a document report such as a correction notice to Automation. To specify the document to be attached, use the HTTP headers "Content-Type:multipart/form-data" and "Content-Disposition:form-data". For the form-data, use the name="uploadedFile" parameter to specify the "filename=", and name="fileInfo" to specify the file attributes. "fileInfo" is a string containing an array of "serviceProviderCode", "fileName", "type", and "description" properties. See the example for details.

Resource Information


Deprecated scope name:   create_documentreview_records_documents

App TypeAgency
Authorization TypeAccess token
URI /v4/documentReview/records/{recordId}/documents?lang={lang}
Automation Version(s)

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
langStringNoIndicates the language applied.7.3.2
recordIdstringYes Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2


Sample Request Head


Sample Request Body

Content-Type: multipart/form-data; boundary=---------------------------7de1a0c22082

-----------------------------7de1a0c22082  (file content)
Content-Disposition: form-data; name="uploadedFile"; filename="summaryReport.pdf"
Content-Type: text/plain

-----------------------------7de1a0c22082  (file attribute)
Content-Disposition: form-data; name="fileInfo"
        "serviceProviderCode": "BPTDEV",
        "fileName": " summaryReport.pdf",
        "type": "text/plain",
        "description": "Upload a report with file info unit testing"

Response Information

FieldTypeDescriptionAutomation Version
result.codestringA code identifying an associated item7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.isSuccessbooleanIndicates whether or not the operation on the item is successful. 7.3.2
result.messagestringA text message related to the operation.7.3.2
statusintegerThe record status.7.3.3


Sample Response Body

  "status": 200,
  "result": [
      "id": 37174