uip é a atividade connectors builder

Sintaxe e opções para criar as atividades de um conector — recursos, campos, métodos e parâmetros — com o construtor de conector do Integration Service.

uip is connectors builder activity cria as atividades de um conector: os pontos de extremidade da API (chamados de recursos no arquivo de recurso padrão) que se tornam atividades do Studio, juntamente com seus campos, métodos e parâmetros. Esse é o maior e mais detalhado domínio no construtor de conector — consulte Construtor de conectores para os conceitos compartilhados (resolência do diretório do conector, design versus publicado, o fluxo de criação típico) que também se aplicam aqui.

Hosts — Transformações pré/pós-solicitação do JavaScript anexadas a um recurso ou global — são um subgrupo activity hook aninhado, documentado separadamente em hooks de Atividade por causa de seu próprio tamanho e a quantidade de detalhes de contexto de runtime de que precisam.

Observação:

activity create não é para endpoints do ciclo de vida como auth-validation ou onProvision — esses são recursos do sistema criados com builder auth system create (consulte Autenticação). activity é para as operações regulares voltados para o usuário do conector.

Resumo

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

Conceitos

• Recurso — uma entrada de ponto de extremidade de API em element.json, identificada por nome, caminho ou um seletor METHOD:/path (por exemplo GET:/accounts). activity create é uma operação localizar ou anexar : executá-la novamente em um nome de recurso existente anexa novos métodos/campos em vez de substituir o recurso.
• Campo — uma propriedade voltado para a interface do usuário em um recurso, armazenada no arquivo de recurso padrão (SR) do recurso. Um campo carrega visibilidade por método HTTP (se faz parte do corpo da solicitação, da resposta, é necessário) além de metadados de design opcionais para como ele é renderizado (lista suspensa, lista suspensa dependente, oculto, ordem de classificação).
• Método — a configuração de recurso padrão por método HTTP para um recurso: seu rótulo de operação, caminho interno, estado de seleção e descrição. activity method curate promove um método em uma atividade independente do Studio.
• Param — um parâmetro de solicitação de runtime (consulta, caminho, cabeçalho ou corpo) armazenado em element.json e espelhado no SR. Ao contrário dos campos, os parâmetros descrevem como um valor atinge a chamada de API do fornecedor, não como ele é renderizado como uma propriedade de interface gráfica estática — embora um parâmetro também possa se tornar um menu suspenso por meio dos mesmos sinalizadores de referência/enum que um campo.
• Lista suspensa / lista suspensa dependente — field create e param create compartilham um conjunto idêntico de sinalizadores (--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 um valor a uma pesquisa em outro recurso Listar. --depends-on <parentField> é um atalho que gera o par de regras padrão exibir/ocultar para uma lista suspensa dependente (oculta até que o pai tenha um valor); --field-actions é a janela de escape JSON bruta para condições que --depends-on não podem expressar.
• Mesclar semântica — field create, param create (por meio de create or replace — veja abaixo) e method set se mesclam em uma entrada existente por padrão: as chaves que você passa ganha, as chaves que você omite são mantidas da definição existente e por A visibilidade do -method em um campo é mesclada profundamente. Portanto, adicionar visibilidade para um método nunca elimina a visibilidade de outro método. method set --replace é a única exceção — ele substitui toda a configuração do método, descartando qualquer coisa não aprovada (incluindo parâmetros e estado selecionado).
• Desdefinir um sinalizador de visibilidade — field create --method 'GET=!request' (observe o prefixo ! ) desativa explicitamente a visibilidade request para GET em uma mesclagem, em vez de deixá-la intacta. Sem o !, um sinalizador é sempre cumulativo.

uip é lista de atividades do connector builder

Lista element.json entradas de recurso, filtradas opcionalmente.

Opções

Long	Valor	Description
--method <method>	String	Filtrar pelo método HTTP (GET, POST,...).
--path <path>	String	Filtrar por caminho de recurso exato (por exemplo /accounts).
--connector-dir <path>	Path	Diretório do conector. Consulte Construtor de conectores → Conceitos para obter a ordem de resolução.

Exemplos

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

Formato dos dados (--output json)

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

uip é a atividade connectors builder get

Obtenha uma element.json entrada de recurso por nome, caminho ou um METHOD:/path seletor.

Argumentos

Name	Required	Finalidade
[name]	não	Nome do recurso, caminho ou seletor METHOD:/path (por exemplo accounts ou 'GET:/accounts'). Também pode ser passado como --name.

Opções

Long	Valor	Description
--name <name>	String	Alternativa ao argumento posicional, para paridade com create/field get/param get.
--connector-dir <path>	Path	Diretório do conector.

Exemplos

uip is connectors builder activity get accounts
uip is connectors builder activity get 'GET:/accounts'

Formato dos dados (--output json)

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

atividade uip é connectors builder activity criar

Criar um recurso completo: um arquivo de recurso padrão mais uma entrada element.json por método. A nova execução em um --name existente é localizada e anexada em vez de ser substituída.

Opções

Long	Valor	Required	Description
--name <name>	String	sim	Nome do recurso (ssegundo o segmento de caminho).
--display-name <name>	String	não	Nome de exibição da interface gráfica. O padrão é --name.
--vendor-path <path>	String	não	Caminho da API do fornecedor. O padrão é /{name}.
--resource-path <path>	String	não	Caminho explícito do recurso, quando ele difere do caminho do fornecedor.
--methods <csv>	csv	não	Métodos HTTP a serem criados. GET,GETBYID,POST,PATCH,DELETEPadrão.
--method-vendor-path <kv>	key=value, repetível	não	Substituição de caminho do fornecedor por método, por exemplo GET=/me/teams).
--primary-key <name>	String	não	Nome do campo de chave primária. idPadrão.
--no-body	Bandeira	não	Omita o parâmetro request-corpo adicionado automaticamente em POST/PUT/PATCH — para ações somente de caminho, como uma chamada de início/parar que precisa apenas de um ID no caminho.
--resource-type <type>	String	não	ResourceType valor (api, apiElementRequest,...). Padrão api.
--has-ceql	Bandeira	não	Habilite a filtragem CEQL em GET.
--has-events	Bandeira	não	Marcar o recurso como compatível com eventos.
--has-bulk	Bandeira	não	Habilite o suporte a download em massa.
--pagination-type <type>	String	não	Tipo de paginação para GET.
--root-key <key>	String	não	Chave raiz de resposta que contém os registros.
--next-page-key <key>	String	não	Chave de resposta que carrega o token da próxima página.
--filter-param <vendorName>	String	não	Nome do parâmetro de consulta do fornecedor para o qual o filtro CEQL mapeia. where Padrão (por exemplo sysparm_query para APIs no estilo do ServiceNow).
--page-size-param <vendorName>	String	não	Nome do parâmetro de consulta do fornecedor para o tamanho da página. pageSize Padrão (por exemplo sysparm_limit, per_page).
--offset-param <vendorName>	String	não	Nome do parâmetro de consulta do fornecedor para deslocamento de linha/número de página (por exemplo sysparm_offset, page).
--next-resource <selector>	String	não	Cadeia para um próximo recurso (por exemplo 'GET:/organization').
--curated-metadata <json>	JSON	não	Metadados selecionados por método, em linha. mutuamente exclusivo com --curated-metadata-file.
--curated-metadata-file <path>	Path	não	Metadados selecionados por método de um arquivo.
--fields <json>	JSON	não	Especificações de campo como uma matriz JSON embutida. mutuamente exclusivo com --fields-file. Consulte activity field schema para o formato.
--fields-file <path>	Path	não	Especificações de campo de um arquivo JSON.
--skip-sr	Bandeira	não	Ignorar a criação de arquivos de recurso padrão.
--no-curate	Bandeira	não	Não selecione métodos automaticamente em atividades independentes do Studio. O padrão é selecionar.
--overwrite-fields	Bandeira	não	Ao anexar a um recurso existente, deixe que as definições de campos de entrada ganharem em uma conflito de nomes. Padrão mantém a definição existente.
--connector-dir <path>	Path	não	Diretório do conector.

Passar --fields e --fields-file (ou ambos --curated-metadata e --curated-metadata-file) é um erro. A carga --fields/--fields-file é validada e normalizada antes que qualquer coisa seja escrita, então uma especificação de campo malformada falha rapidamente com um erro preciso em vez de criar silenciosamente um arquivo de recurso padrão quebrado.

Exemplos

# 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

Formato dos dados (--output json)

{
  "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 é exclusão da atividade connectors builder

Remover um recurso: cada entrada element.json correspondente e seu arquivo de recurso padrão.

Argumentos

Name	Required	Finalidade
<name>	sim	Nome do recurso.

Opções

Long	Valor	Description
--connector-dir <path>	Path	Diretório do conector.

Exemplo

uip is connectors builder activity delete accounts

Formato dos dados (--output json)

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

Isso remove um recurso inteiro. Para remover um único método, edite o restritor de recursos com activity method set --replace ou exclua e re-create com uma lista --methods reduzida — não há nenhuma lista dedicada "remover um método" verbo.

---

Campo de atividade

Gerenciar os campos de recurso padrão de um recurso — sua forma voltado para a interface do usuário.

uip é esquema de campo da atividade do connector builder

Imprimir o esquema de especificação do campo (chaves permitidas, tipos, visibilidade) mais um exemplo válido para criar cargas úteis --fields/--fields-file em activity create ou activity field create. Não precisa de conector — esse é um comando de referência estático e independente de conector.

Nenhum argumento ou opção além dos globais.

Exemplo

uip is connectors builder activity field schema

Formato dos dados (--output json)

Retornado com suas chaves minúsculas nativas (não PascalCased), para que a example matriz seja diretamente copiada-colada-autorizada:

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

A lista de chaves completa (da origem) também inclui nativeType, description, sampleValue, format, mask (uma string padrão de formato de data/número, por exemplo "yyyy-MM-dd'T'HH:mm:ssZ" — não é um booleano), design, methods (alias para method, não ambos), enum, enhancedEnum, reference, sortOrder, searchableNames, defaultValue, custom, order, isCuratedEventField, isPriority, key e fieldActions.

uip é lista de campos da atividade connectors builder

Lista todos os campos no recurso padrão de um recurso.

Opções

Long	Valor	Required	Description
--resource <name>	String	sim	Nome do recurso.
--connector-dir <path>	Path	não	Diretório do conector.

Exemplo

uip is connectors builder activity field list --resource accounts

Formato dos dados (--output json)

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

campo de atividade uip é connectors builder build

Leia um campo por nome.

Argumentos

Name	Required	Finalidade
[name]	não	Nome do campo (ou transmita --name).

Opções

Long	Valor	Required	Description
--resource <name>	String	sim	Nome do recurso.
--name <name>	String	não	Alternativa ao argumento posicional.
--connector-dir <path>	Path	não	Diretório do conector.

Exemplo

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

Formato dos dados (--output json)

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

uip é connectors builder activity campo criar

Criar ou atualizar um campo no recurso padrão de um recurso. A nova execução em um campo existente mescla: as chaves de nível superior que você passa ganha, as chaves não especificadas são mantidas e a visibilidade por método é mesclada profunda, para que a adição da visibilidade de um método nunca perca a de outro método.

Não para adicionar um parâmetro de solicitação de runtime — use activity param create para isso.

Opções

Long	Valor	Required	Description
--resource <name>	String	sim	Nome do recurso.
--name <name>	String	sim	Nome do campo (torna-se a chave do mapa fields).
--type <type>	String	não*	Tipo de campo (string, integer,...). Obrigatório para um campo New; opcional ao mesclar em um arquivo existente.
--native-type <type>	String	não	Nome do tipo nativo do fornecedor. O padrão é --type.
--display-name <name>	String	não	Nome de exibição da interface gráfica.
--description <text>	String	não	Descrição do campo.
--sample-value <value>	String	não	Valor de amostra mostrado no designer.
--format <format>	String	não	Dica de formato de campo (por exemplo date-time, int32).
--enum <json>	JSON	não	Valores permitidos — bare ["a","b"] ou [{"value":"a"}].
--enhanced-enum <json>	JSON	não	Opções rotuladas: [{"name":"Label","value":"V"}].
--reference <json>	JSON	não	Pesquisa dinâmica como JSON. Por exemplo {"objectName":"users","path":"/users","lookupValue":"id","lookupNames":["name"]}).
--reference-object <name>	String	não	Lista suspensa: o nome do objeto do recurso da Lista de destino (por exemplo teams).
--reference-path <path>	String	não	Lista suspensa: o caminho do recurso da lista (por exemplo /teams). Use {parent} para um menu suspenso dependente, por exemplo /teams/{team_id}/channels).
--lookup-value <field>	String	não	Lista suspensa: o campo enviado como o valor.
--lookup-names <csv>	csv	não	Lista suspensa: campos candidatos a exibição para o padrão de exibição.
--display-pattern <pattern>	String	não	Lista suspensa: modelo de rótulo visível, por exemplo "{displayName}" ou."{name} - {id}"
--filter-pattern <pattern>	String	não	Lista suspensa: modelo de filtro de digitação avançada no lado do servidor com {filter}.
--load-by-default	Bandeira	não	Lista suspensa: preencha a lista ao abrir.
--multi-select	Bandeira	não	Lista suspensa: permite selecionar vários valores.
--enable-user-override	Bandeira	não	Lista suspensa: permite que o usuário digite um valor bruto em vez de escolher.
--depends-on <parent>	String	não	Lista suspensa dependente: oculte até que <parent> tenha um valor (gera o par de regras exibir/ocultar). O caminho de referência deve conter {<parent>}.
--field-actions <json>	JSON	não	Mostrar/ocultar/regras obrigatórias como JSON — portal de escape além de --depends-on.
--default-value <value>	escalar ou JSON	não	Valor padrão.
--mask <pattern>	String	não	Padrão de formato de data/número, por exemplo "yyyy-MM-dd'T'HH:mm:ssZ").
--primary-key	Bandeira	não	Marcar o campo como chave primária.
--sort-order <n>	Número inteiro	não	Ordem de classificação.
--searchable	Bandeira	não	Marcar o campo como pesquisável.
--searchable-operators <csv>	csv	não	Operadores pesquisáveis.
--searchable-names <csv>	csv	não	Nomes alternativos para corresponder nas consultas.
--method <method>	string, repetível	não	Método HTTP ao qual os sinalizadores de visibilidade se aplicam. Duas formas, mistas: uniforme (--method GET --method POST --response aplica os mesmos sinalizadores a ambos) ou em linha por método (--method 'GET=response' --method 'POST=request,required'). Prefixe um sinalizador com ! para remover sua definição em uma mesclagem. Por exemplo --method 'GET=!request').
--request	Bandeira	não	O campo faz parte da solicitação, para cada --method.
--response	Bandeira	não	O campo faz parte da resposta, para cada --method.
--required	Bandeira	não	O campo é obrigatório para cada --method.
--request-curated	Bandeira	não	O campo é selecionado por solicitação, para cada --method.
--response-curated	Bandeira	não	O campo é selecionado por resposta, para cada --method.
--design-position <position>	primary|secondary|none	não	Posição do projeto.
--component <component>	String	não	Substituição do componente de design.
--hidden	Bandeira	não	Oculte o campo no designer.
--connector-dir <path>	Path	não	Diretório do conector.

Os tokens de visibilidade por método em linha são: request, response, required, requestCurated (ou request-curated), responseCurated (ou response-curated). Um token não reconhecido falha com um erro explícito listando o conjunto válido.

Exemplos

# 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

Formato dos dados (--output json)

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

uip é conexão do campo de atividade connectors builder

Remova um campo por nome.

Argumentos

Name	Required	Finalidade
[name]	não	Nome do campo (ou transmita --name).

Opções

Long	Valor	Required	Description
--resource <name>	String	sim	Nome do recurso.
--name <name>	String	não	Alternativa ao argumento posicional.
--connector-dir <path>	Path	não	Diretório do conector.

Exemplo

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

Formato dos dados (--output json)

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

---

Método da Atividade

Gerencie a configuração de recurso padrão de um recurso por método: rótulo da operação, caminho interno, estado de seleção.

uip é connectors builder activity método obter

Leia a configuração do recurso padrão de um método.

Opções

Long	Valor	Required	Description
--resource <name>	String	sim	Nome do recurso.
--method <method>	String	sim	Método HTTP (GET, POST,...).
--connector-dir <path>	Path	não	Diretório do conector.

Exemplo

uip is connectors builder activity method get --resource accounts --method GET

Formato dos dados (--output json)

{
  "Code": "Method",
  "Data": { "Resource": "accounts", "Method": "GET", "VendorPath": "/accounts", "Config": {} }
}

VendorPath é exibido separadamente porque a configuração de recurso padrão contém apenas o caminho interno — o roteamento voltado para o fornecedor reside em element.json.

conjunto do método de atividade uip é connectors builder

Criar ou editar a configuração do recurso padrão de um método. Mescla os sinalizadores que você passa na configuração existente por padrão; em--replace vez disso, substitui o bloco inteiro.

Opções

Long	Valor	Required	Description
--resource <name>	String	sim	Nome do recurso.
--method <method>	String	sim	Método HTTP.
--operation <operation>	String	não	Rótulo da operação (List, Retrieve,...).
--operation-id <id>	String	não	Identificador da operação.
--description <text>	String	não	Descrição do método.
--path <path>	String	não	Caminho do método de recurso padrão.
--hidden	Bandeira	não	Oculte o método do designer.
--has-ceql	Bandeira	não	Habilite o CEQL neste método.
--response-display-name <name>	String	não	Nome de exibição da resposta.
--response-description <text>	String	não	Descrição da resposta.
--replace	Bandeira	não	Substitua toda a configuração do método em vez de mesclar. Exclui os parâmetros/estado selecionado não aprovado novamente.
--connector-dir <path>	Path	não	Diretório do conector.

Exemplo

uip is connectors builder activity method set --resource accounts --method GET \
  --operation List --path /accounts --has-ceql

Formato dos dados (--output json)

{ "Code": "MethodSet", "Data": { "Resource": "accounts", "Method": "GET", "Outcome": "updated" } }

curadoria do método de atividade do UiPath connectors Builder

Promover um método para uma atividade independente do Studio.

Opções

Long	Valor	Required	Description
--resource <name>	String	sim	Nome do recurso.
--method <method>	String	sim	Método HTTP.
--display-name <name>	String	sim	Nome de exibição da atividade do Studio.
--name <name>	String	não	Identificador da atividade. O padrão é o nome de exibição.
--description <text>	String	não	Descrição da atividade.
--hidden	Bandeira	não	Ocultar a atividade.
--connector-dir <path>	Path	não	Diretório do conector.

Apenas os sinalizadores que você realmente passa são enviados — uma chamada somente nome de exibição se mescla no bloco selecionado existente em vez de redefinir o identificador ou em branco a descrição.

Exemplo

uip is connectors builder activity method curate --resource accounts --method GET \
  --display-name 'List Accounts'

Formato dos dados (--output json)

{ "Code": "MethodCurated", "Data": { "Resource": "accounts", "Method": "GET", "Curated": {} } }

---

Parâmetro da atividade

Gerencie os parâmetros de runtime de um método de recurso em element.json (espelhado para o recurso-padrão).

uip é a lista de parâmetros da atividade do connector builder

Opções

Long	Valor	Required	Description
--resource <name>	String	sim	Nome do recurso.
--method <method>	String	sim	Método HTTP.
--connector-dir <path>	Path	não	Diretório do conector.

Exemplo

uip is connectors builder activity param list --resource accounts --method GET

Formato dos dados (--output json)

{ "Code": "ParamList", "Data": { "Resource": "accounts", "Method": "GET", "Parameters": [] } }

uip é connectors builder activity param get

Opções

Long	Valor	Required	Description
--resource <name>	String	sim	Nome do recurso.
--method <method>	String	sim	Método HTTP.
--name <name>	String	sim	Nome do parâmetro.
--connector-dir <path>	Path	não	Diretório do conector.

Exemplo

uip is connectors builder activity param get --resource accounts --method GET --name where

Formato dos dados (--output json)

{ "Code": "Param", "Data": { "Resource": "accounts", "Method": "GET", "Param": {} } }

uip é connectors builder activity Param criar

Criar ou substituir um parâmetro em um método de recurso.

Opções

Long	Valor	Required	Description
--resource <name>	String	sim	Nome do recurso.
--method <method>	String	sim	Método HTTP.
--name <name>	String	sim	Nome do parâmetro.
--vendor-name <name>	String	não	Nome do parâmetro do lado do fornecedor.
--type <type>	String	sim	Tipo de parâmetro — execute param create --help para o catálogo de tipos completo, proveniente do registro de tipo de parâmetro da CLI (--type aceita, entre outros, valores como um tipo escalar simples ou value/configuration para constantes e 1:1 mapas de configuração — prefira um tipo declarativo aqui a escrever um hook).
--vendor-type <type>	String	não	Tipo de parâmetro do lado do fornecedor.
--data-type <type>	String	não	Tipo de dados (string, integer,...).
--vendor-data-type <type>	String	não	Tipo de dados do lado do fornecedor.
--source <source>	String	não	Origem do parâmetro (request, response).
--required	Bandeira	não	Marque o parâmetro como necessário.
--description <text>	String	não	Descrição do parâmetro.
--display-name <name>	String	não	Nome de exibição da interface gráfica.
--sort-order <n>	Número inteiro	não	Ordem de classificação.
--enum <json>	JSON	não	Valores permitidos, mesmo formato que field create --enum — um parâmetro de consulta/corpo pode ser uma combinação estática.
--enhanced-enum <json>	JSON	não	Opções rotuladas, com o mesmo formato de 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	—	não	Sinalizadores suspensos idênticos/dependentes como field create — consulte a seção acima. Um caminho ou parâmetro de consulta também pode ser um menu suspenso.
--design-position <position>	primary|secondary|none	não	Posição do projeto.
--hidden	Bandeira	não	Oculte o parâmetro no designer.
--connector-dir <path>	Path	não	Diretório do conector.

--type é realmente necessário; seus valores exatos permitidos vêm do próprio registro de tipo de parâmetro da CLI e são impressos por completo por param create --help, portanto, esta página não codifica uma lista que dataria do registro enviado.

Exemplo

uip is connectors builder activity param create --resource accounts --method GET \
  --name status --type query --data-type string

Formato dos dados (--output json)

{
  "Code": "ParamWritten",
  "Data": {
    "Resource": "accounts",
    "Method": "GET",
    "ParamName": "status",
    "Param": { "name": "status", "type": "query" },
    "Outcome": "created",
    "SrSynced": true
  }
}

Warnings está presente apenas quando a gravação produziu algum.

uip é excluir parâmetro da atividade connectors builder

Opções

Long	Valor	Required	Description
--resource <name>	String	sim	Nome do recurso.
--method <method>	String	sim	Método HTTP.
--name <name>	String	sim	Nome do parâmetro.
--connector-dir <path>	Path	não	Diretório do conector.

Exemplo

uip is connectors builder activity param delete --resource accounts --method GET --name status

Formato dos dados (--output json)

{
  "Code": "ParamRemoved",
  "Data": { "Resource": "accounts", "Method": "GET", "ParamName": "status", "SrSynced": true }
}

Relacionado

• Construtor de conectores — conceitos e os quatro verbos do ciclo de vida do tenant.
• Gatilhos de atividades — Transformações pré/pós-solicitação do JavaScript anexadas a um recurso ou global.
• Inicialização e conector — estrutura o conector em que esta atividade está localizada.
• Autenticação — configure o esquema de autenticação do conector, incluindo recursos do ciclo de vida/sistema.
• Gatilho e estado — gatilhos de eventos e edições de arquivo de elementos de baixo nível.

Veja também

• Visão geral da ferramenta do Integration Service
• Opções globais
• Códigos de saída