This page describe the parameters to use to start an import execution.
Main object
| Field | Data Type | Description |
|---|---|---|
| ConnectionName | string | database connection |
| SynchronizeUsers | boolean | Synchronize the users/groups/user_role/group_role/group_users |
| DataAppendMode | boolean | if true, the records will be appended in the destination. If false, the same ids will be used in the destination. If false, the destination connection has to have permission to do the identity insert. If the destination is the Runtime Connection, this value has to be true! |
| FileBase64 | string | Use this field to import a zip file base64 encoded. This zip can be generated with the StartExecution request, with the export type. The zip file contains some system entity tables (files ossys_*), the entities metadata (files *_Struct.dmm) and the entities records (files *_Data.csv) |
| SFTPConnetion | string | Use this field to import from a SFTP connection. This is the connection name. |
| SFTPFileName | string | Use this field to import from a SFTP connection. This is the file name. |
| FileSystemPath | string | Use this field to import from a folder. This is the zip file path. |
| DeleteImportFile | string | Delete the File from disk after finish the import |
Sample import from Base64 File Configuration
{
"DestinationDBConnection": "Runtime Connection",
"SynchronizeUsers": true,
"DataAppendMode": true,
"FileBase64": "UEsDBBQAAAAIAMxDw1i6eZ+QHAAAACAAAAAUAAAAMDAxX0VudGl0eTFfRGF0YS5jc3Z7v3t/SGpeYl5JvGeKNRA55+cYgggjEGHMywUAUEsDBBQAAAAIAE9Ew1gxLw6MwQEAAM8EAAAWAAAAMDAxX0VudGl0eTFfU3RydWN0LmRtba2TTW7bMBCF1w6QOxTq1hOEPxKp7oIgC6NNUcDJKggKkjMqBNiyK1J1jSIn66JH6hVKyqrRykngoN0InHkznI+P4s/vP76dnkyyG2MX9N4sKXvzKrtqQh22LJsmZYYxxfrlfP6WtqlAcKZKJxGMdQy4ZBK8UwrQOWeEENowvuu+mq+No32jsYwLTJ0y7gExkJBygHFpYkoaPXTO/DyYULsdTGyuzMLTIF0uamrCI9Ktp/barNeE/Yme0G6b+nNHFyG0te0Cvat9iJV398+X9af4u/ZyteiWjU+JGE6SlZNJ9tvHG2pMEz5GB6c74UNbL0273ZmxB4vCrEH6GnPnQ7w3rKJ284VjCVYLDnKzoeiX1SC5k4XHslCMn70+GDTzF11YNd3SUjse5a9Ngyas2jQgtB2l/MP0Ef4nwFPPiJuNueNlSl2cV+AwL0FW/BNYLjWgrqxCpjUb/pBD2D+3P5413gQ72mY+xlXVhliZV0BGEkgnBJSEChRW3GOB2uT0Ym975TlgfjSwGAMjMqaixeBExUAWeXxHghWgdKG1wfjmnP3/wOJoYHkI7FTeA/MELJgYgI2lCIz/CBw/96cnD78AUEsDBBQAAAAIAMVDw1ifzBrBGQAAABsAAAAUAAAAMDAyX0VudGl0eTJfRGF0YS5jc3Z7v3t/SGpeYl5JvGeKNRA55+cYgggjXi4AUEsDBBQAAAAIAGhEw1jMsC+8pAEAAB8EAAAWAAAAMDAyX0VudGl0eTJfU3RydWN0LmRtbaWTz2obMRDGzw7kHcr26imrkfaPegshB9OmFJycSigjaVQWbNldaaGm5Ml66CP1Faq1E9M6cXDpaaX5ZjQ/fbP69ePn9/OzSXFDZsEfaMnF21fFVUhd2mAxHZWZyyHcLufzd7wZE7wlMug0GEQC1SKCptiCQiskkq6bUuyqr+ZrsrwvJCNQOqscKIkC8kbBGAOXl5RDitrHvnGeKHV2B5OLPS0iP0iXi45Deka6jdxf03rNbnujI9pt6L4OfJFS35kh8fsuppz56e7ltO0t/s69XC2GZYhjIG8no5WTSfHo4w0HCulzdnC6Ez723ZL6zc6MPVgWZsHxtxwrH/Z7w9qWBJbegMofUCwlGEkeGl82VnuBWjVvXj9pNIsXQ1qFYWm4P2wVryk4Sqt+bJD6gcf4/fQZ/iPgY80BtzjkNnmygisNeaac/wtUoEtZgTSWTNUSWdJHYP88/nTWPAlxss14iKtiKW1tCdBgDcozgolfahBSVkoa70vr/9nbrfISMJ4MLJ/4S85oR/nxOV+Br0Z/a6eAa4lKN2V+mPI/ge/Oz+5/A1BLAwQUAAAAAACyQ8NYapzorAsAAAALAAAAHAAAAG9zc3lzX2FwcGxpY2F0aW9uX01hcHBlci5jc3bvu79JZDtLRVkNClBLAwQUAAAAAACvQ8NY8mzhURIAAAASAAAAFgAAAG9zc3lzX2VtYWlsX01hcHBlci5jc3bvu79JZDtNRVNTQUdFX0lEDQpQSwMEFAAAAAAA2EPDWF6BFqIYAAAAGAAAABwAAABvc3N5c19lbnRpdHlfYXR0cl9NYXBwZXIuY3N277u/SWQ7RU5USVRZX0lEO1NTX0tFWQ0KUEsDBBQAAAAAAKdDw1i8soORGAAAABgAAAAXAAAAb3NzeXNfZW50aXR5X01hcHBlci5jc3bvu79JZDtFU1BBQ0VfSUQ7U1NfS0VZDQpQSwMEFAAAAAgAz2SiWAaRMY46AAAAQQAAAB4AAABvc3N5c19lbnRpdHlfcmVjb3JkX01hcHBlci5jc3Z7v3u/Z4q1S2JJYjyQ9kvMTbUODo73do20ds0rySypjAfxUiutXYMLEpNT46FynsXxjsklmWWpvFwAUEsDBBQAAAAAAKBDw1iNP/+WDgAAAA4AAAAXAAAAb3NzeXNfZXNwYWNlX01hcHBlci5jc3bvu79JZDtTU19LRVkNClBLAwQUAAAACACdQ8NYSqvmLUYAAABLAAAAFgAAAG9zc3lzX2dyb3VwX01hcHBlci5jc3Y1xiESgEAIBdDujCciIftHCbDOgsFE8ZYGj+QVTL703vvRi5wN1BAydE/tTjLAiVbL+ZcSzp6ljTaOkiOyWxk7rzB4ztMHUEsDBBQAAAAIAJxDw1jVSyiTIAAAACIAAAAbAAAAb3NzeXNfZ3JvdXBfcm9sZV9NYXBwZXIuY3N2e797v2eKtXuQf2hAvKeLdZC/jyuIDnH1c/QLAbJ4uQBQSwMEFAAAAAgAm0PDWCqicQQhAAAAIgAAABsAAABvc3N5c19ncm91cF91c2VyX01hcHBlci5jc3Z7v3u/Z4p1aLBrULyni7V7kH9oAIgR4urn6BcCZPFyAQBQSwMEFAAAAAAAmUPDWOh7+l8dAAAAHQAAABUAAABvc3N5c19yb2xlX01hcHBlci5jc3bvu79JZDtFU1BBQ0VfSUQ7U1NfS0VZO05BTUUNClBLAwQUAAAAAACXQ8NYxJV2XhYAAAAWAAAAFwAAAG9zc3lzX3RlbmFudF9NYXBwZXIuY3N277u/SUQ7TmFtZTtpc19hY3RpdmUNClBLAwQUAAAAAACUQ8NY5f1IiyEAAAAhAAAAGgAAAG9zc3lzX3VzZXJfcm9sZV9NYXBwZXIuY3N277u/SUQ7VVNFUl9JRDtSb2xlX0lkO1RFTkFOVF9JRA0KUEsDBBQAAAAIAKxDw1jRd86LSwAAAFAAAAAWAAAAb3NzeXNfdXNlcnNfTWFwcGVyLmNzdnu/e79ninVIal5iXkk8kBUa7Brk5+jrag0mfPOTMnNSAzLy81KtXX0TM3OsAxKLi8vzi1KsXStKUovyEnNAmjyD4x2dQzzDXHm5AFBLAQIUABQAAAAIAMxDw1i6eZ+QHAAAACAAAAAUAAAAAAAAAAEAIAAAAAAAAAAwMDFfRW50aXR5MV9EYXRhLmNzdlBLAQIUABQAAAAIAE9Ew1gxLw6MwQEAAM8EAAAWAAAAAAAAAAEAIAAAAE4AAAAwMDFfRW50aXR5MV9TdHJ1Y3QuZG1tUEsBAhQAFAAAAAgAxUPDWJ/MGsEZAAAAGwAAABQAAAAAAAAAAQAgAAAAQwIAADAwMl9FbnRpdHkyX0RhdGEuY3N2UEsBAhQAFAAAAAgAaETDWMywL7ykAQAAHwQAABYAAAAAAAAAAQAgAAAAjgIAADAwMl9FbnRpdHkyX1N0cnVjdC5kbW1QSwECFAAUAAAAAACyQ8NYapzorAsAAAALAAAAHAAAAAAAAAAAACAAAABmBAAAb3NzeXNfYXBwbGljYXRpb25fTWFwcGVyLmNzdlBLAQIUABQAAAAAAK9Dw1jybOFREgAAABIAAAAWAAAAAAAAAAEAIAAAAKsEAABvc3N5c19lbWFpbF9NYXBwZXIuY3N2UEsBAhQAFAAAAAAA2EPDWF6BFqIYAAAAGAAAABwAAAAAAAAAAQAgAAAA8QQAAG9zc3lzX2VudGl0eV9hdHRyX01hcHBlci5jc3ZQSwECFAAUAAAAAACnQ8NYvLKDkRgAAAAYAAAAFwAAAAAAAAABACAAAABDBQAAb3NzeXNfZW50aXR5X01hcHBlci5jc3ZQSwECFAAUAAAACADPZKJYBpExjjoAAABBAAAAHgAAAAAAAAABAAAAAACQBQAAb3NzeXNfZW50aXR5X3JlY29yZF9NYXBwZXIuY3N2UEsBAhQAFAAAAAAAoEPDWI0//5YOAAAADgAAABcAAAAAAAAAAAAgAAAABgYAAG9zc3lzX2VzcGFjZV9NYXBwZXIuY3N2UEsBAhQAFAAAAAgAnUPDWEqr5i1GAAAASwAAABYAAAAAAAAAAQAgAAAASQYAAG9zc3lzX2dyb3VwX01hcHBlci5jc3ZQSwECFAAUAAAACACcQ8NY1UsokyAAAAAiAAAAGwAAAAAAAAABACAAAADDBgAAb3NzeXNfZ3JvdXBfcm9sZV9NYXBwZXIuY3N2UEsBAhQAFAAAAAgAm0PDWCqicQQhAAAAIgAAABsAAAAAAAAAAQAgAAAAHAcAAG9zc3lzX2dyb3VwX3VzZXJfTWFwcGVyLmNzdlBLAQIUABQAAAAAAJlDw1joe/pfHQAAAB0AAAAVAAAAAAAAAAEAIAAAAHYHAABvc3N5c19yb2xlX01hcHBlci5jc3ZQSwECFAAUAAAAAACXQ8NYxJV2XhYAAAAWAAAAFwAAAAAAAAABACAAAADGBwAAb3NzeXNfdGVuYW50X01hcHBlci5jc3ZQSwECFAAUAAAAAACUQ8NY5f1IiyEAAAAhAAAAGgAAAAAAAAABACAAAAARCAAAb3NzeXNfdXNlcl9yb2xlX01hcHBlci5jc3ZQSwECFAAUAAAACACsQ8NY0XfOi0sAAABQAAAAFgAAAAAAAAABACAAAABqCAAAb3NzeXNfdXNlcnNfTWFwcGVyLmNzdlBLBQYAAAAAEQARAKQEAADpCAAAAAA"
}
Sample import from SFTP Configuration
{
"DestinationDBConnection": "Runtime Connection",
"SynchronizeUsers": true,
"DataAppendMode": true,
"SFTPConnetion": "SFTP Connection",
"SFTPFileName": "export.zip"
}
Sample import from Folder Configuration
{
"DestinationDBConnection": "Runtime Connection",
"SynchronizeUsers": true,
"DataAppendMode": true,
"FilePath": "C:\\Program Files\\OutputFolder\\export.zip"
}