GET /api/common_parameters
List all global parameters.

Params

Param name Description
show_hidden
optional

Display hidden values

Validations:

  • boolean

search
optional

filter results

Validations:

  • String

order
optional

sort results

Validations:

  • String

page
optional

paginate results

Validations:

  • String

per_page
optional

number of entries per request

Validations:

  • String


GET /api/common_parameters/:id
Show a global parameter

Params

Param name Description
show_hidden
optional

Display hidden values

Validations:

  • boolean

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..


POST /api/common_parameters
Create a global parameter

Params

Param name Description
common_parameter
required

Validations:

  • Hash

common_parameter[name]
required

Validations:

  • String

common_parameter[value]
required

Validations:

  • String

common_parameter[hidden_value]
optional , nil allowed

Validations:

  • Must be one of: true, false.


PUT /api/common_parameters/:id
Update a global parameter

Params

Param name Description
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

common_parameter
required

Validations:

  • Hash

common_parameter[name]
optional

Validations:

  • String

common_parameter[value]
optional

Validations:

  • String

common_parameter[hidden_value]
optional , nil allowed

Validations:

  • Must be one of: true, false.


DELETE /api/common_parameters/:id
Delete a global parameter

Params

Param name Description
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..