{"items":[{"type":"link","fsPath":"connect-apis-catalog/product-catalog/DataCleaning/index.md","metadata":{"type":"markdown"},"label":"Introduction","link":"/connect-apis-catalog/product-catalog/datacleaning","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning"},{"type":"link","fsPath":"connect-apis-catalog/product-catalog/DataCleaning/gettingStarted.md","metadata":{"type":"markdown"},"label":"Getting Started","link":"/connect-apis-catalog/product-catalog/datacleaning/gettingstarted","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/gettingstarted"},{"type":"group","label":"Product Documentation","items":[{"type":"link","fsPath":"connect-apis-catalog/product-catalog/DataCleaning/documentation/processFlow.md","metadata":{"type":"markdown"},"label":"Data Cleaning Process","link":"/connect-apis-catalog/product-catalog/datacleaning/documentation/processflow","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/documentation/processflow"},{"type":"link","fsPath":"connect-apis-catalog/product-catalog/DataCleaning/documentation/coverageAndMatchingData.md","metadata":{"type":"markdown"},"label":"Coverage and Matching Data","link":"/connect-apis-catalog/product-catalog/datacleaning/documentation/coverageandmatchingdata","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/documentation/coverageandmatchingdata"}],"expanded":"true"},{"type":"group","label":"API Documentation","items":[{"type":"link","label":"Data Cleaning","link":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning"},{"type":"group","label":"Authentication","link":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/authentication","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/authentication","items":[{"label":"Authenticate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/authentication/authenticate","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/authentication/authenticate","metadata":{"seo":{"title":"Authenticate","description":"Supply username and password to generate Authentication Token."}},"httpPath":"/authenticate"}]},{"type":"group","label":"Create and View All Jobs","link":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/create-and-view-all-jobs","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/create-and-view-all-jobs","items":[{"label":"Create Job Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/create-and-view-all-jobs/createjob","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/create-and-view-all-jobs/createjob","metadata":{"seo":{"title":"Create Job Request","description":"Enter a name for the 'Job Request' to be associated to the file going to be processed."}},"httpPath":"/dataCleaning/jobs"},{"label":"Returns all Data Cleaning Jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/create-and-view-all-jobs/getalljobs","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/create-and-view-all-jobs/getalljobs","metadata":{"seo":{"title":"Returns all Data Cleaning Jobs","description":"This endpoint can be used to retrieve all created data cleaning job requests as defined by the query parameters."}},"httpPath":"/dataCleaning/jobs"}]},{"type":"group","label":"Individual Job Management","link":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management","items":[{"label":"Returns Job by {id} number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management/getjobbyidnumber","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management/getjobbyidnumber","metadata":{"seo":{"title":"Returns Job by {id} number","description":"Returns Job by {id} number which is generated from 'Creating Job Request' stage. This endpoint is used to check the status of the job."}},"httpPath":"/dataCleaning/jobs/{id}"},{"label":"Upload a Job File with an {id}","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management/jobfileuploadwithid","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management/jobfileuploadwithid","metadata":{"seo":{"title":"Upload a Job File with an {id}","description":"Upload a Job File for processing, you need to link to the {id} number generated from the 'Job Request'."}},"httpPath":"/dataCleaning/jobs/{id}/upload"},{"label":"Update Mappings Request","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management/jobupdatemappings","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management/jobupdatemappings","metadata":{"seo":{"title":"Update Mappings Request","description":"Update the mapping of the uploaded file to match that of the header within it. You can add or remove the required number of mapping points in the Request Body."}},"httpPath":"/dataCleaning/jobs/{id}/mappings"},{"label":"Submit Job Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management/submitjobrequest","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management/submitjobrequest","metadata":{"seo":{"title":"Submit Job Request","description":"Submission of the file after mappings have been carried out. To have a successful submission a blank response body (See example) is required to be posted."}},"httpPath":"/dataCleaning/jobs/{id}/submit"},{"label":"Update Enrichments Request","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management/updatejobenrichments","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management/updatejobenrichments","metadata":{"seo":{"title":"Update Enrichments Request","description":"Detail which package of enrichment settings are to be applied to the uploaded file.<br><br> Select one of the three creditTypes to acquire the JSON Enrichment tag schema possible for that product.<br><br> Removal of Enrichment tags is possible from each creditType. Addition of Enrichment tags to a creditType is not possible beyond the maximum schema for each."}},"httpPath":"/dataCleaning/jobs/{id}/enrichments"},{"label":"Start Enrichment Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management/datacleaningjobenrich","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management/datacleaningjobenrich","metadata":{"seo":{"title":"Start Enrichment Request","description":"Commencing the Job enrichment to the uploaded file after mapping the enrichment requirements. To have a successful submission a blank response body (See example) is required to be posted.<br><br> POST 'enrich' will not commence unless the Job Status is jobMatchingComplete.<br><br>Use the GET/dataCleaning/jobs/{id} to check Status of job."}},"httpPath":"/dataCleaning/jobs/{id}/enrich"},{"label":"Returns Enriched Job File","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management/returnsenrichedjobfile","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management/returnsenrichedjobfile","metadata":{"seo":{"title":"Returns Enriched Job File","description":"Returns the enriched file after enrichment is complete. Identify the file type to be returned via the query parameter."}},"httpPath":"/dataCleaning/jobs/{id}/enrichedFile"},{"label":"Archive Job by id","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management/archivejob","routeSlug":"/connect-apis-catalog/product-catalog/datacleaning/datacleaning/individual-job-management/archivejob","metadata":{"seo":{"title":"Archive Job by id","description":"Archives the job, this can be done at any stage. To have a successful submission a blank response body (See example) is required to be posted."}},"httpPath":"/dataCleaning/jobs/{id}/archive"}]}]}]}