data.network.segment.query

List NetworkSegments (uuid-only)

List NetworkSegments for an organization.

Overview

Property	Value
Workflow type	Atomic
Library	App-network
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	UUID of the organization
network_scope_uuid	uuid	No	—	Filter by parent NetworkScope UUID
availability_zone	string	No	—	Filter by AZ / zone
classification	string	No	—	Filter by classification (public/private/...)
is_public	boolean	No	—	Filter by provider-public flag
provider_segment_ref	string	No	—	Filter by exact provider segment reference
name_contains	string	No	—	Case-insensitive substring filter on name
include_deleted	boolean	No	—	Include soft-deleted rows (default False)
limit	integer	No	—	Max rows to return; default 100, capped at 500
offset	integer	No	—	Pagination offset
actor	string	No	—	Caller initiating the query

Output Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	Organization UUID echoed from input
segments	list	Yes	—	List of segment dicts (uuid-keyed)
count	integer	Yes	—	Number of rows returned
limit	integer	Yes	—	Limit applied
offset	integer	Yes	—	Offset applied
failure_reason	string	No	—	Engine-stamped human-readable failure reason
failed_at_state	string	No	—	Engine-stamped state when the workflow failed
failed_step	string	No	—	Engine-stamped step name (DAG path)
failed_layer	integer	No	—	Engine-stamped layer index (DAG path)
error	string	No	—	Engine-stamped exception message
error_type	string	No	—	Engine-stamped exception class name

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	complete	Query segments
completed	No	Yes	Yes	—	Queried
failed	No	Yes	No	—	Query failed

State Diagram

Transitions

From	Action	To	Description
pending	complete	completed	—
pending	fail	failed	—

Outcomes

Outcome	Type	Description	State Data Keys
queried	SUCCESS	List NetworkSegments (uuid-only)	—
failed	FAILURE	Network workflow failed	failure_reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "data.network.segment.query",
  "initial_data": {
    "organization_uuid": "value"
  }
}