Examples

POST /api/common_parameters
{
  "common_parameter": {
    "name": "special_key",
    "value": "123"
  }
}
201
{
  "created_at": "2019-11-07 08:32:20 UTC",
  "updated_at": "2019-11-07 08:32:20 UTC",
  "hidden_value?": false,
  "hidden_value": "*****",
  "id": 767575239,
  "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

common_parameter
Required

Validations:

  • Must be a Hash

common_parameter[name]
Required

Validations:

  • Must be a String

common_parameter[value]
Required

Validations:

  • Must be a String

common_parameter[parameter_type]
Required

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: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false.