uip api-workflow registry

Syntax and options for `uip api-workflow registry resolve` and `stub`, which look up connector/DAP activities and emit ready-to-paste activity objects for an API Workflow JSON file.

uip api-workflow registry looks up DAP/connector activities (Studio Web's TypeCache) and emits API Workflow–shaped activity stubs you paste directly into a workflow's Sequence_1.do array. Typical flow: resolve a keyword to find a candidate activity, then stub its uiPathActivityTypeId to get the ready-to-paste object.

For vendor ("IntSvc") activities, get a connection UUID via uip is connections list <connector-key> and verify it with uip is connections ping <uuid> before passing --connection-id. The Http kind needs no connection. Generic activities (activityType: "Generic" in resolve output) apply an operation (list/create/retrieve/update/delete/...) to a connector object you choose via --object-name — discover objects with uip is resources list <connector-key> --connection-id <uuid>.

Synopsis

uip api-workflow registry resolve <keyword> [options]
uip api-workflow registry stub    <activity-type-id> [options]

uip api-workflow registry resolve

Search the API-workflow-compatible TypeCache by keyword and return candidate activities.

Arguments

Name	Required	Purpose
<keyword>	yes	Substring matched against display name, connector key, or object name.

Options

Flag	Description
-l, --limit <n>	Maximum results to return. Default 50.

Example

uip api-workflow registry resolve "send email"

Data shape (--output json)

{
  "Code": "ActivityResolveSuccess",
  "Data": {
    "Keyword": "send email",
    "ResultCount": 3,
    "Matches": []
  }
}

uip api-workflow registry stub

Emit a ready-to-paste activity object for a known uiPathActivityTypeId. Combines TypeCache (GUID and instance parameters) with Integration Service Elements metadata (full path, fields, multipart). Picks the Http kind for the HTTP connector and the IntSvc kind for vendor connectors.

Arguments

Name	Required	Purpose
<activity-type-id>	yes	uiPathActivityTypeId returned by resolve.

Options

Flag	Description
--connection-id <id>	Connection UUID. Required for IntSvc-kind vendor activities.
--instance <n>	Instance number, used to build the slot key and export bucket suffix. Default 1.
--slot-key <key>	Override the default PascalCase slot key, for example GetNewestEmail_1.
--inputs <json>	JSON object mapping field names to values, for example '{"message.subject":"hi"}'.
--object-name <name>	Target connector object for Generic activities, for example tickets. Defaults to the object pinned in the activity definition, when present.
--resource-key <field>=<key>	Bind a Solution-resource picker field to a solution resource key. Repeatable, for example --resource-key 'ReleaseName=87ec3255-...'.

Example

uip api-workflow registry stub SendEmail --connection-id 87ec3255-1234-4abc-9def-0123456789ab

Data shape (--output json)

{
  "Code": "ActivityStubSuccess",
  "Data": {
    "kind": "IntSvc",
    "slotKey": "SendEmail_1",
    "exportBucketKey": "SendEmail_1_output",
    "activity": {},
    "parameters": {},
    "requestFields": [],
    "responseFields": []
  }
}

The Activity object's keys are kept in their native camelCase (not PascalCased like most of this CLI's output) — it's pasted verbatim into a workflow's do[] array, and PascalCasing would break the executor. When --resource-key selections are supplied, the response adds a SolutionResourceFields array; when the lookup surfaces enrichment opportunities or caveats, it adds IsEnrichmentAvailable and/or Warnings.

Related

• uip api-workflow bindings — generate bindings for the resources a stub references.
• uip is connections — list and verify connection UUIDs for --connection-id.
• uip is resources — discover connector objects for --object-name.

See also

• API Workflow tool overview
• Global options
• Exit codes