POST api/v7/BatchApply

Request Information

URI Parameters

None.

Body Parameters

Batch Apply
NameDescriptionTypeRequired?Additional information
batchId

Unique BatchApply Control File ID

 string

No

String length: between 1 and 20, inclusive
applyDateTime *

Date and time when Control file would be applied

 date

Yes

None.
fileCount *

Number of payload files to be applied

 integer

Yes

None.
fileType *

Specifies the type of payload files as specified in control data; Value can be 'product', 'taxonomy', 'user' or 'customerinfo'

 string

Yes

None.
fileFormat *

Format of Files eg. Application/JSON or Application/XML

 string

Yes

None.
payloadType

Code determining the PayLoad

 integer

No

None.
filesList *

List of Files to be applied

 Collection of Batch Apply File Information

Yes

None.
batchChecksumValidation

The control file that specifices the validation of checksum flag (YES/NO) to validate records in file.

 string

No

None.
autoStoreDataLoad

Flag indicating whether data should be loaded to the store automotically via the `StoreDataLoad process For Exampe: 0 or NULL or greather than 2 - means no change in existing process 1 - means push message for StorDataLoad process after batch complete 2 - means no message publish to queue only Insert Data to DB.

 integer

No

None.

Request Formats

application/json, text/json

Sample: 
{
  "batchId": "sample string 1",
  "applyDateTime": "2018-01-01T00:00:00",
  "fileCount": 2,
  "fileType": "sample string 3",
  "fileFormat": "sample string 4",
  "payloadType": 1,
  "filesList": [
    {
      "fileOrder": 1,
      "fileName": "sample string 2",
      "recordContainsInFile": 1,
      "checkSumValue": "sample string 3"
    },
    {
      "fileOrder": 1,
      "fileName": "sample string 2",
      "recordContainsInFile": 1,
      "checkSumValue": "sample string 3"
    }
  ],
  "batchChecksumValidation": "sample string 5",
  "autoStoreDataLoad": 1
}

application/xml, text/xml

Sample: 
<BatchApplyDto xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <batchId>sample string 1</batchId>
  <applyDateTime>2018-01-01T00:00:00</applyDateTime>
  <fileCount>2</fileCount>
  <fileType>sample string 3</fileType>
  <fileFormat>sample string 4</fileFormat>
  <payloadType>1</payloadType>
  <filesList>
    <BatchApplyFileInfo>
      <fileOrder>1</fileOrder>
      <fileName>sample string 2</fileName>
      <recordContainsInFile>1</recordContainsInFile>
      <checkSumValue>sample string 3</checkSumValue>
    </BatchApplyFileInfo>
    <BatchApplyFileInfo>
      <fileOrder>1</fileOrder>
      <fileName>sample string 2</fileName>
      <recordContainsInFile>1</recordContainsInFile>
      <checkSumValue>sample string 3</checkSumValue>
    </BatchApplyFileInfo>
  </filesList>
  <batchChecksumValidation>sample string 5</batchChecksumValidation>
  <autoStoreDataLoad>1</autoStoreDataLoad>
</BatchApplyDto>

Response Information

Resource Description

HttpResponseMessage
NameDescriptionType
Version

Version
Content

HttpContent
StatusCode

HttpStatusCode
ReasonPhrase

string
Headers

Collection of Object
RequestMessage

HttpRequestMessage
IsSuccessStatusCode

boolean