セルフサービスソース（バッチ SDK）の仕様の設定

最終更新日： 2023-08-10
  • トピック：
  • Sources
    このトピックの詳細を表示
  • 作成対象：
  • Developer
    User
    Admin
    Leader

エクスプローラ仕様は、ソースに含まれるオブジェクトの調査と検査に必要なパラメータを定義します。 また、エクスプローラの仕様では、オブジェクトの調査と検査時に返される応答形式も定義します。

ヒント

探索の仕様はハードコードされており、以下のペイロードをコピーして、接続の仕様に貼り付けるだけで済みます。

"exploreSpec": {
  "name": "Resource",
  "type": "Resource",
  "requestSpec": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object"
  },
  "responseSpec": {
    "$schema": "http: //json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
      "format": {
        "type": "string"
      },
      "schema": {
        "type": "object",
        "properties": {
          "columns": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "data": {
        "type": "array",
        "items": {
          "type": "object"
        }
      }
    }
  }
}
仕様の調査 説明 例
name エクスプローラ仕様の名前または識別子を定義します。 Resource
type エクスプローラ仕様のタイプを定義します。 Resource
requestSpec 接続内のオブジェクトの探索に必要なパラメータを含みます。
requestSpec.type リクエスト仕様のデータタイプを定義します。 object
responseSpec 探索呼び出しに対して返される応答メッセージの形式を定義するパラメーターを含みます。
responseSpec.type 応答仕様のデータタイプを定義します。 object
responseSpec.properties 応答メッセージの形式に関する情報が含まれます。
responseSpec.properties.format 応答スキーマの形式を定義します。 object
responseSpec.properties.format.type プロパティのデータタイプを定義します。 string
responseSpec.schema 応答スキーマの形式に関する情報が含まれます。
responseSpec.schema.type スキーマのデータ型を定義します。 object
responseSpec.schema.properties スキーマ内で保持される列、タイプ、項目に関する情報が含まれます。
responseSpec.schema.properties.columns.items.properties.name ファイルの名前を表示します。
responseSpec.schema.properties.columns.items.properties.name.type ファイル名のデータタイプを定義します。 string

次の手順

エクスプローラ仕様を入力したら、次を使用して完全な接続仕様を作成できます： Flow Service API. 詳しくは、 セルフサービスソース（バッチ SDK）API ガイド を参照してください。

前のページ
Next page

このページ