Skip to content
Proud to collaborate with Microsoft for Startups

data.network.profile.query ​

List NetworkProfiles (uuid-only)

List NetworkProfiles for an organization.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-network
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—UUID of the organization
network_account_uuiduuidNo—Filter by binding NetworkAccount UUID
profile_typestringNo—Filter by NetworkProfileType
is_defaultbooleanNo—Filter by org-default flag
name_containsstringNo—Case-insensitive substring filter on name
include_deletedbooleanNo—Include archived rows (default False)
limitintegerNo—Max rows to return; default 100, capped at 500
offsetintegerNo—Pagination offset
actorstringNo—Caller initiating the query

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID echoed from input
profileslistYes—List of profile dicts (uuid-keyed)
countintegerYes—Number of rows returned
limitintegerYes—Limit applied
offsetintegerYes—Offset applied
failure_reasonstringNo—Engine-stamped human-readable failure reason
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped step name (DAG path)
failed_layerintegerNo—Engine-stamped layer index (DAG path)
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—completeQuery profiles
completedNoYesYes—Queried
failedNoYesNo—Query failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
queriedSUCCESSList NetworkProfiles (uuid-only)—
failedFAILURENetwork workflow failedfailure_reason

API Usage ​

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

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