Estructura de URL de punto final de la API

Estructura de URL para construir solicitudes de API de Test Cloud, incluidas las URL base para Test Cloud, Test Cloud Sector Público y Test Cloud Dedicado.

En esta sección, puede aprender a construir solicitudes de API entendiendo la estructura de URL de los puntos finales de UiPath®.

URL base

La URL base es el punto de partida para todas las solicitudes de API. Sirve como base para construir la URL del punto final. Dependiendo de la plataforma en la nube que estés utilizando, utiliza la URL base correspondiente:

• Test Cloud: https://cloud.uipath.com
• Sector público de Test Cloud: https://govcloud.uipath.us
• Test Cloud dedicado: https://<customURL>.dedicated.uipath.com

Punto de entrada

api: significa el punto de entrada a los recursos de gestión de la plataforma API, por ejemplo /api/Group/.

RutaDeRecurso

La ruta del recurso especifica el recurso o la operación exacta que deseas realizar. Puede incluir palabras clave como Grupo, Cuenta de UiPath Robot, Configuración, dependiendo del propósito de la solicitud.

Parámetros de ruta

Los parámetros de ruta se utilizan para pasar los valores dinámicos a un punto final de la API. Estos valores ayudan a identificar recursos específicos que son relevantes para la solicitud de la API. Por ejemplo, /Group/{partitionGlobalId}/{groupId}

partitionGlobalId: el ID de la organización.

groupId: el ID del grupo.

Parámetros de consulta

Los parámetros de consulta son parámetros adicionales adjuntos a la URL para proporcionar más contexto o filtros para los datos solicitados. Suelen ir precedidos de un símbolo ? y separados por símbolos & . Por ejemplo, puedes utilizar parámetros de consulta para especificar criterios de filtrado o instrucciones de paginación.

Ejemplo

Putting all components together, a URL for an organization-specific resource might look like this, https://cloud.uipath.com/{organizationName}/identity_/api/group/{partitionGlobalId}/{groupId}.

A URL for a tenant-specific resource can look like this: https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Assets.