Sign in
Flows

Delete Flow

Deletes the flow and associated segments. If flow segment deletion takes too long then this request will return 202 Accepted and the Location header will point to a Flow Delete Request to monitor deletion progress

delete/flows/{flowId}

Response

This request has taken longer than the configured timeout, and will continue asynchronously

idstring required

Deletion Request ID

flow_idstring required

ID of the flow to which the deletion request relates

timerange_to_deletestring required

A timerange of timestamps. It is represented using one or two timestamps with inclusivity and exclusivity markers.

E.g.

  • [0:0_10:0) represents 10 seconds of media starting at timestamp 0:0 and ending before 10:0.
  • (5:0_ represents a timerange starting after 5:0 and to eternity.
  • [1694429247:0_1694429248:0) is a 1 second TAI timerange starting at 2023-09-11T10:46:50.0Z UTC.
  • [1694429247:0] is an instantaneous TAI timerange at 2023-09-11T10:46:50.0Z UTC. This is equivalent to [1694429247:0_1694429247:0]. The short syntax is preferred due to ease of identification as instantaneous. Instantaneous TimeRanges cannot use exclusive markers (i.e. ( or )).
  • A [ or ] indicates that bound is inclusive, and a ( or ) indicates that bound is exclusive.

Details of the format can be found in the Timestamps in TAMS application note.

timerange_remainingstring

A timerange of timestamps. It is represented using one or two timestamps with inclusivity and exclusivity markers.

E.g.

  • [0:0_10:0) represents 10 seconds of media starting at timestamp 0:0 and ending before 10:0.
  • (5:0_ represents a timerange starting after 5:0 and to eternity.
  • [1694429247:0_1694429248:0) is a 1 second TAI timerange starting at 2023-09-11T10:46:50.0Z UTC.
  • [1694429247:0] is an instantaneous TAI timerange at 2023-09-11T10:46:50.0Z UTC. This is equivalent to [1694429247:0_1694429247:0]. The short syntax is preferred due to ease of identification as instantaneous. Instantaneous TimeRanges cannot use exclusive markers (i.e. ( or )).
  • A [ or ] indicates that bound is inclusive, and a ( or ) indicates that bound is exclusive.

Details of the format can be found in the Timestamps in TAMS application note.

delete_flowboolean required

Whether the Flow should be deleted once the timerange has been

createdstring date-time

Date/Time when this deletion request was created

created_bystring

A string identifier for the entity that created the deletion request. Implementations SHOULD set suitable default values for created_by based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.

updatedstring date-time

Date/Time when this deletion request was updated

expirystring date-time

Date/Time when this deletion request will be deleted

status'created' | 'started' | 'done' | 'error' required

Status of the delete request

Changes