Aktivität „uip ist Connectors Builder“.

Syntax und Optionen zum Erstellen der Aktivitäten eines Connectors – Ressourcen, Felder, Methoden und Parameter – mit dem Integration Service-Connector-Generator.

uip is connectors builder activity erstellt die Aktivitäten eines Connectors: die API-Endpunkte (in der Standardressourcendatei als Ressourcen bezeichnet), die zu Studio-Aktivitäten werden, zusammen mit ihren Feldern, Methoden und Parametern. Dies ist die größte und detaillierteste Domäne im Connector-Generator – siehe Connector-Builder für die gemeinsam genutzten Konzepte (Connector-Verzeichnisauflösung, Design vs. veröffentlicht, der typische Erstellungsablauf), die auch hier gelten.

Hooks – JavaScript-Transformationen vor/nach der Anforderung, die an eine Ressource oder global angehängt sind – sind eine verschachtelte activity hook -Untergruppe, die aufgrund ihrer eigenen Größe und des Umfangs der benötigten Runtime-Kontextdetails separat für Aktivitätshooks dokumentiert wird.

Hinweis:

activity create ist nicht für Lebenszyklusendpunkte wie Authentifizierungsvalidierung oder onProvision – das sind Systemressourcen, die mit builder auth system create erstellt wurden (siehe Auth). activity ist für die regulären, benutzerorientierten Vorgänge des Connectors vorgesehen.

Zusammenfassung

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

Konzepte

• Ressource – Ein API-Endpunkteintrag in element.json, der durch Name, Pfad oder ein METHOD:/path -Selektor identifiziert wird (z. B GET:/accounts). activity create ist ein Such- oder Anfügevorgang : Wenn er erneut für einen vorhandenen Ressourcennamen ausgeführt wird, werden neue Methoden/Felder angefügt, anstatt die Ressource zu überschreiben.
• Feld – eine UI-seitige Eigenschaft auf einer Ressource, die in der Standard-Ressourcen-Datei (SR) der Ressource gespeichert ist. Ein Feld bietet eine Sichtbarkeit pro HTTP-Methode (ist es Teil des Anforderungstexts, die Antwort, ist sie erforderlich) sowie optionale Designmetadaten dafür, wie es gerendert wird (Dropdown-Menü, abhängiges Dropdown-Menü, ausgeblendet, Sortierreihenfolge).
• Methode – die Standardressourcenkonfiguration pro HTTP-Methode für eine Ressource: ihre Vorgangsbeschriftung, der interne Pfad, der Kuratierungsstatus und die Beschreibung. activity method curate stufen eine Methode in eine eigenständige Studio-Aktivität hoch.
• Parameter – Ein Runtime-Anforderungsparameter (Abfrage, Pfad, Header oder Textkörper), der in element.json gespeichert und in den SR gespiegelt wird. Im Gegensatz zu Feldern beschreiben Parameter, wie ein Wert den Anbieter-API-Aufruf erreicht, nicht wie er als statische UI-Eigenschaft gerendert wird – obwohl ein Parameter auch über dieselben Referenz-/Aufzählungs-Flags wie ein Feld zu einem Dropdownmenü werden kann.
• Dropdownmenü/abhängiges Dropdownmenü – field create und param create teilen einen identischen Satz von Flags (--reference, --reference-object, --reference-path, --lookup-value, --lookup-names, --display-pattern, --filter-pattern, --load-by-default, --multi-select, --enable-user-override, --depends-on, --field-actions) zum Verknüpfen eines Werts mit einer Suche gegen eine andere Listenressource. --depends-on <parentField> ist eine Verknüpfung, die das standardmäßige Regelpaar zum Anzeigen/Ausblenden für ein abhängiges Dropdownmenü generiert (ausgeblendet, bis das übergeordnete Element einen Wert hat); --field-actions ist der unformatierte JSON-Escape-Hook für Bedingungen, die --depends-on nicht ausdrücken kann.
• Zusammenführungssemantik – field create, param create (über create or replace – siehe unten) und method set werden standardmäßig alle zu einem vorhandenen Eintrag zusammengeführt: Schlüssel, die Sie übergeben, Win, Schlüssel, die Sie weglassen, werden aus der vorhandenen Definition beibehalten und per Die -Methoden-Sichtbarkeit für ein Feld ist tief zusammengeführt, sodass das Hinzufügen der Sichtbarkeit für eine Methode nie die Sichtbarkeit einer anderen Methode beeinträchtigt. method set --replace ist die einzige Ausnahme – sie überschreibt die gesamte Methodenkonfiguration und verwirft alles, was nicht erneut übergeben wird (einschließlich Parameter und kuratierter Status).
• Das Aufheben eines Sichtbarkeits-Flags – field create --method 'GET=!request' (beachten Sie das Präfix ! ) – deaktiviert die request -Sichtbarkeit für GET bei einer Zusammenführung explizit, anstatt sie unverändert zu lassen. Ohne das ! ist ein Flag nur zusätzlich.

UIP ist Connectors Builder-Aktivitätsliste

Listen Sie element.json Ressourceneinträge auf, optional gefiltert.

Optionen

Long	Wert	Beschreibung
--method <method>	string	Filtern nach HTTP-Methode (GET, POST, …).
--path <path>	string	Filtern Sie nach dem genauen Ressourcenpfad (z. B. /accounts).
--connector-dir <path>	Pfad	Connector-Verzeichnis. Die Auflösungsreihenfolge finden Sie unter Connectors Builder → Konzepte .

Beispiele

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

Datenform (--output json)

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

UIP ist Connectors Builder-Aktivität Get

Rufen Sie einen element.json -Ressourceneintrag anhand des Namens, des Pfads oder eines METHOD:/path -Selektors ab.

Argumente

Name	Erforderlich	Zweck
[name]	nein	Ressourcenname, Pfad oder METHOD:/path -Selektor (z. B. accounts oder 'GET:/accounts'). Kann auch als --name übergeben werden.

Optionen

Long	Wert	Beschreibung
--name <name>	string	Alternative zum Positionargument, für Parität mit create/field get/param get.
--connector-dir <path>	Pfad	Connector-Verzeichnis.

Beispiele

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

Datenform (--output json)

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

UIP ist Connectors Builder-Aktivität „Create“.

Erstellen Sie eine vollständige Ressource: eine Standardressourcendatei plus einen element.json -Eintrag pro Methode. Die erneute Ausführung für einen vorhandenen --name findet und anfügt, anstatt zu überschreiben.

Optionen

Long	Wert	Erforderlich	Beschreibung
--name <name>	string	ja	Ressourcenname (Pfadsegment).
--display-name <name>	string	nein	UI-Anzeigename. Die Standardeinstellung ist --name.
--vendor-path <path>	string	nein	Anbieter-API-Pfad. Die Standardeinstellung ist /{name}.
--resource-path <path>	string	nein	Expliziter Ressourcenpfad, wenn er sich vom Anbieterpfad unterscheidet.
--methods <csv>	csv	nein	Zu erstellende HTTP-Methoden. Der Standardwert ist GET,GETBYID,POST,PATCH,DELETE.
--method-vendor-path <kv>	key=value, wiederholbar	nein	Überschreibung des Anbieterpfads pro Methode, z. B. GET=/me/teams).
--primary-key <name>	string	nein	Name des Primärschlüsselfelds. Der Standardwert ist id.
--no-body	Markieren	nein	Lassen Sie den automatisch hinzugefügten Request-Body-Parameter bei POST/PUT/PATCH weg – für reine Pfadaktionen wie einen Start-/Stop-Aufruf, der nur eine ID im Pfad benötigt.
--resource-type <type>	string	nein	ResourceType Wert (api, apiElementRequest, …). Standardmäßig: api.
--has-ceql	Markieren	nein	Aktivieren Sie die CEQL-Filterung für GET.
--has-events	Markieren	nein	Markieren Sie die Ressource als ereignisfähig.
--has-bulk	Markieren	nein	Aktivieren Sie die Unterstützung für Massendownloads.
--pagination-type <type>	string	nein	Paginierungstyp für GET.
--root-key <key>	string	nein	Antwortstammschlüssel, der die Datensätze enthält.
--next-page-key <key>	string	nein	Antwortschlüssel, der das Token für die nächste Seite enthält.
--filter-param <vendorName>	string	nein	Abfrageparametername des Anbieters, dem der CEQL-Filter zugeordnet ist. Der Standardwert where (z. B sysparm_query für APIs im ServiceNow-Stil).
--page-size-param <vendorName>	string	nein	Abfrageparametername des Anbieters für Seitengröße. Der Standardwert pageSize (z. B sysparm_limit, per_page).
--offset-param <vendorName>	string	nein	Abfrageparametername des Anbieters für Zeilen-Offset/Seitennummer (z. B sysparm_offset, page).
--next-resource <selector>	string	nein	Mit einer nächsten Ressource verketten (z. B. 'GET:/organization').
--curated-metadata <json>	JSON	nein	Pro Methode kuratierte Metadaten, inline. Sich gegenseitig mit --curated-metadata-file ausschließen.
--curated-metadata-file <path>	Pfad	nein	Pro Methode kuratierte Metadaten aus einer Datei.
--fields <json>	JSON	nein	Feldspezifikationen als Inline-JSON-Array. Sich gegenseitig mit --fields-file ausschließen. Die Form finden Sie unter activity field schema.
--fields-file <path>	Pfad	nein	Feldspezifikationen aus einer JSON-Datei.
--skip-sr	Markieren	nein	Erstellung von Standardressourcendateien überspringen.
--no-curate	Markieren	nein	Kuratieren Sie Methoden nicht automatisch in eigenständigen Studio-Aktivitäten. Standardmäßig ist Kuratieren.
--overwrite-fields	Markieren	nein	Wenn Sie an eine vorhandene Ressource anfügen, profitieren Sie von eingehenden Felddefinitionen bei einer Namenskonflikt. Der Standardwert behält die vorhandene Definition bei.
--connector-dir <path>	Pfad	nein	Connector-Verzeichnis.

Das Übergeben von sowohl --fields als auch --fields-file (oder sowohl --curated-metadata als auch --curated-metadata-file) ist ein Fehler. Die --fields/--fields-file -Nutzlast wird validiert und normalisiert, bevor etwas geschrieben wird, sodass eine falsch formatierte Feldspezifikation schnell mit einem präzisen Fehler fehlschlägt, anstatt im Hintergrund eine fehlerhafte Standardressourcendatei zu erstellen.

Beispiele

# 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

Datenform (--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 ist Connectors Builder-Aktivität löschen

Entfernen Sie eine Ressource: jeden übereinstimmenden element.json -Eintrag und die zugehörige Standardressourcendatei.

Argumente

Name	Erforderlich	Zweck
<name>	ja	Ressourcenname.

Optionen

Long	Wert	Beschreibung
--connector-dir <path>	Pfad	Connector-Verzeichnis.

Beispiel

uip is connectors builder activity delete accounts

Datenform (--output json)

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

Dadurch wird eine gesamte Ressource entfernt. Um stattdessen eine einzelne Methode zu entfernen, bearbeiten Sie die Ressource enger mit activity method set --replace oder löschen Sie sie undcreate erneut mit einer reduzierten --methods Liste – es gibt keine dedizierte Methode „Eine Methode entfernen“ Verb.

---

Aktivitätsfeld

Verwalten Sie die Standardressourcenfelder einer Ressource – ihre UI-orientierte Form.

„uip ist Connectors Builder“-Aktivitätsfeldschema

Drucken Sie das feldspezifische Schema (zulässige Schlüssel, Typen, Sichtbarkeit) sowie ein gültiges Beispiel für das Erstellen von --fields/--fields-file -Nutzlasten in activity create oder activity field create aus. Benötigt keinen Connector – dies ist ein statischer, Connector-unabhängiger Referenzbefehl.

Keine Argumente oder Optionen über globale Argumente hinaus.

Beispiel

uip is connectors builder activity field schema

Datenform (--output json)

Wird mit den nativen Kleinbuchstaben (nicht PascalCased) zurückgegeben, sodass das example -Array direkt schreibgeschützt ist:

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

Die vollständige Schlüsselliste (aus der Quelle) enthält auch nativeType, description, sampleValue, format, mask (eine Musterzeichenfolge für Datums-/Zahlenformat, z. B "yyyy-MM-dd'T'HH:mm:ssZ" – kein Boolesch), design, methods (Alias für method, nicht beides), enum, enhancedEnum, reference, sortOrder, searchableNames, defaultValue, custom, order, isCuratedEventField, isPriority, key und fieldActions.

UIP ist Connectors Builder-Aktivitätsfeldliste

Listen Sie jedes Feld in der Standardressource einer Ressource auf.

Optionen

Long	Wert	Erforderlich	Beschreibung
--resource <name>	string	ja	Ressourcenname.
--connector-dir <path>	Pfad	nein	Connector-Verzeichnis.

Beispiel

uip is connectors builder activity field list --resource accounts

Datenform (--output json)

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

UIP ist Connectors Builder-Aktivitätsfeld

Lesen Sie ein Feld nach Namen.

Argumente

Name	Erforderlich	Zweck
[name]	nein	Feldname (oder --name übergeben).

Optionen

Long	Wert	Erforderlich	Beschreibung
--resource <name>	string	ja	Ressourcenname.
--name <name>	string	nein	Alternative zum Positionargument.
--connector-dir <path>	Pfad	nein	Connector-Verzeichnis.

Beispiel

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

Datenform (--output json)

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

UIP ist Connectors Builder-Aktivitätsfeld erstellen

Erstellen oder aktualisieren Sie ein Feld in der Standardressource einer Ressource. Die erneute Ausführung für ein vorhandenes Feld führt zusammen: Schlüssel der obersten Ebene, die Sie übergeben, gewinnen, nicht angegebene Schlüssel werden beibehalten, und die Sichtbarkeit pro Methode wird tief zusammengeführt, sodass das Hinzufügen der Sichtbarkeit einer Methode nie die Sichtbarkeit einer anderen Methode beeinträchtigt.

Nicht zum Hinzufügen eines Laufzeitanforderungsparameters – verwenden Sie activity param create dafür.

Optionen

Long	Wert	Erforderlich	Beschreibung
--resource <name>	string	ja	Ressourcenname.
--name <name>	string	ja	Feldname (wird zum fields -Zuordnungsschlüssel).
--type <type>	string	Nein*	Feldtyp (string, integer, …). Erforderlich für ein neues Feld; optional beim Zusammenführen mit einer vorhandenen.
--native-type <type>	string	nein	Name des anbieternativen Typs. Die Standardeinstellung ist --type.
--display-name <name>	string	nein	UI-Anzeigename.
--description <text>	string	nein	Feldbeschreibung.
--sample-value <value>	string	nein	Beispielwert, der im Designer angezeigt wird.
--format <format>	string	nein	Feldformathinweis (z. B date-time, int32).
--enum <json>	JSON	nein	Zulässige Werte – ["a","b"] oder [{"value":"a"}].
--enhanced-enum <json>	JSON	nein	Beschriftete Optionen: [{"name":"Label","value":"V"}].
--reference <json>	JSON	nein	Dynamische Suche als JSON, z. B {"objectName":"users","path":"/users","lookupValue":"id","lookupNames":["name"]}).
--reference-object <name>	string	nein	Dropdown: Der Objektname der Ziellistenressource (z. B teams).
--reference-path <path>	string	nein	Dropdown: Der Pfad der Listenressourcen (z. B. /teams). Verwenden Sie {parent} für ein abhängiges Dropdownmenü, z. B. /teams/{team_id}/channels).
--lookup-value <field>	string	nein	Dropdownmenü: Das einzige Feld, das als Wert gesendet wird.
--lookup-names <csv>	csv	nein	Dropdownmenü: Anzeigekandidatenfelder für das Anzeigemuster.
--display-pattern <pattern>	string	nein	Dropdown: Sichtbare Beschriftungsvorlage, z. B "{displayName}" oder "{name} - {id}".
--filter-pattern <pattern>	string	nein	Dropdown: Serverseitige Typ-Ahead-Filtervorlage mit {filter}.
--load-by-default	Markieren	nein	Dropdownmenü: Füllen Sie die Liste beim Öffnen aus.
--multi-select	Markieren	nein	Dropdownmenü: Ermöglicht die Auswahl mehrerer Werte.
--enable-user-override	Markieren	nein	Dropdown: Lassen Sie den Benutzer einen Rohwert eingeben, anstatt einen auszuwählen.
--depends-on <parent>	string	nein	Abhängiges Dropdownmenü: Ausblenden, bis <parent> einen Wert hat (generiert das Regelpaar für das Anzeigen/Ausblenden). Der Referenzpfad muss {<parent>} enthalten.
--field-actions <json>	JSON	nein	Anzeigen/Ausblenden/erforderliche Regeln als JSON – Escape-Zeichen über --depends-on hinaus.
--default-value <value>	Skalar oder JSON	nein	Standardwert.
--mask <pattern>	string	nein	Formatmuster für Datum/Zahl, z. B. "yyyy-MM-dd'T'HH:mm:ssZ").
--primary-key	Markieren	nein	Markieren Sie das Feld als Primärschlüssel.
--sort-order <n>	Integer	nein	Sortierreihenfolge.
--searchable	Markieren	nein	Markieren Sie das Feld als durchsuchbar.
--searchable-operators <csv>	csv	nein	Durchsuchbare Operatoren.
--searchable-names <csv>	csv	nein	Alternative Namen, die in Abfragen abgeglichen werden sollen.
--method <method>	Zeichenfolge, wiederholbar	nein	HTTP-Methode, für die die Sichtbarkeits-Flags gelten. Zwei Formulare, mischbar: einheitlich (--method GET --method POST --response wendet die gleichen Flags auf beide an) oder Inline pro Methode (--method 'GET=response' --method 'POST=request,required'). Stellen Sie einem Flag ! voran, um es bei einer Zusammenführung aufzuheben, z. B. --method 'GET=!request').
--request	Markieren	nein	Das Feld ist Teil der Anforderung für jedes --method.
--response	Markieren	nein	Das Feld ist Teil der Antwort für jedes --method.
--required	Markieren	nein	Das Feld ist für jedes --method erforderlich.
--request-curated	Markieren	nein	Das Feld ist anforderungskuratiert, für jedes --method.
--response-curated	Markieren	nein	Das Feld ist für jedes --method antwortkuratiert.
--design-position <position>	primary|secondary|none	nein	Designposition.
--component <component>	string	nein	Überschreiben von Designkomponenten.
--hidden	Markieren	nein	Blenden Sie das Feld im Designer aus.
--connector-dir <path>	Pfad	nein	Connector-Verzeichnis.

Inline-Sichtbarkeitstoken pro Methode sind: request, response, required, requestCurated (oder request-curated), responseCurated (oder response-curated). Ein nicht erkanntes Token schlägt mit einem expliziten Fehler fehl, der den gültigen Satz auflistet.

Beispiele

# 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

Datenform (--output json)

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

UIP ist Connectors Builder-Aktivitätsfeld löschen

Entfernt ein Feld nach Namen.

Argumente

Name	Erforderlich	Zweck
[name]	nein	Feldname (oder --name übergeben).

Optionen

Long	Wert	Erforderlich	Beschreibung
--resource <name>	string	ja	Ressourcenname.
--name <name>	string	nein	Alternative zum Positionargument.
--connector-dir <path>	Pfad	nein	Connector-Verzeichnis.

Beispiel

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

Datenform (--output json)

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

---

Aktivitätsmethode

Verwalten Sie die Standardressourcenkonfiguration einer Ressource pro Methode: Vorgangsbeschriftung, interner Pfad, Kuratierungsstatus.

UIP ist die Connectors Builder-Aktivitätsmethode

Lesen Sie die Standardressourcenkonfiguration einer Methode.

Optionen

Long	Wert	Erforderlich	Beschreibung
--resource <name>	string	ja	Ressourcenname.
--method <method>	string	ja	HTTP-Methode (GET, POST, …).
--connector-dir <path>	Pfad	nein	Connector-Verzeichnis.

Beispiel

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

Datenform (--output json)

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

VendorPath wird separat angezeigt, da die Standardressourcenkonfiguration nur den internen Pfad enthält – das anbieterseitige Routing befindet sich in element.json.

„uip“ ist die Aktivitätsmethode „Connectors Builder“.

Erstellen oder bearbeiten Sie die Standardressourcenkonfiguration einer Methode. Führt die Flags zusammen, die Sie standardmäßig an die vorhandene Konfiguration übergeben; --replace überschreibt stattdessen den gesamten Block.

Optionen

Long	Wert	Erforderlich	Beschreibung
--resource <name>	string	ja	Ressourcenname.
--method <method>	string	ja	HTTP-Methode.
--operation <operation>	string	nein	Vorgangsbeschriftung (List, Retrieve, …).
--operation-id <id>	string	nein	Bezeichner des Vorgangs.
--description <text>	string	nein	Methodenbeschreibung.
--path <path>	string	nein	Pfad der Standardressourcenmethode.
--hidden	Markieren	nein	Blenden Sie die Methode vor dem Designer aus.
--has-ceql	Markieren	nein	Aktivieren Sie CEQL für diese Methode.
--response-display-name <name>	string	nein	Anzeigename der Antwort.
--response-description <text>	string	nein	Antwortbeschreibung.
--replace	Markieren	nein	Überschreiben Sie die gesamte Methodenkonfiguration, anstatt sie zusammenzuführen. Parameter werden abgelegt/kuratierter Status nicht erneut übergeben.
--connector-dir <path>	Pfad	nein	Connector-Verzeichnis.

Beispiel

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

Datenform (--output json)

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

UIP ist die Connectors Builder-Aktivitätsmethode kuratieren

Heraufstufen einer Methode zu einer eigenständigen Studio-Aktivität.

Optionen

Long	Wert	Erforderlich	Beschreibung
--resource <name>	string	ja	Ressourcenname.
--method <method>	string	ja	HTTP-Methode.
--display-name <name>	string	ja	Anzeigename der Studio-Aktivität.
--name <name>	string	nein	Aktivitätsbezeichner. Standardmäßig der Anzeigename.
--description <text>	string	nein	Aktivitätsbeschreibung.
--hidden	Markieren	nein	Blenden Sie die Aktivität aus.
--connector-dir <path>	Pfad	nein	Connector-Verzeichnis.

Nur die Flags, die Sie tatsächlich übergeben, werden gesendet – ein Aufruf nur für den Anzeigenamen wird mit dem vorhandenen kuratierten Block zusammengeführt, anstatt den Bezeichner zurückzusetzen oder die Beschreibung auszublenden.

Beispiel

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

Datenform (--output json)

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

---

Aktivitätsparameter

Verwalten Sie die Laufzeitparameter einer Ressourcenmethode in element.json (gespiegelt auf die Standardressource).

UIP ist Connectors Builder-Aktivitätsparameterliste

Optionen

Long	Wert	Erforderlich	Beschreibung
--resource <name>	string	ja	Ressourcenname.
--method <method>	string	ja	HTTP-Methode.
--connector-dir <path>	Pfad	nein	Connector-Verzeichnis.

Beispiel

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

Datenform (--output json)

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

UIP ist Parameter für das Abrufen des Connectors Builder-Aktivitätsparameters

Optionen

Long	Wert	Erforderlich	Beschreibung
--resource <name>	string	ja	Ressourcenname.
--method <method>	string	ja	HTTP-Methode.
--name <name>	string	ja	Parametername.
--connector-dir <path>	Pfad	nein	Connector-Verzeichnis.

Beispiel

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

Datenform (--output json)

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

UIP ist Connectors Builder-Aktivität Parameter erstellen

Erstellen oder ersetzen Sie einen Parameter für eine Ressourcenmethode.

Optionen

Long	Wert	Erforderlich	Beschreibung
--resource <name>	string	ja	Ressourcenname.
--method <method>	string	ja	HTTP-Methode.
--name <name>	string	ja	Parametername.
--vendor-name <name>	string	nein	Name des anbieterseitigen Parameters.
--type <type>	string	ja	Parametertyp – Führen Sie param create --help für den vollständigen Typkatalog aus, der aus der Parametertypregistrierung der CLI extrahiert wird (--type akzeptiert unter anderem Werte wie einen einfachen Orchestrator oder value/configuration für Konstanten und 1:1 configmaps – bevorzugen Sie hier einen deklarativen Typ gegenüber dem Schreiben eines Hooks).
--vendor-type <type>	string	nein	Anbieterseitiger Parametertyp.
--data-type <type>	string	nein	Datentyp (string, integer, …).
--vendor-data-type <type>	string	nein	Anbieterseitiger Datentyp.
--source <source>	string	nein	Parameterquelle (request, response).
--required	Markieren	nein	Markieren Sie den Parameter als erforderlich.
--description <text>	string	nein	Parameterbeschreibung.
--display-name <name>	string	nein	UI-Anzeigename.
--sort-order <n>	Integer	nein	Sortierreihenfolge.
--enum <json>	JSON	nein	Zulässige Werte, gleiche Form wie field create --enum – ein Abfrage-/Textparameter kann eine statische Kombination sein.
--enhanced-enum <json>	JSON	nein	Beschriftete Optionen, gleiche Form wie 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	–	nein	Identische Drop-down-/abhängige Dropdown-Flags als field create – siehe Abschnitt oben. Ein Pfad oder Abfrageparameter kann auch eine Dropdownliste sein.
--design-position <position>	primary|secondary|none	nein	Designposition.
--hidden	Markieren	nein	Blenden Sie den Parameter im Designer aus.
--connector-dir <path>	Pfad	nein	Connector-Verzeichnis.

--type ist wirklich erforderlich; Die genauen zulässigen Werte stammen aus der eigenen Parametertyp-Registrierung der CLI und werden vollständig von param create --help ausgegeben, sodass auf dieser Seite keine Liste hartcodiert wird, die von der ausgelieferten Registrierung abweichen würde.

Beispiel

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

Datenform (--output json)

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

Warnings ist nur vorhanden, wenn der Schreibvorgang welche erzeugt hat.

UIP ist Connectors Builder-Aktivitätsparameter löschen

Optionen

Long	Wert	Erforderlich	Beschreibung
--resource <name>	string	ja	Ressourcenname.
--method <method>	string	ja	HTTP-Methode.
--name <name>	string	ja	Parametername.
--connector-dir <path>	Pfad	nein	Connector-Verzeichnis.

Beispiel

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

Datenform (--output json)

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

Zugehörig

• Connectors Builder – Die Konzepte und die vier Verben für den Mandantenlebenszyklus.
• Aktivitäts-Hooks – JavaScript-Transformationen vor/nach der Anforderung, die an eine Ressource oder eine globale Ressource angehängt sind.
• Init & Connector – Gerüst für den Connector, in dem sich diese Aktivität befindet.
• Auth – konfigurieren Sie das Authentifizierungsschema des Connectors, einschließlich Lebenszyklus-/Systemressourcen.
• Trigger und Status – Ereignistrigger und Bearbeitungen von Elementdateien auf niedriger Ebene.

Siehe auch

• Übersicht über das Integration Service-Tool
• Globale Optionen
• Exitcodes