21.5.1.1 Request JSON Parameters

Table 21-14 Request JSON Parameters

Name Type Required Description
migrationCode STRING Yes Migration code of the object. The minimum code length is 3 and maximum is 30 characters. The allowed characters are alphanumeric, hyphen, and underscore.
fileName STRING Yes if dmpFileURL is not present. The parameters fileName and dmpFileURL can be passed. The file is fetched from Get Download URL API. The file name should consist of _BO_ in the name. By default, the file extension is .DMP.

For Example: "TEST_BO_1234" or "test_BO_1234.DMP

dmpFileURL STRING Yes if fileName is not present. The parameters fileName and dmpFileURL can be passed. For example:

This can be fetched from the object store.

  • dmpFileURL: The file is saved in the Object Store with the same details as mentioned in dmpFileURL.
  • dmpFileURL along with file name: The file is saved with the same name as the file name specified in the request. This is required if you want to change the file name from the name available in dmpFileURL.
  • Only File name: This is required when file was already uploaded and available in object store prior to importing.
  • If you want to provide a different file name, it must have _BO_ . The file name extension should be .DMP.
All the objects in the DMP file will be imported.
failOnErrorOptions STRING Yes The allowed values are Y/N. If you have set this as Y, an error will be displayed. If set as N, no error message is displayed.
overWriteOptions STRING Yes The allowed values are Y/N. If you have set this as Y, you can over write the file. If set as N, you cannot over write this file.

Request JSON Sample

{   

"migrationCode":"PublicExport011"

"fileName":"PublicExport04_BO_6786878_78787899_1.DMP

"dmpFileURL":<The output from Get Download URL API for DMP file>

"failOnErrorOptions":"Y"

"overWriteOptions":"N"

   
}