GET /api/common_parameters
List all common parameters.

Params

Param Name Description
search
Optional

filter results

Validations:

  • Must be a String

order
Optional

sort results

Validations:

  • Must be a String

page
Optional

paginate results

Validations:

  • Must be a String

per_page
Optional

number of entries per request

Validations:

  • Must be a String


GET /api/common_parameters/:id
Show a common 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.


POST /api/common_parameters
Create a common_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

Validations:

  • Must be one of: true, false.


PUT /api/common_parameters/:id
Update a common_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

Validations:

  • Must be one of: true, false.


DELETE /api/common_parameters/:id
Delete a common_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.