- Información general
- Comience ya
- Conceptos
- Uso de UiPath CLI
- Guías prácticas
- Recetas de CI/CD
- Referencia de los comandos
- Información general
- Códigos de salida
- Opciones globales
- agente de código UIP
- uip coder
- uip context-grounding
- UIP Docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip model-hub
- añadir-entidad-de-datos-de-prueba
- añadir-cola-de-datos-de-prueba
- añadir-variación-de-datos-de-prueba
- Analizar
- Crear
- Crear proyecto
- Diferencia
- Buscar actividades
- obtener-reglas-del-analizador
- obtener-predeterminado-actividad-xaml
- obtener-errores
- obtener-casos-de-prueba-manual
- obtener-pasos-de-prueba-manual
- get-library-object-repository
- get-object-repository
- obtener versiones
- get-workflow-example
- indicar-aplicación
- indicar-elemento
- inspeccionar-paquete
- install-data-fabric-entities
- instalar-o-actualizar-paquetes
- enumerar-data-fabric-entities
- list-instances
- ejemplos-de-flujo-de-trabajo-de-lista
- Paquete
- Publicar
- remote
- restore
- run, debug & execution
- archivo de ejecución
- plantillas-de-búsqueda
- iniciar-studio
- detener la ejecución
- tm
- UIA
- uip tasks
- Seguimientos de UIP
- uip traces feedback
- Migración
- Referencia y soporte
Syntax and options for authoring a connector's activities — resources, fields, methods, and parameters — with the Integration Service connector builder.
uip is connectors builder activity authors a connector's activities: the API endpoints (called resources in the standard-resource file) that become Studio activities, along with their fields, methods, and parameters. This is the largest and most detailed domain in the connector builder — see Connectors builder for the shared concepts (connector-directory resolution, design vs. published, the typical authoring flow) that apply here too.
Hooks — JavaScript pre/post-request transforms attached to a resource or global — are a nested activity hook sub-group, documented separately on Activity hooks because of their own size and the amount of runtime-context detail they need.
activity create is not for lifecycle endpoints like auth-validation or onProvision — those are system resources created with builder auth system create (see Auth). activity is for the connector's regular, user-facing operations.
Sinopsis
uip is connectors builder activity list [--method <method>] [--path <path>] [--connector-dir <path>]
uip is connectors builder activity get [<name>] [--name <name>] [--connector-dir <path>]
uip is connectors builder activity create --name <name> [options...] [--connector-dir <path>]
uip is connectors builder activity delete <name> [--connector-dir <path>]
uip is connectors builder activity field schema
uip is connectors builder activity field list --resource <name> [--connector-dir <path>]
uip is connectors builder activity field get [<name>] --resource <name> [--name <name>] [--connector-dir <path>]
uip is connectors builder activity field create --resource <name> --name <name> [options...] [--connector-dir <path>]
uip is connectors builder activity field delete [<name>] --resource <name> [--name <name>] [--connector-dir <path>]
uip is connectors builder activity method get --resource <name> --method <method> [--connector-dir <path>]
uip is connectors builder activity method set --resource <name> --method <method> [options...] [--connector-dir <path>]
uip is connectors builder activity method curate --resource <name> --method <method> --display-name <name> [options...] [--connector-dir <path>]
uip is connectors builder activity param list --resource <name> --method <method> [--connector-dir <path>]
uip is connectors builder activity param get --resource <name> --method <method> --name <name> [--connector-dir <path>]
uip is connectors builder activity param create --resource <name> --method <method> --name <name> --type <type> [options...] [--connector-dir <path>]
uip is connectors builder activity param delete --resource <name> --method <method> --name <name> [--connector-dir <path>]
uip is connectors builder activity list [--method <method>] [--path <path>] [--connector-dir <path>]
uip is connectors builder activity get [<name>] [--name <name>] [--connector-dir <path>]
uip is connectors builder activity create --name <name> [options...] [--connector-dir <path>]
uip is connectors builder activity delete <name> [--connector-dir <path>]
uip is connectors builder activity field schema
uip is connectors builder activity field list --resource <name> [--connector-dir <path>]
uip is connectors builder activity field get [<name>] --resource <name> [--name <name>] [--connector-dir <path>]
uip is connectors builder activity field create --resource <name> --name <name> [options...] [--connector-dir <path>]
uip is connectors builder activity field delete [<name>] --resource <name> [--name <name>] [--connector-dir <path>]
uip is connectors builder activity method get --resource <name> --method <method> [--connector-dir <path>]
uip is connectors builder activity method set --resource <name> --method <method> [options...] [--connector-dir <path>]
uip is connectors builder activity method curate --resource <name> --method <method> --display-name <name> [options...] [--connector-dir <path>]
uip is connectors builder activity param list --resource <name> --method <method> [--connector-dir <path>]
uip is connectors builder activity param get --resource <name> --method <method> --name <name> [--connector-dir <path>]
uip is connectors builder activity param create --resource <name> --method <method> --name <name> --type <type> [options...] [--connector-dir <path>]
uip is connectors builder activity param delete --resource <name> --method <method> --name <name> [--connector-dir <path>]
Conceptos
- Resource — one API endpoint entry in
element.json, identified by name, path, or aMETHOD:/pathselector (e.g.GET:/accounts).activity createis a find-or-append operation: running it again against an existing resource name appends new methods/fields instead of overwriting the resource. - Field — a UI-facing property on a resource, stored in the resource's standard-resource (SR) file. A field carries per-HTTP-method visibility (is it part of the request body, the response, is it required) plus optional design metadata for how it renders (dropdown, dependent dropdown, hidden, sort order).
- Method — the per-HTTP-method standard-resource config for a resource: its operation label, internal path, curation state, and description.
activity method curatepromotes a method into a standalone Studio activity. - Param — a runtime request parameter (query, path, header, or body) stored in
element.jsonand mirrored into the SR. Unlike fields, params describe how a value reaches the vendor API call, not how it renders as a static UI property — though a param can also become a dropdown via the same reference/enum flags as a field. - Dropdown / dependent dropdown —
field createandparam createshare an identical set of flags (--reference,--reference-object,--reference-path,--lookup-value,--lookup-names,--display-pattern,--filter-pattern,--load-by-default,--multi-select,--enable-user-override,--depends-on,--field-actions) for wiring a value to a lookup against another List resource.--depends-on <parentField>is a shortcut that generates the standard show/hide rule pair for a dependent dropdown (hidden until the parent has a value);--field-actionsis the raw JSON escape hatch for conditions--depends-oncan't express. - Merge semantics —
field create,param create(viacreate or replace— see below), andmethod setall merge onto an existing entry by default: keys you pass win, keys you omit are kept from the existing definition, and per-method visibility on a field is deep-merged so adding visibility for one method never drops another method's visibility.method set --replaceis the one exception — it overwrites the whole method config, dropping anything not re-passed (including parameters and curated state). - Unsetting a visibility flag —
field create --method 'GET=!request'(note the!prefix) explicitly turns off therequestvisibility forGETon a merge, rather than leaving it untouched. Without the!, a flag is only ever additive.
uip is connectors builder activity list
List element.json resource entries, optionally filtered.
Opciones
| Largo | Valor | Descripción |
|---|---|---|
--method <method> | String | Filter by HTTP method (GET, POST, ...). |
--path <path> | String | Filter by exact resource path (e.g. /accounts). |
--connector-dir <path> | Ruta | Connector directory. See Connectors builder → Concepts for the resolution order. |
Ejemplos
uip is connectors builder activity list
uip is connectors builder activity list --method GET
uip is connectors builder activity list
uip is connectors builder activity list --method GET
Forma de datos (--json de salida)
{ "Code": "ResourceList", "Data": { "Resources": [] } }
{ "Code": "ResourceList", "Data": { "Resources": [] } }
uip is connectors builder activity get
Get one element.json resource entry, by name, path, or a METHOD:/path selector.
Argumentos
| Nombre | Obligatorio | Propósito |
|---|---|---|
[name] | No | Resource name, path, or METHOD:/path selector (e.g. accounts or 'GET:/accounts'). May also be passed as --name. |
Opciones
| Largo | Valor | Descripción |
|---|---|---|
--name <name> | String | Alternative to the positional argument, for parity with create/field get/param get. |
--connector-dir <path> | Ruta | Connector directory. |
Ejemplos
uip is connectors builder activity get accounts
uip is connectors builder activity get 'GET:/accounts'
uip is connectors builder activity get accounts
uip is connectors builder activity get 'GET:/accounts'
Forma de datos (--json de salida)
{ "Code": "Resource", "Data": { "Resource": {} } }
{ "Code": "Resource", "Data": { "Resource": {} } }
uip is connectors builder activity create
Create a complete resource: a standard-resource file plus one element.json entry per method. Re-running against an existing --name finds and appends rather than overwriting.
Opciones
| Largo | Valor | Obligatorio | Descripción |
|---|---|---|---|
--name <name> | String | Sí | Resource name (path segment). |
--display-name <name> | String | No | UI display name. Defaults from --name. |
--vendor-path <path> | String | No | Vendor API path. Defaults to /{name}. |
--resource-path <path> | String | No | Explicit resource path, when it differs from the vendor path. |
--methods <csv> | csv | No | HTTP methods to create. Default GET,GETBYID,POST,PATCH,DELETE. |
--method-vendor-path <kv> | key=value, repeatable | No | Per-method vendor-path override, e.g. GET=/me/teams. |
--primary-key <name> | String | No | Primary key field name. Default id. |
--no-body | Marca | No | Omit the auto-added request-body parameter on POST/PUT/PATCH — for path-only actions like a start/stop call that needs only an id in the path. |
--resource-type <type> | String | No | ResourceType value (api, apiElementRequest, ...). Default api. |
--has-ceql | Marca | No | Enable CEQL filtering on GET. |
--has-events | Marca | No | Mark the resource as event-capable. |
--has-bulk | Marca | No | Enable bulk download support. |
--pagination-type <type> | String | No | Pagination type for GET. |
--root-key <key> | String | No | Response root key holding the records. |
--next-page-key <key> | String | No | Response key carrying the next page token. |
--filter-param <vendorName> | String | No | Vendor query-param name the CEQL filter maps to. Default where (e.g. sysparm_query for ServiceNow-style APIs). |
--page-size-param <vendorName> | String | No | Vendor query-param name for page size. Default pageSize (e.g. sysparm_limit, per_page). |
--offset-param <vendorName> | String | No | Vendor query-param name for row offset / page number (e.g. sysparm_offset, page). |
--next-resource <selector> | String | No | Chain to a next resource (e.g. 'GET:/organization'). |
--curated-metadata <json> | JSON | No | Per-method curated metadata, inline. Mutually exclusive with --curated-metadata-file. |
--curated-metadata-file <path> | Ruta | No | Per-method curated metadata, from a file. |
--fields <json> | JSON | No | Field specs as an inline JSON array. Mutually exclusive with --fields-file. See activity field schema for the shape. |
--fields-file <path> | Ruta | No | Field specs from a JSON file. |
--skip-sr | Marca | No | Skip standard-resource file creation. |
--no-curate | Marca | No | Do not auto-curate methods into standalone Studio activities. Default is to curate. |
--overwrite-fields | Marca | No | When appending to an existing resource, let incoming field definitions win on a name collision. Default keeps the existing definition. |
--connector-dir <path> | Ruta | No | Connector directory. |
Passing both --fields and --fields-file (or both --curated-metadata and --curated-metadata-file) is an error. The --fields/--fields-file payload is validated and normalized before anything is written, so a malformed field spec fails fast with a precise error instead of silently authoring a broken standard-resource file.
Ejemplos
# CRUD resource with default methods
uip is connectors builder activity create --name accounts --vendor-path /accounts --has-ceql
# List-only resource with cursor pagination
uip is connectors builder activity create --name orders --methods GET \
--pagination-type cursor --next-page-key nextCursor --root-key data
# CRUD resource with default methods
uip is connectors builder activity create --name accounts --vendor-path /accounts --has-ceql
# List-only resource with cursor pagination
uip is connectors builder activity create --name orders --methods GET \
--pagination-type cursor --next-page-key nextCursor --root-key data
Forma de datos (--json de salida)
{
"Code": "ResourceCreated",
"Data": {
"ResourceName": "accounts",
"ConnectorRoot": "/work/my-connector",
"ResourceType": "api",
"SrResolution": "created",
"MethodsAdded": ["GET", "GETBYID", "POST", "PATCH", "DELETE"],
"ElementEntriesAdded": 5,
"ElementEntriesSkipped": 0,
"FieldsCount": 0,
"ParamsSyncedFromElement": 0,
"StandardResourceFile": "app/element/accounts.js",
"SkipSr": false,
"Warnings": []
}
}
{
"Code": "ResourceCreated",
"Data": {
"ResourceName": "accounts",
"ConnectorRoot": "/work/my-connector",
"ResourceType": "api",
"SrResolution": "created",
"MethodsAdded": ["GET", "GETBYID", "POST", "PATCH", "DELETE"],
"ElementEntriesAdded": 5,
"ElementEntriesSkipped": 0,
"FieldsCount": 0,
"ParamsSyncedFromElement": 0,
"StandardResourceFile": "app/element/accounts.js",
"SkipSr": false,
"Warnings": []
}
}
uip is connectors builder activity delete
Remove a resource: every matching element.json entry and its standard-resource file.
Argumentos
| Nombre | Obligatorio | Propósito |
|---|---|---|
<name> | Sí | Resource name. |
Opciones
| Largo | Valor | Descripción |
|---|---|---|
--connector-dir <path> | Ruta | Connector directory. |
Ejemplo
uip is connectors builder activity delete accounts
uip is connectors builder activity delete accounts
Forma de datos (--json de salida)
{
"Code": "ResourceRemoved",
"Data": {
"ResourceName": "accounts",
"RemovedEntries": 5,
"StandardResourceRemoved": true
}
}
{
"Code": "ResourceRemoved",
"Data": {
"ResourceName": "accounts",
"RemovedEntries": 5,
"StandardResourceRemoved": true
}
}
This removes an entire resource. To remove a single method instead, edit the resource narrower with activity method set --replace, or delete and re-create with a reduced --methods list — there is no dedicated "remove one method" verb.
activity field
Manage a resource's standard-resource fields — its UI-facing shape.
uip is connectors builder activity field schema
Print the field-spec schema (allowed keys, types, visibility) plus a valid example, for authoring --fields/--fields-file payloads on activity create or activity field create. Needs no connector — this is a static, connector-independent reference command.
No arguments or options beyond global ones.
Ejemplo
uip is connectors builder activity field schema
uip is connectors builder activity field schema
Forma de datos (--json de salida)
Returned with its native lowercase keys (not PascalCased), so the example array is directly copy-paste-authorable:
{
"Code": "FieldSchema",
"Data": {
"keys": [
{ "key": "name", "required": true, "description": "REQUIRED. Field name; becomes the SR fields[] key (dotted a.b and arr[*].x allowed)." },
{ "key": "type", "required": false, "description": "Scalar type. Optional on merge; defaults to 'string' for a new field." }
],
"types": ["string", "..."],
"designPositions": ["primary", "secondary", "none"],
"visibilityMethods": ["GET", "..."],
"visibilityKeys": ["request", "response", "required", "requestCurated", "responseCurated"],
"notes": [
"Pass an ARRAY of these objects to --fields '<json>' or --fields-file <path> on `activity create`.",
"The array is validated + normalized before anything is written; a bad shape fails fast listing every problem.",
"Unknown top-level keys and duplicate names are rejected. Put 'required' inside a method entry, not at top level.",
"To bulk-add fields to an EXISTING activity, re-run `activity create --name <same> --fields-file <path>` — it merges."
],
"example": [
{ "name": "id", "type": "string", "primaryKey": true, "method": { "GET": { "response": true } } },
{ "name": "email", "type": "string", "displayName": "Email", "searchable": true, "searchableOperators": ["=", "!="], "method": { "GET": { "response": true }, "POST": { "request": true, "response": true, "required": true } } }
]
}
}
{
"Code": "FieldSchema",
"Data": {
"keys": [
{ "key": "name", "required": true, "description": "REQUIRED. Field name; becomes the SR fields[] key (dotted a.b and arr[*].x allowed)." },
{ "key": "type", "required": false, "description": "Scalar type. Optional on merge; defaults to 'string' for a new field." }
],
"types": ["string", "..."],
"designPositions": ["primary", "secondary", "none"],
"visibilityMethods": ["GET", "..."],
"visibilityKeys": ["request", "response", "required", "requestCurated", "responseCurated"],
"notes": [
"Pass an ARRAY of these objects to --fields '<json>' or --fields-file <path> on `activity create`.",
"The array is validated + normalized before anything is written; a bad shape fails fast listing every problem.",
"Unknown top-level keys and duplicate names are rejected. Put 'required' inside a method entry, not at top level.",
"To bulk-add fields to an EXISTING activity, re-run `activity create --name <same> --fields-file <path>` — it merges."
],
"example": [
{ "name": "id", "type": "string", "primaryKey": true, "method": { "GET": { "response": true } } },
{ "name": "email", "type": "string", "displayName": "Email", "searchable": true, "searchableOperators": ["=", "!="], "method": { "GET": { "response": true }, "POST": { "request": true, "response": true, "required": true } } }
]
}
}
The full key list (from source) also includes nativeType, description, sampleValue, format, mask (a date/number format pattern string, e.g. "yyyy-MM-dd'T'HH:mm:ssZ" — not a boolean), design, methods (alias for method, not both), enum, enhancedEnum, reference, sortOrder, searchableNames, defaultValue, custom, order, isCuratedEventField, isPriority, key, and fieldActions.
uip is connectors builder activity field list
List every field in a resource's standard-resource.
Opciones
| Largo | Valor | Obligatorio | Descripción |
|---|---|---|---|
--resource <name> | String | Sí | Resource name. |
--connector-dir <path> | Ruta | No | Connector directory. |
Ejemplo
uip is connectors builder activity field list --resource accounts
uip is connectors builder activity field list --resource accounts
Forma de datos (--json de salida)
{ "Code": "FieldList", "Data": { "Resource": "accounts", "Fields": [] } }
{ "Code": "FieldList", "Data": { "Resource": "accounts", "Fields": [] } }
uip is connectors builder activity field get
Read one field by name.
Argumentos
| Nombre | Obligatorio | Propósito |
|---|---|---|
[name] | No | Field name (or pass --name). |
Opciones
| Largo | Valor | Obligatorio | Descripción |
|---|---|---|---|
--resource <name> | String | Sí | Resource name. |
--name <name> | String | No | Alternative to the positional argument. |
--connector-dir <path> | Ruta | No | Connector directory. |
Ejemplo
uip is connectors builder activity field get --resource accounts name
uip is connectors builder activity field get --resource accounts name
Forma de datos (--json de salida)
{ "Code": "Field", "Data": { "Resource": "accounts", "Field": {} } }
{ "Code": "Field", "Data": { "Resource": "accounts", "Field": {} } }
uip is connectors builder activity field create
Create or update a field on a resource's standard-resource. Re-running on an existing field merges: top-level keys you pass win, unspecified keys are kept, and per-method visibility is deep-merged so adding a method's visibility never drops another method's.
Not for adding a runtime request parameter — use activity param create for that.
Opciones
| Largo | Valor | Obligatorio | Descripción |
|---|---|---|---|
--resource <name> | String | Sí | Resource name. |
--name <name> | String | Sí | Field name (becomes the fields map key). |
--type <type> | String | no* | Field type (string, integer, ...). Required for a NEW field; optional when merging into an existing one. |
--native-type <type> | String | No | Vendor-native type name. Defaults to --type. |
--display-name <name> | String | No | UI display name. |
--description <text> | String | No | Field description. |
--sample-value <value> | String | No | Sample value shown in the designer. |
--format <format> | String | No | Field format hint (e.g. date-time, int32). |
--enum <json> | JSON | No | Allowed values — bare ["a","b"] or [{"value":"a"}]. |
--enhanced-enum <json> | JSON | No | Labelled options: [{"name":"Label","value":"V"}]. |
--reference <json> | JSON | No | Dynamic lookup as JSON, e.g. {"objectName":"users","path":"/users","lookupValue":"id","lookupNames":["name"]}. |
--reference-object <name> | String | No | Dropdown: target List resource's object name (e.g. teams). |
--reference-path <path> | String | No | Dropdown: the List resource path (e.g. /teams). Use {parent} for a dependent dropdown, e.g. /teams/{team_id}/channels. |
--lookup-value <field> | String | No | Dropdown: the one field sent as the value. |
--lookup-names <csv> | csv | No | Dropdown: display-candidate fields for the display pattern. |
--display-pattern <pattern> | String | No | Dropdown: visible label template, e.g. "{displayName}" or "{name} - {id}". |
--filter-pattern <pattern> | String | No | Dropdown: server-side type-ahead filter template with {filter}. |
--load-by-default | Marca | No | Dropdown: populate the list on open. |
--multi-select | Marca | No | Dropdown: allow selecting multiple values. |
--enable-user-override | Marca | No | Dropdown: let the user type a raw value instead of picking. |
--depends-on <parent> | String | No | Dependent dropdown: hide until <parent> has a value (generates the show/hide rule pair). The reference path should contain {<parent>}. |
--field-actions <json> | JSON | No | Show/hide/required rules as JSON — escape hatch beyond --depends-on. |
--default-value <value> | scalar or JSON | No | Valor por defecto. |
--mask <pattern> | String | No | Date/number format pattern, e.g. "yyyy-MM-dd'T'HH:mm:ssZ". |
--primary-key | Marca | No | Mark the field as the primary key. |
--sort-order <n> | Entero | No | Sort order. |
--searchable | Marca | No | Mark the field as searchable. |
--searchable-operators <csv> | csv | No | Searchable operators. |
--searchable-names <csv> | csv | No | Alternate names to match in queries. |
--method <method> | string, repeatable | No | HTTP method the visibility flags apply to. Two forms, mixable: uniform (--method GET --method POST --response applies the same flags to both) or inline per-method (--method 'GET=response' --method 'POST=request,required'). Prefix a flag with ! to unset it on a merge, e.g. --method 'GET=!request'. |
--request | Marca | No | Field is part of the request, for each --method. |
--response | Marca | No | Field is part of the response, for each --method. |
--required | Marca | No | Field is required, for each --method. |
--request-curated | Marca | No | Field is request-curated, for each --method. |
--response-curated | Marca | No | Field is response-curated, for each --method. |
--design-position <position> | primary|secondary|none | No | Design position. |
--component <component> | String | No | Design component override. |
--hidden | Marca | No | Hide the field in the designer. |
--connector-dir <path> | Ruta | No | Connector directory. |
Inline per-method visibility tokens are: request, response, required, requestCurated (or request-curated), responseCurated (or response-curated). An unrecognized token fails with an explicit error listing the valid set.
Ejemplos
# String field, visible as a response on both GET and POST
uip is connectors builder activity field create --resource accounts --name email \
--type string --method GET --method POST --response
# Add request visibility on PATCH without dropping the existing GET/POST visibility (merges)
uip is connectors builder activity field create --resource accounts --name email \
--type string --method PATCH --request
# String field, visible as a response on both GET and POST
uip is connectors builder activity field create --resource accounts --name email \
--type string --method GET --method POST --response
# Add request visibility on PATCH without dropping the existing GET/POST visibility (merges)
uip is connectors builder activity field create --resource accounts --name email \
--type string --method PATCH --request
Forma de datos (--json de salida)
{
"Code": "FieldWritten",
"Data": {
"Resource": "accounts",
"FieldName": "email",
"Field": { "name": "email", "type": "string" },
"Outcome": "created"
}
}
{
"Code": "FieldWritten",
"Data": {
"Resource": "accounts",
"FieldName": "email",
"Field": { "name": "email", "type": "string" },
"Outcome": "created"
}
}
uip is connectors builder activity field delete
Remove a field by name.
Argumentos
| Nombre | Obligatorio | Propósito |
|---|---|---|
[name] | No | Field name (or pass --name). |
Opciones
| Largo | Valor | Obligatorio | Descripción |
|---|---|---|---|
--resource <name> | String | Sí | Resource name. |
--name <name> | String | No | Alternative to the positional argument. |
--connector-dir <path> | Ruta | No | Connector directory. |
Ejemplo
uip is connectors builder activity field delete --resource accounts email
uip is connectors builder activity field delete --resource accounts email
Forma de datos (--json de salida)
{ "Code": "FieldRemoved", "Data": { "Resource": "accounts", "FieldName": "email" } }
{ "Code": "FieldRemoved", "Data": { "Resource": "accounts", "FieldName": "email" } }
activity method
Manage a resource's per-method standard-resource config: operation label, internal path, curation state.
uip is connectors builder activity method get
Read a method's standard-resource config.
Opciones
| Largo | Valor | Obligatorio | Descripción |
|---|---|---|---|
--resource <name> | String | Sí | Resource name. |
--method <method> | String | Sí | HTTP method (GET, POST, ...). |
--connector-dir <path> | Ruta | No | Connector directory. |
Ejemplo
uip is connectors builder activity method get --resource accounts --method GET
uip is connectors builder activity method get --resource accounts --method GET
Forma de datos (--json de salida)
{
"Code": "Method",
"Data": { "Resource": "accounts", "Method": "GET", "VendorPath": "/accounts", "Config": {} }
}
{
"Code": "Method",
"Data": { "Resource": "accounts", "Method": "GET", "VendorPath": "/accounts", "Config": {} }
}
VendorPath is surfaced separately because the standard-resource config only holds the internal path — the vendor-facing routing lives in element.json.
uip is connectors builder activity method set
Create or edit a method's standard-resource config. Merges the flags you pass onto the existing config by default; --replace overwrites the whole block instead.
Opciones
| Largo | Valor | Obligatorio | Descripción |
|---|---|---|---|
--resource <name> | String | Sí | Resource name. |
--method <method> | String | Sí | HTTP method. |
--operation <operation> | String | No | Operation label (List, Retrieve, ...). |
--operation-id <id> | String | No | Operation identifier. |
--description <text> | String | No | Method description. |
--path <path> | String | No | Standard-resource method path. |
--hidden | Marca | No | Hide the method from the designer. |
--has-ceql | Marca | No | Enable CEQL on this method. |
--response-display-name <name> | String | No | Response display name. |
--response-description <text> | String | No | Response description. |
--replace | Marca | No | Overwrite the whole method config instead of merging. Drops parameters/curated state not re-passed. |
--connector-dir <path> | Ruta | No | Connector directory. |
Ejemplo
uip is connectors builder activity method set --resource accounts --method GET \
--operation List --path /accounts --has-ceql
uip is connectors builder activity method set --resource accounts --method GET \
--operation List --path /accounts --has-ceql
Forma de datos (--json de salida)
{ "Code": "MethodSet", "Data": { "Resource": "accounts", "Method": "GET", "Outcome": "updated" } }
{ "Code": "MethodSet", "Data": { "Resource": "accounts", "Method": "GET", "Outcome": "updated" } }
uip is connectors builder activity method curate
Promote a method to a standalone Studio activity.
Opciones
| Largo | Valor | Obligatorio | Descripción |
|---|---|---|---|
--resource <name> | String | Sí | Resource name. |
--method <method> | String | Sí | HTTP method. |
--display-name <name> | String | Sí | Studio activity display name. |
--name <name> | String | No | Activity identifier. Defaults to the display name. |
--description <text> | String | No | Activity description. |
--hidden | Marca | No | Hide the activity. |
--connector-dir <path> | Ruta | No | Connector directory. |
Only the flags you actually pass are sent — a display-name-only call merges into the existing curated block rather than resetting the identifier or blanking the description.
Ejemplo
uip is connectors builder activity method curate --resource accounts --method GET \
--display-name 'List Accounts'
uip is connectors builder activity method curate --resource accounts --method GET \
--display-name 'List Accounts'
Forma de datos (--json de salida)
{ "Code": "MethodCurated", "Data": { "Resource": "accounts", "Method": "GET", "Curated": {} } }
{ "Code": "MethodCurated", "Data": { "Resource": "accounts", "Method": "GET", "Curated": {} } }
activity param
Manage a resource method's runtime parameters in element.json (mirrored to the standard-resource).
uip is connectors builder activity param list
Opciones
| Largo | Valor | Obligatorio | Descripción |
|---|---|---|---|
--resource <name> | String | Sí | Resource name. |
--method <method> | String | Sí | HTTP method. |
--connector-dir <path> | Ruta | No | Connector directory. |
Ejemplo
uip is connectors builder activity param list --resource accounts --method GET
uip is connectors builder activity param list --resource accounts --method GET
Forma de datos (--json de salida)
{ "Code": "ParamList", "Data": { "Resource": "accounts", "Method": "GET", "Parameters": [] } }
{ "Code": "ParamList", "Data": { "Resource": "accounts", "Method": "GET", "Parameters": [] } }
uip is connectors builder activity param get
Opciones
| Largo | Valor | Obligatorio | Descripción |
|---|---|---|---|
--resource <name> | String | Sí | Resource name. |
--method <method> | String | Sí | HTTP method. |
--name <name> | String | Sí | Parameter name. |
--connector-dir <path> | Ruta | No | Connector directory. |
Ejemplo
uip is connectors builder activity param get --resource accounts --method GET --name where
uip is connectors builder activity param get --resource accounts --method GET --name where
Forma de datos (--json de salida)
{ "Code": "Param", "Data": { "Resource": "accounts", "Method": "GET", "Param": {} } }
{ "Code": "Param", "Data": { "Resource": "accounts", "Method": "GET", "Param": {} } }
uip is connectors builder activity param create
Create or replace a parameter on a resource method.
Opciones
| Largo | Valor | Obligatorio | Descripción |
|---|---|---|---|
--resource <name> | String | Sí | Resource name. |
--method <method> | String | Sí | HTTP method. |
--name <name> | String | Sí | Parameter name. |
--vendor-name <name> | String | No | Vendor-side parameter name. |
--type <type> | String | Sí | Parameter type — run param create --help for the full type catalog, sourced from the CLI's parameter-type registry (--type accepts, among others, values like a plain scalar type or value/configuration for constants and 1:1 config maps — prefer a declarative type here over writing a hook). |
--vendor-type <type> | String | No | Vendor-side parameter type. |
--data-type <type> | String | No | Data type (string, integer, ...). |
--vendor-data-type <type> | String | No | Vendor-side data type. |
--source <source> | String | No | Parameter source (request, response). |
--required | Marca | No | Mark the parameter as required. |
--description <text> | String | No | Parameter description. |
--display-name <name> | String | No | UI display name. |
--sort-order <n> | Entero | No | Sort order. |
--enum <json> | JSON | No | Allowed values, same shape as field create --enum — a query/body param can be a static combo. |
--enhanced-enum <json> | JSON | No | Labelled options, same shape as field create --enhanced-enum. |
--reference <json> / --reference-object / --reference-path / --lookup-value / --lookup-names / --filter-pattern / --display-pattern / --load-by-default / --multi-select / --enable-user-override / --depends-on / --field-actions | — | No | Identical dropdown/dependent-dropdown flags as field create — see that section above. A path or query param can be a dropdown too. |
--design-position <position> | primary|secondary|none | No | Design position. |
--hidden | Marca | No | Hide the parameter in the designer. |
--connector-dir <path> | Ruta | No | Connector directory. |
--type is genuinely required; its exact allowed values come from the CLI's own parameter-type registry and are printed in full by param create --help, so this page doesn't hardcode a list that would drift from the shipped registry.
Ejemplo
uip is connectors builder activity param create --resource accounts --method GET \
--name status --type query --data-type string
uip is connectors builder activity param create --resource accounts --method GET \
--name status --type query --data-type string
Forma de datos (--json de salida)
{
"Code": "ParamWritten",
"Data": {
"Resource": "accounts",
"Method": "GET",
"ParamName": "status",
"Param": { "name": "status", "type": "query" },
"Outcome": "created",
"SrSynced": true
}
}
{
"Code": "ParamWritten",
"Data": {
"Resource": "accounts",
"Method": "GET",
"ParamName": "status",
"Param": { "name": "status", "type": "query" },
"Outcome": "created",
"SrSynced": true
}
}
Warnings is present only when the write produced any.
uip is connectors builder activity param delete
Opciones
| Largo | Valor | Obligatorio | Descripción |
|---|---|---|---|
--resource <name> | String | Sí | Resource name. |
--method <method> | String | Sí | HTTP method. |
--name <name> | String | Sí | Parameter name. |
--connector-dir <path> | Ruta | No | Connector directory. |
Ejemplo
uip is connectors builder activity param delete --resource accounts --method GET --name status
uip is connectors builder activity param delete --resource accounts --method GET --name status
Forma de datos (--json de salida)
{
"Code": "ParamRemoved",
"Data": { "Resource": "accounts", "Method": "GET", "ParamName": "status", "SrSynced": true }
}
{
"Code": "ParamRemoved",
"Data": { "Resource": "accounts", "Method": "GET", "ParamName": "status", "SrSynced": true }
}
Relacionado
- Connectors builder — concepts and the four tenant-lifecycle verbs.
- Activity hooks — JavaScript pre/post-request transforms attached to a resource or global.
- Init & connector — scaffold the connector this activity lives in.
- Auth — configure the connector's authentication scheme, including lifecycle/system resources.
- Trigger & state — event triggers and low-level element-file edits.
Ver también
- Sinopsis
- Conceptos
- uip is connectors builder activity list
- Opciones
- Ejemplos
- Forma de datos (--json de salida)
- uip is connectors builder activity get
- Argumentos
- Opciones
- Ejemplos
- Forma de datos (--json de salida)
- uip is connectors builder activity create
- Opciones
- Ejemplos
- Forma de datos (--json de salida)
- uip is connectors builder activity delete
- Argumentos
- Opciones
- Ejemplo
- Forma de datos (--json de salida)
- activity field
- uip is connectors builder activity field schema
- uip is connectors builder activity field list
- uip is connectors builder activity field get
- uip is connectors builder activity field create
- uip is connectors builder activity field delete
- activity method
- uip is connectors builder activity method get
- uip is connectors builder activity method set
- uip is connectors builder activity method curate
- activity param
- uip is connectors builder activity param list
- uip is connectors builder activity param get
- uip is connectors builder activity param create
- uip is connectors builder activity param delete
- Relacionado
- Ver también