論理リソースを管理する

応答および要求スキーマについて

応答および要求のスキーマを表示するには、対象リソースの横にある [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. リソース レベル