論理リソースを管理する

About the Response and Request Schema

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

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

The Parameters section contains all the available parameters supported by the selected resource, along with a short explanation. Additionally, all the supported parameters can be populated with information so that you can actually try the Orchestrator API as you read the documentation.

Listing Operations

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

Using the Response Model to Build Request Parameters

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つのレベルがあります。