Import Setup Data for a Task

You have completed some modifications for a setup task in a development or test environment. And you exported the setup data to move it to another test or production environment. This use case takes you through the steps in using the Setup Task CSV Imports resource to import that setup data. Before you begin, you must have the exported .zip file and know the code of the task provided during the export process.

In this example, the exported file contains setup data for the task code HZ_MANAGE_RESOURCE_ROLES. Let's look at the steps.

  1. Start the import process: Submit a request to start the import process using the setupTaskCSVImports resource.
    curl -i -u "<username>:<password>" -X POST https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVImports
    Content-Type: application/vnd.oracle.adf.resourceitem+json

    Sample Request Payload

    {
      "TaskCode" : "HZ_MANAGE_RESOURCE_ROLES",
      "SetupTaskCSVImportProcess" : [{  "TaskCode" : "HZ_MANAGE_RESOURCE_ROLES",
                                        "FileContent": "UEsDBBQACAgIADypokoAAAAAAAAAAAAAAAASAAAASlRGX1JTX1JPTEVTX0IuY3N2fVDRjsIgEHz3KwzP9xNYq2fS4qWoiU9kLRsloUDo5i7+/ZWUanNnfCDMTGaHYVnjLR7uAQuvkX2wRDOUiBr1xsJ1IDV2F4yZcN0ZZ3qKQH7SKoSHFxxcn+aWzDdmkuIFdNNLa+zbaAIZ7waliAiEenVPcdDTMegHn3qlqvLHUHvDyBas+ORClJWSvCplisj8izcHUTaq3jaDKoZzzveEz0/3MruXNRd8W6aJ9P0Uqfi63ol/rNqf1HxxJ7AvyrQ3cA6tChDJYVTBRwKrYNzeny5z/H5wXPtYcnOUu72Yg5fVfgFQSwcIdbMYV+MAAADmAQAAUEsDBBQACAgIADypokoAAAAAAAAAAAAAAAAaAAAAQVNNX1NFVFVQX0NTVl9NRVRBREFUQS54bWzNVlFzmkAQfu+vYPKs5aDVaIYwgxQbW4QMR5xMX5gTdpQOgoUjmfz73p2igNGYtJn2ydvl+75ddj9AbRovckLjLL3NsxCKwsSzKVASEUpmrv5BkiTtJMTLHgWKA7fXJ5HeHQ6HmryPWwiHrECfkpQsQPKgyMo8ZIcsgSJQkXKJekgN0KDXV5Vg2N8LCVpL6gsUYR6veXtvUKyz28KEgs65XdTrIlVSlSs0vOr1P36u3ZoAVUR3/hNCipdZTkWnNz+CqeEYX63As7B755ns4NoW1uQ2sqngP61B9w38vQKKRIUxc2BFo9HTOGGj57CALSTAljebmJYmN69XrPYOR2URp+x3U6C2UaWivIrV8MG5btjimqL7oXzzx4GHNyMLRoHvGQ62DX/iOpp8jNNSJjRc8ryUlklyfUHzEi7kFuh+lRiU5vG8pGDHBdV3A+zYpKB362gbcTdxMXGoGYfB0kXJjNfBwnY81OQD2YOqThbBLaFLXa4My4Vnbitkg21k/JykRSK2ciwvSKKFXY1mdZ7G8KuENARd0eRGXNu//GYD/E/WeV+78NmbbH7CFvxJFQEGiCAaJ2TRmcJqDrk4GtEqThmJTSbbZGwgW5R4d21hIY0fQByPmu6US3kHvBP8GLM7gvzvuvEfGusVPOX4q4+vuYZ8dtsHLBxma5iRpIQa9ZThnyX8idlZgb0mBsoAnxBSEEKqMuj3LweKGE8b855PzL7WKNv5i9WsPwqafAx1hpaIdfPGcBzLDrAhvp4nkOdK8sbOlxXoU+59eddncjZ/uA6wh6ovYPTfUEsHCJ/X4ztZAgAA2AkAAFBLAQIUABQACAgIADypokp1sxhX4wAAAOYBAAASAAAAAAAAAAAAAAAAAAAAAABKVEZfUlNfUk9MRVNfQi5jc3ZQSwECFAAUAAgICAA8qaJKn9fjO1kCAADYCQAAGgAAAAAAAAAAAAAA"}]
    }

    The import process starts and a process ID is generated.

    Sample Response Payload

    {
        "TaskCode": "HZ_MANAGE_RESOURCE_ROLES",
        ...
        "SetupTaskCSVImportProcess": [
            {
                "ProcessId": 300100032652316,
                ...
            }
        ],
            ...
    }
  2. Check the process status: Send a request using the process ID to check if the import process is completed.
    curl -i -u "<username>:<password>" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVImports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVImportProcess/300100032652316

    You get the response value as true or false.

    Sample Response Payload

    {
      "ProcessId": 300100032652316,
      "ProcessCompletedFlag": true,
      ...
      
    }
  3. Retrieve the import process results: After the import process is complete, send this request to retrieve the process log.
    curl -i -u "<username>:<password>" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVImports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVImportProcess/300100032652316/child/SetupTaskCSVImportProcessResult/300100032652316/enclosure/ProcessLog

    Sample Response Payload

    The process log is the response.

    You can examine the process log to check if the import contained the required setup data.