Retrieve Record Merge Results

GET https://{{vaultDNS}}/api/{{version}}/vobjects/merges/:{job_id}/results

Given a job_id for a merge records job, retrieve the job results.

Before submitting this request:

• You must have previously requested a record merge job which is no longer IN_PROGRESS

• You must have a valid job_id field value returned from the record merge operation

Response

The response contains a JSON object with the following structure:

{
    "responseStatus": "",
    "data": {
        "merge_sets": [
            {
                "duplicate_record_id": "",
                "main_record_id": "",
                "status": "",
                "error": {
                    "type": "",
                    "message": ""
                }
            }
        ]
    }
}

• responseStatus (string): The status of the response.
• merge_sets (array): An array of merge sets, each containing the following properties:
  • duplicate_record_id (string): The ID of the duplicate record.
  • main_record_id (string): The ID of the main record.
  • status (string): The status of the merge operation.
    • INVALID_DATA: The merge was not attempted
    • PROCESSING_ERROR: The merge was attempted, but failed during processing
  • error (object): An object containing error details, with the following properties:
    • type (string): The type of error.
    • message (string): The error message.

HEADERS