Filters

>>>

GET /api/filters
列出所有过滤器

参数

参数名字 描述
location_id
选填

根据位置界定的范围

Validations:

  • Must be a Integer
organization_id
选填

根据机构界定的范围

Validations:

  • Must be a Integer
search
选填

过滤结果

Validations:

  • Must be a String
order
选填

排序项和顺序，例如 ‘id DESC’

Validations:

  • Must be a String
page
选填

编页结果

Validations:

  • Must be a String
per_page
选填

每个请求中的条目数

Validations:

  • Must be a String

搜索字段

字段名 类型 可能的值
limited true, false
location string
location_id integer
organization string
organization_id integer
override true, false
permission string
resource string
role string
role_id integer
search text
unlimited true, false
>>>

GET /api/filters/:id
显示过滤器

参数

参数名字 描述
location_id
选填

根据位置界定的范围

Validations:

  • Must be a Integer
organization_id
选填

根据机构界定的范围

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

根据位置界定的范围

Validations:

  • Must be a Integer
organization_id
选填

根据机构界定的范围

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

根据位置界定的范围

Validations:

  • Must be a Integer
organization_id
选填

根据机构界定的范围

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

根据位置界定的范围

Validations:

  • Must be a Integer
organization_id
选填

根据机构界定的范围

Validations:

  • Must be a Integer
id
必填

Validations:

  • Must be a String