Appearance
composition.delete-archived ​
Soft-delete archived compositions for an organization
Soft-delete archived compositions for an organization.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-composition |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
composition_uuid | uuid | No | — | Archived composition row UUID to delete; omit for broad org cleanup. |
composition_uuids | list | No | — | Archived composition row UUIDs to delete; omit for broad org cleanup. |
name | string | No | — | Lineage name whose archived versions should be deleted; omit for broad org cleanup. |
confirm | string | No | — | Required for deletion; must be delete_archived. Not required for dry_run. |
dry_run | boolean | No | False | — |
delete_schedules | boolean | No | False | Also delete schedules targeting the archived virtual workflow types. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
dry_run | boolean | Yes | — | — |
delete_schedules | boolean | Yes | — | — |
matched_count | integer | Yes | — | — |
deleted_count | integer | Yes | — | — |
remaining_archived_count | integer | Yes | — | — |
schedule_references_count | integer | Yes | — | — |
deleted_schedule_count | integer | Yes | — | — |
selector | dict | Yes | — | — |
sample_compositions | list | Yes | — | — |
sample_schedule_references | list | Yes | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | complete | Apply composition change |
completed | No | Yes | Yes | — | Done |
failed | No | Yes | No | — | Failed |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | complete | completed | — |
pending | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "composition.delete-archived",
"initial_data": {
"organization_uuid": "value"
}
}