Ipro Configuration API documentation version v1

http://acme.company.com:52000/ipro/myIpro/api/v1

Configurations

A collection of configurations

get put post delete

get

fetches all configurations for an Ipro

put

deletes any existing configurations for an ipro, regardless of their config-ids, and then creates configurations for the given config-ids

post

creates or overwrites configuration resources including nested resources for given config-ids

delete

deletes all of the configurations for an ipro

creates or overwrites configuration resources including nested resources for given config-ids

Headers

  • x-csrf-token: (string)

Body

Type: application/json

Example:

[
  {
    "configId": "ahcc",
    "config": {
      "zoomLevel": 4
    },
    "i18n": [
      {
        "lang": "en-US",
        "mapping": [
          {
            "key" : "typeDimLabel", "text" : "Type",
            "key" : "colorLabel","text" : "Color"
          }
        ]
      },
      {
        "lang": "de-DE",
        "mapping": [
          {
            "key" : "typeDimLabel", "text" : "Typ",
            "key" : "colorLabel","text" : "Farbe"
          }
        ]
      }
    ]
  },
  {
    "configId": "eid",
    "config": {
      "zoomLevel": 7
    },
    "i18n" : [
      {
        "lang": "en-US",
        "mapping": [
          {
            "key" : "typeDimLabel", "text" : "Type",
            "key" : "colorLabel","text" : "Color"
          }
        ]
      },
      {
        "lang": "en-GB",
        "mapping": [
          {
            "key" : "typeDimLabel", "text" : "Type",
            "key" : "colorLabel","text" : "Colour"
          }
        ]
      }
    ]
  }
]

HTTP status code 200

get put delete

A specific configuration, a member of the configurations collection

get

fetches configuration for a specific configId

put

updates the configuration for a specific configId

delete

deletes all nested configuration resources for a given configId

fetches configuration for a specific configId

URI Parameters

  • configId: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  "config": {
    "zoomLevel": 4
  },
  "i18n": [
    {
      "lang": "en-US",
      "mapping": [
        {
          "key" : "typeDimLabel", "text" : "Type",
          "key" : "colorLabel","text" : "Color"
        }
      ]
    },
    {
     "lang": "de-DE",
      "mapping": [
        {
          "key" : "typeDimLabel", "text" : "Typ",
          "key" : "colorLabel","text" : "Farbe"
        }
      ]
    }
  ]
}

updates the configuration for a specific configId

URI Parameters

  • configId: required (string)

Headers

  • x-csrf-token: (string)

Body

Type: application/json

Example:

{
  "config": {
    "zoomLevel": 4
  },
  "i18n": [
    {
      "lang": "en-US",
      "mapping": [
        {
          "key" : "typeDimLabel", "text" : "Type",
          "key" : "colorLabel","text" : "Color"
        }
      ]
    },
    {
     "lang": "de-DE",
      "mapping": [
        {
          "key" : "typeDimLabel", "text" : "Typ",
          "key" : "colorLabel","text" : "Farbe"
        }
      ]
    }
  ]
}

HTTP status code 200

deletes all nested configuration resources for a given configId

URI Parameters

  • configId: required (string)

HTTP status code 200

get delete

A collection of common configurations

get

fetches the frontend Insight Provider configuration for a given configId

delete

deletes configuration(frontend and backend) with given configId

fetches the frontend Insight Provider configuration for a given configId

URI Parameters

  • configId: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  "zoomLevel": 4,
  "aggregationLevel": "HOUR"
}

deletes configuration(frontend and backend) with given configId

URI Parameters

  • configId: required (string)

HTTP status code 200

get delete

A collection of text-interpretations

get

fetches all text interpretations for a given configId

delete

deletes all text-interpretations for a given configId

fetches all text interpretations for a given configId

URI Parameters

  • configId: required (string)

HTTP status code 200

Body

Type: application/json

Example:

[
  {
    "lang": "en-US",
    "mapping": [
      {
        "key" : "typeDimLabel", "text" : "Type",
        "key" : "colorLabel","text" : "Color"
      }
    ]
  },
  {
   "lang": "de-DE",
    "mapping": [
      {
        "key" : "typeDimLabel", "text" : "Typ",
        "key" : "colorLabel","text" : "Farbe"
      }
    ]
  }
]

deletes all text-interpretations for a given configId

URI Parameters

  • configId: required (string)

HTTP status code 200

get put delete

A specific text-interpretation, a member of the text-interpretations collection

get

fetches all key text pairs for a given configId and lang combination

put

creates/updates key text pairs for a configId and a given language-id

delete

deletes all key text pairs for a configId and given language

fetches all key text pairs for a given configId and lang combination

URI Parameters

  • configId: required (string)
  • lang: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  "mapping": [
    {
      "key" : "typeDimLabel", "text" : "Type",
      "key" : "colorLabel","text" : "Color"
    }
  ]
}

creates/updates key text pairs for a configId and a given language-id

URI Parameters

  • configId: required (string)
  • lang: required (string)

Headers

  • x-csrf-token: (string)

Body

Type: application/json

Example:

{
  "mapping": [
    {
      "key" : "typeDimLabel", "text" : "Type",
      "key" : "colorLabel","text" : "Color"
    }
  ]
}

HTTP status code 200

deletes all key text pairs for a configId and given language

URI Parameters

  • configId: required (string)
  • lang: required (string)

HTTP status code 200

get put delete

A specific key-value pair in a specific language text-interpretation

get

fetches the text-value for a configId,lang and key combination

put

updates a key's text for configId, lang combination

delete

deletes the text values for a given configId, lang and key

fetches the text-value for a configId,lang and key combination

URI Parameters

  • configId: required (string)
  • lang: required (string)
  • key: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  "text": "Type"
}

updates a key's text for configId, lang combination

URI Parameters

  • configId: required (string)
  • lang: required (string)
  • key: required (string)

Headers

  • x-csrf-token: (string)

Body

Type: application/json

Example:

{
  "text": "Type"
}

HTTP status code 200

deletes the text values for a given configId, lang and key

URI Parameters

  • configId: required (string)
  • lang: required (string)
  • key: required (string)

HTTP status code 200