Sign in
FlowDeleteRequests

List Flow Delete Requests

List deletion requests currently being worked on, for monitoring in development.

This will not necessarily list all requests, nor return a consistent set in any particular order, and should not be relied upon by clients. However if there are any requests in the system, it will always return at least one.

get/flow-delete-requests

Query parameters

reverse_orderboolean

Return Flow Delete Requests in reverse order.

sort_by'created' | 'expiry'

Parameter to sort Flow Delete Requests by. created and expiry sort most recent first by default. Sorting may be reversed using the reverse_order query parameter. Assume created if not set. For resources where the selected parameter is unset, id shall be used. Resources using this fallback shall be sorted after those that aren't by default, and before when reverse_order is true.

pagestring

Opaque string used by backend to access a specific page of results. Clients should read the next URL from the Link header returned with responses, or use value of the returned X-Paging-NextKey header. If not supplied, the first page is accessed. Service implementations should ensure a consistent sort order is applied to pages of results.

limitinteger

Restrict the response to the specified number of results. Service implementations may specify their own default and maximum for the limit

Response

idstring required

A Universally Unique Identifier (UUID) as defined in RFC9562

flow_idstring required

A Universally Unique Identifier (UUID) as defined in RFC9562

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.
  • _ without timestamps or inclusivity markers represents "eternity" (i.e. the entire timeline).
  • () without timestamps represents "never" (i.e. a range of zero length in no particular position).
  • [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.
  • _ without timestamps or inclusivity markers represents "eternity" (i.e. the entire timeline).
  • () without timestamps represents "never" (i.e. a range of zero length in no particular position).
  • [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. Service implementations SHOULD set suitable default values for created_by based on the principal accessing the system.

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