GET /api/filters
すべてのフィルターを一覧表示

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String

page
任意

1 から始まるページ番号

Validations:

  • Must be a number.

per_page
任意

戻されるページごとの結果数

Validations:

  • Must be a number.

検索フィールド

フィールド名 タイプ 設定可能な値
limited true, false
location
location_id
organization
organization_id
override true, false
permission
resource
role
role_id
search
unlimited true, false

GET /api/filters/:id
フィルターの表示

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

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
フィルターの作成

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

filter
必須

Validations:

  • Must be a Hash

filter[role_id]
必須

Validations:

  • Must be a String

filter[search]
任意 , nil可

Validations:

  • Must be a String

filter[override]
任意 , nil可

Validations:

  • Must be one of: true, false, 1, 0.

filter[permission_ids]
任意 , nil可

Validations:

  • Must be an array of any type

filter[organization_ids]
任意 , nil可

Validations:

  • Must be an array of any type

filter[location_ids]
任意 , nil可

Validations:

  • Must be an array of any type


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

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be a String

filter
必須

Validations:

  • Must be a Hash

filter[role_id]
任意

Validations:

  • Must be a String

filter[search]
任意 , nil可

Validations:

  • Must be a String

filter[override]
任意 , nil可

Validations:

  • Must be one of: true, false, 1, 0.

filter[permission_ids]
任意 , nil可

Validations:

  • Must be an array of any type

filter[organization_ids]
任意 , nil可

Validations:

  • Must be an array of any type

filter[location_ids]
任意 , nil可

Validations:

  • Must be an array of any type


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

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be a String