uip es la actividad del creador de conectores

Sintaxis y opciones para crear las actividades de un conector (recursos, campos, métodos y parámetros) con el creador de conectores de Integration Service.

uip is connectors builder activity crea las actividades de un conector: los puntos finales de la API (llamados recursos en el archivo de recursos estándar) que se convierten en actividades de Studio, junto con sus campos, métodos y parámetros. Este es el dominio más grande y detallado del creador de conectores: consulta Creador de conectores para conocer los conceptos compartidos (resolución del directorio de conectores, diseño frente a publicado, el flujo de creación típico) que también se aplican aquí.

Enganches: transformaciones previas/posteriores a la solicitud de JavaScript adjuntas a un recurso o global: son un subgrupo activity hook anidado, documentado por separado en los enlaces de actividad debido a su propio tamaño y la cantidad de detalles de contexto de runtime que necesitan.

Nota:

activity create no es para puntos finales del ciclo de vida como auth-validation o onProvision : esos son recursos del sistema creados con builder auth system create (consulta Auth). activity es para las operaciones regulares orientadas al usuario del conector.

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>]

Conceptos

• Recurso : una entrada de punto final de API en element.json, identificada por nombre, ruta o un selector METHOD:/path (p. ej. GET:/accounts). activity create es una operación de buscar o anexar : ejecutarla de nuevo contra un nombre de recurso existente anexa nuevos métodos/campos en lugar de sobrescribir el recurso.
• Campo : una propiedad orientada a la interfaz de usuario en un recurso, almacenada en el archivo de recursos estándar (SR) del recurso. Un campo tiene visibilidad por método HTTP (forma parte del cuerpo de la solicitud, la respuesta, es obligatorio) más metadatos de diseño opcionales sobre cómo se representa (desplegable, desplegable dependiente, oculto, orden de clasificación).
• Método : la configuración de recursos estándar por método HTTP para un recurso: su etiqueta de operación, ruta interna, estado de selección y descripción. activity method curate promueve un método a una actividad de Studio independiente.
• Parámetro : un parámetro de solicitud de runtime (consulta, ruta, encabezado o cuerpo) almacenado en element.json y reflejado en el SR. A diferencia de los campos, los parámetros describen cómo un valor llega a la llamada a la API del proveedor, no cómo se representa como una propiedad de IU estática, aunque un parámetro también puede convertirse en un menú desplegable a través de los mismos marcadores de referencia/enum que un campo.
• Desplegable/desplegable dependiente : field create y param create comparten un conjunto idéntico de marcadores (--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) para conectar un valor a una búsqueda en otro recurso de lista. --depends-on <parentField> es un atajo que genera el par de reglas estándar mostrar/ocultar para un menú desplegable dependiente (oculto hasta que el elemento principal tenga un valor); --field-actions es la escotilla de escape JSON sin formato para las condiciones que --depends-on no puede expresar.
• Fusionar semántica : field create, param create (a través de create or replace — consulta más abajo) y method set se fusionan en una entrada existente de forma predeterminada: las claves que pasas ganan, las claves que omites se mantienen de la definición existente, y por La visibilidad del método en un campo está fusionada, por lo que añadir visibilidad para un método nunca disminuye la visibilidad de otro método. method set --replace es la única excepción: sobrescribe toda la configuración del método, descartando todo lo que no se haya vuelto a pasar (incluidos los parámetros y el estado seleccionado).
• Desactivar un marcador de visibilidad : field create --method 'GET=!request' (ten en cuenta el prefijo ! ) desactiva explícitamente la visibilidad request para GET en una combinación, en lugar de dejarla intacta. Sin !, un marcador solo es aditivo.

uip es la lista de actividades del creador de conectores

Enumerar element.json entradas de recursos, opcionalmente filtradas.

Opciones

Largo	Valor	Descripción
--method <method>	String	Filtrar por método HTTP (GET, POST, ...).
--path <path>	String	Filtrar por ruta exacta del recurso (por ejemplo /accounts).
--connector-dir <path>	Ruta	Directorio del conector. Consulta Creador de conectores → Conceptos para el orden de resolución.

Ejemplos

uip is connectors builder activity list
uip is connectors builder activity list --method GET

Forma de datos (--json de salida)

{ "Code": "ResourceList", "Data": { "Resources": [] } }

uip es actividad get del creador de conectores

Obtener una entrada de recurso element.json, por nombre, ruta o un selector METHOD:/path.

Argumentos

Nombre	Obligatorio	Propósito
[name]	No	Nombre del recurso, ruta o selector METHOD:/path (por ejemplo accounts o 'GET:/accounts'). También se puede pasar como --name.

Opciones

Largo	Valor	Descripción
--name <name>	String	Alternativa al argumento posicional, para la paridad con create/field get/param get.
--connector-dir <path>	Ruta	Directorio del conector.

Ejemplos

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": {} } }

uip es creación de actividad del creador de conectores

Crea un recurso completo: un archivo de recursos estándar más una entrada element.json por método. Volver a ejecutar contra un --name existente busca y anexa en lugar de sobrescribir.

Opciones

Largo	Valor	Obligatorio	Descripción
--name <name>	String	Sí	Nombre del recurso (segmento de ruta).
--display-name <name>	String	No	Nombre para mostrar de la IU. Valores predeterminados desde --name.
--vendor-path <path>	String	No	Ruta de la API del proveedor. El valor predeterminado es /{name}.
--resource-path <path>	String	No	Ruta de recursos explícita, cuando difiere de la ruta del proveedor.
--methods <csv>	csv	No	Métodos HTTP para crear. Predeterminado GET,GETBYID,POST,PATCH,DELETE.
--method-vendor-path <kv>	key=value, repetible	No	Anulación de la ruta del proveedor por método, por ejemplo GET=/me/teams.
--primary-key <name>	String	No	Nombre del campo de clave principal. Predeterminado id.
--no-body	Marca	No	Omite el parámetro del cuerpo de la solicitud añadido automáticamente en POST/PUT/PATCH — para acciones solo de ruta como una llamada de inicio/detención que solo necesita un ID en la ruta.
--resource-type <type>	String	No	ResourceType (api, apiElementRequest, ...). Predeterminado api.
--has-ceql	Marca	No	Habilita el filtrado CEQL en GET.
--has-events	Marca	No	Marca el recurso como apto para eventos.
--has-bulk	Marca	No	Habilita la compatibilidad con descargas masivas.
--pagination-type <type>	String	No	Tipo de paginación para GET.
--root-key <key>	String	No	Clave raíz de respuesta que contiene los registros.
--next-page-key <key>	String	No	Clave de respuesta que lleva el token de la página siguiente.
--filter-param <vendorName>	String	No	Nombre del parámetro de consulta del proveedor al que se asigna el filtro CEQL. Valor predeterminado where (p. ej. sysparm_query para las API de estilo ServiceNow).
--page-size-param <vendorName>	String	No	Nombre del parámetro de consulta del proveedor para el tamaño de la página. Valor predeterminado pageSize (p. ej. sysparm_limit, per_page).
--offset-param <vendorName>	String	No	Nombre del parámetro de consulta del proveedor para el desplazamiento de fila/número de página (por ejemplo sysparm_offset, page).
--next-resource <selector>	String	No	Encadenar al siguiente recurso (p. ej. 'GET:/organization').
--curated-metadata <json>	JSON	No	Metadatos seleccionados por método, en línea. Mutuamente exclusivo con --curated-metadata-file.
--curated-metadata-file <path>	Ruta	No	Metadatos seleccionados por método, desde un archivo.
--fields <json>	JSON	No	Especificaciones de campo como matriz JSON en línea. Mutuamente exclusivo con --fields-file. Consulta activity field schema para ver la forma.
--fields-file <path>	Ruta	No	Especificaciones de campo de un archivo JSON.
--skip-sr	Marca	No	Omitir la creación de archivos de recursos estándar.
--no-curate	Marca	No	No selecciones automáticamente los métodos en actividades de Studio independientes. El valor predeterminado es seleccionar.
--overwrite-fields	Marca	No	Al anexar a un recurso existente, deje que las definiciones de campo entrantes ganen en una colisión de nombres. El valor predeterminado mantiene la definición existente.
--connector-dir <path>	Ruta	No	Directorio del conector.

Pasar tanto --fields como --fields-file (o ambos --curated-metadata y --curated-metadata-file) es un error. La carga útil --fields/--fields-file se valida y normaliza antes de que se escriba nada, por lo que una especificación de campo mal formada falla rápidamente con un error preciso en lugar de crear silenciosamente un archivo de recursos estándar roto.

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

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": []
  }
}

uip es actividad del creador de conectores eliminar

Eliminar un recurso: cada entrada element.json coincidente y su archivo de recursos estándar.

Argumentos

Nombre	Obligatorio	Propósito
<name>	Sí	Nombre del recurso.

Opciones

Largo	Valor	Descripción
--connector-dir <path>	Ruta	Directorio del conector.

Ejemplo

uip is connectors builder activity delete accounts

Forma de datos (--json de salida)

{
  "Code": "ResourceRemoved",
  "Data": {
    "ResourceName": "accounts",
    "RemovedEntries": 5,
    "StandardResourceRemoved": true
  }
}

Esto elimina un recurso completo. Para eliminar un solo método en su lugar, edita el recurso para reducirlo con activity method set --replace, o elimina y vuelve acreate con una lista --methods reducida — no hay una lista dedicada a "eliminar un método" verbo.

---

campo de actividad

Gestiona los campos de recursos estándar de un recurso: su forma orientada a la interfaz de usuario.

uip es el esquema de campo de actividad del creador de conectores

Imprime el esquema de especificaciones de campo (claves permitidas, tipos, visibilidad) más un ejemplo válido, para crear cargas útiles --fields/--fields-file en activity create o activity field create. No necesita conector: este es un comando de referencia estático e independiente del conector.

No hay argumentos u opciones más allá de los globales.

Ejemplo

uip is connectors builder activity field schema

Forma de datos (--json de salida)

Se devuelve con sus claves nativas en minúsculas (no en PascalCased), por lo que la matriz example se puede copiar y pegar directamente:

{
  "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 } } }
    ]
  }
}

La lista de claves completa (desde el origen) también incluye nativeType, description, sampleValue, format, mask (una cadena de patrón de formato de fecha/número, por ejemplo "yyyy-MM-dd'T'HH:mm:ssZ" — no es un booleano), design, methods (alias de method, no ambos), enum, enhancedEnum, reference, sortOrder, searchableNames, defaultValue, custom, order, isCuratedEventField, isPriority, key y fieldActions.

uip es la lista de campos de actividad del creador de conectores

Enumerar todos los campos en el recurso estándar de un recurso.

Opciones

Largo	Valor	Obligatorio	Descripción
--resource <name>	String	Sí	Nombre del recurso.
--connector-dir <path>	Ruta	No	Directorio del conector.

Ejemplo

uip is connectors builder activity field list --resource accounts

Forma de datos (--json de salida)

{ "Code": "FieldList", "Data": { "Resource": "accounts", "Fields": [] } }

uip es obtener el campo de actividad del creador de conectores

Leer un campo por nombre.

Argumentos

Nombre	Obligatorio	Propósito
[name]	No	Nombre del campo (o pase --name).

Opciones

Largo	Valor	Obligatorio	Descripción
--resource <name>	String	Sí	Nombre del recurso.
--name <name>	String	No	Alternativa al argumento posicional.
--connector-dir <path>	Ruta	No	Directorio del conector.

Ejemplo

uip is connectors builder activity field get --resource accounts name

Forma de datos (--json de salida)

{ "Code": "Field", "Data": { "Resource": "accounts", "Field": {} } }

uip es creación de campo de actividad del creador de conectores

Crear o actualizar un campo en el recurso estándar de un recurso. Volver a ejecutar en un campo existente fusiona: las claves de nivel superior que pasas ganan, las claves no especificadas se mantienen y la visibilidad por método se fusiona en profundidad, por lo que añadir la visibilidad de un método nunca elimina la de otro método.

No para añadir un parámetro de solicitud de runtime: utiliza activity param create para eso.

Opciones

Largo	Valor	Obligatorio	Descripción
--resource <name>	String	Sí	Nombre del recurso.
--name <name>	String	Sí	Nombre del campo (se convierte en la clave del mapa fields).
--type <type>	String	No*	Tipo de campo (string, integer, ...). Obligatorio para un campo NUEVO; opcional al fusionarse con uno existente.
--native-type <type>	String	No	Nombre del tipo nativo del proveedor. El valor predeterminado es --type.
--display-name <name>	String	No	Nombre para mostrar de la IU.
--description <text>	String	No	Descripción del campo.
--sample-value <value>	String	No	Valor de muestra mostrado en el diseñador.
--format <format>	String	No	Sugerencia de formato de campo (por ejemplo date-time, int32).
--enum <json>	JSON	No	Valores permitidos: desnudo ["a","b"] o [{"value":"a"}].
--enhanced-enum <json>	JSON	No	Opciones etiquetadas: [{"name":"Label","value":"V"}].
--reference <json>	JSON	No	Búsqueda dinámica como JSON, por ejemplo {"objectName":"users","path":"/users","lookupValue":"id","lookupNames":["name"]}.
--reference-object <name>	String	No	Menú desplegable: nombre del objeto del recurso de la lista de destino (por ejemplo teams).
--reference-path <path>	String	No	Menú desplegable: la ruta del recurso de la lista (por ejemplo /teams). Usa {parent} para un menú desplegable dependiente, por ejemplo /teams/{team_id}/channels.
--lookup-value <field>	String	No	Menú desplegable: el campo enviado como valor.
--lookup-names <csv>	csv	No	Desplegable: campos candidatos a visualización para el patrón de visualización.
--display-pattern <pattern>	String	No	Menú desplegable: plantilla de etiqueta visible, por ejemplo "{displayName}" o "{name} - {id}".
--filter-pattern <pattern>	String	No	Desplegable: plantilla de filtro de escritura anticipada del lado del servidor con {filter}.
--load-by-default	Marca	No	Menú desplegable: rellena la lista al abrir.
--multi-select	Marca	No	Menú desplegable: permite seleccionar varios valores.
--enable-user-override	Marca	No	Menú desplegable: permite al usuario escribir un valor sin procesar en lugar de elegir.
--depends-on <parent>	String	No	Menú desplegable dependiente: ocultar hasta que <parent> tenga un valor (genera el par de reglas mostrar/ocultar). La ruta de referencia debe contener {<parent>}.
--field-actions <json>	JSON	No	Mostrar/ocultar/reglas requeridas como JSON: escotilla de escape más allá de --depends-on.
--default-value <value>	escalar o JSON	No	Valor por defecto.
--mask <pattern>	String	No	Patrón de formato de fecha/número, por ejemplo "yyyy-MM-dd'T'HH:mm:ssZ".
--primary-key	Marca	No	Marca el campo como clave principal.
--sort-order <n>	Entero	No	Orden de clasificación.
--searchable	Marca	No	Marque el campo como buscable.
--searchable-operators <csv>	csv	No	Operadores que se pueden buscar.
--searchable-names <csv>	csv	No	Nombres alternativos para que coincidan en las consultas.
--method <method>	cadena, repetible	No	Método HTTP al que se aplican los marcadores de visibilidad. Dos formularios, combinables: uniforme (--method GET --method POST --response aplica los mismos marcadores a ambos) o en línea por método (--method 'GET=response' --method 'POST=request,required'). Prefija un marcador con ! para desactivarlo en una fusión, por ejemplo --method 'GET=!request'.
--request	Marca	No	El campo forma parte de la solicitud, para cada --method.
--response	Marca	No	El campo forma parte de la respuesta, para cada --method.
--required	Marca	No	El campo es obligatorio para cada --method.
--request-curated	Marca	No	El campo está seleccionado por la solicitud, para cada --method.
--response-curated	Marca	No	El campo está seleccionado por la respuesta, para cada --method.
--design-position <position>	primary|secondary|none	No	Posición de diseño.
--component <component>	String	No	Anulación de componente de diseño.
--hidden	Marca	No	Ocultar el campo en el diseñador.
--connector-dir <path>	Ruta	No	Directorio del conector.

Los tokens de visibilidad en línea por método son: request, response, required, requestCurated (o request-curated), responseCurated (o response-curated). Un token no reconocido falla con un error explícito que enumera el conjunto válido.

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

Forma de datos (--json de salida)

{
  "Code": "FieldWritten",
  "Data": {
    "Resource": "accounts",
    "FieldName": "email",
    "Field": { "name": "email", "type": "string" },
    "Outcome": "created"
  }
}

uip es eliminar el campo de actividad del creador de conectores

Eliminar un campo por nombre.

Argumentos

Nombre	Obligatorio	Propósito
[name]	No	Nombre del campo (o pase --name).

Opciones

Largo	Valor	Obligatorio	Descripción
--resource <name>	String	Sí	Nombre del recurso.
--name <name>	String	No	Alternativa al argumento posicional.
--connector-dir <path>	Ruta	No	Directorio del conector.

Ejemplo

uip is connectors builder activity field delete --resource accounts email

Forma de datos (--json de salida)

{ "Code": "FieldRemoved", "Data": { "Resource": "accounts", "FieldName": "email" } }

---

método de actividad

Gestione la configuración de recursos estándar por método de un recurso: etiqueta de operación, ruta interna, estado de selección.

uip es el método get de actividad del creador de conectores

Leer la configuración de recursos estándar de un método.

Opciones

Largo	Valor	Obligatorio	Descripción
--resource <name>	String	Sí	Nombre del recurso.
--method <method>	String	Sí	Método HTTP (GET, POST, ...).
--connector-dir <path>	Ruta	No	Directorio del conector.

Ejemplo

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": {} }
}

VendorPath aparece por separado porque la configuración de recursos estándar solo contiene la ruta interna : el enrutamiento orientado al proveedor vive en element.json.

uip es un conjunto de métodos de actividad del creador de conectores

Crear o editar la configuración de recursos estándar de un método. Fusiona los marcadores que pasas en la configuración existente de forma predeterminada; --replace sobrescribe todo el bloque en su lugar.

Opciones

Largo	Valor	Obligatorio	Descripción
--resource <name>	String	Sí	Nombre del recurso.
--method <method>	String	Sí	Método HTTP.
--operation <operation>	String	No	Etiqueta de operación (List, Retrieve, ...).
--operation-id <id>	String	No	Identificador de operación.
--description <text>	String	No	Descripción del método.
--path <path>	String	No	Ruta del método de recurso estándar.
--hidden	Marca	No	Ocultar el método del diseñador.
--has-ceql	Marca	No	Habilite CEQL en este método.
--response-display-name <name>	String	No	Nombre para mostrar de la respuesta.
--response-description <text>	String	No	Descripción de la respuesta.
--replace	Marca	No	Sobrescribe toda la configuración del método en lugar de fusionarla. Parámetros de caída/estado seleccionado no repasados.
--connector-dir <path>	Ruta	No	Directorio del conector.

Ejemplo

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" } }

uip es el método de actividad del creador de conectores seleccionado

Promocionar un método a una actividad de Studio independiente.

Opciones

Largo	Valor	Obligatorio	Descripción
--resource <name>	String	Sí	Nombre del recurso.
--method <method>	String	Sí	Método HTTP.
--display-name <name>	String	Sí	Nombre para mostrar de la actividad de Studio.
--name <name>	String	No	Identificador de actividad. El valor predeterminado es el nombre para mostrar.
--description <text>	String	No	Descripción de la actividad.
--hidden	Marca	No	Ocultar la actividad.
--connector-dir <path>	Ruta	No	Directorio del conector.

Solo se envían los marcadores que realmente pasas: una llamada de solo nombre para mostrar se fusiona en el bloque seleccionado existente en lugar de restablecer el identificador o borrar la descripción.

Ejemplo

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": {} } }

---

parámetro de actividad

Gestiona los parámetros de runtime de un método de recurso en element.json (reflejado en el recurso estándar).

uip es la lista de parámetros de actividad del creador de conectores

Opciones

Largo	Valor	Obligatorio	Descripción
--resource <name>	String	Sí	Nombre del recurso.
--method <method>	String	Sí	Método HTTP.
--connector-dir <path>	Ruta	No	Directorio del conector.

Ejemplo

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": [] } }

uip es obtener el parámetro de actividad del creador de conectores

Opciones

Largo	Valor	Obligatorio	Descripción
--resource <name>	String	Sí	Nombre del recurso.
--method <method>	String	Sí	Método HTTP.
--name <name>	String	Sí	Nombre del parámetro.
--connector-dir <path>	Ruta	No	Directorio del conector.

Ejemplo

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": {} } }

uip es crear un parámetro de actividad del creador de conectores

Crear o reemplazar un parámetro en un método de recurso.

Opciones

Largo	Valor	Obligatorio	Descripción
--resource <name>	String	Sí	Nombre del recurso.
--method <method>	String	Sí	Método HTTP.
--name <name>	String	Sí	Nombre del parámetro.
--vendor-name <name>	String	No	Nombre del parámetro del lado del proveedor.
--type <type>	String	Sí	Tipo de parámetro: ejecuta param create --help para el catálogo de tipos completo, procedente del registro de tipo de parámetro de CLI (--type acepta, entre otros, valores como un tipo escalar simple o value/configuration para constantes y relación 1:1 configmaps: prefiera un tipo declarativo aquí a escribir un gancho).
--vendor-type <type>	String	No	Tipo de parámetro del lado del proveedor.
--data-type <type>	String	No	Tipo de datos (string, integer, ...).
--vendor-data-type <type>	String	No	Tipo de datos del lado del proveedor.
--source <source>	String	No	Origen del parámetro (request, response).
--required	Marca	No	Marca el parámetro como obligatorio.
--description <text>	String	No	Descripción del parámetro.
--display-name <name>	String	No	Nombre para mostrar de la IU.
--sort-order <n>	Entero	No	Orden de clasificación.
--enum <json>	JSON	No	Valores permitidos, misma forma que field create --enum — un parámetro de consulta/cuerpo puede ser un combo estático.
--enhanced-enum <json>	JSON	No	Opciones etiquetadas, misma forma que 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	Indicadores desplegables/desplegables dependientes idénticos a field create: consulta esa sección anterior. Una ruta o un parámetro de consulta también puede ser un menú desplegable.
--design-position <position>	primary|secondary|none	No	Posición de diseño.
--hidden	Marca	No	Ocultar el parámetro en el diseñador.
--connector-dir <path>	Ruta	No	Directorio del conector.

--type es realmente necesario; sus valores permitidos exactos provienen del propio registro de tipo de parámetro de la CLI y se imprimen en su totalidad por param create --help, por lo que esta página no codifica una lista que se desviaría del registro enviado.

Ejemplo

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
  }
}

Warnings está presente solo cuando la escritura produjo alguno.

uip es la eliminación del parámetro de actividad del creador de conectores

Opciones

Largo	Valor	Obligatorio	Descripción
--resource <name>	String	Sí	Nombre del recurso.
--method <method>	String	Sí	Método HTTP.
--name <name>	String	Sí	Nombre del parámetro.
--connector-dir <path>	Ruta	No	Directorio del conector.

Ejemplo

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 }
}

Relacionado

• Creador de conectores : conceptos y los cuatro verbos del ciclo de vida del tenant.
• Enganches de actividad : transformaciones previas/posteriores a la solicitud de JavaScript adjuntas a un recurso o global.
• Inicialización y conector : aplica andamio al conector en el que reside esta actividad.
• Auth : configura el esquema de autenticación del conector, incluidos los recursos del ciclo de vida/sistema.
• Desencadenador y estado : desencadenadores de eventos y ediciones de archivos de elementos de bajo nivel.

Ver también

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