{"info":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","description":"

Documentation describes the API of IXMP backend service.

It consists from following parts:

Auth - user authentication including getting authorization token for guest and non-guest users
Common data - provides access to static and rarely updated informatio such as lists of model and scenario names, list of units etc
Scenarios (runs) - provides access to brief and detailed information about scenario versions (runs), timeseries data and allow to do basic manipulations on scenarios
Workspaces - CRUD interface to workspaces, allows to update workspace previews, publish workspaces etc.
Files - API edpoints to upload and download files
Jobs - allows to submit new and get statuses and logs for existing jobs
Datasets - an alternative API to get access to model data, timeseries, geo-layers and metadata.
Caches - API to manipulate application caches (for internal use)

Data copyright: If you are retrieving data from the `IAMC 1.5C Scenario Explorer hosted by IIASA`, please visit this page for more inforration

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1057691","collectionId":"a1f649b5-845a-4e87-903b-541bc1cf5294","publishedId":"SWE6Zcmd","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-01-14T15:54:37.000Z"},"item":[{"name":"Auth","item":[{"name":"Login","event":[{"listen":"test","script":{"id":"84fe5d3f-cf46-460e-b226-9ca6bc4585d5","exec":["pm.test(\"response is ok\", function () {"," pm.response.to.have.status(200);"," pm.environment.set(\"token\", responseBody.replace(/^\\\"(.+)\\\"$/, \"$1\"));","});",""],"type":"text/javascript"}}],"id":"65d95f07-a88d-48ef-92b0-40aad7994471","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"username\": \"{{username}}\",\n\t\"password\": \"{{password}}\",\n\t\"application\": \"{{application}}\"\n}"},"url":"{{auth-api-url}}/config/v1/login","description":"

Get authentication token as text (body) or Authorization response header

\n","urlObject":{"path":["config","v1","login"],"host":["{{auth-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"65d95f07-a88d-48ef-92b0-40aad7994471"},{"name":"Login without application","event":[{"listen":"test","script":{"id":"84fe5d3f-cf46-460e-b226-9ca6bc4585d5","exec":["pm.test(\"response is ok\", function () {"," pm.response.to.have.status(200);"," pm.environment.set(\"token\", responseBody.replace(/^\\\"(.+)\\\"$/, \"$1\"));","});",""],"type":"text/javascript"}}],"id":"5751f4b6-a385-4f50-83db-9a7a176fc9b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"username\": \"{{username}}\",\n\t\"password\": \"{{password}}\"\n}"},"url":"{{auth-api-url}}/config/v1/login","description":"

Get authentication token as text (body) or Authorization response header

\n","urlObject":{"path":["config","v1","login"],"host":["{{auth-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5751f4b6-a385-4f50-83db-9a7a176fc9b5"},{"name":"Guest login","event":[{"listen":"test","script":{"id":"84fe5d3f-cf46-460e-b226-9ca6bc4585d5","exec":["pm.test(\"response is ok\", function () {"," pm.response.to.have.status(200);"," pm.environment.set(\"token\", responseBody.replace(/^\\\"(.+)\\\"$/, \"$1\"));","});",""],"type":"text/javascript"}}],"id":"edfd17bd-1b77-4701-a39e-8e6126aac868","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{auth-api-url}}/config/v1/anonym/{{application}}","description":"

Get authentication token as text (body) or Authorization response header for guest (anonymous) account

\n","urlObject":{"path":["config","v1","anonym","{{application}}"],"host":["{{auth-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"edfd17bd-1b77-4701-a39e-8e6126aac868"},{"name":"User config","event":[{"listen":"test","script":{"id":"84fe5d3f-cf46-460e-b226-9ca6bc4585d5","exec":[""],"type":"text/javascript"}}],"id":"4383006a-5897-4a28-acda-8bba7c2ab7bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{auth-api-url}}/config/v1/config/user/{{application}}","description":"

Get a config object assosiated with current user (token) for specified application

Renew expored JWT token with new one

Get a list of available scenarios

Get a list of available models

\n","urlObject":{"path":["models"],"host":["{{ixmp-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7d7da29b-a02a-4648-adc3-57f2492015c2"},{"name":"Documentation","id":"6a5108b1-8c17-403b-b793-0b71a82d8617","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"keys\": [\n\t\t\"/metadata/category\",\n\t\t\"/metadata/project\",\n\t\t\"/scenarios/1\"\n\t]\n}"},"url":"{{ixmp-api-url}}/docs","description":"

Fetch list of documentation entries for metadata categories, scenarios, models, variables etc.\nRequest should contain a list of keys in format \"//\", where documentation entity type is one of following:

scenarios
regions
models
timeseries
metadata

Get a list of available models

Get a list of available units

Get a list of available regions. A query parameter \"hierarchy\" can be provided to retrieve specific subset of regions

Get list of available metadata categories - names with data type

Retrieves a listo of runs optionally including metadata for each particular run

if true, only default run versions are included in response

\n","type":"text/plain"},"key":"getOnlyDefaultRuns","value":"false"},{"description":{"content":"

if true, metadata will be included in response

\n","type":"text/plain"},"key":"includeMetadata","value":"true"}],"variable":[]}},"response":[],"_postman_id":"a361ba3a-9c0b-47f5-be21-58202dd6c804"},{"name":"Single run details","id":"62220a9a-c592-4dfb-ba8b-2d7851ac572b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ixmp-api-url}}/runs/{{run-id}}","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}},"urlObject":{"path":["runs","{{run-id}}"],"host":["{{ixmp-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"62220a9a-c592-4dfb-ba8b-2d7851ac572b"},{"name":"References","id":"7256a49c-096f-4c05-bca5-3e8cfe5e294b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ixmp-api-url}}/runs/refs","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}},"urlObject":{"path":["runs","refs"],"host":["{{ixmp-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7256a49c-096f-4c05-bca5-3e8cfe5e294b"},{"name":"Single run parameters","id":"3a5e5969-933b-462b-a16b-0f2a26ad99ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ixmp-api-url}}/runs/{{run-id}}/pars?filters=[]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}},"urlObject":{"path":["runs","{{run-id}}","pars"],"host":["{{ixmp-api-url}}"],"query":[{"key":"filters","value":"[]"}],"variable":[]}},"response":[],"_postman_id":"3a5e5969-933b-462b-a16b-0f2a26ad99ef"},{"name":"Single run variables","id":"3c8e3a1e-c6f1-4304-9163-45d34ed18ad9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ixmp-api-url}}/runs/{{run-id}}/vars?filters=[]","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}},"urlObject":{"path":["runs","{{run-id}}","vars"],"host":["{{ixmp-api-url}}"],"query":[{"key":"filters","value":"[]"}],"variable":[]}},"response":[],"_postman_id":"3c8e3a1e-c6f1-4304-9163-45d34ed18ad9"},{"name":"Single run timeseries list","id":"eba4f61f-d584-4196-91b6-c8ef5ce04892","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ixmp-api-url}}/runs/{{run-id}}/ts/iamvars","description":"

Get a list of available timeseries variables for sing run

Get a list of timeseries details (variable name, region, unit etc) according to the filters provided in request payload (json) such as: list of run ids, list of region names, list of variable names, units and years

Get a list of timeseries data according to the filters provided in request payload (json) such as: list of run ids, list of region names, list of variable names, units and years

API to retrieve scenario details and model (parameters, variables etc) amd timeseries data.

\n","event":[{"listen":"prerequest","script":{"id":"d62f506d-47ee-41ce-a413-5672e6f86d60","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ce083557-0520-4781-ae19-cbf2cad3099b","type":"text/javascript","exec":[""]}}],"_postman_id":"51ad1f83-d6fc-4071-b7dd-b57de07ac7c4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}}},{"name":"Workspaces","item":[{"name":"Create workspace","id":"d915c22f-5361-47c6-bb05-45d14c78fbd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"id\":1,\n\t\"name\":\"Demo\",\n\t\"description\":\"Demo\",\n\t\"panels\":[],\n\t\"preview\":null,\n\t\"publishType\":\"PRIVATE\",\n\t\"accessToken\":\"660fb0e2-7aa0-4064-b5ce-3ba8a8f443a6\"\n}"},"url":"{{ixmp-api-url}}/workspaces","description":"

Create new workspace

Get list of available/accessible workspaces.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}},"urlObject":{"path":["workspaces"],"host":["{{ixmp-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d51379f9-b58c-430a-93fa-6f93e05d882d"},{"name":"Get single workspace details","id":"c5906849-833a-4e78-a226-b01828373094","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ixmp-api-url}}/workspaces/{{workspace-id}}","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}},"urlObject":{"path":["workspaces","{{workspace-id}}"],"host":["{{ixmp-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5906849-833a-4e78-a226-b01828373094"},{"name":"Get workspace preview","id":"74e28034-2d45-41cc-abaf-322b1ce6d7c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ixmp-api-url}}/workspaces/{{workspace-id}}/preview","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}},"urlObject":{"path":["workspaces","{{workspace-id}}","preview"],"host":["{{ixmp-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"74e28034-2d45-41cc-abaf-322b1ce6d7c6"},{"name":"Get workspace preview image (pass authorization token as query parameter)","id":"3fdc1250-84c4-4df9-8663-11ad8eb2f457","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{ixmp-api-url}}/workspaces/{{workspace-id}}/preview.png?token={{token}}","urlObject":{"path":["workspaces","{{workspace-id}}","preview.png"],"host":["{{ixmp-api-url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"3fdc1250-84c4-4df9-8663-11ad8eb2f457"},{"name":"Get workspace preview (token in query)","id":"fe1c1ed8-4421-4d0c-a63c-83ef7e544fb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{ixmp-api-url}}/workspaces/0/preview.png?token={{token}}","urlObject":{"path":["workspaces","0","preview.png"],"host":["{{ixmp-api-url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"fe1c1ed8-4421-4d0c-a63c-83ef7e544fb5"},{"name":"Get shared workspace preview","id":"cdf6866a-0baf-4cb5-ac9f-214a5db7588b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{ixmp-api-url}}/workspaces/shared/{{workspace-share-token}}/preview.png","urlObject":{"path":["workspaces","shared","{{workspace-share-token}}","preview.png"],"host":["{{ixmp-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cdf6866a-0baf-4cb5-ac9f-214a5db7588b"},{"name":"Update workspace preview","id":"23c5510f-19ab-41a3-bd80-701af90a4ea4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/octet-stream","type":"text"}],"body":{"mode":"file","file":{"src":"/Users/kushin/Desktop/response.png"}},"url":"{{ixmp-api-url}}/workspaces/0/preview","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}},"urlObject":{"path":["workspaces","0","preview"],"host":["{{ixmp-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"23c5510f-19ab-41a3-bd80-701af90a4ea4"},{"name":"Get shared workspace","id":"127dad1b-9a42-4a0e-9886-15d48feaf363","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ixmp-api-url}}/workspaces/shared/660fb0e2-7aa0-4064-b5ce-3ba8a8f443a6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}},"urlObject":{"path":["workspaces","shared","660fb0e2-7aa0-4064-b5ce-3ba8a8f443a6"],"host":["{{ixmp-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"127dad1b-9a42-4a0e-9886-15d48feaf363"}],"id":"ca85ca08-7a2f-49ee-8c73-37c20a5077e2","_postman_id":"ca85ca08-7a2f-49ee-8c73-37c20a5077e2","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}}},{"name":"Files","item":[{"name":"Create file","id":"f9ded812-00e5-4fa7-99c0-4e3bfff7f465","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/Users/kushin/Desktop/error_in_data.log"},{"key":"description","value":"picture","type":"text"}]},"url":"{{ixmp-api-url}}/files","description":"

Upload new file

Get list of accessible files (public, shared and owned)

Get list of private/owned files

Get file content

API to manipulate files

\n","event":[{"listen":"prerequest","script":{"id":"9d61fbf7-3f55-4987-ab84-6718afd300d5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"18a29ef6-6c9d-4d08-9a18-23bc73d863ae","type":"text/javascript","exec":[""]}}],"_postman_id":"59eff32b-d589-45a0-8489-a890a9aefc0c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}}},{"name":"Jobs","item":[{"name":"Get list of jobs","id":"90d74510-c637-4406-9084-db84f7b33ed0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{ixmp-api-url}}/jobs?status=CREATED","description":"

Get list of existing jobs, optionally allowing to filter by:

job status (one of CREATED, STARTED, FINISHED)
job submit time (since, till) provided as unix-timestamp

one of CREATED, STARTED, FINISHED

\n","type":"text/plain"},"key":"status","value":"CREATED"},{"disabled":true,"description":{"content":"

filter jobs by submit time

\n","type":"text/plain"},"key":"since","value":"1554208649000"},{"disabled":true,"description":{"content":"

filter jobs by submit time

\n","type":"text/plain"},"key":"till","value":"1554208659000"}],"variable":[]}},"response":[],"_postman_id":"90d74510-c637-4406-9084-db84f7b33ed0"},{"name":"Submit a job","id":"cd04d350-2ab0-42fc-b987-cdc0fd7967ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"parameters\": {\n \t\"filename\": 11111\n }\n}"},"url":"{{ixmp-api-url}}/jobs","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}},"urlObject":{"path":["jobs"],"host":["{{ixmp-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cd04d350-2ab0-42fc-b987-cdc0fd7967ea"},{"name":"Get job details","id":"1b99bf64-7344-4945-8b54-39d3c35a53d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{ixmp-api-url}}/jobs/2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}},"urlObject":{"path":["jobs","2"],"host":["{{ixmp-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1b99bf64-7344-4945-8b54-39d3c35a53d7"},{"name":"Get job log","id":"46ac9ecf-b66f-47b1-ab72-763e7d30ba91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{ixmp-api-url}}/jobs/24/log","description":"

Fetch job execution log

Used by job scheduler to mark a job as started

Used by job scheduler to mark a job as finished

API to manage job queue

\n","event":[{"listen":"prerequest","script":{"id":"783af8a5-0eae-4489-9afc-1f3712333728","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"192a63df-faca-47f9-9cc4-4b8940f5fdaa","type":"text/javascript","exec":[""]}}],"_postman_id":"09cfe2bb-949b-416d-b6ad-ce104108a432","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}}},{"name":"Datasets","item":[{"name":"Get list of datasets","id":"04f4a0b6-81b7-4a5c-bd52-7d6b78ea1e89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"runs\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6,\n 7,\n 8,\n 9,\n 10,\n 11,\n 12,\n 13,\n 14,\n 15,\n 16,\n 17,\n 18,\n 19,\n 20,\n 21,\n 22,\n 23,\n 24,\n 25,\n 26,\n 27,\n 28,\n 29,\n 30,\n 31,\n 32,\n 33,\n 34,\n 35,\n 36,\n 37,\n 38,\n 39,\n 40,\n 41,\n 42,\n 43,\n 44,\n 45,\n 46,\n 47,\n 48\n ],\n \"sources\": {\n \"Capacity|Electricity\": {\n \"type\": \"TIMESERIES\"\n }\n }\n}"},"url":"{{ixmp-api-url}}/datasets/sources","description":"

Return list of available datasets for chosen list of scenarios (runs) and datasets filters (name, type etc)

Retrieve datasets content (data).

Each dataset object contains:

dims (dimensions/columns),
keys (key/value mapping),
entries (2-dimensional array of keys + dataset specific values, e.g. level + margin for parameters, laer reference for layers, value for timeseries)

Datasets API is alternative set of endpoints to retrieve model data, metadata and timeseries data

\n","event":[{"listen":"prerequest","script":{"id":"99b9a0e3-798d-4604-ba6e-92839a36a255","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6c5d2624-a2a1-4cf6-aaee-7bee70788a3d","type":"text/javascript","exec":[""]}}],"_postman_id":"a5401d24-3e92-458a-87cb-8b1fa3917af5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}}},{"name":"Caches","item":[{"name":"List available caches","id":"19cf3703-4f15-4cb7-a855-badb1410ba96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{ixmp-api-url}}/caches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}},"urlObject":{"path":["caches"],"host":["{{ixmp-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"19cf3703-4f15-4cb7-a855-badb1410ba96"},{"name":"Cache keys","id":"6c2554d0-e460-4634-bd14-f703798be142","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{ixmp-api-url}}/caches/timeseriesCache","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}},"urlObject":{"path":["caches","timeseriesCache"],"host":["{{ixmp-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6c2554d0-e460-4634-bd14-f703798be142"},{"name":"Evict whole cache","id":"64b2436c-0734-4384-9a57-8f99d4821bd9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{ixmp-api-url}}/caches/runsMetadataCache","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}},"urlObject":{"path":["caches","runsMetadataCache"],"host":["{{ixmp-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"64b2436c-0734-4384-9a57-8f99d4821bd9"},{"name":"Evict whole cache Copy","id":"14898d1d-8347-4e15-9541-5528cdd4562a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{ixmp-api-url}}/caches/genericCache/timeseries_list","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}},"urlObject":{"path":["caches","genericCache","timeseries_list"],"host":["{{ixmp-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"14898d1d-8347-4e15-9541-5528cdd4562a"}],"id":"21885bbf-85e5-4002-800b-876283df590b","_postman_id":"21885bbf-85e5-4002-800b-876283df590b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}}},{"name":"Metadata","item":[{"name":"Get metadata","id":"b7347dc5-8621-49d1-8fab-620be51d6901","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ixmp-api-url}}/metadata?scenario=7&model=2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}},"urlObject":{"path":["metadata"],"host":["{{ixmp-api-url}}"],"query":[{"description":{"content":"

Current policies (Hot house world, Rep)

\n","type":"text/plain"},"key":"scenario","value":"7"},{"description":{"content":"

MESSAGEix-GLOBIOM 1.0

\n","type":"text/plain"},"key":"model","value":"2"},{"disabled":true,"key":"version","value":"1"}],"variable":[]}},"response":[],"_postman_id":"b7347dc5-8621-49d1-8fab-620be51d6901"},{"name":"Get metadata Copy","id":"ee7527b8-9685-4d12-ab60-4b0cf27bc15f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"entries\": [\n\t\t{\n \"name\": \"exclude\",\n \"value\": false\n },\n {\n \"name\": \"category\",\n \"value\": \"reference\"\n },\n {\n \"name\": \"subcategory\",\n \"value\": \"reference\"\n },\n {\n \"name\": \"Kyoto-GHG|2010 (SAR)\",\n \"value\": \"in range\"\n },\n {\n \"name\": \"reference\",\n \"value\": \"undefined\"\n },\n {\n \"name\": \"project\",\n \"value\": \"unknown\"\n }\n\t],\n\t\"scenarioId\": 175,\n\t\"modelId\": 22,\n\t\"version\": null\n}"},"url":"{{ixmp-api-url}}/metadata","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}},"urlObject":{"path":["metadata"],"host":["{{ixmp-api-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ee7527b8-9685-4d12-ab60-4b0cf27bc15f"}],"id":"97c646ad-1cdf-4fd8-84cf-1d91beff4b40","_postman_id":"97c646ad-1cdf-4fd8-84cf-1d91beff4b40","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a1f649b5-845a-4e87-903b-541bc1cf5294","id":"a1f649b5-845a-4e87-903b-541bc1cf5294","name":"IXMP","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"5b34debc-a7ce-49bc-b21a-ee1f55c0b529","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"aefd4f0c-35ea-4077-988b-c359a865eab5","type":"text/javascript","exec":[""]}}]}