Managing logical resources

About the response and request schema

Para visualizar o esquema de resposta e solicitação, clique no botão Expandir operações ao lado do recurso de seu interesse.

Na seção Classe de resposta , você pode visualizar todo o modelo do recurso junto com explicações sobre como preencher os parâmetros ou um exemplo de como as informações que você solicitou podem parecer.

A seção Parâmetros contém todos os parâmetros disponíveis suportados pelo recurso selecionado, juntamente com uma breve explicação. Além disso, todos os parâmetros com suporte podem ser preenchidos com informações para que você possa realmente experimentar a API do Orchestrator enquanto lê a documentação.

Listing operations

Para visualizar todas as operações disponíveis para um recurso específico, clique no botão Listar operações ao lado do recurso de interesse.

Using the response model to build request parameters

O modelo de resposta de qualquer recurso existe para ajudá-lo a entender sua estrutura e como usá-lo em solicitações futuras. Possui a seguinte anatomia:

• A entidade principal ou Dto (objeto de transferência de dados) e suas propriedades. Para cada propriedade, as seguintes informações são exibidas:

  • o tipo de valor aceito, escrito entre parênteses;
  • obrigatório ou opcional - os parâmetros opcionais são marcados como tal;
  • uma explicação sobre o parâmetro e os valores máximos aceitos.
• A entidade de segundo nível - exibida apenas se a entidade principal contiver um recurso como parâmetro; Observe que pode haver várias entidades de segundo nível, dependendo do recurso principal.

O número total de níveis de recursos depende da entidade principal. Por exemplo, RobotDto tem três níveis, enquanto EnvironmentsDto tem dois.

API estrita

Você pode aliviar a carga potencial colocada por solicitações de API usando a configuração do tenant Strict API, disponível na seção Configurações da API da guia Geral. Quando habilitado, os seguintes campos tornam-se não filtráveis e/ou não classificáveis:

Entidade	Campo	Non-filterable	Non-sortable
Itens de Fila	OutputData	Sim	Sim
	AnalyticsData	Sim	Sim
	ReviewerUserId	N/A	Sim
	Key	Sim	Sim
	Reference	N/A	Sim
	DueDate	Sim	Sim
	RiskSlaDate	Sim	Sim
	DeferDate	Sim	Sim
	StartProcessing	Sim	N/A
	EndProcessing	Sim	N/A
	SecondsInPreviousAttempts	Sim	Sim
	AncestorId	Sim	Sim
	RetryNumber	Sim	Sim
	SpecificData	Sim	Sim
	CreationTime	Sim	Sim
	Progress	Sim	Sim
	RowVersion	Sim	Sim
	OrganizationUnitId	Sim	Sim
	OrganizationUnitFullyQualifiedName	Sim	Sim

A lista acima será ampliada no futuro, com base nos padrões de uso que observarmos.