GET /api/roles
列出所有角色

参数

参数名字 描述
search
选填

过滤结果

Validations:

  • Must be a String

order
选填

结果排序

Validations:

  • Must be a String

page
选填

编页结果

Validations:

  • Must be a String

per_page
选填

每个请求中的条目数

Validations:

  • Must be a String


GET /api/roles/:id
显示角色

参数

参数名字 描述
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.

description
选填

Validations:

  • Must be a String


POST /api/roles
生成角色

参数

参数名字 描述
role
必填

Validations:

  • Must be a Hash

role[name]
必填

Validations:

  • Must be a String

role[description]
选填 , 允许空值

角色描述

Validations:

  • Must be a String

role[location_ids]
选填 , 允许空值

使用给定 id 替换位置

Validations:

  • Must be an array of any type

role[organization_ids]
选填 , 允许空值

使用给定 id 替换机构

Validations:

  • Must be an array of any type


PUT /api/roles/:id
更新角色

参数

参数名字 描述
id
必填

Validations:

  • Must be a String

role
必填

Validations:

  • Must be a Hash

role[name]
选填

Validations:

  • Must be a String

role[description]
选填 , 允许空值

角色描述

Validations:

  • Must be a String

role[location_ids]
选填 , 允许空值

使用给定 id 替换位置

Validations:

  • Must be an array of any type

role[organization_ids]
选填 , 允许空值

使用给定 id 替换机构

Validations:

  • Must be an array of any type


DELETE /api/roles/:id
删除角色

参数

参数名字 描述
id
必填

Validations:

  • Must be a String


POST /api/roles/:id/clone
角色复制

参数

参数名字 描述
id
必填

Validations:

  • Must be a String

role
必填

Validations:

  • Must be a Hash

role[name]
选填

Validations:

  • Must be a String

role[description]
选填 , 允许空值

角色描述

Validations:

  • Must be a String

role[location_ids]
选填 , 允许空值

使用给定 id 替换位置

Validations:

  • Must be an array of any type

role[organization_ids]
选填 , 允许空值

使用给定 id 替换机构

Validations:

  • Must be an array of any type