timeline.purge · Umwelt docs

Reference/Commands/timeline.purge

timeline.purgecommandsince 0.1

Removes every row of a discarded draft. Confirmed history is never deleted.

Command lineTypeScript.NET

Request

umwelt call story.umw timeline.purge '{
  "projectId": "ball",
  "timelineId": "other-ending"
}'

Request

const result = await client.timelinePurge({ projectId: 'ball', timelineId: 'other-ending' });

Request

var result = engine.TimelinePurge(new TimelineRef { ProjectId = "ball", TimelineId = "other-ending" });

Response

{
  "purged": true,
  "removed": { "attempts": 1, "events": 1, "records": 1, "transitions": 0 }
}

Payload

Field	Type	Description
`projectId`required	string	The project to write to.
`timelineId`required	stringdefault "main"	The timeline to write to.

Field	Type	Description
`purged`always	boolean	True once the draft is purged.
`removed`always	PurgeCounts	How many attempts, events, records and transitions were removed.

Only discarded drafts. Main and promoted drafts cannot be purged: confirmed history is never deleted.

Safe to retry. Purging a purged draft removes nothing and reports zeros. Its ids and attempt ids can be used again.

NOT_FOUNDThe project or draft does not exist.

INVALID_STATEThe timeline is main, the draft was promoted or is still active, or a discarded descendant still reads it (details.descendants).

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.