カテゴリー内の他の記事

組織エクスポートAPI

作成日2014年05月23日 06:32
更新日2022年08月03日 04:38

Index

組織エクスポート API（CSV）
組織エクスポート API（JSON）

組織エクスポート API（CSV）

組織情報CSVを出力するためのAPIです。

HTTP メソッド

GET

URI

https://{sub-domain}.cybozu.com/v1/csv/organization.csv

リクエストヘッダ

ヘッダ	値と説明
X-Cybozu-Authorization	「ログイン名:パスワード」をBASE64エンコードしたものを値に指定します。
Authorization	Basic認証を利用している場合、文字列「Basic 」と「ログイン名:パスワード」をBASE64エンコードしたものを値に指定します。

// Sample
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

リクエストボディ

必要なパラメータはありません。

レスポンス

組織情報 CSV が HTTP レスポンスボディに含まれています。
CSV フォーマットの詳細は組織情報 CSV をご参照ください。

アクセス権

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

組織エクスポート API（JSON）

複数の組織情報をJSON形式で取得します。

HTTP メソッド

GET

URI

https://{sub-domain}.cybozu.com/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.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

Content-Typeヘッダは不要です。

レスポンス

パラメータ

パラメータ名	値の種類	説明
organizations	organization型配列	組織情報の配列です。中のデータはid順（昇順）にソートされます。

レスポンスの例

アクセス権

全ユーザーがアクセス可能です。

※kintoneのゲストユーザはアクセスできません。

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

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

斎藤栄 2019年11月06日 05:16

組織エクスポート API(JSON）について、cybozu.com組織情報の画面上で設定可能な組織の「表示順の変更」による並び順の情報が取れないように思われるのですが、この情報は今後取れるようにならないでしょうか？あるいは他のAPIで取れたりしますでしょうか？

cybozu Development team 2019年11月06日 07:59

斎藤栄様

cybozu.com developer network事務局です。
現状、cybozu.comの組織の「表示順の変更」の並び順の情報を取得するAPIはなく、
現時点で、上記のAPI追加の予定もございません。

また、他のAPIでも、現時点で「表示順の変更」の並び順の情報は取得できません。

ご希望に沿えず申し訳ございません。よろしくお願い致します。

中山拓海 2020年11月24日 08:13

お世話になっております。

組織エクスポート API（JSON）につきまして、リクエストボディにcodesを指定して組織情報を取得する際に、特定の条件下でエラーが出てしまうため、こちらに記載させていただきます。

エラー情報

組織エクスポート API（JSON）について、codesに以下のような長さが71以上100以下の配列を指定しコンソールで実行すると、下記のようにエラーが発生してしまいます。

kintone.api(
                    kintone.api.url('/v1/organizations', true),
                    'GET',
                   {codes: Array(71).fill('').map((value, index) => `組織コード${index + 1}`)}
);

show.js:1220 POST https://｛ドメイン名｝.cybozu.com/v1/organizations.json?_method=GET 520 (520)
show.js:1225 Uncaught (in promise) {code: "CB_IL02", id: "MlWss7LBSEIgdz3khJh4", message: "不正なリクエストです。"}

ただし、リクエストボディのcodesに指定した配列について、要素を以下のようにより短く変えた場合はエラーが発生しないようです。

{codes: Array(71).fill('').map((value, index) => `組織${index + 1}`)}

以上より、上記のエラーは配列のサイズと関連して発生しているように考えられますが、それ以上のことはわかっておりません。

再現条件

・kintone環境の任意の画面consoleにて発生

・デバイス: PC

・OS・プラウザ: windows、Chrome

・IP制限などのネットワークに特殊なこと：特になし

以上、上記エラーについてご教授いただければ幸いです。

よろしくお願いいたします。

中山拓海により編集されました 2020年11月24日 08:19

cybozu Development team 2020年12月01日 09:26

中山拓海様

cybozu.com developer network事務局です。

ご指摘いただきました件、確認させていただきましたところ再現致しました。現状はkintone.api()からUser APIへのリクエストを送るときにプロパティのデータ量が多いときに、ご認識いただいているエラーが発生いたします。

今後の対応を検討いたします。ご迷惑をおかけいたします、ご連絡ありがとうございました。

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