Skip to content
Proud to collaborate with Microsoft for Startups

data.network.profile.persist ​

Persist a NetworkProfile (create or restore by org+name)

Create or restore a NetworkProfile.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-network
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—UUID of the organization
network_account_uuiduuidYes—UUID of the NetworkAccount the profile binds to
namestringYes—Profile name (idempotency key within an organization)
descriptionstringNo—Optional description
profile_typestringNo—NetworkProfileType (generic
is_defaultbooleanNo—Whether the profile is the org default
configdictNo—Profile config; UUIDs only - sequential id keys are rejected
actorstringNo—Caller initiating the persist

Output Schema ​

FieldTypeRequiredDefaultDescription
network_profile_uuiduuidYes—UUID of the persisted profile
createdbooleanYes—True when a new row was inserted
restoredbooleanYes—True when a soft-deleted row was restored
persisted_atstringYes—ISO-8601 timestamp
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—completePersist profile
completedNoYesYes—Persisted
failedNoYesNo—Persist failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
persistedSUCCESSPersist a NetworkProfile (create or restore by org+name)—
failedFAILURENetwork workflow failedfailure_reason

API Usage ​

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

{
  "workflow_type": "data.network.profile.persist",
  "initial_data": {
    "organization_uuid": "value",
    "network_account_uuid": "value",
    "name": "value"
  }
}