Document Process Output

Output representation of the document process creation or update request.

Response body example for POST

1{
2  "isSuccess": true,
3  "message": "Account record was created.",
4  "objectFieldList": {
5    "objectFieldList": [
6      {
7        "fieldName": "Name",
8        "fieldValue": "Robert Weber"
9      },
10      {
11        "fieldName": "AccountNumber",
12        "fieldValue": "1962550079"
13      }
14    ]
15  },
16  "ocrDocumentScanResultIdList": {
17    "ocrDocumentScanResultIdList": [
18      {
19        "resultId": "0ixxx00000002t3AAA"
20      }
21    ]
22  },
23  "parentId": "001xx000003GeGFAA0"
24}

Response body example for PATCH

1{
2  "isSuccess": true,
3  "message": "Account record was updated.",
4  "objectFieldList": {
5    "objectFieldList": [
6      {
7        "fieldName": "Id",
8        "fieldValue": "001xx000003GeGFAA0"
9      },
10      {
11        "fieldName": "Name",
12        "fieldValue": "Robert Weber"
13      },
14      {
15        "fieldName": "AccountNumber",
16        "fieldValue": "1962550079"
17      }
18    ]
19  },
20  "ocrDocumentScanResultIdList": {
21    "ocrDocumentScanResultIdList": [
22      {
23        "resultId": "0ixxx00000002t3AAA"
24      }
25    ]
26  },
27  "parentId": "001xx000003GeGFAA0"
28}

Property Name	Type	Description	Filter Group and Version	Available Version
`code`	String	The code returned by the create or update API request.	Small, 55.0	55.0
`conflictFieldList`	Document Conflict Field List	The list of fields in the target object that have conflicts.	Small, 55.0	55.0
`isSuccess`	Boolean	Indicates whether the create or update request is successful (`true`) or not (`false`).	Small, 55.0	55.0
`message`	String	The message of the create or update API request.	Small, 55.0	55.0
`objectFieldList`	Object Field List	The list of fields that are created or updated in the target object record.	Small, 55.0	55.0
`ocrDocumentScanResultIdList`	OCR Document Scan Result List	The list of the OCR document scan result record IDs.	Small, 55.0	55.0
`parentId`	String	The ID of the target object in which the record is created or updated.	Small, 55.0	55.0

Industries Common Resources Developer Guide

Document Process Output