DownloadThis POST API can also be used for bulk upload data processing with a file Id and Template, same as BulkProcess API.
This will only differ in the response returned.
URL Format: https://<Instance> /leo-bulkprocess-api/api/BulkProcess/Upload
{
"FilePath": "string",
"TemplateId": "string",
"FileId": "string",
"DocumentReference": "string",
"CallbackUrl": "string",
"BulkProcessId": "string"
}
{
"statusCode": 0,
"url": "string",
"batchId": "string",
"interval": 0,
"intervalType": "string",
"receivedCount": 0
}
Success Scenario - Request
https://<Instance> /leo-bulkprocess-api/api/BulkProcess/Upload
{
"TemplateId": "ContractInvoiceExcelTemplate",
"FileId": "pXOl3gMlIO2i5n3L8Fy05rh6EnvV2rCXefNRepErb909azNyy8mIPRy7rzz1lVn8",
"DocumentReference": "newtest",
"CallbackUrl": "https://internalapi-leoaks-dev.gep.com/api/v2/BulkUploadFullItem/TriggerCallBackURL"
}
Success Scenario – Response
{
"statusCode": 202,
"url": "https://internalapi-leoaks-dev.gep.com/leo-bulkprocess-api/api/BulkProcess/GetResult?BulkProcessId=1e6c7965-1f6a-4795-8f07-964c98d24a72&IsSuccessRequired=true",
"batchId": "1e6c7965-1f6a-4795-8f07-964c98d24a72",
"interval": 0,
"intervalType": "",
"receivedCount": 0
}
Request | ||||
Property | Required? | Data type | Description | Validations / Exceptions |
FilePath | Optional | String | Filepath location of the file uploaded in the blob api |
|
TemplateId | Yes | String | Bulk template Id config structure |
|
FileId | Yes | String | Encrypted fileid provided by blob upload api of file to process |
|
DocumentReference | Optional | String | Reference object for the batch |
|
CallbackUrl | Optional | String | CallbackUrl of the api to send batch details after processing |
|
BulkProcessId | Optional | String | BulkProcessId if reprocessing |
|
Response | ||||
Property | Required? | Data type | Description | Validations / Exceptions |
statusCode |
| int | Status code response of the api |
|
url |
| String | Url for the getResult api to fetch status of the batch |
|
batchId |
| String | Batch Id returned for tracking batch progress |
|
interval |
| int |
|
|
intervalType |
| String |
|
|
receivedCount |
| int |
|
|