REST API

v2alpha REST API は、Stitch ワークスペースの管理、コードベースの優先事項、インサイト、ソリューションを支えます。

stitch api <path> でエンドポイントを呼び出すには、stitch enable loop でワークスペース機能を事前に一度有効にする必要があります。

CLI から API を呼び出す

stitch api workspaces
stitch api workspaces/<workspace-id>/goals
stitch api -X POST workspaces/<workspace-id>/insights:generate --json '{}'

エンドポイント

メソッド	エンドポイント
`POST`	`clientNotices:fetch`
`POST`	`contexts:parseMcpJson`
`POST`	`feedback:submit`
`POST`	`workspaces/{workspace}/files`
`GET`	`organizations/{organization}`
`GET`	`organizations`
`POST`	`tos:accept`
`GET`	`tos:check`
`GET`	`users/{user}/preferences`
`PATCH`	`users/{user}/preferences`
`POST`	`users/{user}/tos:accept`
`GET`	`users/{user}/tos:check`
`POST`	`v2alpha:completeOAuth`
`POST`	`workspaces/{workspace}:addRepository`
`POST`	`workspaces/{workspace}:addUser`
`POST`	`workspaces`
`POST`	`workspaces/{workspace}:createToolkitConnectLink`
`DELETE`	`workspaces/{workspace}`
`GET`	`workspaces/{workspace}`
`GET`	`workspaces/{workspace}/marketRadarCheckpoint`
`GET`	`workspaces/{workspace}/userNotificationSettings`
`GET`	`workspaces/{workspace}/workspaceNotificationSettings`
`GET`	`workspaces`
`PATCH`	`workspaces/{workspace}`
`POST`	`workspaces/{workspace}:removeRepository`
`POST`	`workspaces/{workspace}:removeUser`
`PATCH`	`workspaces/{workspace}/userNotificationSettings`
`PATCH`	`workspaces/{workspace}/workspaceNotificationSettings`
`DELETE`	`workspaces/{workspace}/assessments/{assessment}`
`POST`	`workspaces/{workspace}/assessments:generate`
`GET`	`workspaces/{workspace}/assessments/{assessment}`
`GET`	`workspaces/{workspace}/assessments`
`PATCH`	`workspaces/{workspace}/assessments/{assessment}`
`POST`	`workspaces/{workspace}/contexts`
`DELETE`	`workspaces/{workspace}/contexts/{context}`
`GET`	`workspaces/{workspace}/contexts/{context}`
`POST`	`workspaces/{workspace}/contexts:initiateOAuth`
`GET`	`workspaces/{workspace}/contexts`
`PATCH`	`workspaces/{workspace}/contexts/{context}`
`GET`	`workspaces/{workspace}/contexts:search`
`GET`	`workspaces/{workspace}/eventDeliveries/{eventDeliverie}`
`GET`	`workspaces/{workspace}/eventDeliveries`
`GET`	`workspaces/{workspace}/events`
`POST`	`workspaces/{workspace}/events/{event}:replay`
`GET`	`workspaces/{workspace}/feedback:batchGet`
`POST`	`workspaces/{workspace}/fileSystemEntries`
`DELETE`	`workspaces/{workspace}/fileSystemEntries/{fileSystemEntrie}`
`GET`	`workspaces/{workspace}/fileSystemEntries/{fileSystemEntrie}`
`GET`	`workspaces/{workspace}/fileSystemEntries`
`PATCH`	`workspaces/{workspace}/fileSystemEntries/{fileSystemEntrie}`
`DELETE`	`workspaces/{workspace}/files/{file}`
`GET`	`workspaces/{workspace}/files/{file}`
`GET`	`workspaces/{workspace}/files`
`GET`	`workspaces/{workspace}/goalTemplates`
`POST`	`workspaces/{workspace}/goals`
`DELETE`	`workspaces/{workspace}/goals/{goal}`
`GET`	`workspaces/{workspace}/goals/{goal}`
`GET`	`workspaces/{workspace}/goals/{goal}/insightGeneration`
`GET`	`workspaces/{workspace}/goals`
`PATCH`	`workspaces/{workspace}/goals/{goal}`
`POST`	`workspaces/{workspace}/goals/suggest`
`GET`	`workspaces/{workspace}/goals/{goal}/insightGeneration:queryStatusUpdates`
`GET`	`workspaces/{workspace}/insights:batchGet`
`POST`	`workspaces/{workspace}/insights/{insight}:dismiss`
`POST`	`workspaces/{workspace}/insights/generate`
`GET`	`workspaces/{workspace}/insights/{insight}`
`GET`	`workspaces/{workspace}/insights/{insight}/investigationReport`
`GET`	`workspaces/{workspace}/insights/summary`
`GET`	`workspaces/{workspace}/insights`
`POST`	`workspaces/{workspace}/insights/{insight}/setReadStatus`
`POST`	`workspaces/{workspace}/insights/{insight}:undismiss`
`POST`	`workspaces/{workspace}/insights/{insight}/feedback`
`DELETE`	`workspaces/{workspace}/insights/{insight}/feedback/{feedback}`
`GET`	`workspaces/{workspace}/insights/{insight}/feedback/{feedback}`
`GET`	`workspaces/{workspace}/insights/{insight}/feedback`
`PATCH`	`workspaces/{workspace}/insights/{insight}/feedback/{feedback}`
`GET`	`workspaces/{workspace}/insights/{insight}/insightUpdates/{insightUpdate}/investigationReport`
`GET`	`workspaces/{workspace}/insights/{insight}/insightUpdates`
`POST`	`workspaces/{workspace}/marketRadarCheckpoint/generate`
`POST`	`workspaces/{workspace}/productMd:generate`
`GET`	`workspaces/{workspace}/productMd:getStatus`
`POST`	`workspaces/{workspace}/skills`
`DELETE`	`workspaces/{workspace}/skills/{skill}`
`GET`	`workspaces/{workspace}/skills`
`PATCH`	`workspaces/{workspace}/skills/{skill}`
`DELETE`	`workspaces/{workspace}/toolProviders/{toolProvider}`
`DELETE`	`workspaces/{workspace}/toolProviders/{toolProvider}:deleteAuth`
`GET`	`workspaces/{workspace}/toolProviders`
`POST`	`workspaces/{workspace}/toolProviders:upsert`
`POST`	`workspaces/{workspace}/toolProviders/{toolProvider}:upsertAuth`
`GET`	`workspaces/{workspace}/users`
`POST`	`workspaces/{workspace}/webhookConfigs`
`DELETE`	`workspaces/{workspace}/webhookConfigs/{webhookConfig}`
`GET`	`workspaces/{workspace}/webhookConfigs/{webhookConfig}`
`GET`	`workspaces/{workspace}/webhookConfigs`
`PATCH`	`workspaces/{workspace}/webhookConfigs/{webhookConfig}`
`PATCH`	`workspaces/{workspace}/webhookConfigs/{webhookConfig}/verify`
`GET`	`workspaces/{workspace}/webhookEvents/{webhookEvent}`
`GET`	`workspaces/{workspace}/webhookEvents`
`POST`	`workspaces/{workspace}/webhookEvents/{webhookEvent}:send`

`clientNotices.fetch`

クライアント向けの動的なお知らせ、警告バナー、障害通知、免責事項を取得します。

stitch api -X POST clientNotices:fetch

`contexts.parseMcpJson`

MCP JSON 設定を解析し、正規化されたツールプロバイダー設定に変換します。

stitch api -X POST contexts:parseMcpJson

`feedback.submit`

製品のフィードバックを送信します（例：Stitch CLI から）。

stitch api -X POST feedback:submit

`media.upload`

File を作成します。

stitch api -X POST workspaces/{workspace}/files

パラメータ

名前	場所	型	説明
`parent` （必須）	`path`	`string`	必須。ファイルのメタデータを作成する親ワークスペース。形式：`workspaces/{workspace}`。

`organizations.get`

リソース名を指定して単一の組織を取得します。

stitch api organizations/{organization}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。取得する組織のリソース名。形式：`organizations/{organization}`

`organizations.list`

組織を一覧表示します。

stitch api organizations

パラメータ

名前	場所	型	説明
`filter`	`query`	`string`	任意。組織を絞り込むための CEL フィルター式。
`pageSize`	`query`	`integer`	任意。返される組織の最大数。
`pageToken`	`query`	`string`	任意。以前の `ListOrganizations` 呼び出しで受け取ったページトークン。

`tos.accept`

認証済みユーザーが指定された ToS バージョンに同意したことを記録します。

stitch api -X POST tos:accept

`tos.check`

認証済みユーザーが指定された ToS バージョンに同意しているかどうかを確認します。

stitch api tos:check

パラメータ

名前	場所	型	説明
`user`	`query`	`string`	任意。ユーザーのリソース名。デフォルトは認証済みユーザー（「users/me」）です。
`version`	`query`	`string`	任意。確認する ToS のバージョン（例：`"2026-03-18"`）。省略した場合、サーバーはバックエンドに構成された有効な ToS バージョンと照合します。

`users.getPreferences`

ユーザーの環境設定を取得します。

stitch api users/{user}/preferences

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。取得するユーザー環境設定のリソース名。形式：`users/{user}/preferences` または `users/me/preferences`

`users.updatePreferences`

ユーザーの環境設定を更新します。

stitch api -X PATCH users/{user}/preferences

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	識別子。ユーザー環境設定のリソース名。形式：`users/{user}/preferences` または `users/me/preferences`
`updateMask`	`query`	`string`	任意。更新するフィールドのリスト。空の場合、または「*」を含む場合は、変更可能なすべてのフィールドが更新されます。

`users.tos.accept`

認証済みユーザーが指定された ToS バージョンに同意したことを記録します。

stitch api -X POST users/{user}/tos:accept

パラメータ

名前	場所	型	説明
`user` （必須）	`path`	`string`	任意。ユーザーのリソース名。デフォルトは認証済みユーザー（「users/me」）です。

`users.tos.check`

認証済みユーザーが指定された ToS バージョンに同意しているかどうかを確認します。

stitch api users/{user}/tos:check

パラメータ

名前	場所	型	説明
`user` （必須）	`path`	`string`	任意。ユーザーのリソース名。デフォルトは認証済みユーザー（「users/me」）です。
`version`	`query`	`string`	任意。確認する ToS のバージョン（例：`"2026-03-18"`）。省略した場合、サーバーはバックエンドに構成された有効な ToS バージョンと照合します。

`completeOAuth`

認可コードをトークンと交換して安全に保存することにより、OAuth 2.0 フローを完了します。ワークスペースとプロバイダーの識別情報は、リソースパスや親コレクションではなく state_token 内に安全にカプセル化され、そこから解決されるため、これはステートレスなカスタムメソッド（AIP-136）です。

stitch api -X POST v2alpha:completeOAuth

`workspaces.addRepository`

ワークスペースにリポジトリを追加します。

stitch api -X POST workspaces/{workspace}:addRepository

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。リポジトリを追加するワークスペースのリソース名。形式：`workspaces/{workspace}`

`workspaces.addUser`

ワークスペースにユーザーを追加します。

stitch api -X POST workspaces/{workspace}:addUser

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。ユーザーを追加するワークスペースのリソース名。形式：`workspaces/{workspace}`

`workspaces.create`

新しいワークスペースを作成します。

stitch api -X POST workspaces

`workspaces.createToolkitConnectLink`

ワークスペース内のツールキットを認証するための接続リンクを作成します。

stitch api -X POST workspaces/{workspace}:createToolkitConnectLink

パラメータ

名前	場所	型	説明
`parent` （必須）	`path`	`string`	必須。ツールキット接続リンクを作成する親ワークスペース。形式：`workspaces/{workspace}`。

`workspaces.delete`

リソース名を指定してワークスペースを削除します。

stitch api -X DELETE workspaces/{workspace}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。削除するワークスペースのリソース名。形式：`workspaces/{workspace}`

`workspaces.get`

リソース名を指定して単一のワークスペースを取得します。

stitch api workspaces/{workspace}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。取得するワークスペースのリソース名。形式：`workspaces/{workspace}`

`workspaces.getMarketRadarCheckpoint`

競合マーケット分析の詳細チェックポイントを取得します。

stitch api workspaces/{workspace}/marketRadarCheckpoint

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。マーケットレーダーチェックポイントのリソース名。形式：`workspaces/{workspace}/marketRadarCheckpoint`

`workspaces.getUserNotificationSettings`

ワークスペースにおける呼び出し元ユーザー自身の通知設定を取得します。

stitch api workspaces/{workspace}/userNotificationSettings

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。ユーザー通知設定のリソース名。形式：`workspaces/{workspace}/userNotificationSettings`

`workspaces.getWorkspaceNotificationSettings`

ワークスペースレベルの通知設定を取得します。

stitch api workspaces/{workspace}/workspaceNotificationSettings

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。ワークスペース通知設定のリソース名。形式：`workspaces/{workspace}/workspaceNotificationSettings`

`workspaces.list`

ワークスペースを一覧表示します。

stitch api workspaces

パラメータ

名前	場所	型	説明
`filter`	`query`	`string`	任意。ワークスペースを絞り込むための CEL フィルター式。
`pageSize`	`query`	`integer`	任意。返されるワークスペースの最大数。
`pageToken`	`query`	`string`	任意。以前の `ListWorkspaces` 呼び出しで受け取ったページトークン。

`workspaces.patch`

既存のワークスペースを更新します。

stitch api -X PATCH workspaces/{workspace}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	識別子。リソース名。形式：`workspaces/{workspace}`
`updateMask`	`query`	`string`	任意。更新するフィールドのリスト。

`workspaces.removeRepository`

ワークスペースからリポジトリを削除します。

stitch api -X POST workspaces/{workspace}:removeRepository

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。リポジトリを削除するワークスペースのリソース名。形式：`workspaces/{workspace}`

`workspaces.removeUser`

ワークスペースからユーザーを削除します。

stitch api -X POST workspaces/{workspace}:removeUser

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。ユーザーを削除するワークスペースのリソース名。形式：`workspaces/{workspace}`

`workspaces.updateUserNotificationSettings`

ワークスペースにおける呼び出し元ユーザー自身の通知設定を更新します。

stitch api -X PATCH workspaces/{workspace}/userNotificationSettings

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	識別子。リソース名。形式：`workspaces/{workspace}/userNotificationSettings`
`updateMask`	`query`	`string`	任意。更新するフィールドのリスト。

`workspaces.updateWorkspaceNotificationSettings`

ワークスペースレベルの通知設定を更新します。

stitch api -X PATCH workspaces/{workspace}/workspaceNotificationSettings

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	識別子。リソース名。形式：`workspaces/{workspace}/workspaceNotificationSettings`
`updateMask`	`query`	`string`	任意。更新するフィールドのリスト。

`workspaces.assessments.delete`

名前を指定してアセスメントを削除します。

stitch api -X DELETE workspaces/{workspace}/assessments/{assessment}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。削除するアセスメントのリソース名。形式：`workspaces/{workspace}/assessments/{assessment}`

`workspaces.assessments.generate`

インサイトのリストに対してアセスメントを生成します。

stitch api -X POST workspaces/{workspace}/assessments:generate

パラメータ

名前	場所	型	説明
`parent` （必須）	`path`	`string`	必須。親ワークスペース。形式：`workspaces/{workspace}`

`workspaces.assessments.get`

名前を指定して単一のアセスメントを取得します。

stitch api workspaces/{workspace}/assessments/{assessment}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。取得するアセスメントのリソース名。形式：`workspaces/{workspace}/assessments/{assessment}`

`workspaces.assessments.list`

ワークスペース内のアセスメントを一覧表示します。

stitch api workspaces/{workspace}/assessments

パラメータ

名前	場所	型	説明
`filter`	`query`	`string`	任意。アセスメントを絞り込むための AIP-160 フィルター式。サポートされるフィールド：`insights`。例：`insights:"workspaces/123/insights/456"`
`pageSize`	`query`	`integer`	任意。返されるアセスメントの最大数。サービスはこの値よりも少ない件数を返す場合があります。未指定の場合、最大 20 件のアセスメントが返されます。最大値は 100 です。100 を超える値は 100 に切り捨てられます。
`pageToken`	`query`	`string`	任意。以前の `ListAssessments` 呼び出しで受け取ったページトークン。これを指定すると、次のページを取得できます。
`parent` （必須）	`path`	`string`	必須。アセスメントを一覧表示する親ワークスペース。形式：`workspaces/{workspace}`

`workspaces.assessments.patch`

アセスメントを更新します。

stitch api -X PATCH workspaces/{workspace}/assessments/{assessment}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	識別子。アセスメントの完全なリソース名。形式：`workspaces/{workspace}/assessments/{assessment}`
`updateMask`	`query`	`string`	任意。更新するフィールドを指定するマスク。

`workspaces.contexts.create`

ワークスペースに新しいコンテキストを取り込みます。

stitch api -X POST workspaces/{workspace}/contexts

パラメータ

名前	場所	型	説明
`parent` （必須）	`path`	`string`	必須。コンテキストを作成する親ワークスペース。形式：`workspaces/{workspace}`。

`workspaces.contexts.delete`

ワークスペース内のコンテキストを削除します。

stitch api -X DELETE workspaces/{workspace}/contexts/{context}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。削除するコンテキストのリソース名。形式：`workspaces/{workspace}/contexts/{context}`。

`workspaces.contexts.get`

ID を指定してコンテキストを取得します。

stitch api workspaces/{workspace}/contexts/{context}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。取得するコンテキストのリソース名。形式：`workspaces/{workspace}/contexts/{context}`。

`workspaces.contexts.initiateOAuth`

ツールプロバイダーの OAuth 2.0 フローを開始します。呼び出し元がユーザーをリダイレクトすべき認可 URL を返します。

stitch api -X POST workspaces/{workspace}/contexts:initiateOAuth

パラメータ

名前	場所	型	説明
`parent` （必須）	`path`	`string`	必須。OAuth を開始する親ワークスペース。形式：`workspaces/{workspace}`。

`workspaces.contexts.list`

ワークスペース内のコンテキストを一覧表示します。

stitch api workspaces/{workspace}/contexts

パラメータ

名前	場所	型	説明
`filter`	`query`	`string`	任意。返されるコンテキストを絞り込むための AIP-160 フィルター式。絞り込み可能なフィールド：- `data_source`：コンテキストのデータソースに対する完全一致。例：`data_source = "user_feedback"` - `annotations.`：アノテーション値に対する完全一致。例：`annotations.env = "prod"` - `description`：HAS（:）演算子を使用した部分一致。例：`description : "error"` - `data`：HAS（:）演算子を使用した部分一致。例：`data : "exception"` - `create_time`：RFC 3339 タイムスタンプを使用した不等号一致（<=、<、>=、>）。例：`create_time >= "2024-01-01T00:00:00Z"` AND を使用した複合式のみがサポートされます：`data_source = "notes" AND description : "bug"` 不正または未サポートのフィルターの場合は INVALID_ARGUMENT を返します。
`orderBy`	`query`	`string`	任意。返されるコンテキストの並べ替え順。
`pageSize`	`query`	`integer`	任意。返されるコンテキストの最大数。サービスはこの値よりも少ない件数を返す場合があります。未指定の場合、最大 50 件のコンテキストが返されます。最大値は 1000 です。1000 を超える値は 1000 に切り捨てられます。
`pageToken`	`query`	`string`	任意。以前の `ListContexts` 呼び出しで受け取ったページトークン。これを指定すると、次のページを取得できます。
`parent` （必須）	`path`	`string`	必須。コンテキストを一覧表示するワークスペース。形式：`workspaces/{workspace}`。

`workspaces.contexts.patch`

ワークスペース内の既存のコンテキストを更新します。

stitch api -X PATCH workspaces/{workspace}/contexts/{context}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	出力専用。識別子。コンテキストの完全なリソース名。形式：`workspaces/{workspace}/contexts/{context}`
`updateMask`	`query`	`string`	任意。更新するフィールドのリスト。

`workspaces.contexts.search`

ベクトル埋め込みによる意味的な類似性でコンテキストを検索します。

stitch api workspaces/{workspace}/contexts:search

パラメータ

名前	場所	型	説明
`filter`	`query`	`string`	任意。返されるコンテキストを絞り込むための AIP-160 フィルター式。https://google.aip.dev/160 に準拠しています。絞り込み可能なフィールド：- `data_source`：コンテキストのデータソースに対する完全一致。例：`data_source = "user_feedback"` - `annotations.`：アノテーション値に対する完全一致。例：`annotations.env = "prod"` - `description`：HAS（:）演算子を使用した部分一致。例：`description : "error"` - `data`：HAS（:）演算子を使用した部分一致。例：`data : "exception"` - `create_time`：RFC 3339 タイムスタンプを使用した不等号一致（<=、<、>=、>）。例：`create_time >= "2024-01-01T00:00:00Z"`
`maxResults`	`query`	`integer`	任意。（非推奨）代わりに `page_size` を使用してください。
`pageSize`	`query`	`integer`	任意。返される検索結果の最大数。未指定の場合、最大 10 件の結果が返されます。最大値は 100 です。100 を超える値は 100 に切り捨てられます。
`pageToken`	`query`	`string`	任意。以前の `SearchContexts` 呼び出しで受け取ったページトークン。これを指定すると、次のページを取得できます。
`parent` （必須）	`path`	`string`	必須。コンテキストを検索する親ワークスペース。形式：`workspaces/{workspace}`。
`query`	`query`	`string`	必須。自然言語の検索クエリ。
`readMask`	`query`	`string`	任意。返す `Context` のフィールドを指定するマスク。

`workspaces.eventDeliveries.get`

リソース名を指定して単一のイベント配信を取得します。

stitch api workspaces/{workspace}/eventDeliveries/{eventDeliverie}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。イベント配信のリソース名。形式：`workspaces/{workspace}/eventDeliveries/{event_delivery}`

`workspaces.eventDeliveries.list`

ワークスペースのイベント配信を一覧表示します。

stitch api workspaces/{workspace}/eventDeliveries

パラメータ

名前	場所	型	説明
`filter`	`query`	`string`	任意。status や event_type（またはその両方）に対する AIP-160 フィルター式。
`pageSize`	`query`	`integer`	任意。返される配信イベントの最大数。
`pageToken`	`query`	`string`	任意。ページネーションに使用する省略可能なトークン。
`parent` （必須）	`path`	`string`	必須。イベント配信を一覧表示するワークスペース。形式：`workspaces/{workspace}`

`workspaces.events.list`

ワークスペースの通知イベントを一覧表示します。

stitch api workspaces/{workspace}/events

パラメータ

名前	場所	型	説明
`pageSize`	`query`	`integer`	任意。返されるイベントの最大数。
`pageToken`	`query`	`string`	任意。ページネーションに使用するトークン。
`parent` （必須）	`path`	`string`	必須。イベントを一覧表示するワークスペース。形式：`workspaces/{workspace}`

`workspaces.events.replay`

1 つ以上のサブスクライバーに通知イベントを再配信します。

stitch api -X POST workspaces/{workspace}/events/{event}:replay

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。再配信するイベントのリソース名。形式：`workspaces/{workspace}/events/{event}`

`workspaces.feedback.batchGet`

複数のインサイトにまたがるフィードバック項目を一括取得します。

stitch api workspaces/{workspace}/feedback:batchGet

パラメータ

名前	場所	型	説明
`names`	`query`	`string`	必須。フィードバックを取得するインサイトのリソース名。形式：`workspaces/{workspace}/insights/{insight}`
`parent` （必須）	`path`	`string`	必須。インサイトを含む親ワークスペース。形式：`workspaces/{workspace}`

`workspaces.fileSystemEntries.create`

指定されたパスにファイルシステムエントリを作成します。

stitch api -X POST workspaces/{workspace}/fileSystemEntries

パラメータ

名前	場所	型	説明
`fileSystemEntryId`	`query`	`string`	任意。ファイルシステムエントリに使用する ID。ファイルシステムエントリのリソース名の最後の構成要素になります。
`parent` （必須）	`path`	`string`	必須。エントリを作成する親ワークスペース。形式：`workspaces/{workspace}`。

`workspaces.fileSystemEntries.delete`

指定されたパスのファイルシステムエントリを削除します。

stitch api -X DELETE workspaces/{workspace}/fileSystemEntries/{fileSystemEntrie}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。削除するファイルシステムエントリの名前。形式：workspaces/{workspace}/fileSystemEntries/{file_system_entry}

`workspaces.fileSystemEntries.get`

パスを指定してファイルシステムエントリを取得します。

stitch api workspaces/{workspace}/fileSystemEntries/{fileSystemEntrie}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。取得するファイルシステムエントリの名前。形式：workspaces/{workspace}/fileSystemEntries/{file_system_entry}

`workspaces.fileSystemEntries.list`

ワークスペース内のファイルシステムエントリを一覧表示します。

stitch api workspaces/{workspace}/fileSystemEntries

パラメータ

名前	場所	型	説明
`filter`	`query`	`string`	任意。標準のフィルター文字列。
`pageSize`	`query`	`integer`	任意。返されるエントリの最大数。
`pageToken`	`query`	`string`	任意。ページネーションに使用するページトークン。
`parent` （必須）	`path`	`string`	必須。エントリを一覧表示する親ワークスペース。形式：`workspaces/{workspace}`。

`workspaces.fileSystemEntries.patch`

指定されたパスのファイルシステムエントリを更新します。

stitch api -X PATCH workspaces/{workspace}/fileSystemEntries/{fileSystemEntrie}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	識別子。ファイルシステムエントリのリソース名。形式：workspaces/{workspace}/fileSystemEntries/{file_system_entry} `{file_system_entry}` セグメントは、ユーザーが指定した相対 `path` です。
`updateMask`	`query`	`string`	任意。更新するフィールドのリスト。

`workspaces.files.delete`

ワークスペースからファイルを削除します。

stitch api -X DELETE workspaces/{workspace}/files/{file}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。削除するファイルのリソース名。形式：`workspaces/{workspace}/files/{file}`。

`workspaces.files.get`

ID を指定してファイルを取得します。

stitch api workspaces/{workspace}/files/{file}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。取得するファイルのリソース名。形式：`workspaces/{workspace}/files/{file}`。

`workspaces.files.list`

ワークスペース内のファイルを一覧表示します。

stitch api workspaces/{workspace}/files

パラメータ

名前	場所	型	説明
`filter`	`query`	`string`	任意。返されるファイルを絞り込むための AIP-160 フィルター式。https://google.aip.dev/160 に準拠しています。絞り込み可能なフィールド：- `annotations.`：FileAnnotations テーブルに保存されたアノテーション値に対する完全一致。`=`（EQUALS）比較演算子のみがサポートされています。例：`annotations.env = "prod"` AND を使用した複合式のみがサポートされます：`annotations.env = "prod" AND annotations.team = "ai"` その他のフィールド（`display_name` など）に対するフィルタリングはサポートされておらず、INVALID_ARGUMENT を返します。不正または未サポートのフィルターの場合は INVALID_ARGUMENT を返します。
`orderBy`	`query`	`string`	任意。返されるファイルの並べ替え順。
`pageSize`	`query`	`integer`	任意。返されるファイルの最大数。
`pageToken`	`query`	`string`	任意。以前の `ListFiles` 呼び出しで受け取ったページトークン。
`parent` （必須）	`path`	`string`	必須。ファイルを一覧表示するワークスペース。形式：`workspaces/{workspace}`。

`workspaces.goalTemplates.list`

ワークスペースで利用可能なスターターゴールテンプレートを一覧表示します。

stitch api workspaces/{workspace}/goalTemplates

パラメータ

名前	場所	型	説明
`filter`	`query`	`string`	任意。ゴールテンプレートを絞り込むための AIP-160 フィルター式。https://google.aip.dev/160 に準拠しています。
`pageSize`	`query`	`integer`	任意。返されるゴールテンプレートの最大数。サービスはこの値よりも少ない件数を返す場合があります。未指定の場合、最大 20 件のテンプレートが返されます。最大値は 100 です。100 を超える値は 100 に切り捨てられます。
`pageToken`	`query`	`string`	任意。以前の `ListGoalTemplates` 呼び出しで受け取ったページトークン。これを指定すると、次のページを取得できます。
`parent` （必須）	`path`	`string`	必須。ゴールが作成される親ワークスペース。形式：`workspaces/{workspace}`
`readMask`	`query`	`string`	任意。読み取るフィールドを指定するマスク。

`workspaces.goals.create`

指定されたワークスペースに新しいゴールを作成します。

stitch api -X POST workspaces/{workspace}/goals

パラメータ

名前	場所	型	説明
`parent` （必須）	`path`	`string`	必須。ゴールを作成する親ワークスペース。形式：`workspaces/{workspace}`

`workspaces.goals.delete`

ゴールを削除します。

stitch api -X DELETE workspaces/{workspace}/goals/{goal}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。削除するゴールのリソース名。形式：`workspaces/{workspace}/goals/{goal}`

`workspaces.goals.get`

リソース名を指定して単一のゴールを取得します。

stitch api workspaces/{workspace}/goals/{goal}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。取得するゴールのリソース名。形式：`workspaces/{workspace}/goals/{goal}`
`readMask`	`query`	`string`	任意。読み取るフィールドを指定するマスク。

`workspaces.goals.getInsightGeneration`

最新のインサイト生成実行のステータスと状態を取得します。

stitch api workspaces/{workspace}/goals/{goal}/insightGeneration

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。インサイト生成ステータスのリソース名。形式：`workspaces/{workspace}/goals/{goal}/insightGeneration`。

`workspaces.goals.list`

ワークスペース内のゴールを一覧表示します。

stitch api workspaces/{workspace}/goals

パラメータ

名前	場所	型	説明
`filter`	`query`	`string`	任意。ゴールを絞り込むための AIP-160 フィルター式。
`pageSize`	`query`	`integer`	任意。返されるゴールの最大数。サービスはこの値よりも少ない件数を返す場合があります。未指定の場合、最大 20 件のゴールが返されます。最大値は 100 です。100 を超える値は 100 に切り捨てられます。
`pageToken`	`query`	`string`	任意。以前の `ListGoals` 呼び出しで受け取ったページトークン。これを指定すると、次のページを取得できます。
`parent` （必須）	`path`	`string`	必須。ゴールを一覧表示する親ワークスペース。形式：`workspaces/{workspace}`
`readMask`	`query`	`string`	任意。読み取るフィールドを指定するマスク。

`workspaces.goals.patch`

既存のゴールを更新します。

stitch api -X PATCH workspaces/{workspace}/goals/{goal}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	識別子。ゴールの完全なリソース名。形式：`workspaces/{workspace}/goals/{goal}`
`updateMask`	`query`	`string`	任意。更新するフィールドのリスト。

`workspaces.goals.suggest`

ワークスペースのゴールを提案します。

stitch api -X POST workspaces/{workspace}/goals/suggest

パラメータ

名前	場所	型	説明
`parent` （必須）	`path`	`string`	必須。ゴールを提案する親ワークスペース。形式：`workspaces/{workspace}`

`workspaces.goals.insightGeneration.queryStatusUpdates`

インサイト生成実行中に発行される中間ステータス更新をクエリします。

stitch api workspaces/{workspace}/goals/{goal}/insightGeneration:queryStatusUpdates

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。インサイト生成ステータスのリソース名。形式：`workspaces/{workspace}/goals/{goal}/insightGeneration`。
`pageSize`	`query`	`integer`	任意。返されるステータス更新の最大数。
`pageToken`	`query`	`string`	任意。新しく発行された更新のみを取得するために、以前の呼び出しで受け取ったページトークン。

`workspaces.insights.batchGet`

名前を指定して複数のインサイトを取得します。

stitch api workspaces/{workspace}/insights:batchGet

パラメータ

名前	場所	型	説明
`names`	`query`	`string`	必須。取得するインサイトの名前。1 回のバッチで最大 100 件のインサイトを取得できます。形式：`workspaces/{workspace}/insights/{insight}`
`parent` （必須）	`path`	`string`	必須。インサイトを含む親ワークスペース。形式：`workspaces/{workspace}`

`workspaces.insights.dismiss`

インサイトを非表示にします。

stitch api -X POST workspaces/{workspace}/insights/{insight}:dismiss

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。非表示にするインサイトのリソース名。形式：`workspaces/{workspace}/insights/{insight}`。

`workspaces.insights.generate`

ワークスペース内の一連のゴールに対してインサイトを生成します。

stitch api -X POST workspaces/{workspace}/insights/generate

パラメータ

名前	場所	型	説明
`parent` （必須）	`path`	`string`	必須。インサイト生成をトリガーする親ワークスペース。形式：`workspaces/{workspace}`

`workspaces.insights.get`

名前を指定して単一のインサイトを取得します。

stitch api workspaces/{workspace}/insights/{insight}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。取得するインサイトのリソース名。形式：`workspaces/{workspace}/insights/{insight}`。

`workspaces.insights.getInvestigationReport`

インサイトまたは特定のインサイト更新の調査レポートを取得します。インサイトに対してリクエストした場合（workspaces/{workspace}/insights/{insight}/investigationReport）、最新の調査レポート（最新のインサイト更新に対応するもの）を返します。特定のインサイト更新に対してリクエストした場合（workspaces/{workspace}/insights/{insight}/insightUpdates/{insight_update}/investigationReport）、その更新時点の調査レポートを返します。

stitch api workspaces/{workspace}/insights/{insight}/investigationReport

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。調査レポートのリソース名。形式：- `workspaces/{workspace}/insights/{insight}/investigationReport`：インサイトの最新の調査レポート（最新のインサイト更新に対応するもの）を取得します。`workspaces/{workspace}/insights/{insight}/insightUpdates/{insight_update}/investigationReport`：特定のインサイト更新の調査レポートを取得します。

`workspaces.insights.getSummary`

ワークスペースのステータス別インサイト件数のサマリーを取得します。

stitch api workspaces/{workspace}/insights/summary

パラメータ

名前	場所	型	説明
`filter`	`query`	`string`	任意。インサイトサマリーを絞り込むための AIP-160 フィルター式。
`name` （必須）	`path`	`string`	必須。インサイトサマリーを照会する親ワークスペース。形式：`workspaces/{workspace}`。

`workspaces.insights.list`

ワークスペース内のインサイトを一覧表示します。

stitch api workspaces/{workspace}/insights

パラメータ

名前	場所	型	説明
`filter`	`query`	`string`	任意。インサイトを絞り込むための AIP-160 フィルター式。サポートされるフィールド：「state」、「goal_ids」。
`pageSize`	`query`	`integer`	任意。返されるインサイトの最大数。サービスはこの値よりも少ない件数を返す場合があります。未指定の場合、最大 20 件のインサイトが返されます。最大値は 100 です。100 を超える値は 100 に切り捨てられます。
`pageToken`	`query`	`string`	任意。以前の `ListInsights` 呼び出しで受け取ったページトークン。これを指定すると、次のページを取得できます。
`parent` （必須）	`path`	`string`	必須。インサイトを一覧表示する親ワークスペース。形式：`workspaces/{workspace}`。
`readMask`	`query`	`string`	任意。読み取るフィールドを指定するマスク。ワイルドカード `*` はサポートされていません。

`workspaces.insights.setReadStatus`

インサイトのユーザーごとの既読／未読ステータスを設定します。

stitch api -X POST workspaces/{workspace}/insights/{insight}/setReadStatus

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。インサイトのリソース名。形式：workspaces/{workspace}/insights/{insight}

`workspaces.insights.undismiss`

インサイトの非表示を解除します。

stitch api -X POST workspaces/{workspace}/insights/{insight}:undismiss

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。非表示を解除するインサイトのリソース名。形式：`workspaces/{workspace}/insights/{insight}`。

`workspaces.insights.feedback.create`

インサイトに対するフィードバックを送信します。

stitch api -X POST workspaces/{workspace}/insights/{insight}/feedback

パラメータ

名前	場所	型	説明
`insightFeedbackId`	`query`	`string`	任意。フィードバックに使用する ID。フィードバックのリソース名の最後の構成要素になります。クライアント割り当て ID はサポートされていません。このフィールドは空にする必要があります。
`parent` （必須）	`path`	`string`	必須。親インサイトのリソース名。形式：`workspaces/{workspace}/insights/{insight}`

`workspaces.insights.feedback.delete`

インサイトのフィードバックエントリを削除します。

stitch api -X DELETE workspaces/{workspace}/insights/{insight}/feedback/{feedback}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。削除するフィードバック項目のリソース名。形式：`workspaces/{workspace}/insights/{insight}/feedback/{feedback}` 仮想リソースエイリアス `like`（AIP-122 準拠）をサポートしており、認証済み呼び出し元の `like` を、その ID を事前に取得することなく直接操作できます。

`workspaces.insights.feedback.get`

インサイトの特定のフィードバックエントリを取得します。

stitch api workspaces/{workspace}/insights/{insight}/feedback/{feedback}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。フィードバック項目のリソース名。形式：`workspaces/{workspace}/insights/{insight}/feedback/{feedback}` 仮想リソースエイリアス `like`（AIP-122 準拠）をサポートしており、認証済み呼び出し元の `like` を、その ID を事前に取得することなく直接操作できます。

`workspaces.insights.feedback.list`

インサイトのフィードバックエントリを一覧表示します。

stitch api workspaces/{workspace}/insights/{insight}/feedback

パラメータ

名前	場所	型	説明
`pageSize`	`query`	`integer`	任意。返されるフィードバック項目の最大数。
`pageToken`	`query`	`string`	任意。以前の `ListInsightFeedbacks` 呼び出しで受け取ったページトークン。
`parent` （必須）	`path`	`string`	必須。フィードバックを一覧表示する親インサイト。形式：`workspaces/{workspace}/insights/{insight}`

`workspaces.insights.feedback.patch`

既存のインサイトフィードバックの送信内容を更新します。

stitch api -X PATCH workspaces/{workspace}/insights/{insight}/feedback/{feedback}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	識別子。フィードバック項目の完全なリソース名。形式：`workspaces/{workspace}/insights/{insight}/feedback/{feedback}`
`updateMask`	`query`	`string`	任意。更新するフィールドのリスト。

`workspaces.insights.insightUpdates.getInvestigationReport`

stitch api workspaces/{workspace}/insights/{insight}/insightUpdates/{insightUpdate}/investigationReport

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。調査レポートのリソース名。形式：- `workspaces/{workspace}/insights/{insight}/investigationReport`：インサイトの最新の調査レポート（最新のインサイト更新に対応するもの）を取得します。`workspaces/{workspace}/insights/{insight}/insightUpdates/{insight_update}/investigationReport`：特定のインサイト更新の調査レポートを取得します。

`workspaces.insights.insightUpdates.list`

インサイトの更新を一覧表示します。

stitch api workspaces/{workspace}/insights/{insight}/insightUpdates

パラメータ

名前	場所	型	説明
`filter`	`query`	`string`	任意。インサイト更新を絞り込むための AIP-160 フィルター式。サポートされるフィールド：`substantive`、`source`、`create_time`、`description`。
`orderBy`	`query`	`string`	任意。インサイト更新を並べ替えるフィールド。サポートされる構文は AIP-132 に準拠しています（例：`create_time`、`create_time desc`）。サポートされるフィールド：`create_time`。空の場合、デフォルトは `create_time desc` です。
`pageSize`	`query`	`integer`	任意。返されるインサイト更新の最大数。サービスはこの値よりも少ない件数を返す場合があります。未指定の場合、最大 20 件のインサイト更新が返されます。最大値は 100 です。100 を超える値は 100 に切り捨てられます。
`pageToken`	`query`	`string`	任意。以前の `ListInsightUpdates` 呼び出しで受け取ったページトークン。これを指定すると、次のページを取得できます。
`parent` （必須）	`path`	`string`	必須。更新を一覧表示する親インサイト。形式：`workspaces/{workspace}/insights/{insight}`。
`readMask`	`query`	`string`	任意。読み取るフィールドを指定するマスク。ワイルドカード `*` はサポートされていません。

`workspaces.marketRadarCheckpoint.generate`

マーケットレーダーチェックポイントのバックグラウンド生成をトリガーします。

stitch api -X POST workspaces/{workspace}/marketRadarCheckpoint/generate

パラメータ

名前	場所	型	説明
`parent` （必須）	`path`	`string`	必須。マーケットレーダー生成をトリガーする親ワークスペース。形式：`workspaces/{workspace}`

`workspaces.productMd.generate`

ワークスペースの ProductMd エージェントを起動します。

stitch api -X POST workspaces/{workspace}/productMd:generate

パラメータ

名前	場所	型	説明
`parent` （必須）	`path`	`string`	必須。ProductMd を生成するワークスペースのリソース名。形式：workspaces/{workspace}

`workspaces.productMd.getStatus`

実行中の ProductMd エージェントから中間ステータス更新をポーリングします。

stitch api workspaces/{workspace}/productMd:getStatus

パラメータ

名前	場所	型	説明
`agencySessionId`	`query`	`string`	任意。（非推奨）代わりに execution_id を使用してください。GenerateProductMd から返されるエージェンシーセッション ID。
`continuationToken`	`query`	`string`	任意。以前の GetProductMdStatus レスポンスから取得した継続トークン。
`executionId`	`query`	`string`	任意。GenerateProductMd から返される実行 ID。
`parent` （必須）	`path`	`string`	必須。ワークスペースのリソース名。形式：workspaces/{workspace}

`workspaces.skills.create`

ワークスペースにスキルを作成します。

stitch api -X POST workspaces/{workspace}/skills

パラメータ

名前	場所	型	説明
`parent` （必須）	`path`	`string`	必須。スキルを作成する親ワークスペース。形式：`workspaces/{workspace}`。
`skillId`	`query`	`string`	任意。スキルに使用する ID。スキルのリソース名（`workspaces/{workspace}/skills/{skill_id}`）の最後の構成要素になります。サーバーは ID を生成しないため、ID はここか `skill.name` で指定する必要があります。両方が設定されている場合は一致している必要があり、一致しない場合は INVALID_ARGUMENT が返されます。

`workspaces.skills.delete`

ワークスペース内のスキルを削除します。

stitch api -X DELETE workspaces/{workspace}/skills/{skill}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。削除するスキルの名前。形式：workspaces/{workspace}/skills/{skill}

`workspaces.skills.list`

ワークスペース内のスキルを一覧表示します。

stitch api workspaces/{workspace}/skills

パラメータ

名前	場所	型	説明
`filter`	`query`	`string`	任意。標準のフィルター文字列。
`pageSize`	`query`	`integer`	任意。返されるスキルの最大数。
`pageToken`	`query`	`string`	任意。ページネーションに使用するページトークン。
`parent` （必須）	`path`	`string`	必須。スキルを一覧表示する親ワークスペース。形式：`workspaces/{workspace}`。

`workspaces.skills.patch`

ワークスペース内のスキルを更新します。

stitch api -X PATCH workspaces/{workspace}/skills/{skill}

パラメータ

名前	場所	型	説明
`allowMissing`	`query`	`boolean`	任意。true に設定すると、スキルが見つからない場合に新しいスキルが作成されます。
`name` （必須）	`path`	`string`	識別子。スキルのリソース名。形式：workspaces/{workspace}/skills/{skill}
`updateMask`	`query`	`string`	任意。更新するフィールドのリスト。

`workspaces.toolProviders.delete`

ユーザーのツールプロバイダー設定を削除します。

stitch api -X DELETE workspaces/{workspace}/toolProviders/{toolProvider}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。削除するツールプロバイダーのリソース名。形式：`workspaces/{workspace}/toolProviders/{tool_provider}`

`workspaces.toolProviders.deleteAuth`

ツールプロバイダーのすべての認証情報を削除します。

stitch api -X DELETE workspaces/{workspace}/toolProviders/{toolProvider}:deleteAuth

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。認証情報を削除するツールプロバイダーのリソース名。形式：`workspaces/{workspace}/toolProviders/{tool_provider}`

`workspaces.toolProviders.list`

ワークスペースで利用可能なツールプロバイダーを一覧表示します。

stitch api workspaces/{workspace}/toolProviders

パラメータ

名前	場所	型	説明
`filter`	`query`	`string`	任意。AIP-160 フィルター式。
`orderBy`	`query`	`string`	任意。ツールプロバイダーの並べ替え順。
`pageSize`	`query`	`integer`	任意。返されるツールプロバイダーの最大数。
`pageToken`	`query`	`string`	任意。ページネーションに使用するページトークン。
`parent` （必須）	`path`	`string`	必須。ツールプロバイダーを一覧表示するワークスペース。形式：`workspaces/{workspace}`。

`workspaces.toolProviders.upsert`

ユーザーのツールプロバイダー設定をアップサートします。

stitch api -X POST workspaces/{workspace}/toolProviders:upsert

パラメータ

名前	場所	型	説明
`parent` （必須）	`path`	`string`	必須。ツールプロバイダーをアップサートする親ワークスペース。形式：`workspaces/{workspace}`。

`workspaces.toolProviders.upsertAuth`

ツールプロバイダーの認証ヘッダーセット全体を置き換えます。

stitch api -X POST workspaces/{workspace}/toolProviders/{toolProvider}:upsertAuth

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。認証を更新するツールプロバイダーのリソース名。形式：`workspaces/{workspace}/toolProviders/{tool_provider}`

`workspaces.users.list`

ワークスペース内のユーザーを一覧表示します。

stitch api workspaces/{workspace}/users

パラメータ

名前	場所	型	説明
`filter`	`query`	`string`	任意。ユーザーを絞り込むための CEL フィルター式。
`pageSize`	`query`	`integer`	任意。返されるユーザーの最大数。
`pageToken`	`query`	`string`	任意。以前の `ListUsers` 呼び出しで受け取ったページトークン。
`parent` （必須）	`path`	`string`	必須。ユーザーを一覧表示するワークスペースのリソース名。形式：`workspaces/{workspace}`

`workspaces.webhookConfigs.create`

指定されたワークスペースに新しい Webhook 設定を作成します。

stitch api -X POST workspaces/{workspace}/webhookConfigs

パラメータ

名前	場所	型	説明
`parent` （必須）	`path`	`string`	必須。Webhook 設定を作成する親ワークスペース。形式：`workspaces/{workspace}`

`workspaces.webhookConfigs.delete`

リソース名を指定して Webhook 設定を削除します。

stitch api -X DELETE workspaces/{workspace}/webhookConfigs/{webhookConfig}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。削除する Webhook 設定のリソース名。形式：`workspaces/{workspace}/webhookConfigs/{webhook_config}`

`workspaces.webhookConfigs.get`

リソース名を指定して単一の Webhook 設定を取得します。

stitch api workspaces/{workspace}/webhookConfigs/{webhookConfig}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。取得する Webhook 設定のリソース名。形式：`workspaces/{workspace}/webhookConfigs/{webhook_config}`

`workspaces.webhookConfigs.list`

ワークスペースのすべての Webhook 設定を一覧表示します。

stitch api workspaces/{workspace}/webhookConfigs

パラメータ

名前	場所	型	説明
`pageSize`	`query`	`integer`	任意。1 ページあたりに返される Webhook 設定の最大数。許容される最大値は 100 です。
`pageToken`	`query`	`string`	任意。以前の `ListWebhookConfigs` 呼び出しで受け取ったページトークン。これを指定すると、次のページを取得できます。
`parent` （必須）	`path`	`string`	必須。Webhook 設定を一覧表示する親ワークスペース。形式：`workspaces/{workspace}`

`workspaces.webhookConfigs.patch`

既存の Webhook 設定を更新します。更新マスクで指定されたフィールドのみが変更されます。

stitch api -X PATCH workspaces/{workspace}/webhookConfigs/{webhookConfig}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	識別子。Webhook 設定のリソース名。形式：`workspaces/{workspace}/webhookConfigs/{webhook_config}`
`updateMask`	`query`	`string`	任意。更新するフィールドのリスト。設定されていない場合、変更可能なすべてのフィールドが更新されます。

`workspaces.webhookConfigs.verify`

チャレンジリクエストを送信し、エンドポイントが正しくエコーバックすることを確認して、Webhook エンドポイントを検証します。

stitch api -X PATCH workspaces/{workspace}/webhookConfigs/{webhookConfig}/verify

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。検証する Webhook 設定のリソース名。形式：`workspaces/{workspace}/webhookConfigs/{webhook_config}`

`workspaces.webhookEvents.get`

リソース名を指定して単一の Webhook イベントを取得します。

stitch api workspaces/{workspace}/webhookEvents/{webhookEvent}

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。取得する Webhook イベントのリソース名。形式：`workspaces/{workspace}/webhookEvents/{webhook_event}`

`workspaces.webhookEvents.list`

ワークスペースのすべての Webhook イベントを一覧表示します。

stitch api workspaces/{workspace}/webhookEvents

パラメータ

名前	場所	型	説明
`filter`	`query`	`string`	任意。レスポンスで返される Webhook イベントを絞り込むフィルター式。フィルタリングは「delivery_state」と「event_type」でサポートされています。
`pageSize`	`query`	`integer`	任意。1 ページあたりに返される Webhook イベントの最大数。許容される最大値は 100 です。
`pageToken`	`query`	`string`	任意。以前の `ListWebhookEvents` 呼び出しで受け取ったページトークン。これを指定すると、次のページを取得できます。
`parent` （必須）	`path`	`string`	必須。Webhook イベントを一覧表示する親ワークスペース。形式：`workspaces/{workspace}`

`workspaces.webhookEvents.send`

Webhook イベントのペイロードを設定済みのエンドポイントに配信します。イベントを手動で再配信するために使用できます。

stitch api -X POST workspaces/{workspace}/webhookEvents/{webhookEvent}:send

パラメータ

名前	場所	型	説明
`name` （必須）	`path`	`string`	必須。送信する Webhook イベントのリソース名。形式：`workspaces/{workspace}/webhookEvents/{webhook_event}`