AWaws-samples
FlowSegments

Delete Flow Segment

Changed on

Deletes the Flow Segments. If the 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.

Services SHALL only delete Objects when they are no longer referenced by any Flow Segments or other Objects (i.e. as init Objects).

delete/flows/{flowId}/segments

Request

  • Base URL
    http://localhost:4010
  • URL
    http://localhost:4010/flows/{flowId}/segments
  • Auth
    • HTTP bearer
    • or API key in query parameter access_token
    • or HTTP basic

Query parameters

timerangestring

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.

Only delete Flow Segments that are completely covered by the given timerange.

object_idstring

Filter on Object identifier.

Response

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

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

  • e3d4dd57646bRevision changes
    • warning

      changed the pattern of the query request parameter timerange from ^(\[|\()?(-?\d+:\d+)?(_(-?\d+:\d+)?)?(\]|\))?$ to ^(\[|\()?(-?(0|[1-9][0-9]*):(0|[1-9][0-9]{0,8}))?(_(-?(0|[1-9][0-9]*):(0|[1-9][0-9]{0,8}))?)?(\]|\))?$

    • info

      the response's property pattern was changed from ^(\[|\()?(-?\d+:\d+)?(_(-?\d+:\d+)?)?(\]|\))?$ to ^(\[|\()?(-?(0|[1-9][0-9]*):(0|[1-9][0-9]{0,8}))?(_(-?(0|[1-9][0-9]*):(0|[1-9][0-9]{0,8}))?)?(\]|\))?$ for the status

    • info

      the response's property pattern was changed from ^(\[|\()?(-?\d+:\d+)?(_(-?\d+:\d+)?)?(\]|\))?$ to ^(\[|\()?(-?(0|[1-9][0-9]*):(0|[1-9][0-9]{0,8}))?(_(-?(0|[1-9][0-9]*):(0|[1-9][0-9]{0,8}))?)?(\]|\))?$ for the status

  • b01aaf8cffe2Revision changes
    • warning

      changed the pattern of the query request parameter timerange from ^(\[|\()?(-?(0|[1-9][0-9]*):(0|[1-9][0-9]{0,8}))?(_(-?(0|[1-9][0-9]*):(0|[1-9][0-9]{0,8}))?)?(\]|\))?$ to ^(\[|\()?(-?\d+:\d+)?(_(-?\d+:\d+)?)?(\]|\))?$

    • info

      the response's property pattern was changed from ^(\[|\()?(-?(0|[1-9][0-9]*):(0|[1-9][0-9]{0,8}))?(_(-?(0|[1-9][0-9]*):(0|[1-9][0-9]{0,8}))?)?(\]|\))?$ to ^(\[|\()?(-?\d+:\d+)?(_(-?\d+:\d+)?)?(\]|\))?$ for the status

    • info

      the response's property pattern was changed from ^(\[|\()?(-?(0|[1-9][0-9]*):(0|[1-9][0-9]{0,8}))?(_(-?(0|[1-9][0-9]*):(0|[1-9][0-9]{0,8}))?)?(\]|\))?$ to ^(\[|\()?(-?\d+:\d+)?(_(-?\d+:\d+)?)?(\]|\))?$ for the status