导出组API（JSON）
通过JSON格式获取组信息。
HTTP 方法
GET
URI
https://{sub-domain}.cybozu.cn/v1/groups.json
请求
头部
| 头部 | 值与说明 |
|---|---|
| X-Cybozu-Authorization | 值为“登录名:密码”通过BASE64编码之后的字符。 |
| Authorization | 使用Basic验证时，值为“Basic”和“登录名:密码”通过BASE64编码之后的字符。 |
参数
| 参数名称 | 要指定的值 | 必须 | 说明 |
|---|---|---|---|
| ids | ID类型数组 | 可省略(省略时最大100)。 | 要获取的组的ID列表。 |
| codes | 字符串类型数 | 可省略(省略时最大100)。 | 要获取的组的代码列表。 |
| offset | 数值 | 可省略(省略时为0)。 | 偏移量。 |
| size | 数值 | 可省略(省略时最大100)。 | 获取条数。 |
※不可同时指定ids和codes。同时指定时将报错。
请求范例
通过HTTP的查询字符串发送参数时
查询字符串
ids[0]=1&ids[1]=2&ids[2]=3&offset=0&size=100
包含请求头部的字符串
GET /v1/groups.json?ids[0]=1&ids[1]=2&ids[2]=3&offset=0&size=100 HTTP/1.1 Host: example.cybozu.cn:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type头部不需要。
应答
参数
| key | 类型 | 说明 |
|---|---|---|
| groups | group类型的数组 | 组信息 |
应答的范例
{
"groups": [
{
"id": "1",
"code": "1",
"name": "董事",
"description": ""
},
{
"id": "2",
"code": "部门经理",
"name": "部门经理",
"description": ""
},
{
"id": "7532782697181632513",
"code": "everyone",
"name": "Everyone",
"description": null
}
]
}代码范例
用curl发送请求的范例 ：
curl -X GET 'https://sample.cybozu.com/v1/groups.json?codes%5B0%5D=Recruit2022&codes%5B1%5D=Recruit2023' \ -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
访问权限
所有用户均可访问。
※kintone的来宾用户不可访问。