Widget management API

The widget management service of UI hub has two sets of endpoints. The primary set is open to users to create and customize dashboards. The second set, called the administrative API, is used to configure tenant scoped dashboards. Users who are provisioned in a tenant can access a set of working layouts and widgets.

Environments

To access the widget management service, go to Widget Management Service.

  • https://api.ibm.com/supplychainui/run/{{region}}
UI hub is deployed in two regions. Each region is isolated from the other. You must specify the target region as a two letter region code that is appended to the base URL. The following region codes are currently supported.
  • Europe - eu
  • North America - na

Standard user endpoints

Layout templates
  • GET /api/v1/wms/layout_templates
  • GET /api/v1/wms/layout_templates/{id}
  • GET /api/v1/wms/layout_templates/by_layout_template_ids?layoutTemplateIds={{templateId}}
  • GET /api/v1/wms/layout_templates/{layoutTemplateId}/widgets
  • GET /api/v1/wms/layout_templates/{layoutTemplateId}/widgets/{id}
  • GET /api/v1/wms/layout_templates/default
Entitlements
  • GET /api/v1/wms/entitlements
  • GET /api/v1/wms/entitlements/{widgetDefinitionId}
  • GET /api/v1/wms/entitlements/byWidgetDefinitionIds
Layouts
  • GET /api/v1/wms/layouts
  • POST /api/v1/wms/layouts
  • GET api/v1/layouts/by_layout_ids?layoutIds={{layoutId}}
  • GET /api/v1/wms/layouts/default
  • PUT /api/v1/wms/layouts/default
  • GET /api/v1/wms/layouts/default/for_template?templateId={{templateId}}
  • PUT /api/v1/wms/layouts/default/for_template?layoutId={{layoutId}}
  • GET /api/v1/wms/layouts/{id}
  • PUT /api/v1/wms/layouts/{id}
  • DELETE /api/v1/wms/layouts/{id}
Layout widgets
  • GET /api/v1/wms/layouts/{layoutId}/widgets
  • POST /api/v1/wms/layouts/{layoutId}/widgets
  • GET /api/v1/wms/layouts/{layoutId}/widgets/{id}
  • PUT /api/v1/wms/layouts/{layoutId}/widgets/{id}
  • DELETE /api/v1/wms/layouts/{layoutId}/widgets/{id}

Administrator user endpoints

DSR requests
  • POST /api/v1/wms/dsr/requests
  • GET /api/v1/wms/dsr/requests/{requestId}
Layout templates (Admin)
  • POST /api/v1/wms/layout_templates
  • PUT /api/v1/wms/layout_templates/{id}
  • DELETE /api/v1/wms/layout_templates/{id}
  • PUT /api/v1/wms/layout_templates/default
Layout template widgets
  • POST /api/v1/wms/layout_templates/{layoutId}/widgets
  • PUT /api/v1/wms/layout_templates/{layoutId}/widgets/{id}
  • DELETE /api/v1/wms/layout_templates/{layoutId}/widgets/{id}
Subscriptions
  • GET /api/v1/wms/subscriptions
  • GET /api/v1/wms/subscriptions/by_widget_definition_id/{widgetDefinitionId}
  • POST /api/v1/wms/subscriptions/subscribe
  • GET /api/v1/wms/subscriptions/{subscriptionId}
  • PUT /api/v1/wms/subscriptions/{subscriptionId}
  • DELETE /api/v1/wms/subscriptions/{widgetDefinitionId}/unsubscribe?tenantId={tenantId}
Widget definitions
  • GET /api/v1/wms/widget_definitions
  • POST /api/v1/wms/widget_definitions
  • GET /api/v1/wms/widget_definitions/{id}
  • PUT /api/v1/wms/widget_definitions/{id}
  • DELETE /api/v1/wms/widget_definitions/{id}
Management
POST /api/v1/wms/management/archive
Migration
  • GET /api/v1/wms/internal/migrate/{id}
  • POST /api/v1/wms/internal/migrate