1. Data integration
  2. Anaplan API Guide and Reference
  3. Use the bulk APIs
  4. Perform an import action
  5. Initiate an import action
  6. Get the metadata for the import action

This call provides information on the import file, such as file format, header information, delimiters, and column count.

Method and endpoint

https://api.anaplan.com/2/0/workspaces/{workspaceID}/models/{modelID}/imports/{importID}

GET

Parameters

ParameterDescription
AnaplanAuthToken:{token}Your Anaplan authentication token value.
workspaceIDThe workspace ID
modelIDThe model ID
importIDThe import ID

Curl example

curl -X GET \
https://api.anaplan.com/2/0/workspaces/0a800b00e0000000f000001eab0d0000/models/F1111111C11111111B11111F1111E11F/imports/113000000020 \
-H 'Accept: */*' \
-H 'Accept-Encoding: gzip, deflate' \
-H 'Authorization: AnaplanAuthToken:{token}'

Response

{

   "meta":{

      "schema":"https://api.anaplan.com/2/0/models/F1111111C11111111B11111F1111E11F/objects/importMetadata"

   },

   "status":{

      "code":200,

      "message":"Success"

   },

   "importMetadata":{

      "name":"Employees from Employees.txt",

      "type":"FILE",

      "source":{

         "textEncoding":"ISO-8859-1",

         "columnSeparator":"\t",

         "textDelimiter":"\"",

         "headerRow":1,

         "firstDataRow":2,

         "decimalSeparator":".",

         "headerNames":[

            "Name",

            "Sales Region",

            "Parent",

            "Code",

            "Sales Team",

            "Start Date",

            "Leave Date",

            "Salary",

            "Address",

            "Quota",

            "Bonus %",

            "Sales Rep",

            "Staff",

            "Exec"

         ],

         "columnCount":14

      }

   }

}