联系我们角色
角色对象
| 属性 | 类型 | 描述 |
|---|---|---|
id |
整数 | 角色的唯一ID。 |
的名字 |
字符串 | 角色的名称。 |
user_id |
整数数组 | 分配给该角色的用户id。 |
created_at |
datetime | 创建角色的日期和时间。 |
updated_at |
datetime | 角色上次更新的日期和时间。 |
需要的权限
必须是管理员才能与/ v2 /角色端点。权限不足将导致403年被禁止的状态码。
列出所有角色
返回帐户中的角色列表。角色按创建日期排序返回，最近创建的角色出现在前面。
响应包含一个对象角色属性，该属性包含最多到的数组per_page的角色。数组中的每个条目都是一个单独的角色对象。如果没有更多可用的角色，则生成的数组将为空。响应中包含了几个额外的分页属性，以简化对角色的分页。
获得/ v2 /角色| 参数 | 类型 | 描述 |
|---|---|---|
页面 |
整数 | 在分页中使用的页码。例如，如果您提出一个列表请求并收到2000条记录，您的后续呼叫可以包括页面= 2检索列表的下一页。(默认值:1) |
per_page |
整数 | 每页要返回的记录数。取值范围为1 ~ 2000。(默认:2000) |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/roles" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"示例响应:
｛“角色”：［｛“id”：618100，“名称”：“设计师”，“created_at”：“2020 - 04 - 17 - t10:09:41z”，“updated_at”：“2020 - 04 - 17 - t10:09:41z”，“user_id”：［］}，｛“id”：618099，“名称”：“开发人员”，“created_at”：“2020 - 04 - 17 - t10:08:43z”，“updated_at”：“2020 - 04 - 17 - t10:08:43z”，“user_id”：［］}，｛“id”：617630，“名称”：“销售”，“created_at”：“2020 - 04 - 16 - t16:59:59z”，“updated_at”：“2020 - 04 - 16 - t16:59:59z”，“user_id”：［2084359，3122373，3122374］｝]，“per_page”：2000，“total_pages”：1，“total_entries”：2，“next_page”：零，“previous_page”：零，“页面”：1，“链接”：｛“第一”：“https://api.bob客服端下载harvestapp.com/v2/roles?page=1&per_page=2000”，“下一个”：零，“以前”：零，“最后一次”：“https://api.bob客服端下载harvestapp.com/v2/roles?page=1&per_page=2000”｝｝检索角色
检索具有给定ID的角色。返回角色对象和200好了提供有效标识符时的响应代码。
GET / v2 /角色/ {ROLE_ID}示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/roles/617630" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"示例响应:
｛“id”：617630，“名称”：“销售”，“created_at”：“2020 - 04 - 16 - t16:59:59z”，“updated_at”：“2020 - 04 - 16 - t16:59:59z”，“user_id”：［2084359，3122373，3122374］｝创建角色
创建一个新的角色对象。返回角色对象和201年创建调用成功时的响应代码。
POST / v2 /角色| 参数 | 类型 | 要求 | 描述 |
|---|---|---|---|
的名字 |
字符串 | 要求 | 角色的名称。 |
user_id |
整数数组 | 可选 | 分配给该角色的用户id。 |
示例请求:
邮差集合
我们有一组API请求邮递员这样就很容易验证了。点击这里了解更多!
指定用户id
为了为您创建的角色指定多个用户id，您所需要做的就是添加一个额外的用户iduser_id []参数，如下图所示。
curl "https://api.bob客服端下载harvestapp.com/v2/roles" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X POST \ -H "Content-Type: application/json" \ -d '{"name":"Marketing"，"user_ids":[3122374,3122373,2084359]}'示例响应:
｛“id”：617670，“名称”：“市场营销”，“created_at”：“2020 - 04 - 16 - t18:18:30z”，“updated_at”：“2020 - 04 - 16 - t18:18:30z”，“user_id”：［3122374，3122373，2084359］｝更新角色
通过设置传递的参数值更新特定角色。任何未提供的参数将保持不变。返回角色对象和200好了调用成功时的响应代码。
补丁/ v2 /角色/ {ROLE_ID}| 参数 | 类型 | 要求 | 描述 |
|---|---|---|---|
的名字 |
字符串 | 可选 | 角色的名称。 |
user_id |
整数数组 | 可选 | 分配给该角色的用户id。 |
示例请求:
邮差集合
我们有一组API请求邮递员这样就很容易验证了。点击这里了解更多!
修改用户id
任何现有的用户id将被您的user_id []参数。这意味着如果你只指定一个user_id参数时，除该用户外的所有用户都将从角色中取消分配。
curl "https://api.bob客服端下载harvestapp.com/v2/roles/618099" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X PATCH \ -H "Content-Type: application/json" \ -d '{"name":"HR"，"user_ids":[2084359,3122373,3122374]}'示例响应:
｛“id”：618099，“名称”：“人力资源”，“created_at”：“2020 - 04 - 16 - t17:00:38z”，“updated_at”：“2020 - 04 - 16 - t17:00:57z”，“user_id”：［2084359］｝删除角色
删除角色。删除角色将断开它与分配给它的任何用户的链接。返回一个200好了调用成功时的响应代码。
删除/ v2 /角色/ {ROLE_ID}