メインコンテンツへスキップ

カオナビ サポートサイト

なにかお困りのことはありますか？

カオナビ総合サポートページを公開しました！ 詳しく見る

トップへ戻る

このセクションの記事

（v2）各種詳細を確認する

実行結果を確認する

初期表示画面では、『実行結果』が表示されます。
APIv2による登録・更新・削除の結果が表示されます。

api_002_001.png

エラーメッセージが表示されている場合、内容をご確認の上対応を行ってください。


 

APIv2による登録・更新・削除の結果を表示します。表示対象はAPIv2のみです。APIv1の結果は表示されません。
また、データ取得のAPIの結果は表示されません。


 

アクセスログを確認する

『アクセスログ』をクリックすると表示されます。
※『データ安心パック』ご契約中のお客様環境のみ表示されます。

api_002_002.png


 

APIv2によるアクセスログを表示します。
APIv1やその他画面操作によるアクセスログは含まれません。

 

アクセスログの見方

列名 意味 表示例
Date APIを実行した日時 2021/01/06 11:11:01
Source IP APIを実行した環境のIPアドレス xxx.xxx.xx.xxx
Credential 認証情報 デフォルトの認証情報 または 任意で設定した認証情報名
Method HTTPメソッド GET
URL 実行したAPIのURL https://api.kaonavi.jp/api/v2.0/sheet_layouts
Status HTTPステータスコード 200
Request ID APIリクエストごとのID Root=XXXXXXXXXXXXXX


 

サポートデスクへのお問い合わせの際は、『Request ID』をご記載ください。

 

認証情報の管理

認証情報を確認する

『認証情報』をクリックすると表示されます。

api_002_003.png

認証情報を追加する

画面右上の「新規追加」をクリックします。

api_002_008.png

『認証情報名』を入力します。

api_002_009.png

必要に応じて操作対象の設定を行い、「作成」をクリックします。

api_002_010.png

認証情報が表示されるので確認し、「閉じる」をクリックします。

api_002_011.png

作成された認証情報が一覧に表示されます。

api_002_012.png

 

認証情報は5件まで作成できます。

 

認証情報を再発行する

再発行を行いたい認証情報の「編集」をクリックします。

api_002_013.png

「再発行」をクリックします。

api_002_007.png

テキスト入力欄に『注意事項を理解して実行します』と入力して、「再発行ボタン」を押してください。

api_002_008.png


 

再発行時の注意事項

・既存のConsumer Key、Consumer Secretは即時に無効となります。
・既存のConsumer Key、Consumer Secretから生成された全てのトークンも即時に無効となります。
・API連携中のアプリケーションを継続して利用する場合、各アプリケーションで再発行後のConsumer_Key、Consumer_Secretの設定が必要です。
・API連携中のすべてのアプリケーションで認証エラーとなります。
・再発行の操作は取り消すことができません。

 

認証情報を削除する

再発行を行いたい認証情報の「編集」をクリックします。

api_002_013.png

「削除」をクリックします。

api_002_014.png

テキスト入力欄に『注意事項を理解して実行します』と入力して、「削除」ボタンを押してください。

api_002_015.png


 

削除時の注意事項

・既存のConsumer Key、Consumer Secretは即時に無効となります。
・既存のConsumer Key、Consumer Secretから生成された全てのトークンも即時に無効となります。
・API連携中のアプリケーションを継続して利用する場合、各アプリケーションで再発行後のConsumer_Key、Consumer_Secretの設定が必要です。
・API連携中のすべてのアプリケーションで認証エラーとなります。
・削除の操作は取り消すことができません。

 

操作対象の管理

APIv2実行にあたって取得・更新するシート／設定の制御が行えます。

設定を行いたい認証情報の「編集」をクリックします。

api_002_013.png

認証情報の編集画面にて『操作対象の設定』が表示されます。

api_002_004.png

利用手順

取得・更新を行いたい項目にチェックを入れ、右上「設定保存」をクリックします。

メンバー情報・シート情報

api_002_005.png

拡張アクセス設定

api_002_006.png

 

設定をオンにした場合の挙動一覧

メンバー情報

設定をオンにする項目 実行内容
メンバー情報 レイアウト設定  マスター情報
取得 一括取得 メンバー情報定義

・一括取得に、基本情報に紐づくマスターが含まれる

・基本情報に紐づくマスターが取得できる
更新 一括更新・部分更新　または　全入れ替え
登録 登録　または　全入れ替え
削除 登録　または　全入れ替え – –
  • レイアウト設定およびマスター情報の取得は、登録・取得・更新いずれかが設定されている場合のみ可能です
  • メンバー情報の全入れ替えを行うには、登録・更新・削除のすべての設定が必要です

 

シート情報

設定をオンにする項目 実行内容
シート情報 レイアウト設定 マスター情報
取得 取得

・シート情報 レイアウト設定 一括取得 に対象シートが含まれる

・シート情報 レイアウト設定 取得 で対象シートが取得できる

・一括取得 に対象シートに紐づくマスターが含まれる

・対象シートに紐づくマスターが取得できる
更新 一括更新・部分更新
  • レイアウト設定の取得は、取得・更新いずれかが設定されているシートのみ可能です
  • マスター情報の取得は、取得・更新いずれかが設定されているシートに紐づくマスターのみ可能です

 

拡張アクセス設定

設定をオンにする項目 実行内容
拡張アクセス設定
取得 一括取得
更新 全入れ替え
登録 全入れ替え
削除 全入れ替え
  • 拡張アクセス設定の全入れ替えを行うには、登録・更新・削除のすべての設定が必要です

 

注意事項

事前設定

「操作対象の管理」を利用するには、アクセス管理＞使える機能＞管理者機能メニューで、「公開API v2情報」と「公開API v2情報 – 操作対象の管理」がどちらも利用可（○）になっている必要があります。
 

設定の適応範囲

「操作対象の管理」で設定された内容は、公開API v2を利用者共通の設定になります。
そのため、利用者ごとに取得・更新の制御を別々に設定することはできません。
 

新たにシートを追加した場合

新たにシートを追加した場合は、取得・更新ともにチェックが入っていない状態となります。
 

項目ごとの制御

項目単位で制御をすることはできません。
 

マスター情報 更新

マスター情報 更新は、メンバー情報・シート情報のチェック状態に関わらず更新されます。
 

操作対象外のデータ

以下のデータは、「操作対象の管理」で制御する対象外となります。

  • ユーザー管理
  • 所属ツリー
  • ロール

キーワード

関連記事