Synchronization finalization request format

Starting with Collibra version 2022.08, the finalizationParameters is deprecated and replaced with missingAssetStatusId.

The finalization step calls /import/synchronize/<synchronization_id>/finalize/job and has finalizationStrategy and finalizationParameters as optional parameters.

When you set the finalizationStrategy to CHANGE_STATUS, you must also provide a value for finalizationParameters.

Curl

To call the finalization step using curl, add the finalizationParameters field as JSON with an application/json content type appended to the end, for example:

curl \
  -X POST \
  -u <your_credentials> \
  -H  'content-type: multipart/form-data' \
  -H  'accept: application/json' \
  https://<your_collibra_platform_url>/rest/2.0/import/synchronize/<synchronization_id>/finalize/job \
  -F 'finalizationStrategy=CHANGE_STATUS' \
  -F 'finalizationParameters={ "STATUS_ID": "00000000-0000-0000-0000-000000005066" };type=application/json'

Postman

  1. Create a JSON file with the finalizationParameters, for example:
    {
        ​"STATUS_ID": "00000000-0000-0000-0000-000000005066"
    }
  2. Change the input type of the finalizationParameters to File and select the JSON file that you created:

Java

To call the finalization step in Java use dgcClient to make the REST API calls, for example:

import static com.collibra.dgc.configuration.core.model.ResourceIDConstants.META_STATUS_MISSING_FROM_SOURCE;
import com.collibra.dgc.importer.api.request.SynchronizationFinalizationRequest;
public class SynchronizationFinalizationTest extends AbstractSynchronizationFunctionalTest {
	SynchronizationFinalizationRequest synchronizationFinalizationRequest = SynchronizationFinalizationRequest.builder()
		.synchronizationId(synchronizationId)
		.saveResult(false)
		.finalizationStrategy("CHANGE_STATUS")
		.addFinalizationParameter(
			SynchronizationFinalizationRequest.SynchronizationFinalizationRequestBuilder.CustomFinalizationParameter.STATUS_ID,
			META_STATUS_MISSING_FROM_SOURCE
		)
		.build();
	Job job = dgcClient.importer().synchronizeFinalizationInJob(synchronizationFinalizationRequest);
}