Common parameters

>>>

GET /api/common_parameters
List all global parameters.

Params

Param name Description
show_hidden
optional

Display hidden values

Validations:

  • Must be one of: true, false, 1, 0
search
optional

filtrera resultat

Validations:

  • Must be a String
order
optional

sortera resultat

Validations:

  • Must be a String
page
optional

paginate results

Validations:

  • Must be a String
per_page
optional

antal poster per begäran

Validations:

  • Must be a String
>>>

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

Params

Param name Description
show_hidden
optional

Display hidden values

Validations:

  • Must be one of: true, false, 1, 0
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.
>>>

POST /api/common_parameters
Create a global parameter

Params

Param name Description
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[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:

  • 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[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:

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