その他
公開API情報確認
カテゴリー

(v2)各種詳細を確認する

実行結果を確認する

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

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

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

アクセスログを確認する

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

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

アクセスログの見方

列名 意味 表示例
Date APIを実行した日時 2021/01/06 11:11:01
Source IP APIを実行した環境のIPアドレス xxx.xxx.xx.xxx
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』をご記載ください。

認証情報を確認する

「認証情報」タブをクリックすると表示されます。

操作対象の管理

「操作対象の管理」タブをクリックすると表示されます。
ここでは、APIv2実行にあたって取得・更新するシートの制御が行えます。

利用手順

①取得・更新を行って良いシートにチェックを入れ、右上「設定保存」をクリックします。

②確認画面が表示され、「保存」をクリックすると設定が反映されます。

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

メンバー情報

設定をオンにする項目 実行内容
メンバー情報 レイアウト定義 マスター情報
取得 一括取得 メンバー情報定義 ・一括取得に、基本情報に紐づくマスターが含まれる

・基本情報に紐づくマスターが取得できる

更新 一括更新・部分更新
登録 登録
削除 削除
  • レイアウト定義およびマスター情報の取得は、登録・取得・更新いずれかが設定されている場合のみ可能です

シート情報

設定をオンにする項目 実行内容
シート情報 レイアウト定義 マスター情報
取得 取得 ・シート情報 レイアウト定義 一括取得 に対象シートが含まれる

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

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

・対象シートに紐づくマスターが取得できる

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

注意事項

事前設定

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

設定の適応範囲

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

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

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

項目ごとの制御

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

マスター情報 更新

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

操作対象外のデータ

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

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