uip api-workflow bindings

Syntax and options for `uip api-workflow bindings sync`, which generates a bindings_v2.json file from an API Workflow JSON for solutions authored outside Studio Web.

uip api-workflow bindings generates the per-project bindings_v2.json file that uip solution resources refresh needs to populate a solution's resource catalogue. Studio Web computes this file in-memory whenever a workflow is opened in the designer; for agent-authored workflows that never get opened in Studio, bindings sync does the same translation offline — it walks the workflow, extracts IntSvc connector activities (skipping Http-kind / implicit-connection activities), dedupes by connection UUID, and writes bindings_v2.json next to the workflow file.

Synopsis

uip api-workflow bindings sync --workflow <path>

uip api-workflow bindings sync

Options

Flag	Description
--workflow <path>	Required. Path to the API Workflow JSON file. bindings_v2.json is written into the same directory.

Example

uip api-workflow bindings sync --workflow ./my-workflow/Workflow.json

Data shape (--output json)

{
  "Code": "BindingsSync",
  "Data": {
    "BindingsPath": "/work/my-workflow/bindings_v2.json",
    "ResourceCount": 3,
    "ActivitiesVisited": 12,
    "IntSvcActivities": 4,
    "DuplicatesCollapsed": 1,
    "ResourceBindings": [],
    "PreservedResources": []
  }
}

PreservedResources lists any existing bindings_v2.json entries that were kept as-is because they didn't correspond to an IntSvc activity found during this walk (for example, a resource referenced only by a Http-kind activity).

Related

• uip solution resources — consumes bindings_v2.json to populate the solution resource catalogue and per-user debug overwrites.
• uip is connections — get a connection UUID to pass into an activity stub before running bindings sync.
• uip api-workflow registry — emit the connector activity stubs that bindings sync walks.

See also

• API Workflow tool overview
• Global options
• Exit codes