GET api/v7/BatchApply?BatchCode={BatchCode}
Request Information
URI Parameters
| Name | Description | Type | Required? | Additional information |
|---|---|---|---|---|
| BatchCode * | string |
Yes |
None. |
Body Parameters
None.
Response Information
Resource Description
BatchApplyInfo| Name | Description | Type |
|---|---|---|
| batchCode |
Batch code of the control file. This has to match with the Payload file's batch code |
string |
| tenantId |
The tenant ID |
integer |
| orgId |
Current Taxonomy ID |
integer |
| userName |
The user name of the submitter control file |
string |
| userCulture |
Culture for the user who submitted the control file |
string |
| orgCulture |
Culture for the org associated with the user who submited the Batch |
string |
| payloadData |
The control file that specifices the details for the BA processing |
string |
| applyStatus |
The status of the control file 0 = new , 1 = applying, 2 = success, 3 = failed, 4 = future, 5 = completed with errors. |
integer |
| createDate |
Date Batch Apply was created. |
date |
| lastChangedTime |
Date and Time when the batch apply was last modified |
date |
| fileDetails |
List of files and it's details |
Collection of BatchFileStatus |
| version |
Version of Batch Apply |
string |
| applyStartTime |
Time when Batch Apply Started for this batch |
date |
| applyCompleteTime |
Time when Batch Apply completed for this batch |
date |
| totalNumberOfFiles |
Total Number of Files in this batch |
integer |
| numberOfFilesPassed |
Number of Files passed in this batch |
integer |
| numberOfFilesFailed |
Number of Files failed in this batch |
integer |
Response Formats
application/json, text/json
Sample:
{
"batchCode": "sample string 1",
"tenantId": 2,
"orgId": 3,
"userName": "sample string 4",
"userCulture": "sample string 5",
"orgCulture": "sample string 6",
"payloadData": "sample string 7",
"applyStatus": 8,
"createDate": "2018-01-01T00:00:00",
"lastChangedTime": "2018-01-01T00:00:00",
"fileDetails": [
{
"payloadFileName": "sample string 1",
"fileOrder": 2,
"action": "sample string 3",
"dataType": "sample string 4",
"applyDateTime": "2018-01-01T00:00:00",
"applyCompleteTime": "2018-01-01T00:00:00",
"applyStatus": "sample string 6",
"applyStatusCode": 7,
"totalFileRecords": 1,
"fileRecordsPassed": 1,
"fileRecordsFailed": 1,
"recordContainsInFile": 1,
"checkSumValue": "sample string 8"
},
{
"payloadFileName": "sample string 1",
"fileOrder": 2,
"action": "sample string 3",
"dataType": "sample string 4",
"applyDateTime": "2018-01-01T00:00:00",
"applyCompleteTime": "2018-01-01T00:00:00",
"applyStatus": "sample string 6",
"applyStatusCode": 7,
"totalFileRecords": 1,
"fileRecordsPassed": 1,
"fileRecordsFailed": 1,
"recordContainsInFile": 1,
"checkSumValue": "sample string 8"
}
],
"version": "sample string 11",
"applyStartTime": "2018-01-01T00:00:00",
"applyCompleteTime": "2018-01-01T00:00:00",
"totalNumberOfFiles": 1,
"numberOfFilesPassed": 1,
"numberOfFilesFailed": 1
}
application/xml, text/xml
Sample:
<BatchApplyInfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<batchCode>sample string 1</batchCode>
<tenantId>2</tenantId>
<orgId>3</orgId>
<userName>sample string 4</userName>
<userCulture>sample string 5</userCulture>
<orgCulture>sample string 6</orgCulture>
<payloadData>sample string 7</payloadData>
<applyStatus>8</applyStatus>
<createDate>2018-01-01T00:00:00</createDate>
<lastChangedTime>2018-01-01T00:00:00</lastChangedTime>
<fileDetails>
<BatchFileStatus>
<payloadFileName>sample string 1</payloadFileName>
<fileOrder>2</fileOrder>
<action>sample string 3</action>
<dataType>sample string 4</dataType>
<applyDateTime>2018-01-01T00:00:00</applyDateTime>
<applyCompleteTime>2018-01-01T00:00:00</applyCompleteTime>
<applyStatus>sample string 6</applyStatus>
<applyStatusCode>7</applyStatusCode>
<totalFileRecords>1</totalFileRecords>
<fileRecordsPassed>1</fileRecordsPassed>
<fileRecordsFailed>1</fileRecordsFailed>
<recordContainsInFile>1</recordContainsInFile>
<checkSumValue>sample string 8</checkSumValue>
</BatchFileStatus>
<BatchFileStatus>
<payloadFileName>sample string 1</payloadFileName>
<fileOrder>2</fileOrder>
<action>sample string 3</action>
<dataType>sample string 4</dataType>
<applyDateTime>2018-01-01T00:00:00</applyDateTime>
<applyCompleteTime>2018-01-01T00:00:00</applyCompleteTime>
<applyStatus>sample string 6</applyStatus>
<applyStatusCode>7</applyStatusCode>
<totalFileRecords>1</totalFileRecords>
<fileRecordsPassed>1</fileRecordsPassed>
<fileRecordsFailed>1</fileRecordsFailed>
<recordContainsInFile>1</recordContainsInFile>
<checkSumValue>sample string 8</checkSumValue>
</BatchFileStatus>
</fileDetails>
<version>sample string 11</version>
<applyStartTime>2018-01-01T00:00:00</applyStartTime>
<applyCompleteTime>2018-01-01T00:00:00</applyCompleteTime>
<totalNumberOfFiles>1</totalNumberOfFiles>
<numberOfFilesPassed>1</numberOfFilesPassed>
<numberOfFilesFailed>1</numberOfFilesFailed>
</BatchApplyInfo>