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 NameTypeDescriptionFilter Group and VersionAvailable Version
codeStringThe code returned by the create or update API request.Small, 55.055.0
conflictFieldListDocument Conflict Field ListThe list of fields in the target object that have conflicts.Small, 55.055.0
isSuccessBooleanIndicates whether the create or update request is successful (true) or not (false).Small, 55.055.0
messageStringThe message of the create or update API request.Small, 55.055.0
objectFieldListObject Field ListThe list of fields that are created or updated in the target object record.Small, 55.055.0
ocrDocumentScan​ResultIdListOCR Document Scan Result ListThe list of the OCR document scan result record IDs.Small, 55.055.0
parentIdStringThe ID of the target object in which the record is created or updated.Small, 55.055.0