Crear solicitudes de API

All Orchestrator API calls are made using HTTP methods to the Orchestrator URL. The Orchestrator URL has the following syntax: https://{yourDomain} . It is recommended to encrypt the data you send via API calls, by using the HTTPS protocol.

Importante:

Para acceder a los recursos de una carpeta, cada solicitud debe contener FolderId, FolderPatho FolderKey en un encabezado HTTP. Este encabezado puede estar codificado (usando la codificación Base64 UTF-16LE) o como texto sin formato.

Por ejemplo:

• X-UIPATH-OrganizationUnitId "FolderId":
• X-UIPATH-FolderPath-Encoded "{Encoded FolderPath value}":
• X-UIPATH-FolderPath "PlainText FolderPath value"o
• X-UIPATH-FolderKey "FolderKey".

El FolderId puede obtenerse realizando una solicitud GET al punto final /odata/Folders y copiando el valor "Id", o desde la URL de Orchestrator - https://your-domain-server.com/? fid=2032 &tid=8. FolderId es de tipo Int 64.

El FolderKey se puede obtener realizando una solicitud GET al punto final /odata/Folders y copiando el valor de la "Clave". FolderKey es de tipo ID / cadena únicos.

Si cambia el plan de licencias para su cuenta de Orchestrator (por ejemplo, de Enterprise Trial a Enterprise), el valor de FolderId también cambia, mientras que el valor FolderKey permanece igual.

En un encabezado X-UIPATH-FolderPath-Encoded se admiten rutas de carpeta relativas, de la siguiente manera:

• /rootRuta a partir de : se inicia desde la carpeta de arbol de la que forma parte la carpeta de entorno.
• .La ruta con : se inicia desde la carpeta de entorno.
• La ruta a partir de .. : inicia en un nivel superior de la jerarquía de la carpeta de entorno para cada .. en la ruta (p. ej. ../para un nivel superior, ../../ para dos niveles superiores en la jerarquía).

Ten en cuenta que no se admiten las barras diagonales finales.

Importante: Cuando se utiliza la API de Orchestrator junto con MSXML, la respuesta "204 "Sin contenido puede generar un código de estado 1223 y provocar errores.

OBTENER Solicitudes

Las solicitudes GET suelen ser las más simples de realizar. Le ayudan a recuperar datos y a usar cláusulas OData genéricas:

• $ top
• $filter
• $ expandir
• $ seleccionar
• $ pedido por
• $skip

$ top

Esta cláusula le ayuda a limitar la cantidad de datos que recupera. Tiene un límite superior que está determinado por el punto final al que está realizando llamadas y el número de recursos de este tipo que existen en sus instancias de Orchestrator.

For example, this request https://{yourDomain}/odata/Environments?$top=10 returns the first 10 environments available in the Community Edition of Orchestrator. However, if only 5 environments exist, only those are retrieved.

$filter

Esta cláusula OData se utiliza para filtrar un recurso específico según sus propiedades.

Por ejemplo, se puede filtrar según:

• propiedades numéricas:

  • https://{yourDomain}/odata/Environments?$filter=Id%20eq%2015 - requests a specific environment based on its Id

• propiedades del texto:

  • https://{yourDomain}/odata/Environments?$filter=contains(Name,'N')&$top=10 - returns the first 10 environments whose name contains the letter "N"

• propiedades Boolean:

  • https://{yourDomain}/odata/Processes?$filter=Title%20eq%20'test'%20%26%20IsLatestVersion%20eq%20true - returns all processes that contain the word "test" and represent the latest version

• propiedades enumerables:

  • https://{yourDomain}/odata/QueueItems?$filter=Priority%20eq%20'High' - returns all queue items that have a High priority

• la propiedad de una propiedad:

  • https://{yourDomain}/odata/Jobs?$top=10$filter=Robot/MachineName%20eq%20'Documentation' - returns the first 10 jobs that were executed by any Robot that exists on the "Documentation" machine

Los parámetros de filtro se pueden combinar usando los operadores lógicos "y", "o" y / o "no" y se pueden agrupar con paréntesis "()", como la siguiente solicitud:

• https://{yourDomain}/odata/Jobs?$top=10&$filter=Robot/MachineName eq 'LAVINIA-PC' and (not(Source eq 'Manual') or StartTime gt 2017-10-28T12:13:00.07Z) - displays the top 10 jobs that are being executred manually or after "2017-10-28T12:13:00.07Z", by a Robot deployed on the "LAVINIA-PC" machine.

$ expandir

Esta cláusula se utiliza para cargar completamente las propiedades de navegación del recurso solicitado.

$ seleccionar

Esta cláusula OData te permite especificar un subconjunto de propiedades del recurso que deseas que se devuelvan. Si quieres extraer varios recursos, puedes separarlos con una coma.

$ pedido por

La cláusula $orderby te permite ordenar los recursos recuperados. Al igual que con la cláusula $select , los recursos que deseas ordenar están separados por comas y se pueden ordenar en orden ascendente (asc) o descendente (desc). Si no se especifica ninguno de estos operadores, los recursos se ordenan automáticamente de manera ascendente.

$skip

Esta cláusula le permite omitir los primeros n elementos, en un filtro indicado.

Solicitudes POST

El verbo POST HTTP le ayuda a crear nuevos elementos subordinados a otros recursos. Al crear un nuevo recurso, PUBLICAR en el elemento principal y Orchestrator se encargará de asociar el nuevo recurso con el elemento principal, asignar una ID y otra información necesaria. Los datos se agregan a través del cuerpo de la solicitud y la respuesta es el objeto creado completo.

Puede agregar nuevos elementos a una cola, crear nuevos activos, entornos o procesos, asignar un revisor a una o varias transacciones fallidas y la lista continúa.

Nota: los caracteres especiales no se pueden omitir en el cuerpo de las solicitudes POST. Para usar caracteres especiales debes declarar primero el parámetro en el que los usas como cadena, utilizando el siguiente formato "[e-mail]": "#String". Para entender mejor, consulte cómo se rellenó el parámetro Specific Content en el siguiente ejemplo.

Solicitudes PUT

PUT suele ser necesario cuando se quiere actualizar el contenido de un recurso. En general, las solicitudes se realizan a una entidad específica añadiendo su Id en la URL. Ten en cuenta que una llamada PUT reemplaza la entidad existente con el contenido de la solicitud o, si no existe en la ubicación designada, intenta crearla.

Es posible actualizar colas, entornos, unidades de organización, comentarios sobre transacciones, procesos y detalles de otros recursos.

Solicitudes PATCH

PATCH se utiliza para actualizar los contenidos de una entidad existente, con la entidad deseada especificada añadiendo su Id en la URL. El cuerpo de la solicitud contiene solo los contenidos que quieres cambiar. Esto se distingue de una llamada PUT que reemplaza la entidad actual con el contenido de la solicitud posterior.

Es posible utilizar una solicitud de PATCH para actualizar Máquinas, Procesos, Robots, Tenants, Usuarios (excepto la Unidad de Organización y los Roles) y las entidades de Webhooks.

Solicitudes ELIMINAR

El uso de este verbo HTTP te permite marcar un elemento especificado como eliminado en la base de datos. El recurso generalmente se indica con la ayuda de su ID en la URL a la que realiza la llamada. Una respuesta 209 debe informarle que su solicitud se ha realizado correctamente.

Es posible eliminar activos, entornos, comentarios de elementos de la cola, procesos, roles, tenants, usuarios y muchos otros.