Beginner's guide to data integration using Anaplan REST API

Options
pmarpaka
pmarpaka Member, ALL USERS, GroupMember, Employee, Certified Model Builder Posts: 5 Expert
in Anaplan Community

Introduction

Data Integration is a set of processes that bring data from disparate sources in to Anaplan models.  These processes could include activities that help understand the data (Data Profiling), cleanse & standardize data (Data Quality), and transform/load data (ETL).

Anaplan offers following data integration options. 

  • Manual import
  • Anaplan Connect
  • Extract Transform & Load (ETL)
  • REST API 

Anaplan learning center offers several on-demand courses on Anaplan’s data integration options.  Following is a list of on-demand courses.

This article presents step by step instructions on different integration tasks that can be performed using Anaplan integration APIs.  These tasks include:

  • Import data into Anaplan
  • Export data from Anaplan
  • Run a process
  • Downloading files
  • Delete files

Setup Install & Configure Postman

  • Download latest Postman application for your platform (Ex: Mac, Windows, Linux) from https://www.getpostman.com/apps.
  • Instructions to install Postman app for your platform may be found here.
    • Postman account: Signing up for a postman account is optional.  However, having an account will give you additional benefits of backing up history, collections, environments, and header presets (ex: authorization credentials).  Instructions for creating a postman account may be accessed here. 

Download Files

You may follow instructions provided in this article against your instance of Anaplan platform.  You will need to download a set of files for these exercises.

  1. Customers.csv: Download the .csv file to a directory on your workstation.  This file consists a list of customers you will import into a list using Anaplan integration APIs.
  2. Anaplan Community REST API Solution.txt: This is an export (json) from postman that contains solution to the exercises outlined in this article. You may choose to import this file into postman to review the solution. Although the file extension is .txt, it is a json file that can be imported into Postman.

Anaplan Setup 

Anaplan RESTful API, Import, allows you to bring data into Anaplan.  This is done by using POST HTTPs verb to call an import.   This means, an import action must exist in Anaplan prior to the API call.  Initially, you will import Employees.csv into Anaplan using the application.  Subsequent imports into this list will be carried out via API calls.

  1. Create a new model named Data Integration API
  2. Import Customers.csv
      • Create a list named Customers
      • Using Anaplan application import Customers.csv to Customers list.
      • Set File Options as shown below2a_1.jpeg
      • Map each column to a property in the list as shown below and Run Import.2b_2.jpeg
      • 31 records should be imported into the list.2c_1.jpeg
  3. Create an Export action.
    In this article, you will also learn how to export the data from Anaplan using APIs.  Anaplan API, Export, calls an export action previously created.  Therefore, create an Export of Customers list & save the export definition.  This will create an export action (ex: Grid – Customers.csv).
    Note:  Set file type to .csv in export action. You may choose to rename the export action under Settings ==> Actions ==> Exports.
  4. Create a Process
    Along with Import & Export, you will also learn how to leverage APIs to call an Anaplan process.
    Create a Process named “Import & Export a List” that calls Import (ex: Import Customers from Customers.csv) first followed by Export (Ex: Grid – Customers.csv).  Name the process, Import & Export a List.2d_1.jpeg

Anaplan Integration API Fundamentals

Anaplan Integration APIs (v1.3) are RESTful API that allow for requests to be made via HTTPS using GET, PUT, POST, & DELETE verbs.  Using these APIs, you can perform integration tasks such as:

  • Import data into a module/list
  • Export data from a module/list
  • Upload files for import
  • Run an Anaplan Process
  • Download Files that have been uploaded or file that were created during an export
  • Delete from list using selection

End points enable you to obtain information regarding workspaces, models, imports, exports, processes, etc… Many end points contain a chain of parameters.

Example

We want to get a list of models in a workspace. In order to get a list of models, we will, first, need to select a workspace a model belongs to. 

                            {

                                   "guid": "8a81b09d5e8c6f27015ece3402487d33",

                                   "name": "Pavan Marpaka"

                             }

Chaining Parameters

Many end points contain a set of parameters that can be chained together in a request.  For example, to get a list of import actions we can chain together workspaceId & modelId as parameters in a GET request.  Request call to get a list of import action might look something like:

            https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/imports

Following sequence of requests need to be made to get a list of import actions in a selected model.

  • GET a list of workspaces user has access to 

         https://api.anaplan.com/1/3/workspaces

  • Select a workspaceID (guid) from the result
  • GET a list of models in a workspace providing workspaceID as a parameter value 

          https://api.anaplan.com/1/3/workspaces/{workspaceID}/models

  • Select a modelID from the result
  • GET a list of Imports from a model in a workspace.

          https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/imports

Formats 

Format for most request and responses is application-json.  Exception to this are when uploading files in a single chunk or multiple chunks and getting data in a chunk. These requests use application/octet-stream format.  These formats are specified in header of an API request. They are also specified in header of a response.

Data Integration with Anaplan APIs & Postman Background 

Next few sections will provide you with step by step instructions on how to perform different data integration tasks via Anaplan integration API requests. You will perform following data integration tasks using Anaplan APIs:

  • Upload file(s) to Anaplan
  • Import data into a list
  • Export data from a list
  • Download file that has been uploaded or exported
  • Run an Anaplan Process
  • Delete uploaded file(s) 

Postman application, an HTTP client for making RESTful API calls, will be used to perform these integration tasks. You should have installed and configured Postman on your workstation using instructions provided in the beginning of this article.  You may follow steps outlined in the next few sections.  You may also import Postman collection (json file) provided with this article. 

Navigating Postman UI

This section presents basics of Postman user interface (UI).  You will learn how to perform simple tasks required to make API calls.  These tasks include:

  • Create a new collection
  • Adding a Folder
  • Add a Request
  • Submit a Request
    • Selecting a Request Method (GET, POST, PUT, DELETE)
    • Specifying a Resource URI
    • Specify Authorization, Headers, and Body (raw, binary)

You will perform above steps repeatedly for each integration task.

  1. Create a new collection
    • From New orange drop down box select “Collection”New CollectionNew Collection
    • Provide name for the collection (Ex: Data Integration API)
    • Click Create
  2. Add Folders
    • Create following folders in the collection
      • Authentication, Upload, Import, Export, Download Files, Process, Delete Files.Folders in a collectionFolders in a collection
    • Add a Request
      • You don’t need to perform this step right now. Following steps will outline how a request can be added to a folder.  You will use this instruction each time a new request is created.
      • Select a folder where you want to add a new request.
      • Click on 4c.jpgand select Add RequestAdd a requestAdd a request
      • Provide a Request Name and click on Save
  • Submit a Request
    • Select a Request Method (GET, PUT, POST, DELETE)Select request methodSelect request method
    • Provide a resource URI (ex: https://api.anaplan.com/1/3/workspaces)
    • Click on Authorization and select “Basic Auth” for Authorization Type.
    • Provide your Anaplan credentials (username & password)AuthorizationAuthorization
    • Provide necessary Headers. Common Headers include Authorization (should be pre-populated from Authorization tab), and Content-Type.Header variables & valuesHeader variables & values
    • Some requests may also require a Body. Information for Body will be available in API documentation.BodyBody
    • Click on Submit.

Import data into a List using Anaplan APIs

One of the data integration tasks is to bring data into Anaplan.  Popular method to bring data into Anaplan platform is via Import feature in Anaplan application.  Once imported, an import action is created.  This import action can be executed via an API request. 

Earlier, you have imported Employees.csv file into a hierarchy.  In this section, you will use Anaplan Integration APIs to import employees’ data into the hierarchy.  Following sequence of requests will be made to import data into the list.5a1.jpeg

Get a list of workspaces

  1. In Postman, under the folder “Authentication”, create a new request and label it “GET List of Workspaces”
  2. Select request method GET
  3. Type https://api.anaplan.com/1/3/workspaces for resource URI
  4. Under “Authorization” tab, select Basic Auth and provide your Anaplan credentials.
  5. Click Send
  6. Response to this request should result in the following.
    • Status: 200 OK
    • Body: guid & name. “guid” is the workspaceID.  Sample result is shown below.  WorkspaceID for workspace “Pavan Marpaka” is 8a81b09d5e8c6f27015ece3402487d33.  This workspaceID will be passed as an input parameter in the next request, GET List of Models in a Workspace.5b.jpg

 Get a list of Models in a workspace

  1. In Postman, under the folder “Authentication”, create a new request and label it “GET List of Models in a Workspaces”
  2. Select request method GET
  3. Input parameter for this request will be a workspaceID (8a81b09d5e8c6f27015ece3402487d33), which was retrieved in the last request.
  4. Type https://api.anaplan.com/1/3/workspaces/{workspaceID}/models for resource URI.
  5. Under “Authorization” tab, select Basic Auth and provide your Anaplan credentials.
  6. Click on “Headers” tab and create key, value pair of Content-Type, application/json.5c.jpg
  7. Click Send
  8. Response to this request should result in the following.
    • Status: 200 OK
    • Body: activeState, id & name. “id” is the modelID, which will passed as an input parameter in subsequent request calls.  In the result is shown below (your result may vary), “Top 15 DI API” is the model name.  92269C17A8404B7A90C536F4642E93DE is the modelID. 5d.jpg

Get a list of files

  1. In Postman, under the folder “Upload”, create a new request and label it “GET List of Files and FileID”
  2. Select request method GET
  3. Input parameters for this request will be a workspaceID (8a81b09d5e8c6f27015ece3402487d33) and modelID (92269C17A8404B7A90C536F4642E93DE) that were retrieved in the last request.
  4. Type https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/files for resource URI. Example:https://api.anaplan.com/1/3/workspaces/8a81b09d5e8c6f27015ece3402487d33/models/92269C17A8404B7A90C536F4642E93DE/files
  5. Under “Authorization” tab, select Basic Auth and provide your Anaplan credentials.
  6. Click on “Headers” tab and create key, value pair of Content-Type, application/json.5c.jpg
  7. Click Send
  8. Response to this request should result in the following.
    • Status: 200 OK
    • Body: id & name of the files that were either previously uploaded or exported. In the result below (your result may vary), fileID is 113000000001. This fileID will be passed as an input parameter in the next request (PUT) that will upload the file, Customers.csv5f_1.jpeg

Upload a file

  1. In Postman, under the folder “Upload”, create a new request and label it “Upload File”
  2. Select request method PUT
  3. Input parameters for this request will be a workspaceID (8a81b09d5e8c6f27015ece3402487d33) and modelID (92269C17A8404B7A90C536F4642E93DE) that were retrieved in the last request.
  4. Type https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/files for resource URI. Example:https://api.anaplan.com/1/3/workspaces/8a81b09d5e8c6f27015ece3402487d33/models/92269C17A8404B7A90C536F4642E93DE/files
  5. Under “Authorization” tab, select Basic Auth and provide your Anaplan credentials.
  6. Click on “Headers” tab and create key, value pair of Content-Type, application/octet-stream.5g.jpg
  7. Click on “Body” tab, select “binary” radio button, and click “Choose Files” to select Customers.csv file you downloaded earlier.5h_1.jpeg
  8. Click Send
  9. Response to this request should result in the following.
    • Status: 204 No Content. This is an expected response.  It just means the request was successful, but the response is empty.

Get a list of Import actions in a model

  1. In Postman, under the folder “Import”, create a new request and label it “GET a list of Import Actions”
  2. Select request method GET
  3. Input parameters for this request will be a workspaceID (8a81b09d5e8c6f27015ece3402487d33) and modelID (92269C17A8404B7A90C536F4642E93DE) that were retrieved in the last request. (Note: Your workspaceID and modelID may be different)
  4. Type https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/imports for resource URI. Example: https://api.anaplan.com/1/3/workspaces/8a81b09d5e8c6f27015ece3402487d33/models/92269C17A8404B7A90C536F4642E93DE/imports
  5. Under “Authorization” tab, select Basic Auth and provide your Anaplan credentials.
  6. Click on “Headers” tab and create key, value pair of Content-Type, application/json.5c.jpg
  7. Click Send button
  8. Response to this request should result in the following.
    • Status: 200 OK
    • Body: “id” is the importID (112000000001). This value will be passed as an input parameter to a POST request in the next step.  The POST request will call an import action that will import data from the uploaded Customers.csv into the list.5i_1.jpeg

Call an import Action

  1. In Postman, under the folder “Import”, create a new request and label it “Call an Import Action”
  2. Select request method POST
  3. Input parameters for this request will be a workspaceID (8a81b09d5e8c6f27015ece3402487d33), modelID (92269C17A8404B7A90C536F4642E93DE), and importID (112000000001) that were retrieved in the last request. (Note: Your workspaceID, modelID, and importID may be different)
  4. Type https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/imports/{importID}/tasks for resource URI. Example:https://api.anaplan.com/1/3/workspaces/8a81b09d5e8c6f27015ece3402487d33/models/92269C17A8404B7A90C536F4642E93DE/imports/112000000001/tasks
  5. Under “Authorization” tab, select Basic Auth and provide your Anaplan credentials.
  6. Click on “Headers” tab and create key, value pair of Content-Type, application/json.5c.jpg
  7. Click on “Body” tab, select “raw” and type following

    {

      "localeName": "en_US"

    }

  8.  Click Send button

  9. Response to this request should result in the following.

    • Status: 200 OK

    • Body: “taskId” is for the import is returned as a json object. This task id can be used to check for status of import. 

      {

          "taskId": "2D88EBAA093B4D4C9603DD9278521EBC"

      }

Check status of an import call

  1. In Postman, under the folder “Import”, create a new request and label it “Check Status of Import Call”
  2. Select request method GET
  3. Input parameters for this request will be a workspaceID (8a81b09d5e8c6f27015ece3402487d33), modelID (92269C17A8404B7A90C536F4642E93DE), importID (112000000000), and taskId (2D88EBAA093B4D4C9603DD9278521EBC) that were retrieved in the last request. (Note: Your workspaceID, modelID, importID, and taskId may be different)
  4. Type https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/imports/{importID}/tasks/taskId for resource URI.Example:https://api.anaplan.com/1/3/workspaces/8a81b09d5e8c6f27015ece3402487d33/models/92269C17A8404B7A90C536F4642E93DE/imports/112000000000/tasks/2D88EBAA093B4D4C9603DD9278521EBC
  5. Under “Authorization” tab, select Basic Auth and provide your Anaplan credentials.
  6. Click on “Headers” tab and create key, value pair of Accept, application/json.5c.jpg
  7. Click Send button
  8. Response to this request should result in the following.
    • Status: 200 OK
    • Response should include “Complete” status, Number of records, and a value of “true” for “successful”.

Validate import in Anaplan

In Anaplan application, validate the Customers list with a list of customers.2c_1.jpeg

Export data using Anaplan APIs

An export definition can be saved for later use.  Saved export definitions can be viewed under Settings > Actions > Exports.

Earlier (Section 2), you exported the organization hierarchy and saved the export definition.  This should have created an export action (ex: Grid – Customers.csv).

In this section, we will use Anaplan APIs to execute the export action.  Following sequence of requests will be made to export data.6a.jpeg

Get a list of Export Definitions

  1. In Postman, under the folder “Export”, create a new request and label it “Get a list of Export Definitions”
  2. Select request method GET
  3. Input parameters for this request will be a workspaceID (8a81b09d5e8c6f27015ece3402487d33) and modelID (92269C17A8404B7A90C536F4642E93DE) that were retrieved earlier. Refer to results for requests under “Authentication” folder to obtain your workspaceId and modelId.
  4. Type https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/exports for resource URI. Example:https://api.anaplan.com/1/3/workspaces/8a81b09d5e8c6f27015ece3402487d33/models/92269C17A8404B7A90C536F4642E93DE/exports
  5. Under “Authorization” tab, select Basic Auth and provide your Anaplan credentials.
  6. Click on “Headers” tab and create key, value pair of Content-Type, application/json.5c.jpg
  7. Click Send
  8. Response to this request should result in the following.
    • Status: 200 OK
    • Body: Should consist of id & name of export action. 6b_1.jpeg

Run the export

  1. In Postman, under the folder “Export”, create a new request and label it “Run the export”
  2. Select request method POST
  3. Input parameters for this request will be a workspaceID (8a81b09d5e8c6f27015ece3402487d33), modelID (92269C17A8404B7A90C536F4642E93DE), and exportId (116000000001) that were retrieved in the previous request.
  4. Type https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/exports/{exportId}/tasks for resource URI. Example: https://api.anaplan.com/1/3/workspaces/8a81b09d5e8c6f27015ece3402487d33/models/92269C17A8404B7A90C536F4642E93DE/exports/116000000001/tasks
  5. Under “Authorization” tab, select Basic Auth and provide your Anaplan credentials.
  6. Click on “Headers” tab and create key, value pair of Content-Type, application/json.5c.jpg
  7. Click on “Body” tab, select “raw” radio button, and type the following.

    {

      "localeName": "en_US"

    }

  8. Click Send
  9. Response to this request should result in the following.
    • Status: 200 OK.
    • Body: Response should return a taskId.  The taskId can be used to determine status of export.

      {

          "taskId": "29B4617C3D8646018B269F428AC396A3"

      }

Get status of an export task

  1. In Postman, under the folder “Export”, create a new request and label it “Get status of an export task”.
  2. Select request method GET
  3. Input parameters for this request will be a workspaceID (8a81b09d5e8c6f27015ece3402487d33), modelID (92269C17A8404B7A90C536F4642E93DE), exportId (116000000001) and taskId (29B4617C3D8646018B269F428AC396A3) that were retrieved in the previous request. (Note:  Your workspaceID, modelID, exportId, and taskId may be different)
  4. For resource URI type https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/exports/{exportId}/tasks/{taskId} Example:https://api.anaplan.com/1/3/workspaces/8a81b09d5e8c6f27015ece3402487d33/models/92269C17A8404B7A90C536F4642E93DE/exports/116000000001/tasks/29B4617C3D8646018B269F428AC396A3
  5. Under “Authorization” tab, select Basic Auth and provide your Anaplan credentials.
  6. Click on “Headers” tab and create key, value pair of Content-Type, application/json.5c.jpg
  7. Click Send button
  8. Response to this request should result in the following.
    • Status: 200 OK
    • Body6c_1.jpeg

Download File using Anaplan APIs

Files that have been either previously uploaded or exported can be downloaded using Anaplan API.

In previous section, you exported the list to a csv file via APIs.  In this section, you will use APIs to download the exported file. Following sequence of requests will be made to download files.

9a_new.jpegGet a list of files

  1. In Postman, under the folder “Download Files”, create a new request and label it “Get a list files”
  2. Select request method GET
  3. Input parameters for this request will be a workspaceID (8a81b09d5e8c6f27015ece3402487d33) and modelID (92269C17A8404B7A90C536F4642E93DE) that were retrieved earlier. Refer to results for requests under “Authentication” folder to obtain your workspaceId and modelId. Your workspaceId and modelId may be different.
  4. Type https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/files for resource URI. Example:https://api.anaplan.com/1/3/workspaces/8a81b09d5e8c6f27015ece3402487d33/models/92269C17A8404B7A90C536F4642E93DE/files
  5. Under “Authorization” tab, select Basic Auth and provide your Anaplan credentials.
  6. Click on “Headers” tab and create key, value pair of Content-Type, application/json.5c.jpg
  7. Click Send
  8. Response to this request should result in the following.
    • Status: 200 OK
    • Body: Response body returns information about available files in json format. “id” is the fileId, which will be passed as an input parameter in the next request to download the file7b_1.jpeg

Get chunkID and Name a file

  1. In Postman, under the folder “Download Files”, create a new request and label it “Get chunkID and Name of a file”
  2. Select request method GET
  3. Input parameters for this request will be a workspaceID (8a81b09d5e8c6f27015ece3402487d33) and modelID (92269C17A8404B7A90C536F4642E93DE), and fileId (116000000001), that were retrieved earlier. Your workspaceId, modelId, and fileId may be different.
  4. Type https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/files/{fileId}/chunks for resource URI. For Example: https://api.anaplan.com/1/3/workspaces/8a81b09d5e8c6f27015ece3402487d33/models/92269C17A8404B7A90C536F4642E93DE/files/116000000001/chunks
  5. Under “Authorization” tab, select Basic Auth and provide your Anaplan credentials.
  6. Click on “Headers” tab and create key, value pair of Accept, application/json. Click Send9b_new.jpeg
  7. Response to this request should result in the following
    • Status: 200 OK
    • Body: Response body returns chunkID and chunk name in json format.9c_new.jpeg

Get a chunk of data 

  1. In Postman, under the folder “Download Files”, create a new request and label it “Get a chunk of data”.
  2. Select request method GET
  3. Input parameters for this request will be a workspaceID (8a81b09d5e8c6f27015ece3402487d33) and modelID (92269C17A8404B7A90C536F4642E93DE), and fileId (116000000001), that were retrieved earlier. Your workspaceId, modelId, and fileId may be different.
  4. Type https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/files/{fileId}/chunks/{chunkID} for resource URI. For Example: https://api.anaplan.com/1/3/workspaces/8a81b09d5e8c6f27015ece3402487d33/models/92269C17A8404B7A90C536F4642E93DE/files/116000000001/chunks/0
  5. Under “Authorization” tab, select Basic Auth and provide your Anaplan credentials.
  6. Click on “Headers” tab and create key, value pair of Accept, application/octet-stream. Click Send9d_new.jpeg
  7. Response to this request should result in the following
    • Status: 200 OK
    • Body: Response body returns data in csv format.9e_new.jpeg

Repeat

Repeat the above step for each chunkID returned from the "Get chunkID and Name" API call.  Concatenate all the data into a single file.

Concatenate chunks into a single file 

After collecting data from all the chunks, concatenate the chunks into a single output file.

 

CAUTION:  If you would like to download the file in a single chunk, DO NOT make the following API call.  It is NOT supported by Anaplan and may result in performance issues.  Best practice for large files is to download the files in chunks using steps described above.

GET https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/files/{fileId}

Delete File using Anaplan APIs

Files that have been either previously uploaded or exported can be deleted using Anaplan API. In previous sections, you have uploaded a file to Anaplan for import.  You’ve also exported a list to a csv file via APIs.  In this section, you will use APIs to delete the exported file.

  1. In Postman, under the folder “Delete File”, create a new request and label it “Delete an export file”
  2. Select request method DELETE
  3. Input parameters for this request will be a workspaceID (8a81b09d5e8c6f27015ece3402487d33) and modelID (92269C17A8404B7A90C536F4642E93DE), and fileId (116000000001), that were retrieved earlier. Your workspaceId, modelId, and fileId may be different.
  4. Type https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/files/{fileId} for resource URI. For Example: https://api.anaplan.com/1/3/workspaces/8a81b09d5e8c6f27015ece3402487d33/models/92269C17A8404B7A90C536F4642E93DE/files/116000000001
  5. Under “Authorization” tab, select Basic Auth and provide your Anaplan credentials.
  6. Click on “Headers” tab and create key, value pair of Content-Type, application/json.5c.jpg
  7. Click Send
  8. Response to this request should result in the following.
    • Status: 204 OK No Content. This is an expected response.  It just means the request was successful, but the response is empty

Run a Process using Anaplan APIs

A process is a sequence of actions.  Actions such as import, and export can be included in a process. In an earlier section (Setup), you created a process called “Import & Export a List”.  In this section, we will execute this process using Anaplan APIs.  Following sequence of requests will be made to execute a process.9a.jpeg

  Get a list of Processes in a model

  1. In Postman, under the folder “Process”, create a new request and label it “Get a list of Processes in a model”
  2. Select request method GET
  3. Input parameters for this request will be a workspaceID (8a81b09d5e8c6f27015ece3402487d33) and modelID (92269C17A8404B7A90C536F4642E93DE) that were retrieved earlier. Refer to results for requests under “Authentication” folder to obtain your workspaceId and modelId. Your workspaceId and modelId may be different.
  4. Type https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/processes for resource URI. For example: https://api.anaplan.com/1/3/workspaces/8a81b09d5e8c6f27015ece3402487d33/models/92269C17A8404B7A90C536F4642E93DE/processes
  5. Under “Authorization” tab, select Basic Auth and provide your Anaplan credentials.
  6. Click on “Headers” tab and create key, value pair of Content-Type, application/json.5c.jpg
  7. Click Send
  8. Response to this request should result in the following.
    • Status: 200 OK
    • Body: Response body returns proccessId and name of each process.9b.jpg
  9.  

 

 

 

Run a Process

  1. In Postman, under the folder “Process”, create a new request and label it “Run a Process”
  2. Select request method POST
  3. Input parameters for this request will be a workspaceID (8a81b09d5e8c6f27015ece3402487d33) and modelID (92269C17A8404B7A90C536F4642E93DE), and processId (118000000001), that were retrieved earlier. Your workspaceId, modelId, and processId may be different.
  4. Type https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/processes/{processId}/tasks for resource URI. For example: https://api.anaplan.com/1/3/workspaces/8a81b09d5e8c6f27015ece3402487d33/models/92269C17A8404B7A90C536F4642E93DE/processes/118000000001/tasks
  5. Under “Authorization” tab, select Basic Auth and provide your Anaplan credentials.
  6. Click on “Headers” tab and create key, value pair of Content-Type, application/json.5c.jpg
  7. Click on “Body” tab. Select “raw” radio button and type the following.

    {

      "localeName": "en_US"

    }

  8. Click Send
  9. Response to this request should result in the following.
    • Status: 200 OK
    • Body: Response body returns a taskId for executed process. This taskId can be used to request status of process excecution.

      {

          "taskId": "1573150F0B3A4F9D90676E777FFFB7C1"

      }

Get status of a process task

  1. In Postman, under the folder “Process”, create a new request and label it “Get status of a process”
  2. Select request method GET
  3. Input parameters for this request will be a workspaceID (8a81b09d5e8c6f27015ece3402487d33) and modelID (92269C17A8404B7A90C536F4642E93DE), processId (118000000001), and taskId (1573150F0B3A4F9D90676E777FFFB7C1) that were retrieved earlier. Your workspaceId, modelId, processId, and taskId may be different.
  4. Type https://api.anaplan.com/1/3/workspaces/{workspaceID}/models/{modelID}/processes/{processId}/tasks/1573150F0B3A4F9D90676E777FFFB7C1 for resource URI. For example: https://api.anaplan.com/1/3/workspaces/8a81b09d5e8c6f27015ece3402487d33/models/92269C17A8404B7A90C536F4642E93DE/processes/118000000001/tasks/1573150F0B3A4F9D90676E777FFFB7C1
  5. Under “Authorization” tab, select Basic Auth and provide your Anaplan credentials.
  6. Click on “Headers” tab and create key, value pair of Content-Type, application/json.5c.jpg
  7. Click Send
  8. Response to this request should result in the following.
    • Status: 200 OK

Conclusion

In this article, you learned fundamentals of Anaplan integration APIs & their structure.  You were also presented with step by step instructions on how to call Anaplan REST APIs to perform various data integration tasks.

 Attached with this article is an export of Postman collection in .json format.  If you choose to, you may import this export into your Postman environment for solution to exercises described in this article.  You will need to modify various variables (ex: username/password) and end points specific to your environment, for the solution to run successfully.

Tagged:

Categories