/unitConversions/{unitConversionID} (POST)

Creates a new import job, automatically determining the import type based on the unit conversion ID.

This endpoint allows you to specify the Mapping property. It is persisted and exists for the lifetime of the job.

You can also specify a JobSettings property, which allows you to fine tune the behavior of the job. To get the available JobSettings for your desired unit conversion table, use the following endpoint: /unitConversions/{unitConversionID} (GET).

After the job has been created, the endpoint returns the ID of the job with which you can interact further, as well as a jobURL, which you can use to post data to the job.

For more info on posting data to the job see: /jobs/{jobID} (POST).

API Request Details

URL

{BaseURL}/unitConversions/{unitConversionID} (POST)

Request Type

POST

Request Content

application/json

Required Header

Name

x-csrf-token

Value

<token>

Sample Request

https://your-sac-tenant-url.cloud/api/v1/dataimport/unitConversion/T006

There are several different body formats that can be sent in the request:

  • Body with the Mapping property to rename the MSEHI column, add a default value for DIMID column, and set the executeWithFailedRows jobSetting:

    { 
        "Mapping": { 
            "UnitID": "MSEHI" 
        }, 
        "DefaultValues": { 
            "DIMID": "GROUP", 
        }, 
        "JobSettings": { 
            " executeWithFailedRows": "false" 
        } 
    } 
  • No mapping specified (empty body):

    {}

Sample Response

201: Created
{ 
    "JobID": "{jobID}", 
    "JobURL": "{BaseURL}/jobs/{jobID} " 
}