Enhancement to existing Bulk API for Import Metadata

kevin.cho

There is an existing bulk API endpoint that allows workspace admins to retrieve the full list of Import actions from a given model. This endpoint is in the format: 

https://api.anaplan.com/2/0/models/{{mdlID}}/imports/

 where {{mdlID}} is the model GUID. 

This returns a JSON response, which contains an object called "imports" - which is a list of JSON objects that define each import within a model. 

Each import has the following attributes: 

• id - guid of the import action, used for executing it via the Bulk APIs)
• name - name of the action from Anaplan front-end
• importDataSourceId
• importType - defines if loading into a list or module

 

The importDataSourceId is currently only populated for import actions that are sourced from a flat file, and returns the file ID of the associated import file. This key is blank for those imports that are sourced from a view/module. 

 

Enhancement request: 

The schema of an Anaplan import is defined in the following metadata endpoint 

https://api.anaplan.com/2/0/models/{{mdlID}}/objects/import

 where {{mdlID}} is the model GUID. The schema actually includes a key called importDataSource with structure below: 

"importDataSource": {
   "properties": { 
      "importDataSourceId":...,
      "sourceModelId": ...,
      "sourceModelName": ...,
      "sourceWorkspaceId": ...,
      "type": ...}}

This key should be returned as part of each import, such that we can programatically create data flow maps between our Anaplan models - something which is becoming increasingly difficult to do as the number of models and actions increase. 

axel.frot

Great suggestion !