导出组织API

aki发表于:2019年11月08日 13:37:40更新于:2020年01月23日 12:54:01

导出组织API(JSON)

JSON格式导出多个组织信息。

HTTP 方法

GET

URI

https://{sub-domain}.cybozu.cn/v1/organizations.json

请求

参数

参数名称要指定的值必须说明
idsID型数组可省略用数组形式指定组织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头部不需要。

应答

参数

参数名称值的类型说明
organizationsorganization类型数组组织信息的数组。其中的数据按照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",    
        }    
    ]    
}

访问权限

所有用户均可访问。

※kintone的来宾用户不可访问。

    注意:贴代码时请注意格式并使用"代码语言",与本文无关的问题请至“讨论社区”提问。