{ "openapi" : "3.0.1", "info" : { "title" : "HubDB", "version" : "v3", "x-hubspot-product-tier-requirements" : { "marketing" : "PROFESSIONAL", "cms" : "PROFESSIONAL" }, "x-hubspot-documentation-banner" : "NONE", "x-hubspot-api-use-case" : "ウェブサイトで製品を掲載するための動的ページの生成と記録管理の両方を目的として在庫データをHubDBテーブルに格納できます。", "x-hubspot-related-documentation" : [ { "name" : "HubDB Guide", "url" : "https://developers.hubspot.com/beta-docs/guides/api/cms/hubdb" } ], "x-hubspot-introduction" : "HubDB APIを使用して、アカウント内でHubDBテーブルを作成して管理できるだけでなく、各テーブルデータのインポート、取得、管理もできます。" }, "servers" : [ { "url" : "https://api.hubapi.com" } ], "tags" : [ { "name" : "Tables" }, { "name" : "テーブル" }, { "name" : "Rows" }, { "name" : "行" }, { "name" : "Rows Batch" }, { "name" : "行バッチ" } ], "paths" : { "/cms/v3/hubdb/tables/{tableIdOrName}/draft/export" : { "get" : { "tags" : [ "Tables", "テーブル" ], "summary" : "下書きテーブルをエクスポート", "description" : "テーブルの下書きバージョンがCSV/EXCEL形式にエクスポートされます。", "operationId" : "get-/cms/v3/hubdb/tables/{tableIdOrName}/draft/export_exportDraftTable", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "エクスポートするテーブルのIDまたは名前。", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "format", "in" : "query", "description" : "エクスポートするファイル形式。使用可能な値には「CSV」、「XLSX」、「XLS」などが含まれます。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/vnd.ms-excel" : { "schema" : { "type" : "string", "format" : "binary" } }, "text/csv" : { "schema" : { "type" : "string", "format" : "binary" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/draft" : { "get" : { "tags" : [ "Tables", "テーブル" ], "summary" : "下書きテーブルを全て返す", "description" : "列定義を含めて、指定されたアカウントで定義された各下書きテーブルの詳細が返されます。", "operationId" : "get-/cms/v3/hubdb/tables/draft_getAllDraftTables", "parameters" : [ { "name" : "sort", "in" : "query", "description" : "結果の並べ替えに使用するフィールドが指定されます。有効なフィールドは「name」、「createdAt」、「updatedAt」、「createdBy」、「updatedBy」で、既定では「createdAt」が使用されます。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "after", "in" : "query", "description" : "次の結果のセットを取得するためのカーソルトークン値。これはその他の結果が含まれるページ付けされたレスポンスの「paging.next.after」JSONプロパティーから取得できます。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "返す結果の最大数。既定値は1000です。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "createdAt", "in" : "query", "description" : "指定された時間ちょうどに作成されたテーブルのみを返します。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "date-time" } }, { "name" : "createdAfter", "in" : "query", "description" : "指定された時間より後に作成されたテーブルのみを返します。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "date-time" } }, { "name" : "createdBefore", "in" : "query", "description" : "指定された時間より前に作成されたテーブルのみを返します。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "date-time" } }, { "name" : "updatedAt", "in" : "query", "description" : "指定された時間ちょうどに最後に更新されたテーブルのみを返します。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "date-time" } }, { "name" : "updatedAfter", "in" : "query", "description" : "指定された時間より後に最後に更新されたテーブルのみを返します。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "date-time" } }, { "name" : "updatedBefore", "in" : "query", "description" : "指定された時間より前に最後に更新されたテーブルのみを返します。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "date-time" } }, { "name" : "contentType", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } }, { "name" : "archived", "in" : "query", "description" : "アーカイブ済みのテーブルを返すかどうかが指定されます。既定値は「false」です。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseWithTotalHubDbTableV3ForwardPaging" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft" : { "get" : { "tags" : [ "Rows", "行" ], "summary" : "下書きテーブルから行を取得", "description" : "指定されたテーブルの下書きバージョンの行が返されます。行の結果は絞り込みや並べ替えが可能です。絞り込みや並べ替えのオプションはクエリーパラメーターとしてAPIリクエストに送信されます。例えば、クエリーパラメーター「column1__gt=5&sort=-column1」を追加すると、APIによって「column1」列の値が5より大きい行が「column1」の値の降順で返されます。絞り込みや並べ替えのオプションについて詳しくは、［概要セクション］（https://developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows）を参照してください。", "operationId" : "get-/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft_readDraftTableRows", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "照会するテーブルのIDまたは名前。", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "sort", "in" : "query", "description" : "結果を並べ替える基準にする列名が指定されます。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "after", "in" : "query", "description" : "次の結果のセットを取得するためのカーソルトークン値。これはその他の結果が含まれるページ付けされたレスポンスの「paging.next.after」JSONプロパティーから取得できます。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "返す結果の最大数。既定値は「1000」です。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "properties", "in" : "query", "description" : "全ての列の詳細ではなく必要な列のみが含まれる結果を取得するには、列名を指定してください。結果に複数の列を含めるには、必要な回数だけこのクエリーパラメーターを使用してください。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "offset", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "archived", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UnifiedCollectionResponseWithTotalBaseHubDbTableRowV3" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}" : { "get" : { "tags" : [ "Rows", "行" ], "summary" : "テーブル行を取得", "description" : "テーブルの公開済みバージョンからIDを基準に1行を取得します。\n**注：**このエンドポイントは、テーブルが公開アクセスを許可するように設定されていれば、許可なくアクセスできます。", "operationId" : "get-/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}_getTableRow", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "テーブルのIDまたは名前", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "rowId", "in" : "path", "description" : "行のID", "required" : true, "style" : "simple", "explode" : false, "schema" : { "pattern" : "\\d+", "type" : "string" } }, { "name" : "archived", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableRowV3" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft/clone" : { "post" : { "tags" : [ "Rows", "行" ], "summary" : "行を複製", "description" : "テーブルの下書きバージョンの1行が複製されます。", "operationId" : "post-/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft/clone_cloneDraftTableRow", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "テーブルのIDまたは名前", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "rowId", "in" : "path", "description" : "行のID", "required" : true, "style" : "simple", "explode" : false, "schema" : { "pattern" : "\\d+", "type" : "string" } }, { "name" : "name", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableRowV3" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/draft/reset" : { "post" : { "tags" : [ "Tables", "テーブル" ], "summary" : "下書きテーブルをリセット", "description" : "テーブルの下書きバージョンのデータを公開済みバージョンの値に置き換えます。下書きで公開終了された変更はこの呼び出しが行われた後に失われます。", "operationId" : "post-/cms/v3/hubdb/tables/{tableIdOrName}/draft/reset_resetDraftTable", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "リセットするテーブルのIDまたは名前。", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "includeForeignIds", "in" : "query", "description" : "レスポンスで外部ID値を入力するには、これを「true」に設定してください。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableV3" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/export" : { "get" : { "tags" : [ "Tables", "テーブル" ], "summary" : "テーブルの公開済みバージョンをエクスポート", "description" : "テーブルの公開済みバージョンが指定された形式でエクスポートされます。", "operationId" : "get-/cms/v3/hubdb/tables/{tableIdOrName}/export_exportTable", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "エクスポートするテーブルのIDまたは名前。", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "format", "in" : "query", "description" : "エクスポートするファイル形式。使用可能な値には「CSV」、「XLSX」、「XLS」などが含まれます。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/vnd.ms-excel" : { "schema" : { "type" : "string", "format" : "binary" } }, "text/csv" : { "schema" : { "type" : "string", "format" : "binary" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/replace" : { "post" : { "tags" : [ "Rows Batch", "行バッチ" ], "summary" : "下書きテーブルの行を一括で置換", "description" : "セルあたり最大100行で、テーブルの下書きバージョンの複数の行がバッチとして置き換えられます。1行の更新に関する詳細については、「PUT /tables/{tableIdOrName}/rows/{rowId}/draft」エンドポイントを参照してください。", "operationId" : "post-/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/replace_replaceDraftTableRows", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "テーブルのIDまたは名前", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputHubDbTableRowV3BatchUpdateRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseHubDbTableRowV3" } } } }, "207" : { "description" : "multiple statuses", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseHubDbTableRowV3WithErrors" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/draft/clone" : { "post" : { "tags" : [ "Tables", "テーブル" ], "summary" : "テーブルを複製", "description" : "既存のHubDBテーブルを複製します。新しいテーブルの「newName」と「newLabel」はリクエスト本文のJSONとして送信できます。複製されたテーブルが下書きとして作成されます。", "operationId" : "post-/cms/v3/hubdb/tables/{tableIdOrName}/draft/clone_cloneDraftTable", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "複製するテーブルのIDまたは名前。", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableCloneRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableV3" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/purge" : { "post" : { "tags" : [ "Rows Batch", "行バッチ" ], "summary" : "行が完全に削除されます", "description" : "行IDのセットが指定されると、テーブルの下書きバージョンから行が完全に削除されます。セルあたり最大100個の行ID。", "operationId" : "post-/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/purge_purgeDraftTableRows", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "テーブルのIDまたは名前", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputString" } } }, "required" : true }, "responses" : { "204" : { "description" : "No content", "content" : { } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/draft/import" : { "post" : { "tags" : [ "Tables", "テーブル" ], "summary" : "データを下書きテーブルにインポート", "description" : "CSVファイルの内容を既存のHubDBテーブルにインポートします。データは必ずテーブルの下書きバージョンにインポートされます。これらの変更を公開済みバージョンにプッシュするには、「/publish」エンドポイントを使用してください。\nこのエンドポイントでは、マルチパートのPOSTリクエストが使用されます。最初のパートはインポートのJSON形式のオプションのセットであり、これは名前を「config」として指定できます。2番目のパートはインポートするCSVファイルであり、これは名前を「file」として指定できます。［概要セクション（https://developers.hubspot.com/docs/api/cms/hubdb#importing-tables）を参照して、インポートのJSON形式のオプションの詳細や形式をご確認ください。", "operationId" : "post-/cms/v3/hubdb/tables/{tableIdOrName}/draft/import_importDraftTable", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "データがインポートされるインポート先テーブルのID。", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "object", "properties" : { "config" : { "type" : "string" }, "file" : { "type" : "string", "format" : "binary" } } } } } }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ImportResult" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft" : { "get" : { "tags" : [ "Rows", "行" ], "summary" : "下書きテーブルから行を取得", "description" : "テーブルの下書きバージョンからIDを基準に1行を取得します。", "operationId" : "get-/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft_getDraftTableRowById", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "テーブルのIDまたは名前", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "rowId", "in" : "path", "description" : "行のID", "required" : true, "style" : "simple", "explode" : false, "schema" : { "pattern" : "\\d+", "type" : "string" } }, { "name" : "archived", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableRowV3" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] }, "put" : { "tags" : [ "Rows", "行" ], "summary" : "既存の行が置き換えられます", "description" : "テーブルの下書きバージョンの1行を置き換えます。全ての列値を指定する必要があります。列の対象テーブルに値があり、このリクエストでその値が定義されていない場合、削除されます。\nJSON行定義を形式設定する手順については、「Create a row」エンドポイントを参照してください。", "operationId" : "put-/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft_replaceDraftTableRow", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "テーブルのIDまたは名前", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "rowId", "in" : "path", "description" : "行のID", "required" : true, "style" : "simple", "explode" : false, "schema" : { "pattern" : "\\d+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableRowV3Request" } } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableRowV3" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] }, "delete" : { "tags" : [ "Rows", "行" ], "summary" : "行が完全に削除されます", "description" : "テーブルの下書きバージョンから行が完全に削除されます。", "operationId" : "delete-/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft_purgeDraftTableRow", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "テーブルのIDまたは名前", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "rowId", "in" : "path", "description" : "行のID", "required" : true, "style" : "simple", "explode" : false, "schema" : { "pattern" : "\\d+", "type" : "string" } } ], "responses" : { "204" : { "description" : "No content", "content" : { } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] }, "patch" : { "tags" : [ "Rows", "行" ], "summary" : "既存の行が更新されます", "description" : "テーブルの下書きバージョンの1行がスパース更新されます。\n全ての列値を指定する必要はありません。指定できるのは、変更する必要がある列またはフィールドのみです。\nJSON行定義を形式設定する手順については、「Create a row」エンドポイントを参照してください。", "operationId" : "patch-/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft_updateDraftTableRow", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "テーブルのIDまたは名前", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "rowId", "in" : "path", "description" : "行のID", "required" : true, "style" : "simple", "explode" : false, "schema" : { "pattern" : "\\d+", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableRowV3Request" } } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableRowV3" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/rows" : { "get" : { "tags" : [ "Rows", "行" ], "summary" : "テーブルの行を取得", "description" : "指定されたテーブルの公開済みバージョンの行のセットが返されます。行の結果は絞り込みや並べ替えが可能です。絞り込みや並べ替えのオプションはクエリーパラメーターとしてAPIリクエストに送信されます。例えば、クエリーパラメーター「column1__gt=5&sort=-column1」を追加すると、APIによって「column1」列の値が5より大きい行が「column1」の値の降順で返されます。絞り込みや並べ替えのオプションについて詳しくは、［概要セクション］（https://developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows）を参照してください。\n**注：**このエンドポイントは、テーブルが公開アクセスを許可するように設定されていれば、許可なくアクセスできます。", "operationId" : "get-/cms/v3/hubdb/tables/{tableIdOrName}/rows_getTableRows", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "照会するテーブルのIDまたは名前。", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "sort", "in" : "query", "description" : "結果の並べ替えの基準となる列名が指定されます。詳細については、上記の説明を参照してください。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "after", "in" : "query", "description" : "次の結果のセットを取得するためのカーソルトークン値。これはその他の結果が含まれるページ付けされたレスポンスの「paging.next.after」JSONプロパティーから取得できます。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "返す結果の最大数。既定値は「1000」です。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "properties", "in" : "query", "description" : "全ての列の詳細ではなく必要な列のみが含まれる結果を取得するには、列名を指定してください。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "offset", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "archived", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UnifiedCollectionResponseWithTotalBaseHubDbTableRowV3" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] }, "post" : { "tags" : [ "Rows", "行" ], "summary" : "テーブルに新しい行を追加", "description" : "HubDBテーブルに新しい行を追加します。新しい行はテーブルの下書きバージョンに追加されます。これらの変更を公開済みバージョンにプッシュするには、「/publish」エンドポイントを使用してください。", "operationId" : "post-/cms/v3/hubdb/tables/{tableIdOrName}/rows_createTableRow", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "対象テーブルのIDまたは名前。", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableRowV3Request" } } }, "required" : true }, "responses" : { "201" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableRowV3" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/rows/batch/read" : { "post" : { "tags" : [ "Rows Batch", "行バッチ" ], "summary" : "行のセットを取得", "description" : "行IDのセットが指定されると、指定されたテーブルの公開済みバージョンの行が返されます。\n**注：**このエンドポイントは、テーブルが公開アクセスを許可するように設定されていれば、許可なくアクセスできます。", "operationId" : "post-/cms/v3/hubdb/tables/{tableIdOrName}/rows/batch/read_readTableRows", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "照会するテーブルのIDまたは名前。", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputString" } } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseHubDbTableRowV3" } } } }, "207" : { "description" : "multiple statuses", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseHubDbTableRowV3WithErrors" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/create" : { "post" : { "tags" : [ "Rows Batch", "行バッチ" ], "summary" : "行を一括で作成", "description" : "行オブジェクトの配列が指定されると、指定されたテーブルの下書きバージョンの行が作成されます。セルあたり最大100個の行オブジェクト。例を含む詳細については、概要セクションを参照してください。", "operationId" : "post-/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/create_createDraftTableRows", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "テーブルのIDまたは名前", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputHubDbTableRowV3Request" } } }, "required" : true }, "responses" : { "201" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseHubDbTableRowV3" } } } }, "207" : { "description" : "multiple statuses", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseHubDbTableRowV3WithErrors" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}" : { "get" : { "tags" : [ "Tables", "テーブル" ], "summary" : "公開済みのテーブルの詳細を取得", "description" : "指定されたテーブルの公開済みバージョンの詳細が返されます。テーブル内の列の定義と、テーブル内の行数が含まれます。\n\n**注：**このエンドポイントは、テーブルが公開アクセスを許可するように設定されていれば、許可なくアクセスできます。そのように設定するには、「portalId」クエリーパラメーターにHubSpotアカウントIDを含める必要があります。", "operationId" : "get-/cms/v3/hubdb/tables/{tableIdOrName}_getTableDetails", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "返すテーブルのIDまたは名前。", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "isGetLocalizedSchema", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } }, { "name" : "archived", "in" : "query", "description" : "アーカイブ済みのテーブルの詳細を返すには、これを「true」に設定してください。既定値は「false」です。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } }, { "name" : "includeForeignIds", "in" : "query", "description" : "結果で外部ID値を入力するには、これを「true」に設定してください。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableV3" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] }, "delete" : { "tags" : [ "Tables", "テーブル" ], "summary" : "テーブルをアーカイブ", "description" : "既存のHubDBテーブルをアーカイブ（論理削除）します。公開済みバージョンと下書きバージョンの両方がアーカイブされます。", "operationId" : "delete-/cms/v3/hubdb/tables/{tableIdOrName}_archiveTable", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "アーカイブするテーブルのIDまたは名前。", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No content", "content" : { } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/read" : { "post" : { "tags" : [ "Rows Batch", "行バッチ" ], "summary" : "下書きテーブルから行のセットを取得", "description" : "行IDのセットが指定されると、指定されたテーブルの下書きバージョンの行が返されます。", "operationId" : "post-/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/read_readDraftTableRows", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "テーブルのIDまたは名前", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputString" } } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseHubDbTableRowV3" } } } }, "207" : { "description" : "multiple statuses", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseHubDbTableRowV3WithErrors" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/clone" : { "post" : { "tags" : [ "Rows Batch", "行バッチ" ], "summary" : "行を一括で複製", "description" : "行IDのセットが指定されると、指定されたテーブルの下書きバージョンの行が複製されます。セルあたり最大100個の行ID。", "operationId" : "post-/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/clone_cloneDraftTableRows", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "テーブルのIDまたは名前", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputHubDbTableRowBatchCloneRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseHubDbTableRowV3" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables" : { "get" : { "tags" : [ "Tables", "テーブル" ], "summary" : "公開済みのテーブルを全て取得", "description" : "アカウントで定義された各テーブルの公開済みバージョンの詳細（列定義など）が返されます。", "operationId" : "get-/cms/v3/hubdb/tables_getAllTables", "parameters" : [ { "name" : "sort", "in" : "query", "description" : "結果の並べ替えに使用するフィールドが指定されます。有効なフィールドは「name」、「createdAt」、「updatedAt」、「createdBy」、「updatedBy」で、既定では「createdAt」が使用されます。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "after", "in" : "query", "description" : "次の結果のセットを取得するためのカーソルトークン値。これはその他の結果が含まれるページ付けされたレスポンスの「paging.next.after」JSONプロパティーから取得できます。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "返す結果の最大数。既定値は1000です。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "createdAt", "in" : "query", "description" : "指定された時間ちょうどに作成されたテーブルのみを返します。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "date-time" } }, { "name" : "createdAfter", "in" : "query", "description" : "指定された時間より後に作成されたテーブルのみを返します。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "date-time" } }, { "name" : "createdBefore", "in" : "query", "description" : "指定された時間より前に作成されたテーブルのみを返します。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "date-time" } }, { "name" : "updatedAt", "in" : "query", "description" : "指定された時間ちょうどに最後に更新されたテーブルのみを返します。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "date-time" } }, { "name" : "updatedAfter", "in" : "query", "description" : "指定された時間より後に最後に更新されたテーブルのみを返します。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "date-time" } }, { "name" : "updatedBefore", "in" : "query", "description" : "指定された時間より前に最後に更新されたテーブルのみを返します。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "date-time" } }, { "name" : "contentType", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" } }, { "name" : "archived", "in" : "query", "description" : "アーカイブ済みのテーブルを返すかどうかが指定されます。既定値は「false」です。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseWithTotalHubDbTableV3ForwardPaging" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] }, "post" : { "tags" : [ "Tables", "テーブル" ], "summary" : "新規テーブルを作成", "description" : "JSONスキーマが指定されれば、新しい下書きHubDBテーブルが作成されます。テーブル名とラベルはアカウントごとに固有である必要があります。", "operationId" : "post-/cms/v3/hubdb/tables_createTable", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableV3Request" } } }, "required" : true }, "responses" : { "201" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableV3" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/unpublish" : { "post" : { "tags" : [ "Tables", "テーブル" ], "summary" : "テーブルの公開を終了", "description" : "テーブルが公開終了されます。つまり、このテーブルのデータを使用している全てのウェブサイトページでデータが表示されなくなります。", "operationId" : "post-/cms/v3/hubdb/tables/{tableIdOrName}/unpublish_unpublishTable", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "公開するテーブルのIDまたは名前。", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "includeForeignIds", "in" : "query", "description" : "レスポンスで外部ID値を入力するには、これを「true」に設定してください。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableV3" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/draft" : { "get" : { "tags" : [ "Tables", "テーブル" ], "summary" : "下書きテーブルの詳細を取得", "description" : "特定のHubDBテーブルの下書きバージョンの詳細を取得します。テーブル内の列の定義と、テーブル内の行数が含まれます。", "operationId" : "get-/cms/v3/hubdb/tables/{tableIdOrName}/draft_getDraftTableDetailsById", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "返すテーブルのIDまたは名前。", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "isGetLocalizedSchema", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } }, { "name" : "archived", "in" : "query", "description" : "アーカイブ済みのテーブルを返すには、これを「true」に設定してください。既定値は「false」です。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } }, { "name" : "includeForeignIds", "in" : "query", "description" : "結果で外部ID値を入力するには、これを「true」に設定してください。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableV3" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] }, "patch" : { "tags" : [ "Tables", "テーブル" ], "summary" : "既存のテーブルを更新", "description" : "既存のHubDBテーブルを更新します。このエンドポイントを使用して、テーブルに対する列の追加や削除を行うだけでなく、アーカイブ済みのテーブルを復元できます。このエンドポイントを使用してテーブルが更新されると、テーブルの下書きバージョンのみが変更されます。全ての変更を公開済みバージョンにプッシュするには、「/publish」エンドポイントを使用します。テーブルを復元するには、クエリーパラメーター「archived=true」と「\"archived\": false」をjson本文に含めます。\n**注：**列の追加／削除／更新を行う際には、入力に全ての列を含める必要があります。リクエストにまだ既存の列を含めていない場合、削除されます。", "operationId" : "patch-/cms/v3/hubdb/tables/{tableIdOrName}/draft_updateDraftTable", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "更新するテーブルのIDまたは名前。", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "isGetLocalizedSchema", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } }, { "name" : "archived", "in" : "query", "description" : "アーカイブ済みのテーブルを返すかどうかが指定されます。既定値は「false」です。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } }, { "name" : "includeForeignIds", "in" : "query", "description" : "結果で外部ID値を入力するには、これを「true」に設定してください。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableV3Request" } } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableV3" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/draft/publish" : { "post" : { "tags" : [ "Tables", "テーブル" ], "summary" : "下書きからテーブルを公開", "description" : "データやテーブルスキーマの変更を下書きバージョンから公開済みバージョンにコピーすることで、テーブルが公開されます。つまり、このテーブルのデータを使用している全てのウェブサイトページが更新されます。", "operationId" : "post-/cms/v3/hubdb/tables/{tableIdOrName}/draft/publish_publishDraftTable", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "公開するテーブルのIDまたは名前。", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "includeForeignIds", "in" : "query", "description" : "レスポンスで外部ID値を入力するには、これを「true」に設定してください。", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HubDbTableV3" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } }, "/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/update" : { "post" : { "tags" : [ "Rows Batch", "行バッチ" ], "summary" : "下書きテーブルの行を一括で更新", "description" : "セルあたり最大100行で、テーブルの下書きバージョンの複数の行がバッチとして更新されます。1行の更新に関する詳細については、「PATCH /tables/{tableIdOrName}/rows/{rowId}/draft」エンドポイントを参照してください。", "operationId" : "post-/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/update_updateDraftTableRows", "parameters" : [ { "name" : "tableIdOrName", "in" : "path", "description" : "テーブルのIDまたは名前", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputHubDbTableRowV3BatchUpdateRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseHubDbTableRowV3" } } } }, "207" : { "description" : "multiple statuses", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseHubDbTableRowV3WithErrors" } } } }, "default" : { "$ref" : "#/components/responses/Error" } }, "security" : [ { "private_apps_legacy" : [ "hubdb" ] }, { "oauth2_legacy" : [ "hubdb" ] } ] } } }, "components" : { "schemas" : { "BatchInputString" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "description" : "", "items" : { "type" : "string" } } } }, "StandardError" : { "required" : [ "category", "context", "errors", "links", "message", "status" ], "type" : "object", "properties" : { "subCategory" : { "type" : "object", "properties" : { }, "description" : "" }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } }, "description" : "" }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "" }, "id" : { "type" : "string", "description" : "" }, "category" : { "type" : "string", "description" : "" }, "message" : { "type" : "string", "description" : "" }, "errors" : { "type" : "array", "description" : "", "items" : { "$ref" : "#/components/schemas/ErrorDetail" } }, "status" : { "type" : "string", "description" : "" } } }, "BoundedNextPage" : { "required" : [ "offset" ], "type" : "object", "properties" : { "offset" : { "type" : "integer", "format" : "int32" }, "link" : { "type" : "string" } } }, "HubDbTableCloneRequest" : { "required" : [ "copyRows", "isHubspotDefined" ], "type" : "object", "properties" : { "newName" : { "type" : "string", "description" : "複製されたテーブルの新しい名前", "example" : "test_table_new" }, "isHubspotDefined" : { "type" : "boolean" }, "newLabel" : { "type" : "string", "description" : "複製されたテーブルの新しいラベル", "example" : "Test Table New" }, "copyRows" : { "type" : "boolean", "description" : "複製時に行をコピーするかどうかが指定されます", "example" : true } } }, "SimpleUser" : { "required" : [ "email", "firstName", "id", "lastName" ], "type" : "object", "properties" : { "firstName" : { "type" : "string", "description" : "" }, "lastName" : { "type" : "string", "description" : "" }, "id" : { "type" : "string", "description" : "" }, "email" : { "type" : "string", "description" : "" } } }, "CollectionResponseWithTotalHubDbTableV3ForwardPaging" : { "required" : [ "results", "total" ], "type" : "object", "properties" : { "total" : { "type" : "integer", "description" : "", "format" : "int32" }, "paging" : { "$ref" : "#/components/schemas/ForwardPaging" }, "results" : { "type" : "array", "description" : "", "items" : { "$ref" : "#/components/schemas/HubDbTableV3" } } } }, "BoundedPaging" : { "type" : "object", "properties" : { "next" : { "$ref" : "#/components/schemas/BoundedNextPage" } } }, "BatchInputHubDbTableRowBatchCloneRequest" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HubDbTableRowBatchCloneRequest" } } } }, "BatchInputHubDbTableRowV3Request" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "description" : "", "items" : { "$ref" : "#/components/schemas/HubDbTableRowV3Request" } } } }, "ErrorDetail" : { "required" : [ "message" ], "type" : "object", "properties" : { "subCategory" : { "type" : "string", "description" : "エラーに関するより具体的な詳細が含まれる特定のカテゴリー" }, "code" : { "type" : "string", "description" : "エラーの詳細に関連付けられているステータスコード" }, "in" : { "type" : "string", "description" : "エラーが見つかったフィールドまたはパラメーターの名前。" }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } }, "description" : "エラー条件に関する状況", "example" : { "missingScopes" : [ "scope1", "scope2" ] } }, "message" : { "type" : "string", "description" : "エラーと修正手順（該当する場合）を記した人間が理解できるメッセージ" } } }, "ForwardPaging" : { "type" : "object", "properties" : { "next" : { "$ref" : "#/components/schemas/NextPage" } } }, "HubDbTableRowBatchCloneRequest" : { "required" : [ "id" ], "type" : "object", "properties" : { "name" : { "type" : "string" }, "id" : { "type" : "string" } } }, "UnifiedCollectionResponseWithTotalBaseHubDbTableRowV3" : { "properties" : { }, "oneOf" : [ { "$ref" : "#/components/schemas/RandomAccessCollectionResponseWithTotalHubDbTableRowV3" }, { "$ref" : "#/components/schemas/StreamingCollectionResponseWithTotalHubDbTableRowV3" } ] }, "Column" : { "required" : [ "label", "name", "type" ], "type" : "object", "properties" : { "createdByUserId" : { "type" : "integer", "format" : "int32" }, "foreignTableId" : { "type" : "integer", "description" : "参照される外部テーブルID", "format" : "int64" }, "updatedBy" : { "$ref" : "#/components/schemas/SimpleUser" }, "description" : { "type" : "string" }, "label" : { "type" : "string", "description" : "列のラベル", "example" : "Text Column" }, "updatedByUserId" : { "type" : "integer", "format" : "int32" }, "type" : { "type" : "string", "description" : "列のタイプ", "example" : "TEXT", "enum" : [ "NULL", "TEXT", "NUMBER", "URL", "IMAGE", "SELECT", "MULTISELECT", "BOOLEAN", "LOCATION", "DATE", "DATETIME", "CURRENCY", "RICHTEXT", "FOREIGN_ID", "VIDEO", "CTA", "FILE", "JSON", "COMPOSITE", "CODE" ] }, "optionCount" : { "type" : "integer", "description" : "使用可能なオプションの数", "format" : "int32" }, "foreignIds" : { "type" : "array", "description" : "外部ID", "items" : { "$ref" : "#/components/schemas/ForeignId" } }, "createdAt" : { "type" : "string", "format" : "date-time" }, "deleted" : { "type" : "boolean" }, "createdBy" : { "$ref" : "#/components/schemas/SimpleUser" }, "name" : { "type" : "string", "description" : "列の名前", "example" : "text_column" }, "options" : { "type" : "array", "description" : "選択列と複数選択列に選択できるオプション", "items" : { "$ref" : "#/components/schemas/Option" } }, "width" : { "type" : "integer", "description" : "HubDB UIの列幅", "format" : "int32" }, "id" : { "type" : "string", "description" : "列ID", "example" : "1" }, "foreignIdsById" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ForeignId" }, "description" : "外部ID" }, "foreignColumnId" : { "type" : "integer", "description" : "外部列ID", "format" : "int32" }, "foreignIdsByName" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ForeignId" }, "description" : "名前による外部ID" }, "updatedAt" : { "type" : "string", "format" : "date-time" } } }, "StreamingCollectionResponseWithTotalHubDbTableRowV3" : { "title" : "STREAMING", "required" : [ "results", "total", "type" ], "type" : "object", "properties" : { "total" : { "type" : "integer", "format" : "int32" }, "paging" : { "$ref" : "#/components/schemas/Paging" }, "type" : { "type" : "string", "default" : "STREAMING", "enum" : [ "STREAMING" ] }, "results" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HubDbTableRowV3" } } } }, "HubDbTableV3" : { "required" : [ "label", "name" ], "type" : "object", "properties" : { "dynamicMetaTags" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32" }, "description" : "関連付けられている列IDがあるメタデータフィールドのキー値ペアが指定されます", "example" : { } }, "updatedBy" : { "$ref" : "#/components/schemas/SimpleUser" }, "allowPublicApiAccess" : { "type" : "boolean", "description" : "テーブルを許可なしで誰でも読み取れるかどうかが指定されます", "example" : false }, "useForPages" : { "type" : "boolean", "description" : "テーブルを動的ページの作成に使用できるかどうかが指定されます", "example" : true }, "publishedAt" : { "type" : "string", "description" : "テーブルが最近公開された時点のタイムスタンプ", "format" : "date-time", "example" : "2020-04-02T16:00:45.009+00:00" }, "columns" : { "type" : "array", "description" : "テーブル内の列のリスト", "example" : [ { "id" : "1", "name" : "text_column", "type" : "TEXT", "label" : "Text Column", "archived" : false, "foreignIdsById" : { }, "foreignIdsByName" : { } } ], "items" : { "$ref" : "#/components/schemas/Column" } }, "label" : { "type" : "string", "description" : "テーブルのラベル", "example" : "Test Table" }, "published" : { "type" : "boolean" }, "columnCount" : { "type" : "integer", "description" : "削除された列を含む列の数", "format" : "int32", "example" : 3 }, "allowChildTables" : { "type" : "boolean", "description" : "子テーブルを作成できるかどうかが指定されます", "example" : true }, "createdAt" : { "type" : "string", "description" : "テーブルが作成された時点のタイムスタンプ", "format" : "date-time", "example" : "2019-03-15T21:20:51.556+00:00" }, "deleted" : { "type" : "boolean" }, "createdBy" : { "$ref" : "#/components/schemas/SimpleUser" }, "name" : { "type" : "string", "description" : "テーブルの数", "example" : "test_table" }, "enableChildTablePages" : { "type" : "boolean", "description" : "子テーブルを使用した複数レベルの動的ページの作成が指定されます", "example" : false }, "id" : { "type" : "string", "description" : "テーブルのID", "example" : "1630034" }, "rowCount" : { "type" : "integer", "description" : "テーブル内の行数", "format" : "int32", "example" : 0 }, "isOrderedManually" : { "type" : "boolean" }, "updatedAt" : { "type" : "string", "description" : "テーブルが最近更新された時点のタイムスタンプ", "format" : "date-time", "example" : "2020-04-02T16:00:43.880+00:00" } } }, "BatchResponseHubDbTableRowV3" : { "type" : "object", "properties" : { "completedAt" : { "type" : "string", "format" : "date-time" }, "requestedAt" : { "type" : "string", "format" : "date-time" }, "startedAt" : { "type" : "string", "format" : "date-time" }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "results" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HubDbTableRowV3" } }, "status" : { "type" : "string", "enum" : [ "PENDING", "PROCESSING", "CANCELED", "COMPLETE" ] } } }, "ForeignId" : { "required" : [ "id", "name", "type" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "" }, "id" : { "type" : "string", "description" : "" }, "type" : { "type" : "string", "description" : "" } } }, "RandomAccessCollectionResponseWithTotalHubDbTableRowV3" : { "title" : "RANDOM_ACCESS", "required" : [ "results", "total", "type" ], "type" : "object", "properties" : { "total" : { "type" : "integer", "format" : "int32" }, "paging" : { "$ref" : "#/components/schemas/BoundedPaging" }, "type" : { "type" : "string", "default" : "RANDOM_ACCESS", "enum" : [ "RANDOM_ACCESS" ] }, "results" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HubDbTableRowV3" } } } }, "ImportResult" : { "required" : [ "duplicateRows", "errors", "rowLimitExceeded", "rowsImported" ], "type" : "object", "properties" : { "rowLimitExceeded" : { "type" : "boolean", "description" : "インポート時に行の上限を超えたかどうかが指定されます" }, "duplicateRows" : { "type" : "integer", "description" : "重複する行の数が指定されます", "format" : "int32" }, "rowsImported" : { "type" : "integer", "description" : "インポートされる行の数が指定されます", "format" : "int32" }, "errors" : { "type" : "array", "description" : "インポート時のエラーのリスト", "items" : { "$ref" : "#/components/schemas/Error" } } } }, "Paging" : { "type" : "object", "properties" : { "next" : { "$ref" : "#/components/schemas/NextPage" }, "prev" : { "$ref" : "#/components/schemas/PreviousPage" } } }, "HubDbTableV3Request" : { "required" : [ "label", "name" ], "type" : "object", "properties" : { "dynamicMetaTags" : { "type" : "object", "additionalProperties" : { "type" : "integer", "format" : "int32" }, "description" : "関連付けられている列IDがあるメタデータフィールドのキー値ペアが指定されます", "example" : { } }, "allowPublicApiAccess" : { "type" : "boolean", "description" : "テーブルを許可なしで誰でも読み取れるかどうかが指定されます", "example" : false }, "useForPages" : { "type" : "boolean", "description" : "テーブルを動的ページの作成に使用できるかどうかが指定されます", "example" : true }, "columns" : { "type" : "array", "description" : "テーブル内の列のリスト", "example" : [ { "id" : "1", "name" : "text_column", "type" : "TEXT", "label" : "Text Column" } ], "items" : { "$ref" : "#/components/schemas/ColumnRequest" } }, "name" : { "type" : "string", "description" : "テーブルの数", "example" : "test_table" }, "enableChildTablePages" : { "type" : "boolean", "description" : "子テーブルを使用した複数レベルの動的ページの作成が指定されます", "example" : false }, "label" : { "type" : "string", "description" : "テーブルのラベル", "example" : "Test Table" }, "allowChildTables" : { "type" : "boolean", "description" : "子テーブルを作成できるかどうかが指定されます", "example" : true } } }, "Error" : { "required" : [ "category", "correlationId", "message" ], "type" : "object", "properties" : { "subCategory" : { "type" : "string", "description" : "エラーに関するより具体的な詳細が含まれる特定のカテゴリー" }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } }, "description" : "エラー条件に関する状況", "example" : { "missingScopes" : [ "scope1", "scope2" ], "invalidPropertyName" : [ "propertyValue" ] } }, "correlationId" : { "type" : "string", "description" : "リクエストの固有ID。エラーレポートやサポートチケットには必ずこの値を含めてください", "format" : "uuid", "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "エラーまたは推奨の修正手順に関するドキュメントが含まれる関連付けられたURIへのリンク名のひも付け", "example" : { "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" } }, "message" : { "type" : "string", "description" : "エラーと修正手順（該当する場合）を記した人間が読めるメッセージ", "example" : "Invalid input (details will vary based on the error)" }, "category" : { "type" : "string", "description" : "エラーカテゴリー", "example" : "VALIDATION_ERROR" }, "errors" : { "type" : "array", "description" : "エラーに関する詳細情報", "items" : { "$ref" : "#/components/schemas/ErrorDetail" } } }, "example" : { "message" : "Invalid input (details will vary based on the error)", "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", "category" : "VALIDATION_ERROR", "links" : { "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" } } }, "BatchResponseHubDbTableRowV3WithErrors" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "description" : "", "format" : "date-time" }, "numErrors" : { "type" : "integer", "description" : "", "format" : "int32" }, "requestedAt" : { "type" : "string", "description" : "", "format" : "date-time" }, "startedAt" : { "type" : "string", "description" : "", "format" : "date-time" }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "" }, "results" : { "type" : "array", "description" : "", "items" : { "$ref" : "#/components/schemas/HubDbTableRowV3" } }, "errors" : { "type" : "array", "description" : "", "items" : { "$ref" : "#/components/schemas/StandardError" } }, "status" : { "type" : "string", "description" : "", "enum" : [ "PENDING", "PROCESSING", "CANCELED", "COMPLETE" ] } } }, "ColumnRequest" : { "required" : [ "id", "label", "name", "options", "type" ], "type" : "object", "properties" : { "foreignTableId" : { "type" : "integer", "description" : "列が参照する別のテーブルのID。", "format" : "int64" }, "name" : { "type" : "string", "description" : "列の名前", "example" : "text_column" }, "options" : { "type" : "array", "description" : "選択列と複数選択列に選択できるオプション", "items" : { "$ref" : "#/components/schemas/Option" } }, "id" : { "type" : "integer", "description" : "列ID", "format" : "int32", "example" : 1 }, "label" : { "type" : "string", "description" : "列のラベル", "example" : "Text Column" }, "type" : { "type" : "string", "description" : "列のタイプ", "example" : "TEXT", "enum" : [ "NULL", "TEXT", "NUMBER", "URL", "IMAGE", "SELECT", "MULTISELECT", "BOOLEAN", "LOCATION", "DATE", "DATETIME", "CURRENCY", "RICHTEXT", "FOREIGN_ID", "VIDEO", "CTA", "FILE", "JSON", "COMPOSITE", "CODE" ] }, "foreignColumnId" : { "type" : "integer", "description" : "列が参照する別のテーブルの列のID。", "format" : "int32" } } }, "Variant" : { "type" : "object", "properties" : { } }, "HubDbTableRowV3BatchUpdateRequest" : { "required" : [ "id", "values" ], "type" : "object", "properties" : { "path" : { "type" : "string", "description" : "動的ページのスラッグとして使用される「hs_path」列の値が指定されます", "example" : "test_path" }, "childTableId" : { "type" : "integer", "description" : "列の子テーブルIDの値が指定されます", "format" : "int32", "example" : 1902373 }, "values" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Variant" }, "description" : "列名と列値が含まれるキー値ペアのリスト", "example" : { "multiselect" : [ { "id" : "1", "name" : "Option 1", "type" : "option", "order" : 0 }, { "id" : "2", "name" : "Option 2", "type" : "option", "order" : 1 } ], "text_column" : "sample text value", "number_column" : 76 } }, "name" : { "type" : "string", "description" : "動的ページのタイトルとして使用される「hs_name」列の値が指定されます", "example" : "test_title" }, "id" : { "type" : "string", "description" : "テーブル行のID", "example" : "4099275931" }, "displayIndex" : { "type" : "integer", "format" : "int32" } } }, "PreviousPage" : { "required" : [ "before" ], "type" : "object", "properties" : { "before" : { "type" : "string" }, "link" : { "type" : "string" } } }, "HubDbTableRowV3" : { "required" : [ "values" ], "type" : "object", "properties" : { "path" : { "type" : "string", "description" : "動的ページのスラッグとして使用される「hs_path」列の値が指定されます", "example" : "test_path" }, "createdAt" : { "type" : "string", "description" : "行が作成された時点のタイムスタンプ", "format" : "date-time", "example" : "2020-03-30T20:39:52.328+00:00" }, "childTableId" : { "type" : "string", "description" : "列の子テーブルIDの値が指定されます", "example" : "1902373" }, "publishedAt" : { "type" : "string", "format" : "date-time" }, "values" : { "type" : "object", "additionalProperties" : { "type" : "object", "properties" : { } }, "description" : "列名と列値が含まれるキー値ペアのリスト", "example" : { "multiselect" : [ { "id" : "1", "name" : "Option 1", "type" : "option", "order" : 0 }, { "id" : "2", "name" : "Option 2", "type" : "option", "order" : 1 } ], "text_column" : "sample text value", "number_column" : 76 } }, "name" : { "type" : "string", "description" : "動的ページのタイトルとして使用される「hs_name」列の値が指定されます", "example" : "test_title" }, "id" : { "type" : "string", "description" : "テーブル行のID", "example" : "4099275931" }, "updatedAt" : { "type" : "string", "description" : "行が最後に更新された時点のタイムスタンプ", "format" : "date-time", "example" : "2020-03-30T20:39:52.328+00:00" } } }, "HubDbTableRowV3Request" : { "required" : [ "values" ], "type" : "object", "properties" : { "path" : { "type" : "string", "description" : "動的ページのスラッグとして使用される「hs_path」列の値が指定されます", "example" : "test_path" }, "childTableId" : { "type" : "integer", "description" : "列の子テーブルIDの値が指定されます", "format" : "int64", "example" : 1902373 }, "values" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Variant" }, "description" : "列名と列値が含まれるキー値ペアのリスト", "example" : { "multiselect" : [ { "id" : "1", "name" : "Option 1", "type" : "option", "order" : 0 }, { "id" : "2", "name" : "Option 2", "type" : "option", "order" : 1 } ], "text_column" : "sample text value", "number_column" : 76 } }, "name" : { "type" : "string", "description" : "動的ページのタイトルとして使用される「hs_name」列の値が指定されます", "example" : "test_title" }, "displayIndex" : { "type" : "integer", "format" : "int32" } } }, "Option" : { "required" : [ "createdAt", "id", "name", "order", "type", "updatedAt" ], "type" : "object", "properties" : { "createdByUserId" : { "type" : "integer", "format" : "int32" }, "createdAt" : { "type" : "string", "format" : "date-time" }, "updatedBy" : { "$ref" : "#/components/schemas/SimpleUser" }, "createdBy" : { "$ref" : "#/components/schemas/SimpleUser" }, "name" : { "type" : "string", "description" : "" }, "id" : { "type" : "string", "description" : "" }, "label" : { "type" : "string" }, "updatedByUserId" : { "type" : "integer", "format" : "int32" }, "type" : { "type" : "string", "description" : "" }, "order" : { "type" : "integer", "description" : "", "format" : "int32" }, "updatedAt" : { "type" : "string", "format" : "date-time" } } }, "NextPage" : { "required" : [ "after" ], "type" : "object", "properties" : { "link" : { "type" : "string", "description" : "" }, "after" : { "type" : "string", "description" : "" } } }, "BatchInputHubDbTableRowV3BatchUpdateRequest" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HubDbTableRowV3BatchUpdateRequest" } } } } }, "responses" : { "Error" : { "description" : "An error occurred.", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Error" } } } } }, "securitySchemes" : { "oauth2_legacy" : { "type" : "oauth2", "flows" : { "authorizationCode" : { "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", "scopes" : { "hubdb" : "Read from and write to my HubDB" } } } }, "private_apps_legacy" : { "type" : "apiKey", "name" : "private-app-legacy", "in" : "header" } } }, "x-hubspot-available-client-libraries" : [ "PHP", "Node", "Ruby", "Python" ], "x-hubspot-product-tier-requirements" : { "marketing" : "PROFESSIONAL", "cms" : "PROFESSIONAL" }, "x-hubspot-documentation-banner" : "NONE" }