Skip to content
Proud to collaborate with Microsoft for Startups

data.network.profile.soft_delete ​

Soft-delete a NetworkProfile row (archive)

Soft-delete a NetworkProfile by uuid.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-network
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—UUID of the organization
network_profile_uuiduuidYes—UUID of the profile to soft-delete
actorstringNo—Caller initiating the delete

Output Schema ​

FieldTypeRequiredDefaultDescription
network_profile_uuiduuidYes—UUID of the soft-deleted profile
deletedbooleanYes—True when this run mutated the row
already_deletedbooleanYes—True when the row was already soft-deleted
deleted_atstringNo—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—completeArchive profile
completedNoYesYes—Archived
failedNoYesNo—Archive failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
removedSUCCESSSoft-delete a NetworkProfile row (archive)—
failedFAILURENetwork workflow failedfailure_reason

API Usage ​

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

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