Update batch status

put

https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/global/batches/{batchId}

Updates the status of an existing batch. Only valid status transitions are accepted.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

batchId

int64

required

Body Params

Batch Upload. only except the zip which is encoded base64 and created by csv file. zip inside the zip is not supported.

base64EncodedFile

string

Base64 Encoded string of uploaded file

base64EncodedZipFile

string

Only accept base64 Encoded ZipFile

batchNumber

string

callbackUrl

string

length between 10 and 2000

^http(s)?:\/\/.*\..*$

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

string

enum

Category of dump data to upload

Allowed:

complianceRiskAgencies

string

complianceRiskAgency named it allows multiple agencies by coma separated

considerFirstRowAsHeader

boolean

Flag to consider first row as a header

created

date-time

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

customerIds

string

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

deleteExistingRecord

boolean

Flag to delete existing record from the table before insert data

description

string

length between 0 and 2000

(?s)^(?:[\t\r\n]|[^\p{C}<>])*$

string

Primary email address of the tenant

fileBody

string

String body of uploaded file

fileType

string

enum

Type of the file to upload

Allowed:

info

string

Json string to be inserted in consolidated list

organisationIds

string

Comma separated organisationIds to be ratified.

qrcodeType

string

enum

Allowed:

seqNumber

string

status

string

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

subType

string

enum

Allowed:

tenantId

int64

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

type

string

enum

Allowed:

Responses

400

Bad Request

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

404Batch not found

500Internal Server Error