{"id":3326,"date":"2023-04-12T15:26:35","date_gmt":"2023-04-12T15:26:35","guid":{"rendered":"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/"},"modified":"2023-04-12T17:27:24","modified_gmt":"2023-04-12T17:27:24","slug":"anaplan-api-integration-large-volume-read","status":"publish","type":"post","link":"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/","title":{"rendered":"Anaplan API Integration \u2013 Large Volume Read"},"content":{"rendered":"<p>Not long ago Anaplan updated their transactional API (Application Programming Interface), allowing users to read \u201clarge volume view and list\u201d data. To qualify as \u201clarge volume\u201d the data set should consist of at least one-million cells or list members respectively. For those familiar with Anaplan and its methods of integration, these API endpoints allow for reading data without the need for a predefined export action, similar to the reading of Anaplan module saved views. This means that no Anaplan know-how is necessary to make these API calls, so long as a user has a valid means of authentication and access to workspace and model IDs.<\/p>\n<p>There are four core endpoints needed to fulfill the process of reading from a large volume view, all of which will be covered in this article.<\/p>\n<ol>\n<li>Initiate large read request<\/li>\n<li>Retrieve status of large read request<\/li>\n<li>Download pages<\/li>\n<li>Delete read requests<\/li>\n<\/ol>\n<p>It is important to recognize however that authentication must be performed, and model metadata will need to be collected as well. These steps will be included in the final solution below.<\/p>\n<p>In the <a href=\"https:\/\/anaplanbulkapi20.docs.apiary.io\/#\/introduction\">Anaplan Integration API V2 Guide and Reference<\/a>, endpoints are shown in curl request formatting as follows:<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignleft size-full wp-image-2481\" src=\"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP1-min.jpg\" alt=\"\" width=\"732\" height=\"114\" \/><\/p>\n<p>This simply reads as a request of type \u2018GET,\u2019 at some URI (Uniform Resource Indentifier), with both Authorization and Accept headers attached. The \u2018{modelId}\u2019 is found within your target Anaplan model, and the \u2018{anaplan_auth_token}\u2019 is found after performing basic authentication, which will be shown.<\/p>\n<p>There are many ways to run and implement these API requests. For the scope of this article, I will be showing how to set up and run requests in Postman, an API testing and design platform, and how to put together a Python script which will allow for automation and reusability.<\/p>\n<h3>Postman<\/h3>\n<p>For Postman, a collection called \u2018Read Large Volume\u2019 has been set up to contain all the requests. The authorization for the collection is set to Bearer Token, and all the requests, other than the authentication request, are set to \u2018Inherit auth from parent.\u2019 For all requests, the headers may be left as Postman generates them. The authorization tab in the authorization request will be set to \u2018Basic Auth\u2019 where you will then enter your username and password. The only request which requires a body is the \u2018Initiate read request.\u2019<\/p>\n<p>Variables included are:<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignleft size-full wp-image-2480\" src=\"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP2-min.jpg\" alt=\"\" width=\"871\" height=\"464\" \/><\/p>\n<p>Once you hit \u2018Send,\u2019 in the returned body, everything in quotes after \u201ctokenValue\u201d: will be copied and pasted into the collection\u2019s bearer token input field:<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignleft size-full wp-image-2471\" src=\"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP3-min.jpg\" alt=\"\" width=\"871\" height=\"550\" \/><\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignleft size-full wp-image-2472\" src=\"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP4-min.jpg\" alt=\"\" width=\"869\" height=\"432\" \/><\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignleft size-full wp-image-2473\" src=\"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP5-min.jpg\" alt=\"\" width=\"862\" height=\"544\" \/><\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignleft size-full wp-image-2474\" src=\"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP6-min.jpg\" alt=\"\" width=\"865\" height=\"405\" \/><\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignleft size-full wp-image-2475\" src=\"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP7-min.jpg\" alt=\"\" width=\"865\" height=\"602\" \/><\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignleft size-full wp-image-2476\" src=\"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP8-min.jpg\" alt=\"\" width=\"869\" height=\"658\" \/><\/p>\n<h3>Python<\/h3>\n<p>This is a basic script which can be used to automate the running of the above process. If this script is used, the global variables at the top of the script need to be adjusted to match the credentials and workspace metadata of someone with proper access. It is important to note, the code written below is not the only way to achieve the desired result. This script is available to be used as an example and a means of generating a starting point for Anaplan API integration scripts.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignleft size-full wp-image-2477\" src=\"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP9-min.jpg\" alt=\"\" width=\"645\" height=\"695\" \/><\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignleft size-full wp-image-2478\" src=\"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP10-min.jpg\" alt=\"\" width=\"647\" height=\"689\" \/><\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignleft size-full wp-image-2479\" src=\"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP11-min.jpg\" alt=\"\" width=\"645\" height=\"642\" \/><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Not long ago Anaplan updated their transactional API (Application Programming Interface), allowing users to read \u201clarge volume view and list\u201d data. To qualify as \u201clarge volume\u201d the data set should consist of at least one-million cells or list members respectively. For those familiar with Anaplan and its methods of integration, these API endpoints allow for&hellip;<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[22],"tags":[66,68,35],"class_list":["post-3326","post","type-post","status-publish","format-standard","hentry","category-anaplan","tag-analplan-development","tag-anaplan","tag-development"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.2 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Anaplan API Integration \u2013 Large Volume Read - QueBIT<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Anaplan API Integration \u2013 Large Volume Read - QueBIT\" \/>\n<meta property=\"og:description\" content=\"Not long ago Anaplan updated their transactional API (Application Programming Interface), allowing users to read \u201clarge volume view and list\u201d data. To qualify as \u201clarge volume\u201d the data set should consist of at least one-million cells or list members respectively. For those familiar with Anaplan and its methods of integration, these API endpoints allow for&hellip;\" \/>\n<meta property=\"og:url\" content=\"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/\" \/>\n<meta property=\"og:site_name\" content=\"QueBIT\" \/>\n<meta property=\"article:published_time\" content=\"2023-04-12T15:26:35+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2023-04-12T17:27:24+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP1-min.jpg\" \/>\n<meta name=\"author\" content=\"agoddard\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"agoddard\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/\"},\"author\":{\"name\":\"agoddard\",\"@id\":\"https:\/\/quebit.com\/askquebit\/#\/schema\/person\/e52d72da0fd2f5f70d189343fe4f5084\"},\"headline\":\"Anaplan API Integration \u2013 Large Volume Read\",\"datePublished\":\"2023-04-12T15:26:35+00:00\",\"dateModified\":\"2023-04-12T17:27:24+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/\"},\"wordCount\":507,\"commentCount\":0,\"image\":{\"@id\":\"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP1-min.jpg\",\"keywords\":[\"Analplan Development\",\"Anaplan\",\"Development\"],\"articleSection\":[\"Anaplan\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/\",\"url\":\"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/\",\"name\":\"Anaplan API Integration \u2013 Large Volume Read - QueBIT\",\"isPartOf\":{\"@id\":\"https:\/\/quebit.com\/askquebit\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP1-min.jpg\",\"datePublished\":\"2023-04-12T15:26:35+00:00\",\"dateModified\":\"2023-04-12T17:27:24+00:00\",\"author\":{\"@id\":\"https:\/\/quebit.com\/askquebit\/#\/schema\/person\/e52d72da0fd2f5f70d189343fe4f5084\"},\"breadcrumb\":{\"@id\":\"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/#primaryimage\",\"url\":\"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP1-min.jpg\",\"contentUrl\":\"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP1-min.jpg\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/quebit.com\/askquebit\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Anaplan API Integration \u2013 Large Volume Read\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/quebit.com\/askquebit\/#website\",\"url\":\"https:\/\/quebit.com\/askquebit\/\",\"name\":\"QueBIT\",\"description\":\"QueBIT\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/quebit.com\/askquebit\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/quebit.com\/askquebit\/#\/schema\/person\/e52d72da0fd2f5f70d189343fe4f5084\",\"name\":\"agoddard\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/secure.gravatar.com\/avatar\/d817b364cff1d66116debde8d1c85e5e76eeece9c5ae731b19276a6040231455?s=96&d=mm&r=g\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/d817b364cff1d66116debde8d1c85e5e76eeece9c5ae731b19276a6040231455?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/d817b364cff1d66116debde8d1c85e5e76eeece9c5ae731b19276a6040231455?s=96&d=mm&r=g\",\"caption\":\"agoddard\"},\"sameAs\":[\"https:\/\/quebit.com\/askquebit\"],\"url\":\"https:\/\/quebit.com\/askquebit\/author\/agoddard\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Anaplan API Integration \u2013 Large Volume Read - QueBIT","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/","og_locale":"en_US","og_type":"article","og_title":"Anaplan API Integration \u2013 Large Volume Read - QueBIT","og_description":"Not long ago Anaplan updated their transactional API (Application Programming Interface), allowing users to read \u201clarge volume view and list\u201d data. To qualify as \u201clarge volume\u201d the data set should consist of at least one-million cells or list members respectively. For those familiar with Anaplan and its methods of integration, these API endpoints allow for&hellip;","og_url":"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/","og_site_name":"QueBIT","article_published_time":"2023-04-12T15:26:35+00:00","article_modified_time":"2023-04-12T17:27:24+00:00","og_image":[{"url":"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP1-min.jpg","type":"","width":"","height":""}],"author":"agoddard","twitter_card":"summary_large_image","twitter_misc":{"Written by":"agoddard","Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/#article","isPartOf":{"@id":"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/"},"author":{"name":"agoddard","@id":"https:\/\/quebit.com\/askquebit\/#\/schema\/person\/e52d72da0fd2f5f70d189343fe4f5084"},"headline":"Anaplan API Integration \u2013 Large Volume Read","datePublished":"2023-04-12T15:26:35+00:00","dateModified":"2023-04-12T17:27:24+00:00","mainEntityOfPage":{"@id":"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/"},"wordCount":507,"commentCount":0,"image":{"@id":"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/#primaryimage"},"thumbnailUrl":"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP1-min.jpg","keywords":["Analplan Development","Anaplan","Development"],"articleSection":["Anaplan"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/","url":"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/","name":"Anaplan API Integration \u2013 Large Volume Read - QueBIT","isPartOf":{"@id":"https:\/\/quebit.com\/askquebit\/#website"},"primaryImageOfPage":{"@id":"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/#primaryimage"},"image":{"@id":"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/#primaryimage"},"thumbnailUrl":"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP1-min.jpg","datePublished":"2023-04-12T15:26:35+00:00","dateModified":"2023-04-12T17:27:24+00:00","author":{"@id":"https:\/\/quebit.com\/askquebit\/#\/schema\/person\/e52d72da0fd2f5f70d189343fe4f5084"},"breadcrumb":{"@id":"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/#primaryimage","url":"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP1-min.jpg","contentUrl":"https:\/\/quebit.com\/askquebit\/wp-content\/uploads\/2022\/09\/AP1-min.jpg"},{"@type":"BreadcrumbList","@id":"https:\/\/quebit.com\/askquebit\/anaplan-api-integration-large-volume-read\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/quebit.com\/askquebit\/"},{"@type":"ListItem","position":2,"name":"Anaplan API Integration \u2013 Large Volume Read"}]},{"@type":"WebSite","@id":"https:\/\/quebit.com\/askquebit\/#website","url":"https:\/\/quebit.com\/askquebit\/","name":"QueBIT","description":"QueBIT","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/quebit.com\/askquebit\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/quebit.com\/askquebit\/#\/schema\/person\/e52d72da0fd2f5f70d189343fe4f5084","name":"agoddard","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/d817b364cff1d66116debde8d1c85e5e76eeece9c5ae731b19276a6040231455?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/d817b364cff1d66116debde8d1c85e5e76eeece9c5ae731b19276a6040231455?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/d817b364cff1d66116debde8d1c85e5e76eeece9c5ae731b19276a6040231455?s=96&d=mm&r=g","caption":"agoddard"},"sameAs":["https:\/\/quebit.com\/askquebit"],"url":"https:\/\/quebit.com\/askquebit\/author\/agoddard\/"}]}},"_links":{"self":[{"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/posts\/3326","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/comments?post=3326"}],"version-history":[{"count":1,"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/posts\/3326\/revisions"}],"predecessor-version":[{"id":3797,"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/posts\/3326\/revisions\/3797"}],"wp:attachment":[{"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/media?parent=3326"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/categories?post=3326"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/quebit.com\/askquebit\/wp-json\/wp\/v2\/tags?post=3326"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}