/models/{modelID}/importType (POST)

API Request Details

Additional Parameters

• importType: mandatory parameter to specify the type of import job you want to create.

  • factData: import data to the fact data table (Data Foundation).

  • masterData: import data to all dimensions of the model.

  • masterFactData: import data to all dimensions and to the fact data table.

  • privateFactData: import data to the fact data table with a specified private version.

• Mapping: optional parameter that allows custom column names to reference internal column names on the model.

• JobSettings: optional parameter to fine-tune how the data is combined with the target model based on matches of dimensions.

Sample Request

• Body with mapping property to rename two columns. In the example below, the import method is set to CleanAndReplace on dimensions Version and Bicycle:

  { 
  	"Mapping": { 
  		"Bicycle": "Bike", 
  		"Shop": "Store" 
  	}, 						
  	"JobSettings": { 
  		"importMethod": "CleanAndReplace", 
  		"dimensionScope": ["Version", "Bicycle"] 
  	} 				
  } 

• No job settings specified. In the example below, the import method will be set to Update by default. Mapping specified to rename two columns:

  { 
  	"Mapping": { 
  		"Bicycle": "Bike", 
  		"Shop": "Store" 
  	} 
  } 

• No job settings specified. No mapping specified (empty body):

  {}

• In the example below, the import method set to Append:

  { 
  	"JobSettings": { 
  	"importMethod": "Append" 
  	} 
  } 

• Content-type: text/csv

  Version,Date,Bicycle,Shop,QuantitySold,TotalEarnings

Sample Response

201: Created

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

Error Responses