API トリガー

API トリガーを使用すると、ユーザーが作成したカスタム要求 URL を通じて HTTP 経由でジョブを効率的に開始できます。API トリガーは、既存のプロセスをラップするレイヤーとして機能し、既にトリガーで利用可能なオプションを利用します。

API トリガーを作成すると、外部アプリケーションで簡単にジョブを開始したり、その出力を利用したりできます。

認証

API トリガーの起動と呼び出しは、個人用アクセス トークンを使用して認可されます。

必要な作業は、必要なリソースにアクセスするために使用できるトークンを生成し、トークンを要求で使用することだけです。たとえば、プロセスで Orchestrator ジョブに対する読み取りおよび書き込みアクセス権が必要な場合は、OR.Jobs リソースを選択します。

トークンを生成してコピーしたら、ベアラー トークン フィールドに貼り付けてジョブ要求を認可できます。

権限

API トリガーで操作を実行するために必要な権限は以下のとおりです。

• フォルダー レベルでのトリガー権限 (これにより、API トリガーで実行できるアクションを指定します):

  • 表示 - テナント内の API トリガーを表示できます。

  • 編集 - API トリガーを変更できます。

  • 作成 - API トリガーを作成できます。

  • 削除 - API トリガーを削除できます。

• フォルダー レベルでのジョブ権限 (ジョブ トリガーを呼び出し、結果が利用可能になるまでジョブの実行を追跡するために必要です):

  • 作成 - API トリガーに基づいて API 呼び出しを開始できます。

  • 表示 - API 要求のステータスを表示できます。