Skip to main content

List TWU Models

List all TWU models for an instance with pagination, filtering, and sorting. Endpoint: GET /instances/:instanceId/twu-models Query Parameters:
  • page (number, optional) - Page number (0-based)
  • size (number, optional) - Page size
  • sort (string, optional) - Sort field and direction (e.g., “model_id,desc”)
  • name (string, optional) - Filter by name/description (searches both, min 3 chars)
  • status (string, optional) - Filter by status: “DRAFT”, “PUBLISHED”, “ARCHIVED”
  • versions (string, optional) - Filter by versions: “ALL”, “LATEST”
Response: Paginated response with model list Source: Feature Inventory - API Surface (TWU Models API)

Create TWU Model

Create a new TWU model. Endpoint: POST /instances/:instanceId/twu-models Request Body:
{
  "name": "Model Name",
  "description": "Model description",
  "entities": [...],
  "actions": [...],
  "events": [...],
  "outcomes": [...]
}
Fields:
  • name (string, required) - Model name
  • description (string, required) - Model description
  • entities (array, required) - List of entity definitions
  • actions (array, required) - List of action definitions
  • events (array, required) - List of event definitions
  • outcomes (array, required) - List of outcome definitions
Response: Created model object with id or modelId Source: Feature Inventory - API Surface (TWU Models API)

Delete TWU Model

Delete a TWU model. Endpoint: DELETE /instances/:instanceId/twu-models/:modelId Response: 204 No Content Source: Feature Inventory - API Surface (TWU Models API)

List Versions

List all versions of a TWU model. Endpoint: GET /instances/:instanceId/twu-models/:modelId/versions Response: Array of version objects with full payloads (entities, actions, events, outcomes) Source: Feature Inventory - API Surface (TWU Models API)

Get Version

Get a specific version of a TWU model. Endpoint: GET /instances/:instanceId/twu-models/:modelId/versions/:version Response: Version object with full data Source: Feature Inventory - API Surface (TWU Models API)

Create Version

Create a new version of a TWU model. Endpoint: POST /instances/:instanceId/twu-models/:modelId/versions Request Body: Same as Create TWU Model Response: Created version object Source: Feature Inventory - API Surface (TWU Models API)

Publish Draft

Publish a draft version of a TWU model. Endpoint: POST /instances/:instanceId/twu-models/:modelId/publish Response: Published version object Source: Feature Inventory - API Surface (TWU Models API)

Delete Draft

Delete a draft version of a TWU model. Endpoint: DELETE /instances/:instanceId/twu-models/:modelId/draft Response: 204 No Content Source: Feature Inventory - API Surface (TWU Models API)