导入组织API

aki发表于:2019年10月31日 13:35:04更新于:2021年04月20日 17:15:46

导入组织API(JSON)

添加组织

添加用JSON格式指定的组织。

HTTP 方法

POST

URI

 https://(子域名).cybozu.cn/v1/organizations.json

请求头部

头部值和说明
X-Cybozu-Authorization值为“登录名:密码”通过BASE64编码之后的字符
Authorization使用Basic验证时,值为“Basic”和“登录名:密码”通过BASE64编码之后的字符。
Content-Type

指定为“application/json”。

※不指定时,无法解析JSON ,执行时将报错。

// Sample
      X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
      Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
      Content-Type: application/json

请求正文

organizations数组中一次最多可以指定100条。

参数名称要指定的值必须说明
code字符串

必须

组织代码

128个字符以内

不能为空或仅输入空格字符

name字符串必须

组织名称

128个字符以内

不能为空或仅输入空格字符

localName字符串

其他语言下的显示名称

128个字符以内

省略时默认空字符。

localNameLocale字符串

显示语言

可指定的值如下。

  • ja

  • en

  • zh

省略・空字符・null时,默认cybozu.cn共同管理的“本地化设置”中设置的值。

parentCode字符串

上级组织的代码

上级组织如果为最顶部的组织,为null。

description字符串

说明

1000个字符以内

省略时为空字符。

请求正文范例

{    
    "organizations": [    
        {    
            "code": "organization-1",    
            "name": "组织-1",    
            "localName": "Organization 1",    
            "localNameLocale": "en",    
            "description": "组织1的说明",    
            "parentCode": null    
        }    
    ]    
}

应答

成功时返回如下应答。

    {}

访问权限

cybozu.cn共通管理员可执行。

限制事项

  • 通过CSV导入组织的处理发生冲突时,按照导入的顺序依次处理。

  • 本API不会上锁,因此不推荐同时进行:通过本API导入、通过CSV导入、在页面上手动添加用户等操作。

  • organizations 中包含parentCode可指定的上级组织,但是需要按上级 → 下级的顺序来写JSON列表。

  • 启用组织的预先设置时,不可执行API。

更新组织

更新用JSON格式指定的组织。

HTTP 方法

PUT

URI

 https://(子域名).cybozu.cn/v1/organizations.json

请求头部

头部值和说明
X-Cybozu-Authorization值为“登录名:密码”通过BASE64编码之后的字符
Authorization使用Basic验证时,值为“Basic”和“登录名:密码”通过BASE64编码之后的字符。
Content-Type

指定为“application/json”。

※不指定时,无法解析JSON ,执行时将报错。

// Sample
      X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
      Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
      Content-Type: application/json

请求正文

organizations数组中最多可指定100条。

参数名称要指定的值必须说明
code字符串

必须

组织代码

128个字符以内

name字符串

组织名称

128个字符以内

省略时不更新。

localName字符串

其他语言下的显示名称

128个字符以内

省略时不更新。

localNameLocale字符串

显示语言

可指定的value如下。

  • ja

  • en

  • zh

省略・空字符・null时不更新。

parentCode字符串

上级组织代码

128个字符以内

省略时不更新。
指定空字符时,移到顶部组织。

description字符串

说明

1000个字符以内

省略时为空字符。

请求正文的范例

{    
    "organizations": [    
        {    
            "code": "organization-1",    
            "name": "组织-1",    
            "localName": "Organization 1",    
            "localNameLocale": "en",    
            "description": "组织1的说明",    
            "parentCode": null    
        }    
    ]    
}

应答

成功时返回以下应答。

    {}

访问权限

cybozu.cn共通管理员可执行。

限制事项

  • 通过CSV导入组织的处理发生冲突时,按照导入的顺序依次处理。

  • 本API不会上锁,因此不推荐同时进行:通过本API导入、通过CSV导入、在页面上手动添加用户等操作。

  • 启用组织的预先设置时,不可执行API。

  • 请求正文的organizations 中包含相同组织代码时,用后面的组织信息更新。

删除组织

删除用JSON格式指定的组织。

HTTP 方法

DELETE

URI

 https://(子域名).cybozu.cn/v1/organizations.json

请求头部

头部值和说明
X-Cybozu-Authorization值为“登录名:密码”通过BASE64编码之后的字符
Authorization使用Basic验证时,值为“Basic”和“登录名:密码”通过BASE64编码之后的字符。
Content-Type

指定为“application/json”。

※不指定时,无法解析JSON ,执行时将报错。

// Sample
      X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
      Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
      Content-Type: application/json

请求正文

参数名称要指定的值必须说明
codes字符串

必须

要删除的组织代码

最大100
删除上级组织时,下级组织也会被删除。

请求正文的范例

{    
    "codes": [    
        "code1",    
        "code2",    
        "code3",    
        "code4"    
    ]    
}

请求

成功时返回如下应答。

    {}

访问权限

cybozu.cn共通管理员可执行。

制限事項

  • 本API不会上锁,因此不推荐同时进行:通过本API导入、通过CSV导入、在页面上手动添加用户等操作。

  • 启用组织的预先设置时,不可执行API。

更新组织代码

更新用JSON格式指定的组织代码。

HTTP 方法

PUT

URI

 https://(子域名).cybozu.com/v1/organizations/codes.json

请求头部

头部值和说明
X-Cybozu-Authorization值为“登录名:密码”通过BASE64编码之后的字符
Authorization使用Basic验证时,值为“Basic”和“登录名:密码”通过BASE64编码之后的字符。
Content-Type

指定为“application/json”。

※不指定时,无法解析JSON ,执行时将报错。

// Sample
      X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
      Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
      Content-Type: application/json

请求正文

codes数组中最大可指定100条。

参数名称要指定的值必须说明
currentCode字符串

必须

当前组织代码

128个字符以内

不能为空或仅输入空格字符

newCode字符串必须

更新后的组织代码

128个字符以内

不能为空或仅输入空格字符

请求正文的范例

{    
    "codes": [    
        {    
            "currentCode": "organization-1",    
            "newCode": "organization-2"    
        }    
    ]    
}

应答

成功时返回如下应答。

    {}

访问权限

cybozu.cn共通管理员可执行。

制限事项

  • 通过CSV导入组织的处理发生冲突时,按照导入的顺序依次处理。

  • 本API不会上锁,因此不推荐同时进行:通过本API导入、通过CSV导入、在页面上手动添加用户等操作。

  • 启用组织的预先设置时,不可执行API。

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