GET /api/common_parameters
List all common parameters.

Params

Param name Description
search
optional

filter results


Value: Must be String
order
optional

sort results


Value: Must be String
page
optional

paginate results


Value: Must be String
per_page
optional

number of entries per request


Value: Must be String

GET /api/common_parameters/:id
Show a common parameter.

Params

Param name Description
id
required

Value: 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

Value: Must be a Hash
common_parameter[name]
required

Value: Must be String
common_parameter[value]
required

Value: Must be String
common_parameter[hidden_value]
optional

Value: Must be one of: true, false.

PUT /api/common_parameters/:id
Update a common_parameter

Params

Param name Description
id
required

Value: 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

Value: Must be a Hash
common_parameter[name]
optional

Value: Must be String
common_parameter[value]
optional

Value: Must be String
common_parameter[hidden_value]
optional

Value: Must be one of: true, false.

DELETE /api/common_parameters/:id
Delete a common_parameter

Params

Param name Description
id
required

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