Skip to content

list_calc_mappings

POST /API/v2/list_calc_mappings
Provides the list of calculated mappings. See example.

Request body

  • project_name: the name of the project.

Response

  • status: the status of the request. success, if the request was processed successfully, or error code, if any error occurred. If the status is not success**, then the response contains the status and reason fields only. Possible values:
    • success: the request was processed successfully.
    • bad_request: invalid request parameters, please see the reason field for more details.
    • timeout: the request took too long to complete.
    • access_error: the user doesn't have access to the specified project/slicer, or a wrong token was used.
    • internal_error: the request failed due to an unknown problem.

  • reason: user-friendly description of the occurred error. This field is displayed for failed requests only.

  • result: an array of dictionaries with the following format:

    • name: mapping name (used in formulas as a link), unique across each project.
    • author: mapping author username.
    • created: mapping creation date.
    • updated: mapping update date.
    • mapped_key: mapped key name.
    • mappings: an array of dictionaries with the following structure:
      • key: mapping key.
      • value: mapping value.

Example

Display the list of all calculation mappings created in the demo project.

Path:

https://uslicer.iponweb.com/API/v2/list_calc_mappings

Request

{
  "project_name": "demo",
}

curl --data '{
  "project_name": "demo"
}' \
-H "Authorization: Bearer <token>" \
"https://uslicer.iponweb.com/API/v2/list_calc_mappings"

Response

{
  "status" : "success",
  "result" : [
      {
        "author" : "test",
        "created" : "2018-01-23 16:12:55",
        "name" : "test_mapping",
        "mapped_key" : "country",
        "mappings" : {
            "US" : 10,
            "NL" : 20,
            "" : 56
        }
      }
  ]
}