Examples

PUT /api/common_parameters/636252244-test
{
  "common_parameter": {
    "name": "special_key",
    "value": "123"
  }
}
200
{
  "created_at": "2019-11-07 08:32:17 UTC",
  "updated_at": "2019-11-07 08:32:20 UTC",
  "hidden_value?": false,
  "hidden_value": "*****",
  "id": 636252244,
  "name": "special_key",
  "parameter_type": "string",
  "value": "123"
}

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

common_parameter
Required

Validations:

  • Must be a Hash

common_parameter[name]
Optional

Validations:

  • Must be a String

common_parameter[value]
Optional

Validations:

  • Must be a String

common_parameter[parameter_type]
Optional

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

common_parameter[hidden_value]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false.