uip est une activité de générateur de connecteurs

Syntaxe et options de création des activités d'un connecteur — ressources, champs, méthodes et paramètres — avec le générateur de connecteurs Integration Service.

uip is connectors builder activity crée les activités d'un connecteur: les points de terminaison d'API (appelés ressources dans le fichier de ressources standard) qui deviennent les activités Studio, avec leurs champs, méthodes et paramètres. Il s'agit du domaine le plus volumineux et le plus détaillé du générateur de connecteurs — voir Générateur de connecteurs pour les concepts partagés (résolution vers annuaire de connecteurs, conception vs. publication, flux de création typique) qui s'appliquent également.

Les hooks - Transformations JavaScript pré/post-requête associées à une ressource ou global — sont un sous-groupe activity hook imbriqué, documenté séparément dans les hooks d'activité en raison de leur propre taille et de la quantité de détails du contexte de runtime dont ils ont besoin.

Remarque :

activity create n'est pas pour les points de terminaison du cycle de vie tels que auth-validation ou onProvision — il s'agit de ressources système créées avec builder auth system create (voir Authentification). activity correspond aux opérations régulières et destinées à l'utilisateur du connecteur.

Synthèse

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

Concepts

• Ressource — une entrée de point de terminaison d'API dans element.json, identifiée par nom, chemin ou un sélecteur METHOD:/path (par exemple GET:/accounts). activity create est une opération de recherche ou d'ajout : sa réexécution sur un nom de ressource existant ajoute de nouvelles méthodes/champs au lieu d'écraser la ressource.
• Champ — une propriété orientée interface utilisateur sur une ressource, stockée dans le fichier de ressources standard de la ressource. Un champ porte une visibilité par méthode HTTP (fait partie du corps de la demande, la réponse est-elle requise) plus des métadonnées de conception facultatives pour le rendu (liste déroulante, liste déroulante dépendante, masquée, ordre de tri).
• Méthode — la configuration des ressources standard par méthode HTTP pour une ressource: son libellé d'opération, son chemin interne, son état de sélection et sa description. activity method curate promouvoir une méthode dans une activité Studio autonome.
• Param — un paramètre de requête de runtime (requête, chemin, en-tête ou corps) stocké dans element.json et mis en miroir dans le SR. Contrairement aux champs, les paramètres décrivent comment une valeur atteint l'appel d'API du fournisseur, et non comment elle s'affiche en tant que propriété d'interface utilisateur statique — bien qu'un paramètre puisse également devenir une liste déroulante via les mêmes indicateurs de référence/enum qu'un champ.
• Liste déroulante / liste déroulante dépendante - field create et param create partagent un ensemble identique d'indicateurs (--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) pour connecter une valeur à une recherche par rapport à une autre ressource de liste. --depends-on <parentField> est un raccourci qui génère la paire de règles d'affichage/de masquage standard pour une liste déroulante dépendante (masquée jusqu'à ce que le parent ait une valeur); --field-actions est le panneau d’échappement JSON brut pour les conditions que --depends-on ne peut pas exprimer.
• Fusionner la sémantique — field create, param create (via create or replace — voir ci-dessous) et method set sont tous fusionnés dans une entrée existante par défaut: les clés que vous réussissez, les clés que vous omettez sont conservées dans la définition existante et par La visibilité de la méthode sur un champ est fusionnée en profondeur, de sorte que l’ajout de la visibilité pour une méthode n’entraîne jamais la visibilité de l’autre méthode. method set --replace est la seule exception. Elle écrase l'ensemble de la configuration de la méthode et supprime tout ce qui n'est pas transmis (y compris les paramètres et l'état sélectionné).
• Désactivation d'un indicateur de visibilité - field create --method 'GET=!request' (notez le préfixe ! ) désactive explicitement la visibilité request pour GET lors d'une fusion, plutôt que de la laisser inchangée. Sans !, un indicateur n'est jamais cumulé.

uip est une liste d'activités du générateur de connecteurs

Répertoriez element.json entrées de ressource, filtrées éventuellement.

Options

Long	Valeur (Value)	Description
--method <method>	string	Filtrer par méthode HTTP (GET, POST,...).
--path <path>	string	Filtrer par chemin de ressource exact (par exemple /accounts).
--connector-dir <path>	Chemin d'accès	Répertoire des connecteurs. Voir Générateur de connecteurs → Concepts pour l'ordre de résolution.

Exemples

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

Format des données (--sortie json)

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

uip est l'activité du générateur de connecteurs

Obtenez une element.json entrée de ressource, par nom, par chemin ou par un sélecteur METHOD:/path.

Arguments

Nom	Requis	Objectif
[name]	non	Nom, chemin d'accès ou sélecteur de METHOD:/path de la ressource (par exemple, accounts ou 'GET:/accounts'). Peut également être transmis par --name.

Options

Long	Valeur (Value)	Description
--name <name>	string	Alternative à l’argument de position, pour la parité avec create/field get/param get.
--connector-dir <path>	Chemin d'accès	Répertoire des connecteurs.

Exemples

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

Format des données (--sortie json)

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

uip est la création d'une activité de générateur de connecteurs

Créez une ressource complète: un fichier de ressource standard plus une entrée element.json par méthode. La réexécution sur une base --name existante permet de trouver et d'ajouter des éléments plutôt que de l'écraser.

Options

Long	Valeur (Value)	Requis	Description
--name <name>	string	oui	Nom de la ressource (segment de chemin).
--display-name <name>	string	non	Nom complet de l'interface utilisateur. La valeur par défaut est --name.
--vendor-path <path>	string	non	Chemin de l’API fournisseur. La valeur par défaut est /{name}.
--resource-path <path>	string	non	Chemin de ressource explicite, lorsqu’il diffère du chemin du fournisseur.
--methods <csv>	csv	non	Méthodes HTTP à créer. Par défaut GET,GETBYID,POST,PATCH,DELETE.
--method-vendor-path <kv>	key=value, répétable	non	Remplacement du chemin du fournisseur par méthode, par exemple GET=/me/teams.
--primary-key <name>	string	non	Nom du champ de clé principal. Par défaut id.
--no-body	Drapeau	non	Omettez le paramètre de corps de requête ajouté automatiquement sur POST/PUT/PATCH — pour les actions de chemin d'accès uniquement comme un appel de démarrage/arrêt qui ne nécessite qu'un identifiant dans le chemin d'accès.
--resource-type <type>	string	non	ResourceType (api, apiElementRequest,...). Par défaut api.
--has-ceql	Drapeau	non	Activez le filtrage CEQL sur GET.
--has-events	Drapeau	non	Marquez la ressource comme étant capable d’événements.
--has-bulk	Drapeau	non	Activez la prise en charge du téléchargement en bloc.
--pagination-type <type>	string	non	Type de pagination pour GET.
--root-key <key>	string	non	Clé racine de réponse contenant les enregistrements.
--next-page-key <key>	string	non	Clé de réponse portant le jeton de page suivant.
--filter-param <vendorName>	string	non	Nom de la requête du fournisseur auquel le filtre CEQL correspond. where par défaut (par exemple sysparm_query pour les API de style ServiceNow).
--page-size-param <vendorName>	string	non	Nom du paramètre de requête du fournisseur pour la taille de la page. pageSize par défaut (par exemple sysparm_limit, per_page).
--offset-param <vendorName>	string	non	Nom du paramètre de requête du fournisseur pour le décalage de ligne/numéro de page (par exemple sysparm_offset, page).
--next-resource <selector>	string	non	Chaîner vers une ressource suivante (par exemple 'GET:/organization').
--curated-metadata <json>	JSON	non	Métadonnées sélectionnées par méthode, en ligne. Capture mutuellement exclusive avec --curated-metadata-file.
--curated-metadata-file <path>	Chemin d'accès	non	Métadonnées sélectionnées par méthode, à partir d'un fichier.
--fields <json>	JSON	non	Le champ se présente sous la forme d'un tableau JSON en ligne. Capture mutuellement exclusive avec --fields-file. Voir activity field schema pour la forme.
--fields-file <path>	Chemin d'accès	non	Spécifications de champ d'un fichier JSON.
--skip-sr	Drapeau	non	Ignorez la création du fichier de ressources standard.
--no-curate	Drapeau	non	Ne sélectionnez pas de méthodes de sélection automatique dans des activités Studio autonomes. La valeur par défaut consiste à sélectionner.
--overwrite-fields	Drapeau	non	Lors de l'ajout à une ressource existante, laissez les définitions de champs entrantes l'avantager sur une conflit de nom. La valeur par défaut conserve la définition existante.
--connector-dir <path>	Chemin d'accès	non	Répertoire des connecteurs.

La transmission à la fois de --fields et --fields-file (ou à la fois de --curated-metadata et --curated-metadata-file) est une erreur. La charge utile --fields/--fields-file est validée et normalisée avant que quoi que ce soit d’écrit, une spécification de champ mal formée échoue rapidement avec une erreur précise au lieu de créer en mode silencieux un fichier de ressources standard endommagé.

Exemples

# 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

Format des données (--sortie 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 est la suppression de l'activité du générateur de connecteurs

Supprimer une ressource: chaque entrée element.json correspondante et son fichier de ressources standard.

Arguments

Nom	Requis	Objectif
<name>	oui	Nom de la ressource.

Options

Long	Valeur (Value)	Description
--connector-dir <path>	Chemin d'accès	Répertoire des connecteurs.

Exemple

uip is connectors builder activity delete accounts

Format des données (--sortie json)

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

Cela supprime une ressource entière. Pour supprimer une seule méthode à la place, modifiez la ressource plus précisément avec activity method set --replace, ou supprimez-la etcreate avec une liste --methods réduite — il n’y a pas de « supprimer une méthode » dédiée verbe.

---

Champ d'activité

Gérer les champs de ressources standard d'une ressource, c'est-à-dire sa forme orientée vers l'interface utilisateur.

uip est un schéma de champ d'activité du générateur de connecteurs

imprimez le schéma spécifique au champ (clés autorisées, types, visibilité) ainsi qu’un exemple valide afin de créer les charges utiles --fields/--fields-file sur activity create ou activity field create. Ne nécessite aucun connecteur: il s’agit d’une commande de référence statique indépendante du connecteur.

Aucun argument ou option autre que global.

Exemple

uip is connectors builder activity field schema

Format des données (--sortie json)

Renvoyé avec ses clés minuscules natives (pas PascalCase), de sorte que le tableau example est directement modifiable-collable:

{
  "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 liste complète des clés (depuis la source) comprend également nativeType, description, sampleValue, format, mask (une chaîne de modèle au format date/nombre, par exemple "yyyy-MM-dd'T'HH:mm:ssZ" — ce n'est pas un booléen), design, methods (alias pour method, pas les deux), enum, enhancedEnum, reference, sortOrder, searchableNames, defaultValue, custom, order, isCuratedEventField, isPriority, key et fieldActions.

uip est une liste de champs d'activité du générateur de connecteurs

Répertoriez chaque champ dans la ressource standard d'une ressource.

Options

Long	Valeur (Value)	Requis	Description
--resource <name>	string	oui	Nom de la ressource.
--connector-dir <path>	Chemin d'accès	non	Répertoire des connecteurs.

Exemple

uip is connectors builder activity field list --resource accounts

Format des données (--sortie json)

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

uip est le champ d’activité du générateur de connecteurs

Lisez un champ par nom.

Arguments

Nom	Requis	Objectif
[name]	non	Nom du champ (ou saisissez --name).

Options

Long	Valeur (Value)	Requis	Description
--resource <name>	string	oui	Nom de la ressource.
--name <name>	string	non	Alternative à l’argument de position.
--connector-dir <path>	Chemin d'accès	non	Répertoire des connecteurs.

Exemple

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

Format des données (--sortie json)

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

uip est la création d'un champ d'activité du générateur de connecteurs

Créez ou mettez à jour un champ sur la ressource standard d'une ressource. La réexécution sur un champ existant fusionne: les clés de niveau supérieur que vous transmettez, les clés non spécifiées sont conservées et la visibilité par méthode est fusionnée en profondeur, de sorte que l’ajout de la visibilité d’une méthode n’interrompt jamais celle d’une autre méthode.

Pas pour ajouter un paramètre de requête de runtime — utilisez activity param create pour cela.

Options

Long	Valeur (Value)	Requis	Description
--resource <name>	string	oui	Nom de la ressource.
--name <name>	string	oui	Nom du champ (devient la clé de carte fields).
--type <type>	string	non*	Type de champ (string, integer,...). Obligatoire pour un nouveau champ; facultatif lors de la fusion dans une cellule existante.
--native-type <type>	string	non	Nom de type natif du fournisseur. La valeur par défaut est --type.
--display-name <name>	string	non	Nom complet de l'interface utilisateur.
--description <text>	string	non	Description des champs.
--sample-value <value>	string	non	Exemple de valeur affichée dans le concepteur.
--format <format>	string	non	Suggestion de format de champ (par ex. date-time, int32).
--enum <json>	JSON	non	Valeurs autorisées - barre de ["a","b"] ou [{"value":"a"}].
--enhanced-enum <json>	JSON	non	Options labellisées: [{"name":"Label","value":"V"}].
--reference <json>	JSON	non	Recherche dynamique en JSON, par ex. {"objectName":"users","path":"/users","lookupValue":"id","lookupNames":["name"]}.
--reference-object <name>	string	non	Liste déroulante: le nom de l'objet de la ressource de la liste cible (par exemple, teams).
--reference-path <path>	string	non	Liste déroulante: le chemin de la ressource de la liste (par exemple /teams). Utilisez {parent} pour une liste déroulante dépendante, par exemple /teams/{team_id}/channels.
--lookup-value <field>	string	non	Liste déroulante: le champ envoyé comme valeur.
--lookup-names <csv>	csv	non	Liste déroulante: champs candidats à l'affichage pour le modèle d'affichage.
--display-pattern <pattern>	string	non	Liste déroulante: modèle de libellé visible, par exemple "{displayName}" ou "{name} - {id}".
--filter-pattern <pattern>	string	non	Liste déroulante: modèle de filtre de type-tête côté serveur avec {filter}.
--load-by-default	Drapeau	non	Liste déroulante: remplissez la liste lorsqu'elle est ouverte.
--multi-select	Drapeau	non	Liste déroulante: permet de sélectionner plusieurs valeurs.
--enable-user-override	Drapeau	non	Liste déroulante: permettent à l'utilisateur de saisir une valeur brute au lieu de choisir.
--depends-on <parent>	string	non	Liste déroulante dépendante: masquer jusqu'à ce que <parent> ait une valeur (génère la paire de règles Afficher/Masquer). Le chemin de référence doit contenir {<parent>}.
--field-actions <json>	JSON	non	Afficher/masquer/requis au format JSON — heure d'échappement au-delà de --depends-on.
--default-value <value>	scale ou JSON	non	Valeur par défaut.
--mask <pattern>	string	non	Modèle de format date/nombre, par exemple "yyyy-MM-dd'T'HH:mm:ssZ".
--primary-key	Drapeau	non	Marquez le champ comme clé primaire.
--sort-order <n>	Integer	non	sortOrder.
--searchable	Drapeau	non	Marquez le champ comme étant consultable.
--searchable-operators <csv>	csv	non	Opérateurs consultables.
--searchable-names <csv>	csv	non	Les noms alternatifs à faire correspondre dans les requêtes.
--method <method>	chaîne, répétable	non	Méthode HTTP à laquelle les indicateurs de visibilité s'appliquent. Deux formulaires, mixtes: uniformes (--method GET --method POST --response applique les mêmes indicateurs aux deux) ou en ligne par méthode (--method 'GET=response' --method 'POST=request,required'). Préfixez un indicateur avec ! pour le désélectionner lors d'une fusion, par exemple --method 'GET=!request'.
--request	Drapeau	non	Le champ fait partie de la requête, pour chaque --method.
--response	Drapeau	non	Le champ fait partie de la réponse, pour chaque --method.
--required	Drapeau	non	Ce champ est obligatoire pour chaque --method.
--request-curated	Drapeau	non	Le champ est sélectionné par demande, pour chaque --method.
--response-curated	Drapeau	non	Le champ est sélectionné en fonction de la réponse, pour chaque --method.
--design-position <position>	primary|secondary|none	non	Position de conception
--component <component>	string	non	Remplacement du composant de conception.
--hidden	Drapeau	non	Masquez le champ dans le concepteur.
--connector-dir <path>	Chemin d'accès	non	Répertoire des connecteurs.

Les jetons de visibilité par méthode en ligne sont: request, response, required, requestCurated (ou request-curated), responseCurated (ou response-curated). Un jeton non reconnu échoue avec une erreur explicite répertoriant l’ensemble valide.

Exemples

# 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

Format des données (--sortie json)

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

uip est la suppression du champ d'activité du générateur de connecteurs

Supprimez un champ par nom.

Arguments

Nom	Requis	Objectif
[name]	non	Nom du champ (ou saisissez --name).

Options

Long	Valeur (Value)	Requis	Description
--resource <name>	string	oui	Nom de la ressource.
--name <name>	string	non	Alternative à l’argument de position.
--connector-dir <path>	Chemin d'accès	non	Répertoire des connecteurs.

Exemple

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

Format des données (--sortie json)

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

---

Méthode d'activité

Gérer la configuration des ressources standard par méthode d’une ressource: libellé d’opération, chemin interne, état de sélection.

uip est la méthode d’activité du générateur de connecteurs

Lire la configuration des ressources standard d'une méthode.

Options

Long	Valeur (Value)	Requis	Description
--resource <name>	string	oui	Nom de la ressource.
--method <method>	string	oui	Méthode HTTP (GET, POST,...).
--connector-dir <path>	Chemin d'accès	non	Répertoire des connecteurs.

Exemple

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

Format des données (--sortie json)

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

VendorPath est affiché séparément car la configuration des ressources standard ne contient que le chemin interne - le routage orienté vers le fournisseur réside dans element.json.

uip est un ensemble de méthodes d'activité générateur de connecteurs

Créez ou modifiez la configuration des ressources standard d'une méthode. Fusionne les indicateurs que vous transmettez à la configuration existante par défaut; --replace écrase l'ensemble du bloc à la place.

Options

Long	Valeur (Value)	Requis	Description
--resource <name>	string	oui	Nom de la ressource.
--method <method>	string	oui	Méthode HTTP.
--operation <operation>	string	non	Libellé d'opération (List, Retrieve,...).
--operation-id <id>	string	non	Identificateur d'opération.
--description <text>	string	non	Description de la méthode.
--path <path>	string	non	Chemin de la méthode de ressource standard.
--hidden	Drapeau	non	Masquez la méthode du concepteur.
--has-ceql	Drapeau	non	Activez CEQL pour cette méthode.
--response-display-name <name>	string	non	Nom complet de la réponse.
--response-description <text>	string	non	Description de la réponse.
--replace	Drapeau	non	Écrasez l’ensemble de la configuration de la méthode au lieu de la fusion. Dépasse les paramètres/états sélectionnés.
--connector-dir <path>	Chemin d'accès	non	Répertoire des connecteurs.

Exemple

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

Format des données (--sortie json)

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

uip est une méthode d'activité du générateur de connecteurs sélectionnée

Promouvoir une méthode vers une activité Studio autonome.

Options

Long	Valeur (Value)	Requis	Description
--resource <name>	string	oui	Nom de la ressource.
--method <method>	string	oui	Méthode HTTP.
--display-name <name>	string	oui	Nom complet de l'activité Studio.
--name <name>	string	non	Identificateur d'activité. Par défaut, le nom complet.
--description <text>	string	non	Description de l'activité.
--hidden	Drapeau	non	Masquez l’activité.
--connector-dir <path>	Chemin d'accès	non	Répertoire des connecteurs.

Seuls les indicateurs que vous transmettez réellement sont envoyés - un appel en nom d'affichage uniquement fusionne dans le bloc sélectionné existant plutôt que de réinitialiser l'identifiant ou d'effacer la description.

Exemple

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

Format des données (--sortie json)

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

---

paramètre d'activité

Gérez les paramètres de runtime d’une méthode de ressource dans element.json ( miroir à la ressource standard ).

uip est une liste de paramètres d'activité du générateur de connecteurs

Options

Long	Valeur (Value)	Requis	Description
--resource <name>	string	oui	Nom de la ressource.
--method <method>	string	oui	Méthode HTTP.
--connector-dir <path>	Chemin d'accès	non	Répertoire des connecteurs.

Exemple

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

Format des données (--sortie json)

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

uip est un paramètre d’activité du générateur de connecteurs

Options

Long	Valeur (Value)	Requis	Description
--resource <name>	string	oui	Nom de la ressource.
--method <method>	string	oui	Méthode HTTP.
--name <name>	string	oui	Nom du paramètre.
--connector-dir <path>	Chemin d'accès	non	Répertoire des connecteurs.

Exemple

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

Format des données (--sortie json)

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

uip est la création d'un paramètre d'activité du générateur de connecteurs

Créez ou remplacez un paramètre sur une méthode de ressource.

Options

Long	Valeur (Value)	Requis	Description
--resource <name>	string	oui	Nom de la ressource.
--method <method>	string	oui	Méthode HTTP.
--name <name>	string	oui	Nom du paramètre.
--vendor-name <name>	string	non	Nom du paramètre côté fournisseur.
--type <type>	string	oui	Type de paramètre — exécutez param create --help pour le catalogue de types complet, provenant du registre de types de paramètres de la CLI (--type accepte, entre autres, des valeurs comme un type scalaire simple ou value/configuration pour les constantes et 1:1 configmaps - préférez un type déclaratif ici pour écrire un hook).
--vendor-type <type>	string	non	Type de paramètre côté fournisseur.
--data-type <type>	string	non	Type de données (string, integer,...).
--vendor-data-type <type>	string	non	Type de données côté fournisseur.
--source <source>	string	non	Source des paramètres (request, response).
--required	Drapeau	non	Marquez le paramètre comme obligatoire.
--description <text>	string	non	Description du paramètre.
--display-name <name>	string	non	Nom complet de l'interface utilisateur.
--sort-order <n>	Integer	non	sortOrder.
--enum <json>	JSON	non	Valeurs autorisées, même forme que field create --enum — un paramètre requête/corps peut être une combinaison statique.
--enhanced-enum <json>	JSON	non	Options labellisées, même forme 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	—	non	Indicateurs déroulant/dépendants identiques en tant que field create — voir cette section ci-dessus. Un chemin ou un paramètre de requête peut également être une liste déroulante.
--design-position <position>	primary|secondary|none	non	Position de conception
--hidden	Drapeau	non	Masquez le paramètre dans le concepteur.
--connector-dir <path>	Chemin d'accès	non	Répertoire des connecteurs.

--type est réellement requis; ses valeurs exactes autorisées proviennent du propre registre de types de paramètres de la CLI et sont entièrement imprimés par param create --help, de sorte que cette page ne code pas en dur une liste qui dériverait du registre livré.

Exemple

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

Format des données (--sortie json)

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

Warnings est présent uniquement lorsque l'écriture en a produit.

uip est la suppression du paramètre d'activité du générateur de connecteurs

Options

Long	Valeur (Value)	Requis	Description
--resource <name>	string	oui	Nom de la ressource.
--method <method>	string	oui	Méthode HTTP.
--name <name>	string	oui	Nom du paramètre.
--connector-dir <path>	Chemin d'accès	non	Répertoire des connecteurs.

Exemple

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

Format des données (--sortie json)

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

Associé

• Générateur de connecteurs - concepts et les quatre verbes du cycle de vie du locataire.
• Points d'activité hooks - Transformations pré/post-requête JavaScript associées à une ressource ou globale.
• Init & connector - élaboration du connecteur dans lequel se trouve cette activité.
• Authentification : configurez le schéma d’authentification du connecteur, y compris les ressources de cycle de vie/système.
• Déclencheur et état — déclencheurs d'événements et modifications de fichiers d'éléments de bas niveau.

Voir également

• Présentation de l’outil Integration Service
• Options globales
• Codes de sortie