GET /api/filters
フィルタ一覧

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/filters/: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/filters
フィルタの作成

Params

Param Name Description
filter
Required

Validations:

  • Must be a Hash

filter[role_id]
Required

Validations:

  • Must be String

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

Validations:

  • Must be String

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

Validations:

  • Must be an array of any type

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

Validations:

  • Must be an array of any type

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

Validations:

  • Must be an array of any type


PUT /api/filters/:id
フィルタの更新

Params

Param Name Description
id
Required

Validations:

  • Must be String

filter
Required

Validations:

  • Must be a Hash

filter[role_id]
Optional

Validations:

  • Must be String

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

Validations:

  • Must be String

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

Validations:

  • Must be an array of any type

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

Validations:

  • Must be an array of any type

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

Validations:

  • Must be an array of any type


DELETE /api/filters/:id
フィルタの削除

Params

Param Name Description
id
Required

Validations:

  • Must be String