data.network.profile.persist ​
Persist a NetworkProfile (create or restore by org+name)
Create or restore a NetworkProfile.
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_account_uuid | uuid | Yes | — | UUID of the NetworkAccount the profile binds to |
name | string | Yes | — | Profile name (idempotency key within an organization) |
description | string | No | — | Optional description |
profile_type | string | No | — | NetworkProfileType (generic |
is_default | boolean | No | — | Whether the profile is the org default |
config | dict | No | — | Profile config; UUIDs only - sequential id keys are rejected |
actor | string | No | — | Caller initiating the persist |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
network_profile_uuid | uuid | Yes | — | UUID of the persisted profile |
created | boolean | Yes | — | True when a new row was inserted |
restored | boolean | Yes | — | True when a soft-deleted row was restored |
persisted_at | string | Yes | — | ISO-8601 timestamp |
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 | Persist profile |
completed | No | Yes | Yes | — | Persisted |
failed | No | Yes | No | — | Persist failed |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | complete | completed | — |
pending | fail | failed | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
persisted | SUCCESS | Persist a NetworkProfile (create or restore by org+name) | — |
failed | FAILURE | Network workflow failed | failure_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"
}
}