API呼び出し処理

オペレーション名

API呼び出し

機能概要

kintone API(REST API)を呼び出します。

kintone APIについてはサイボウズ社のデベロッパーサイト(https://developer.cybozu.io/hc/ja)を参照してください。

本オペレーションは、2014年4月10日時点のkintone APIをもとにしています。
今後行われるkintone APIの改修・追加によっては、正しく実行ができない場合があります。

データモデル

本コンポーネントのデータモデルはXML型です。

プロパティ

変数の使用については、「変数」を参照してください。
基本設定
項目名 必須/省略可 変数の使用 説明 備考
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  
入力データ 必須 使用不可 スクリプトキャンバス上にあるコンポーネントを選択します。  
必須設定
項目名 必須/省略可 変数の使用 説明 備考
接続先 必須 使用不可 グローバルリソースを選択します。
グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
  
API種別 必須 使用不可 APIの種別を設定します。
  • 以下のAPIを指定することはできません。
    • レコード取得
    • レコード登録
    • レコード更新
    • レコード削除
    • レコード一括取得
    • ファイルアップロード
    • ファイルダウンロード
    • API 一覧の取得
    • API スキーマ情報の取得
  • 2014年4月10日以降追加されたAPIについての表記はkeyのみとなります。
    keyについては「API 一覧の取得」(https://developer.cybozu.io/hc/ja/articles/201941934)を参照してください。
プロパティアクション
項目名 説明 備考
API種別の更新 API種別の一覧を更新します。  
ゲストスペース
項目名 必須/省略可 変数の使用 説明 備考
ゲストスペースを有効にする 省略可 使用不可 APIの操作対象がゲストスペースの場合、有効にします。  
ゲストスペースID 省略可 使用可 APIの操作対象のゲストスペースIDを指定します。
  • [ゲストスペースを有効にする]にチェックを入れた場合、有効になります。
データ処理方式
項目名 必須/省略可 変数の使用 説明 備考
データ処理方式 省略可 使用不可 データ処理方式を選択します。  
コメント
項目名 必須/省略可 変数の使用 説明 備考
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。		  

スキーマ

入力スキーマ

本アダプタが使用するスキーマについては、「APIスキーマ」を参照してください。

出力スキーマ

本アダプタが使用するスキーマについては、「APIスキーマ」を参照してください。

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。
詳細については、「スキーマ編集」を参照してください。

大容量データ処理

大容量データ処理に対応しています。

トランザクション

トランザクションはサポートしていません。

PSPでの使用について

PSPでは使用できません。

使用できるコンポーネント変数

コンポーネント変数名 説明 備考
message_category エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。
  • デフォルト値はnullです。
message_code エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。
  • デフォルト値はnullです。
message_level エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。
  • デフォルト値はnullです。
error_type エラー発生時、発生したエラーの種類が格納されます。
  • デフォルト値はnullです。
  • エラーの種類は、以下のような形式となります。
    例:「java.io.FileNotFoundException」
  • DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
error_message エラー発生時、発生したエラーのメッセージが格納されます。
  • デフォルト値はnullです。
  • DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
error_trace エラー発生時、発生したエラーのトレース情報が格納されます。
  • デフォルト値はnullです。
  • DataSpider Servistaのバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限

主な例外

例外名 原因 対策
InputDataNotFoundException [入力データ]が指定されていません。 [入力データ]を指定する、またはデータフローを引いてください。
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[]		 [接続先]が指定されていません。 [接続先]を指定してください。
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]		 [接続先]で指定したリソース定義が見つかりません。 [接続先]で指定したグローバルリソースを確認してください。
InvalidPropertyConfigurationException
<プロパティ名>が指定されていません。		 [<プロパティ名>]が指定されていません。 [<プロパティ名>]を指定してください。
KintoneResponseStatusException
<ステータスコード> <ステータスコードの内容>
<エラーの内容>		 kintoneでの処理中にエラーが発生しました。 エラーメッセージにしたがって設定、入力値を確認してください。
RequestParameterRequiredException
<入力データ>の必須パラメータが指定されていません。		 [<入力データ>]の必須パラメータが指定されていません。 [<入力データ>]の必須パラメータを指定してください。