Orchestrator - 論理リソースを管理する

orchestrator

2023.4

false

Orchestrator API ガイド

重要 :

このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。新しいコンテンツの翻訳は、およそ 1 ～ 2 週間で公開されます。

論理リソースを管理する

応答および要求のスキーマを表示するには、対象リソースの横にある [Expand Operations] ボタンを選択します。

図 1. 応答および要求スキーマ

[Response Class] セクションでは、リソースの全体的なモデルのほか、パラメーターを事前設定する手順の説明や要求した情報の表示例などを確認できます。

[パラメーター] セクションには、選択したリソースでサポートされている利用可能なすべてのパラメーターと、簡単な説明が表示されます。さらに、サポートされているすべてのパラメーターに情報を入力できるため、ドキュメントを読みながら実際に Orchestrator API を試すことができます。

特定のリソースで使用可能なすべての操作を表示するには、対象リソースの横にある [List Operations] ボタンを選択します。

図 2. 使用可能な操作

The response model of any resource is there to help you understand its structure and how to use it in future requests. It has the following anatomy:

メインエンティティまたは Dto (データ転送オブジェクト)、およびそのプロパティ。各プロパティについて、次の情報が表示されます。
- the accepted value type, written in parenthesis;
- required or optional - optional parameters are marked as such;
- an explanation regarding the parameter and the maximum accepted values.
The second level entity - only displayed if the main entity contains a resource as a parameter; Please note that there can be multiple second level entities, depending on the main resource.

リソースレベルの合計数は、メインエンティティによって異なります。たとえば、RobotDto には3つのレベル、EnvironmentsDto には2つのレベルがあります。

図 3. リソースレベル

[全般] タブの [API の設定] セクションで利用可能な [ストリクト API] テナント設定を使用すると、API 要求による潜在的な負荷を軽減できます。有効化すると、以下のフィールドがフィルター処理不可/並べ替え不可になります。

エンティティ	フィールド	Non-filterable	Non-sortable
キューアイテム	`OutputData`	はい	はい
	`AnalyticsData`	はい	はい
	`ReviewerUserId`	N/A	はい
	`Key`	はい	はい
	`Reference`	N/A	はい
	`DueDate`	はい	はい
	`RiskSlaDate`	はい	はい
	`DeferDate`	はい	はい
	`StartProcessing`	はい	N/A
	`EndProcessing`	はい	N/A
	`SecondsInPreviousAttempts`	はい	はい
	`AncestorId`	はい	はい
	`RetryNumber`	はい	はい
	`SpecificData`	はい	はい
	`CreationTime`	はい	はい
	`Progress`	はい	はい
	`RowVersion`	はい	はい
	`OrganizationUnitId`	はい	はい
	`OrganizationUnitFullyQualifiedName`	はい	はい

上記のリストは今後、観察された使用パターンに基づいて拡張される予定です。

前へSwagger での API 呼び出しを認可する

次へアラートの要求