Gestionar recursos lógicos

Cómo navegar y utilizar la interfaz de Swagger para gestionar recursos lógicos a través de la API de Orchestrator

Acerca del esquema de respuesta y solicitud

Para ver el esquema de respuesta y solicitud, haz clic en el botón Expandir operaciones junto al recurso que te interesa.

En la sección Respuesta, puedes ver el modelo completo del recurso junto con explicaciones sobre cómo rellenar los parámetros, o un ejemplo de cómo puede ser la información que has solicitado.

La sección Parámetros contiene todos los parámetros disponibles que admite el recurso seleccionado, junto con una breve explicación. Además, todos los parámetros compatibles se pueden rellenar con información para que puedas probar la API de Orchestrator mientras lees la documentación.

Operaciones de listado

Para ver todas las operaciones disponibles para un recurso específico, haz clic en el botón Enumerar operaciones junto al recurso de interés.

Utilizar el modelo de respuesta para crear parámetros de solicitud

El modelo de respuesta de cualquier recurso está ahí para ayudarte a comprender su estructura y cómo utilizarlo en futuras solicitudes. Tiene la siguiente anatomía:

• La entidad principal o Dto (objeto de transferencia de datos) y sus propiedades. Para cada propiedad, se muestra la siguiente información:
  • el tipo de valor aceptado, escrito entre paréntesis;
  • obligatorio u opcional: los parámetros opcionales están marcados como tales;
  • una explicación sobre el parámetro y los valores máximos aceptados.
• La entidad de segundo nivel: solo se muestra si la entidad principal contiene un recurso como parámetro; Ten en cuenta que puede haber varias entidades de segundo nivel, dependiendo del recurso principal.

El número total de niveles de recursos depende de la entidad principal. Por ejemplo, RobotDto tiene tres niveles, mientras que EnvironmentDto tiene dos.

API estricta

Puedes aliviar la carga potencial que generan las solicitudes de la API utilizando la configuración de tenant de la API estricta, disponible en la sección Configuración de la API de la pestaña General. Cuando se habilita, los siguientes campos se convierten en no filtrables y/o no clasificables:

Entidad	Campo	Non-filterable	Non-sortable
Artículos en cola	OutputData	Sí	Sí
	AnalyticsData	Sí	Sí
	ReviewerUserId	N/D	Sí
	Key	Sí	Sí
	Reference	N/D	Sí
	DueDate	Sí	Sí
	RiskSlaDate	Sí	Sí
	DeferDate	Sí	Sí
	StartProcessing	Sí	N/D
	EndProcessing	Sí	N/D
	SecondsInPreviousAttempts	Sí	Sí
	AncestorId	Sí	Sí
	RetryNumber	Sí	Sí
	SpecificData	Sí	Sí
	CreationTime	Sí	Sí
	Progress	Sí	Sí
	RowVersion	Sí	Sí
	OrganizationUnitId	Sí	Sí
	OrganizationUnitFullyQualifiedName	Sí	Sí

La lista anterior se ampliará en el futuro, en función de los patrones de uso que observamos.