Managing Logical Resources

About the Response and Request Schema

To view the response and request schema click the Expand Operations button next to the resource you are interested in.

In the Response Class section, you can view the entire model of the resource along with explanations about how to populate parameters, or an example of how the information you have requested can look like.

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

To view all the operations available for a specific resource, click the List Operations button next to the resource of interest.

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:

• The main entity or Dto (data transfer object) and its properties. For each property, the following information is displayed:

  • 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.

The total number of resource levels depends on the main entity. For example, RobotDto has three levels, while EnvironmentsDto has two.

Strict API

You can alleviate the potential load placed by API requests using the Strict API tenant setting, available in the API Settings section of the General tab. When enabled, the following fields become non-filterable and/or non-sortable:

Entity	Field	Non-filterable	Non-sortable
Queue items	OutputData	Yes	Yes
	AnalyticsData	Yes	Yes
	ReviewerUserId	N/A	Yes
	Key	Yes	Yes
	Reference	N/A	Yes
	DueDate	Yes	Yes
	RiskSlaDate	Yes	Yes
	DeferDate	Yes	Yes
	StartProcessing	Yes	N/A
	EndProcessing	Yes	N/A
	SecondsInPreviousAttempts	Yes	Yes
	AncestorId	Yes	Yes
	RetryNumber	Yes	Yes
	SpecificData	Yes	Yes
	CreationTime	Yes	Yes
	Progress	Yes	Yes
	RowVersion	Yes	Yes
	OrganizationUnitId	Yes	Yes
	OrganizationUnitFullyQualifiedName	Yes	Yes

The list above will be extended in the future, based on the usage patterns we observe.