用JSON格式导出多个组织信息。
HTTP 方法
GET
URI
https://{sub-domain}.cybozu.cn/v1/organizations.json
请求
参数
| 参数名称 | 要指定的值 | 必须 | 说明 |
|---|---|---|---|
| ids | ID型数组 | 可省略 | 用数组形式指定组织id来指定要获取的组织。和下述codes一同省略时，获取全部组织。※ 上限值为100。 |
| codes | 字符串数组 | 可省略 | 用数组形式指定组织code来指定要获取的组织。和上述ids一同省略时，获取全部组织。※ 上限值为100。 |
| offset | 数值 | 可省略 | 指定获取过来的组织信息数组中要从第几条数据开始输出结果。 省略时为0。 |
| size | 数值 | 可省略 | 要输出的数组数据的最大个数。省略时为100。 上限值为100。 |
※ids和codes不可同时指定。同时指定时，将报错。
请求范例
查询字符串
ids[0]=1&ids[1]=2&ids[2]=3&offset=0&size=10
包含请求头部的字符串
GET /v1/organizations.json?ids[0]=1&ids[1]=2&ids[2]=3&offset=0&size=10 HTTP/1.1 Host: example.cybozu.cn:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type头部不需要。
应答
参数
| 参数名称 | 值的类型 | 说明 |
|---|---|---|
| organizations | organization类型数组 | 组织信息的数组。其中的数据按照id顺序(升序)排列。 |
应答的范例
{
"organizations": [
{
"id": 5,
"name": "org1",
"code": "org1",
"parentCode": "org3",
"localName": "ln1",
"localNameLocale": "en",
"description": "desc1",
},
{
"id": 6,
"name": "org2",
"code": "org2",
"parentCode": "org3",
"localName": "ln2",
"localNameLocale": "zh",
"description": "desc2",
},
{
"id": 7,
"name": "org3",
"code": "org3",
"parentCode": null,
"localName": "ln3",
"localNameLocale": "zh",
"description": "desc3",
}
]
}代码范例
用curl发送请求的范例 ：
curl -X GET 'https://sample.cybozu.cn/v1/organizations.json?codes%5B0%5D=Sales01&codes%5B1%5D=Sales02' \ -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
访问权限
所有用户均可访问。
※kintone的来宾用户不可访问。