Batch Apply Information
| Name | Description | Type | Required? | Additional information |
|---|---|---|---|---|
| batchCode |
Batch code of the control file. This has to match with the Payload file's batch code |
string |
No |
None. |
| tenantId |
The tenant ID |
integer |
No |
None. |
| orgId |
Current Taxonomy ID |
integer |
No |
None. |
| userName |
The user name of the submitter control file |
string |
No |
None. |
| userCulture |
Culture for the user who submitted the control file |
string |
No |
None. |
| orgCulture |
Culture for the org associated with the user who submited the Batch |
string |
No |
None. |
| payloadData |
The control file that specifices the details for the BA processing |
string |
No |
None. |
| applyStatus |
The status of the control file 0 = new , 1 = applying, 2 = success, 3 = failed, 4 = future, 5 = completed with errors. |
integer |
No |
None. |
| createDate |
Date Batch Apply was created. |
date |
No |
None. |
| lastChangedTime |
Date and Time when the batch apply was last modified |
date |
No |
None. |
| fileDetails |
List of files and it's details |
Collection of BatchFileStatus |
No |
None. |
| version |
Version of Batch Apply |
string |
No |
None. |
| applyStartTime |
Time when Batch Apply Started for this batch |
date |
No |
None. |
| applyCompleteTime |
Time when Batch Apply completed for this batch |
date |
No |
None. |
| totalNumberOfFiles |
Total Number of Files in this batch |
integer |
No |
None. |
| numberOfFilesPassed |
Number of Files passed in this batch |
integer |
No |
None. |
| numberOfFilesFailed |
Number of Files failed in this batch |
integer |
No |
None. |