v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB

b) Tenant Configuration & Onboarding

Upload a batch file for the tenant

Accepts a base64-encoded ZIP file containing a single CSV, processes the batch, and returns the batch record.

post/eclipse-conductor/rest/v1/tenants/{tenantId}/batches

Path parameters

tenantIdinteger required

Request body

base64EncodedFilestring

Base64 Encoded string of uploaded file

base64EncodedZipFilestring

Only accept base64 Encoded ZipFile

batchNumberstring

callbackUrlstring

Eclipse just Post the Eclipse Batch Object to URL. Optional as one can always do a GET to get the result instead of using callbacks. This will be a system-system call

category'CUSTOMER' | 'ORGANISATION'

complianceRiskAgenciesstring

complianceRiskAgency named it allows multiple agencies by coma separated

considerFirstRowAsHeaderboolean

Flag to consider first row as a header

createdstring date-time

ISO 8601 date/time of when the record was first created

customerIdsstring

For ratify batch, represent comma separated user Ids OR sql query to retrieve user Ids for example select user_id from user where [condition].

deleteExistingRecordboolean

Flag to delete existing record from the table before insert data

descriptionstring

emailstring

Primary email address of the tenant

fileBodystring

String body of uploaded file

fileType'CSV' | 'EXCEL' | 'JSON'

infostring

Json string to be inserted in consolidated list

organisationIdsstring

Comma separated organisationIds to be ratified.

qrcodeType'EXTERNAL_REF' | 'RANDOM_10' | 'ZA_MASTERPASS'

seqNumberstring

statusstring

String to update the status of batch, Only supported AVAILABLE and CLOSED status for type PRODUCT_BATCH

subType'COMPLIANCE' | 'OCR' | 'OCR_WITH_COMPLIANCE' | 'PHYSICAL'

tenantIdinteger

Tenant Id. This is mandatory unless running ratify batch with customerIds

Example request

{
  "created": "2022-03-10T12:15:50-04:00"
}

Response

infostring