Overview

Infrastructure APIs provide common functionality that is needed across multiple products; for example uploading entities in bulk, bulk downloads, etc.

Infrastructure API for bulk upload is essentially a delegating API, which does some groundwork and then delegates to an actual product specific API. The actual work is done by a more product specific API.

The Bulk Upload end points provided by the Infrastructure API are currently being used (via UI) for uploading publisher sites, publisher ad tags, channel partner domains, placements, F-cap and i-cap settings, publisher blocklist, channel partner domain deletion, campaign blocklist and whitelist etc. 

The Bulk upload API operation itself is asynchronous (meaning you don't see results immediately). The following four APIs have been provided to upload and check status:

Methods

Method Path HTTP Method Type Description Link to Definition

/infrastructure/bulkOperations

POST

This API gives the functionality of providing the bulk operations on APIs using supported multi-part request formats.

This method submits the file to the uploader process. (At this point processing has not completed.)

Bulk Upload

/infrastructure/bulkOperations/

 

GET

Get the list of bulk operations as per the criteria given in request.

This API can be used to check the status for a job that was submitted earlier.

Get all Bulk Uploads

/infrastructure/bulkOperations/{id}/failedRecords

GET

Once a job completes following APIs can be used to fetch records that went through and records which did not because of validation errors.

This method gets the file of failed records.

Get failed records
/infrastructure/bulkOperations/{id}/successfulRecords GET

Once a job completes following APIs can be used to fetch records that went through and records which did not because of validation errors.

This method gets the file of successful records.

Get successful records