DeliveryRequestSubmissionAttachedAnnotation

Represents the relation between a DeliveryRequestSubmission and a Annotation that is part of the submission (files that need to be transferred).

For example, the DeliveryRequestSubmission shown below contains three DeliveryRequestSubmissionAttachedAnnotations.

dialog draft

Property Reference

Field Name Required Type Description Format

annotation

✘

Annotation

created

✘

Date

The time when this resource was created

date-time

createdBy

✘

String

The request or process that created this resource

deliveryRequestSubmission

✘

DeliveryRequestSubmission

excludeFromDelivery

✘

Boolean

funnel

✘

String

id

✔

Long

The id of this resource

int64

lastUpdated

✘

Date

The time when this resource was last updated

date-time

modifiedBy

✔

String

The request or process responsible for the last update of this resource

objectType

✘

String

The data model type or class name of this resource

order

✘

Integer

int32

preDeliveryStatus

✘

String

Enum: TransferStarted, TransferCompleted, ProbeCompleted, TransferFailed, ProbeFailed, LinkCompleted, LinkFailed,

remark

✘

String

version

✔

Long

The version of this resource, used for Optimistic Locking

int64

preDeliveryStatus

The preDeliveryStatus contains the status of the attached clip. Possible values are given in the table below.

preDeliveryStatus Description

TransferStarted

The transfer has been started

TransferCompleted

The transfer completed

ProbeCompleted

The probe step (read media info from file) has completed

TransferFailed

The transfer did not complete successfully

ProbeFailed

The probe step did not complete successfully

LinkCompleted

The link step which links a Transfer.completed or Transfer.failed back to a clip completed sucessfully

LinkFailed

The link step which links a Transfer.completed or Transfer.failed back to a clip did not complete sucessfully

The submissionStatus of the DeliveryRequestSubmission is influenced by the preDeliveryStatus of its DeliveryRequestSubmissionAttachedAnnotations.

  • Only if all DeliveryRequestSubmissionAttachedAnnotations have a preDeliveryStatus of ProbeCompleted, the submission will be considered to be ProbeCompleted.

  • Failure to probe a DeliveryRequestSubmissionAttachedAnnotations will result in a