UIP son recursos

Sintaxis y opciones para `uip es recursos`, que enumera, describe y ejecuta operaciones en objetos del plano de datos del conector.

uip is resources con los objetos de runtime que direcciona un conector: tickets, contactos, registros, archivos. list enumera los objetos del conector, describe devuelve el esquema de campo y las operaciones para un objeto, y run llama al plano de datos del conector (Crear/Enumerar/Obtener/Actualizar/Reemplazar/Eliminar) contra una conexión. Cada verbo run requiere --connection-id; las lecturas de metadatos en caché (list, describe) lo aceptan opcionalmente para mostrar objetos/campos personalizados.

Importante:

El grupo de verbos del plano de datos es uip is resources run, no execute — uip is resources execute ... no existe y falla con "comando desconocido".

Sinopsis

uip is resources <verb> [options]

Verbos

Verbo	Propósito
list	Enumerar objetos disponibles en un conector; filtrar opcionalmente por operación.
describe	Describir las operaciones y el esquema de campo de un objeto.
run	Llama al plano de datos del conector (Crear/Enumerar/Obtener/Actualizar/Reemplazar/Eliminar).

uip es una lista de recursos

Enumera los objetos disponibles en un conector. Los resultados dependen de si se proporciona --connection-id : los listados de ámbito de conexión incluyen objetos personalizados; los listados sin ámbito no (la CLI muestra un Warning en ese caso).

Argumentos

Nombre	Obligatorio	Propósito
<connector-key>	Sí	Clave del conector, por ejemplo uipath-zoho-desk.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--operation	ENUM	—	Filtrar por operación: List, Retrieve, Create, Update, Delete, Replace.
—	--connection-id	id	—	Ámbito a una conexión específica (habilita objetos personalizados).
—	--refresh	Marca	Desactivado	Fuerza la nueva recuperación desde la API, ignorando la caché.

Ejemplos

uip is resources list uipath-zoho-desk

# Only objects that support a Create operation
uip is resources list uipath-zoho-desk --operation Create

# Connection-scoped listing — includes custom objects
uip is resources list uipath-zoho-desk \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

Forma de datos (--json de salida)

{
  "Code": "ResourceList",
  "Data": [
    {
      "Name": "tickets",
      "DisplayName": "Tickets",
      "Path": "/tickets",
      "Type": "standard",
      "SubType": "standard",
      "Custom": "no",
      "ElementKey": "uipath-zoho-desk"
    }
  ]
}

UIP es descripción de recursos

Describir los campos y operaciones de un objeto. --operation, devuelve la lista de operaciones disponibles y una sugerencia. Con --operation, se limita a una operación y devuelve sus parámetros, campos de solicitud y campos de respuesta.

Argumentos

Nombre	Obligatorio	Propósito
<connector-key>	Sí	Clave del conector.
<object-name>	Sí	Nombre del objeto: el objectName del JSON de configuración de la actividad (por ejemplo, tickets). Buscar nombres con resources list. Se dirige al objeto de la misma manera en ambos valores --activity-version (ver más abajo).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--connection-id	id	—	Ámbito a una conexión (habilita campos personalizados; necesarios junto con --field).
—	--operation	ENUM	—	List, Retrieve, Create, Update, Delete o Replace. Necesario junto con --field.
—	--activity-version	1.0.0 | 4.0.0	1.0.0	Qué puntos finales de metadatos de actividad consultar: consulta Versiones de metadatos de actividad a continuación.
-f	--field	name=value	—	Valor del campo principal. Repetible. Ejecuta el tipo de API del conector ObjectAction (por ejemplo GenerateSchema de Jira, GenerateQuerySchema de Salesforce) y fusiona su respuesta de campo personalizado en requestFields. Requiere tanto --connection-id como --operation. No compatible con --activity-version 4.0.0.
—	--action	name	inferido	Nombre explícito de tipo API ObjectAction (por ejemplo, GenerateSchema). Opcional — inferido de los nombres --field cuando se omite; páselo para eliminar la ambigüedad cuando pueda coincidir más de una acción.
—	--refresh	Marca	Desactivado	Fuerza la nueva recuperación desde la API, ignorando la caché. La caché también se omite automáticamente cada vez que se proporciona --field, ya que una respuesta de acción de diseño varía según la combinación de campo principal.

Versiones de metadatos de actividad

--activity-version cambia qué punto final de metadatos de Integration Service describe consulta:

• 1.0.0 predeterminado): puntos finales de elementos v3, ámbito de conexión. Admite búsquedas de acción de diseño -f/--field.
• 4.0.0 — puntos finales de elementos v4, no de ámbito de conexión. Se acepta pasar --connection-id junto con él, pero se ignora (con una advertencia) ya que la v4 no lo necesita para la obtención en sí. -f/--field se rechaza directamente con --activity-version 4.0.0: los ObjectActionde tiempo de diseño son una característica solo de v3 y de ámbito de instancia.

En ambos casos, el posicional <object-name> significa lo mismo: el nombre del objeto, por lo que no hay diferencia de direccionamiento entre las dos versiones, solo qué punto final del backend responde a la llamada.

Ejemplos

# List operations available on this object (v3, default)
uip is resources describe uipath-zoho-desk tickets

# Field schema for the Create operation
uip is resources describe uipath-zoho-desk tickets --operation Create

# Required request fields, scripting-friendly
uip is resources describe uipath-zoho-desk tickets --operation Create \
    --output-filter 'Data.requestFields[?required].name'

# Describe a 4.0.0 activity by object name (v4 elements endpoints)
uip is resources describe uipath-salesforce-slack add_users_to_usergroup \
    --activity-version 4.0.0

# Parent-field values (Jira: project + issue type → custom fields for that combination)
uip is resources describe uipath-atlassian-jira curated_create_issue \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --operation Create \
    -f fields.project.key=ENGCE -f fields.issuetype.id=3

# Body-token parent field (Salesforce SOQL: query → response columns)
uip is resources describe uipath-salesforce-sfdc query_records \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --operation Create \
    -f query="SELECT Id, Name FROM Account WHERE Status = 'Active'"

Nota:

Si una llamada -f/--field vuelve con solo los campos que has proporcionado (ninguno de los campos personalizados propios de la conexión), la respuesta también incluye un Warning: uno de los valores que has pasado probablemente no exista en esa conexión. Compruébalo con la búsqueda de ese campo.

Forma de datos (--json de salida)

Sin --operation:

{
  "Code": "ResourceMetadata",
  "Data": {
    "name": "tickets",
    "displayName": "Tickets",
    "elementKey": "uipath-zoho-desk",
    "availableOperations": [
      { "method": "GET", "name": "List", "description": "Search for Tickets", "path": "/tickets" },
      { "method": "POST", "name": "Create", "description": "Create a Tickets", "path": "/tickets" }
    ],
    "hint": "Use --operation <Create|List|Retrieve|Update|Delete|Replace> to see fields for a specific operation."
  }
}

Con --operation Create, se devuelve el mismo Code: "ResourceMetadata" , pero en lugar de availableOperations la carga útil lleva operation, parameters, requestFields y responseFields.

Con -f/--field (búsqueda de campo principal/acción de diseño), requestFields refleja el esquema fusionado específico de la conexión:

{
  "Code": "ResourceMetadata",
  "Data": {
    "name": "curated_create_issue",
    "operation": { "method": "POST", "name": "Create" },
    "requestFields": [
      { "name": "fields.project.key", "required": true, "displayName": "Project" },
      { "name": "fields.issuetype.id", "required": true, "displayName": "Issue type" },
      { "name": "fields.summary", "required": true, "displayName": "Summary" },
      { "name": "fields.description", "required": false, "displayName": "Description" }
    ]
  }
}

uip es recursos ejecutados

Llama al plano de datos del conector. run en sí mismo es un grupo; los verbos reales son create, list, get, update, replace y delete. Cada verbo requiere --connection-id; create, update y replace requieren además --body con un cuerpo de solicitud JSON. delete es destructivo y requiere -y, --yes : la CLI nunca solicita.

uip is resources run create   <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources run list     <connector-key> <object-name> --connection-id <id>
uip is resources run get      <connector-key> <object-name> --connection-id <id> [--query <params>]
uip is resources run update   <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources run replace  <connector-key> <object-name> --connection-id <id> --body <json>
uip is resources run delete   <connector-key> <object-name> --connection-id <id> -y, --yes [--query <params>]

Asignación de métodos HTTP: create → POST, list → GET (colección), get → GET-by-id, update → PATCH, replace → PUT, delete → DELETE.

Argumentos

Nombre	Obligatorio	Propósito
<connector-key>	Sí	Clave del conector.
<object-name>	Sí	Nombre del objeto (por ejemplo, tickets).

Opciones compartidas

Corto	Largo	Valor	Predeterminado	Descripción
—	--connection-id	id	obligatorio	Conexión utilizada para autorizar la llamada del plano de datos.
—	--query	Parámetros	—	Parámetros de consulta. Acepta key=value&key=value o un objeto JSON.
—	--body	JSON	—	Cuerpo de la solicitud. Obligatorio para create, update, replace.
-y	--yes	Marca	—	Obligatorio solo en delete . Confirma esta operación irreversible: la CLI nunca solicita.

Ejemplos

# Create a ticket
uip is resources run create uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"subject":"New issue","departmentId":"DEP-1"}'

# List tickets — first page
uip is resources run list uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001

# Delete a ticket by ID — destructive, requires --yes
uip is resources run delete uipath-zoho-desk tickets \
    --connection-id a1b2c3d4-0000-0000-0000-000000000001 \
    --query 'id=TK-1001' \
    --yes

Forma de datos (--json de salida)

{
  "Code": "ExecuteOperation",
  "Data": { "id": "TK-1001", "subject": "New issue", "status": "Open" }
}

Las operaciones list devuelven { "items": [...] } y, cuando el backend señala más páginas a través de encabezados Elements-Has-More / Elements-Next-Page-Token , incluye un objeto Pagination con HasMore y NextPageToken.

Las llamadas fallidas emergen con Failure, el estado HTTP como Message y el cuerpo del servidor como Instructions.

Relacionado

• uip is connections — Los valores --connection-id provienen de connections list / connections create.
• uip is connectors : descubre primero la clave del conector.
• uip is activities : consulta las operaciones con nombre que expone un conector.
• uip is triggers : contrapartes impulsadas por eventos de los verbos del plano de datos aquí.

Ver también

• Descripción general de la herramienta de Integration Service
• Opciones globales
• Códigos de salida