Skip to main content
GET
自動化イベントのスキーマを取得

権限

組織レベルの ViewOrgAutomations 権限を持つサービスユーザーまたはパーソナルアクセストークンが必要です。

使用方法

自動化を構築する前に、このエンドポイントを呼び出してください。サポートされているすべてのトリガーイベントタイプ (ソース、イベント名の順にキー付け) と、そのペイロードフィールド、条件で使用できる演算子、有効な replies 動詞が返されます。これにより、作成および更新エンドポイント用の有効な triggers を構築できます。組織で有効になっていないソースは除外されます。

承認

Authorization
string
header
必須

サービスユーザーの認証情報(接頭辞: cog_)

パスパラメータ

org_id
string
必須

組織 ID(プレフィックス: org-)

例:

"org-abc123def456"

クエリパラメータ

security_profile_id
string | null

security_profile.profile_id にこのプロファイルを指定する作成操作で使用する、default_net_policy と security_profile の値を解決します。セキュリティプロファイルの管理権限が必要です。

レスポンス

成功レスポンス

default_net_policy
AutomationNetPolicy · object | null
必須

クライアントが新しい自動化の初期設定に利用すべきネットワークポリシー:デプロイの Git Manager のみを許可するポリシー(タスクに必要な接続先のみを追加)。ただし、適用されるセキュリティプロファイル(security_profile を参照)にネットワークポリシーがある場合は null。この場合、セッションはプロファイルのポリシーを利用します。タスクでさらに制限する必要がない限り、session_settings.net_policy は省略してください。

sources
Sources · object
必須

イベントソース → イベント名 → スキーマ。

update_semantics
string
必須

この組織で有効な PATCH セマンティクス: 'replace_groups'(リクエストに含まれる設定グループが、保存済みのグループ全体を置き換える)または 'merge_patch'(オブジェクトには RFC 7396 を適用: 存在するグループ内で省略されたメンバーは保存済みの値を保持し、明示的な null はクリアされる。リストのメンバーシップは引き続き全体が置き換えられる。削除するには、その要素を除いたリストを再送信する。ただし、両方に同じ種類がそれぞれ 1 つだけ存在する場合、送信した各要素は同じ種類の保存済み要素にマージされる。種類が重複する場合は、完全に再指定する必要がある)。オープン列挙型 — クライアントは新しい値を許容する必要があります。

security_profile
AutomationSchemasSecurityProfile · object | null

この組織の自動化セッションに適用されるセキュリティプロファイル。適用されるものがない場合は null。