検索
Close
カテゴリー内の他の記事

組織インポートAPI

作成日
更新日

Index

組織インポートAPI（CSV）

ファイルアップロード API でアップロードした CSV ファイルを組織情報として取り込むためのAPIです。

HTTP メソッド

POST

URI

https://{sub-domain}.cybozu.com/v1/csv/organization.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

リクエストボディ

パラメータ値 指定する値 必須 説明
fileKey 文字列 必須 ファイルアップロード API でアップロードした際にレスポンスで取得した「fileKey」を指定します。

レスポンス

レスポンスには、結果確認 API で使用する処理の結果確認用 ID がセットされます。

CSVファイルのフォーマット

組織情報 CSVをご参照ください。

アクセス権

cybozu.com共通管理者のみ実行できます。

注意事項

  • CSV は上書き取り込みです。取り込む CSV に存在しない組織コードの組織は削除されます。
  • 取り込むCSVの項目数は組織情報 CSVのフォーマット通りに揃える必要があります。
  • 項目数が少なくても多くても取り込みエラーになります。

組織インポート API（JSON）

組織の登録

JSON形式で指定した組織を登録します。

HTTP メソッド

POST

URI

 https://（サブドメイン名）.cybozu.com/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
  • zh-TW

省略・空文字・nullの場合は、cybozu.com共通管理の「ローカライズの設定」で設定した値となります。
parentCode 文字列  

親組織のコード

親組織がルート組織の場合はnullとなります。
description 文字列  

説明

1000文字以下
省略した場合は空文字となります。

リクエストボディの例

レスポンス

成功の場合、以下のレスポンスが返ります。

アクセス権

cybozu.com共通管理者のみ実行できます。

制限事項

  • CSV による組織インポートと処理が重なるとき、書き込まれた順番に登録されるものとします。
  • 本APIではロックなどをしないため、本API/CSV読み込み/通常画面からのユーザーの操作を並行して行うことは推奨しません。
  • organizations にparentCodeに指定できる親組織を含めることができますが、親 → 子 の順にJSONのリストに書かれている必要があります。
  • 組織の事前設定が有効な場合はAPIを実行することはできません。

組織の更新

JSON形式で指定した組織を更新します。

HTTP メソッド

PUT

URI

 https://（サブドメイン名）.cybozu.com/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
  • zh-TW

省略・空文字・nullの場合は、更新されません。
parentCode 文字列  

親組織のコード

128文字以下
省略した場合は更新されません。
空文字を指定した場合は、ルート組織に移動します。
description 文字列  

説明

1000文字以下
省略した場合は空文字となります。

リクエストボディの例

レスポンス

成功の場合、以下のレスポンスが返ります。

アクセス権

cybozu.com共通管理者のみ実行できます。

制限事項

  • CSV による組織インポートと処理が重なるとき、書き込まれた順番に登録されるものとします。
  • 本APIではロックなどをしないため、本API/CSV読み込み/通常画面からのユーザーの操作を並行して行うことは推奨しません。
  • 組織の事前設定が有効な場合はAPIを実行することはできません。
  • リクエストボディの organizations に同じ組織コードが含まれていた場合、後の組織情報で更新されます。

組織の削除

JSON形式で指定した組織を削除します。

HTTP メソッド

DELETE

URI

 https://（サブドメイン名）.cybozu.com/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
親組織を削除する場合、その下位組織も削除されます。

リクエストボディの例

レスポンス

成功の場合、以下のレスポンスが返ります。

アクセス権

cybozu.com共通管理者のみ実行できます。

制限事項

  • 本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文字以下
空文字または空白文字のみは禁止

リクエストボディの例

レスポンス

成功の場合、以下のレスポンスが返ります。

アクセス権

cybozu.com共通管理者のみ実行できます。

制限事項

  • CSV による組織インポートや組織の登録と処理が重なるとき、書き込まれた順番に登録されるものとします。
  • 本APIではロックなどをしないため、本API/CSV読み込み/通常画面からのユーザーの操作を並行して行うことは推奨しません。
  • 組織の事前設定が有効な場合はAPIを実行することはできません。

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

サインインしてコメントを残してください。