Create Scheduled Export of Duplicate Data Subjects

post

https://{hostname}/api/consentmanager/v1/scheduled-jobs/merge-request

Use this API to create a scheduled export of duplicate data subjects.

🗒
Things to Know

Once the scheduled export is created, you can retrieve the file using the Generate Export of Duplicate Data Subjects API.

Body Params

mergeRequestId

uuid

required

Unique identifier of the merge request

mergeRequestName

string

required

Name of the merge request which uniquely identifies the job

triggerTime

date-time

The time at which triggers the job to find duplicate Data Subjects

jobFrequency

string

enum

required

Frequency at which the job runs

Allowed:

jobStatus

string

enum

Current status of the job

Allowed:

mergeCondition

string

enum

required

Condition used to apply between Data Subject Elements when identifying duplicates

Allowed:

totalDataSubjectCount

int32

Total number of Data Subjects that match the given conditions

duplicateDataSubjectCount

int32

Number of duplicate Data Subjects found based on the specified conditions

customDataElementNames

array of strings

required

length ≥ 1

List of Data Element names for which the merge condition will be applied

customDataElementNames*

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

*/*

200OK - Successfully created scheduled export

429Too Many Requests. For more information, see API Rate Limits.