GET /api/common_parameters
グローバルパラーメータ一覧.

Params

Param Name Description
search
Optional

結果をフィルタ

Validations:

  • Must be String

order
Optional

結果をソート

Validations:

  • Must be String

page
Optional

結果をページ分割

Validations:

  • Must be String

per_page
Optional

リクエストあたりのエントリ数

Validations:

  • Must be String


GET /api/common_parameters/:id
グローバルパラメータの表示

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
グローバルパラメータの作成

Params

Param Name Description
common_parameter
Required

Validations:

  • Must be a Hash

common_parameter[name]
Required

Validations:

  • Must be String

common_parameter[value]
Required

Validations:

  • Must be String

common_parameter[hidden_value]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false.


PUT /api/common_parameters/:id
グローバルパラメータの更新

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 String

common_parameter[value]
Optional

Validations:

  • Must be String

common_parameter[hidden_value]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false.


DELETE /api/common_parameters/:id
グローバルパラメータの削除

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.