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
選填

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
選填

頁數,從 1 開始

Validations:

  • Must be a number.

per_page
選填

每頁要傳回的結果數量

Validations:

  • Must be a number.

Search fields

Field name 類型 Possible values
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]
選填 , 允許空值

Validations:

  • Must be a String

filter[override]
選填 , 允許空值

Validations:

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

filter[permission_ids]
選填 , 允許空值

Validations:

  • Must be an array of any type

filter[organization_ids]
選填 , 允許空值

Validations:

  • Must be an array of any type

filter[location_ids]
選填 , 允許空值

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]
選填 , 允許空值

Validations:

  • Must be a String

filter[override]
選填 , 允許空值

Validations:

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

filter[permission_ids]
選填 , 允許空值

Validations:

  • Must be an array of any type

filter[organization_ids]
選填 , 允許空值

Validations:

  • Must be an array of any type

filter[location_ids]
選填 , 允許空值

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