GET /api/common_parameters
List all global 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 global 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 global 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 , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Value: Must be one of: true, false.

PUT /api/common_parameters/:id
Update a global 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 , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Value: Must be one of: true, false.

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