导入组织API（JSON）

• 添加组织

• 更新组织

• 删除组织

• 更新组织代码

添加组织

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

HTTP 方法

POST

URI

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

请求头部

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

请求正文

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

请求正文范例

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

应答

成功时返回如下应答。

    {}

代码范例

用curl发送请求的范例 ：

curl -X POST 'https://sample.cybozu.cn/v1/organizations.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
        "organizations": [
          {
            "code": "Sales03",
            "name": "北美销售部",
            "localName": "North America Sales Department",
            "localNameLocale": "en",
            "description": "北美销售部",
            "parentCode": "Sales00"
          }
        ]
      }'

访问权限

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

限制事项

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

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

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

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

更新组织

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

HTTP 方法

PUT

URI

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

请求头部

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

请求正文

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

请求正文的范例

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

应答

成功时返回以下应答。

    {}

代码范例

用curl发送请求的范例 ：

curl -X PUT 'https://sample.cybozu.cn/v1/organizations.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
        "organizations": [
          {
            "code": "Sales03",
            "name": "北美销售部",
            "localName": "North America Sales Department",
            "localNameLocale": "en",
            "description": "北美销售部",
            "parentCode": "Sales00"
          }
        ]
      }'

访问权限

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

限制事项

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

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

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

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

删除组织

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

HTTP 方法

DELETE

URI

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

请求头部

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

请求正文

请求正文的范例

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

请求

成功时返回如下应答。

    {}

代码范例

用curl发送请求的范例 ：

curl -X DELETE 'https://sample.cybozu.cn/v1/organizations.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
        "codes": ["Sales01", "Sales02"]
      }'

访问权限

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

制限事項

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

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

更新组织代码

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

HTTP 方法

PUT

URI

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

请求头部

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

请求正文

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

请求正文的范例

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

应答

成功时返回如下应答。

    {}

代码范例

用curl发送请求的范例 ：

curl -X PUT 'https://sample.cybozu.cn/v1/organizations/codes.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
        "codes": [
          {
            "currentCode": "Sales03",
            "newCode": "Sales05"
          }
        ]
      }'

访问权限

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

制限事项

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

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

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