Set Parameters

This request sets the values of parameters of a configuration session.

Endpoints

  • PUT /configsessions/{sessionId}/parameters

Url

sessionID

The ID of the configuration session

Header

Authorization

Bearer {token}

X-API-KEY

{API key}

Body

JSON

A JSON object with the parameters

Response

A JSON object with the newest state of the parameters

see format in the example below

Remark

In most cases setting anything else but the "value" attribute of a parameter does not make a difference.

Example request


 PUT https://api.paramate.trinckle.com/configsessions/305bdb5c-cf8f-4256-9180-fe050d119f03/parameters
 -H Authorization: Bearer eyJhbGciOiJIUzI1Ni ... 3H8gC1k2DIKNEeJpb72yvmdY
 -H X-API-KEY: 5b260091e8a03ab9af7716af0d71474a
 -H Content-Type: application/json
 {
   "diameter":
    {
      "value": 22.0
    }
  }

 

Output


 HTTP/1.1 200 OK
 {
   "diameter":
    {
      "name": "Diameter",
      "type": "float",
      "min": 10.0,
      "default": 26.0,
      "max": 30.0,
      "value": 22.0
    },
    "bladePitch":
    {
      "name": "Blade Pitch",
      "type": "float",
      "min": 0.0,
      "default": 30.0,
      "max": 45.0,
      "value": 30.0
    }
  }
 

See also