Delivery Request Submission
The DeliveryRequestSubmission contains the information the user submits on the request. This information is both the form field data (contained in formFieldValues) and the files transferred (linked via attachedAnnotations).
Structure
Internally, the Flow-API stores Delivery Request Submissions as objects with objectType:DeliveryRequestSubmission. Learn more about them here.
Listing and searching of delivery request submissions of a Delivery Workspace
Query delivery request submissions
Note that the call uses paging, so multiple calls using offset and limit might be needed to get all results. Learn more here.
GET /production/{productionId}/delivery_request_submissionThis call retrieves all delivery request submissions of a production.
Details
Description
Parameters
Path Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✔ |
Long |
Return Type
DeliveryRequestSubmission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeStatus |
✔ |
String |
Is the submission active, or is it archived? |
Enum: Active, Archived, |
allClipsPreDeliveryStatus |
✘ |
String |
Enum: TransferStarted, TransferCompleted, ProbeCompleted, TransferFailed, ProbeFailed, LinkCompleted, LinkFailed, |
|
attachedAnnotations |
✘ |
Set of DeliveryRequestSubmissionAttachedAnnotation |
||
autoValidatedAt |
✘ |
Date |
date-time |
|
autoValidationError |
✘ |
Object |
||
autoValidationReport |
✘ |
Object |
||
autoValidationStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
deliveryError |
✘ |
Object |
||
deliveryReport |
✘ |
Object |
||
deliveryRequest |
✘ |
DeliveryRequest |
||
deliveryRequestId |
✘ |
Long |
int64 |
|
deliveryStatus |
✘ |
String |
Enum: Pending, Delivered, Failed, |
|
deliveryWorkflowId |
✘ |
String |
||
formFieldValues |
✘ |
Object |
||
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 |
|
reviewStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
reviewedAt |
✘ |
Date |
date-time |
|
reviewer |
✘ |
User |
||
skipReview |
✘ |
Boolean |
||
skipValidation |
✘ |
Boolean |
||
submissionComments |
✘ |
Set of DeliveryRequestSubmissionComment |
||
submissionStatus |
✘ |
String |
Enum: Open, Draft, AwaitingProbe, AwaitingAutoValidation, AwaitingDelivery, AwaitingReview, Accepted, Rejected, DraftFailed, DeliveryFailed, |
|
submissionVersion |
✘ |
Long |
int64 |
|
submittedAt |
✘ |
Date |
date-time |
|
submitter |
✘ |
User |
||
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |
Content Type
-
application/json
Responses
| Code | Description | Datatype |
|---|---|---|
200 |
The request was successful. |
|
403 |
The user needs PRODUCTION_VIEW rights. |
|
404 |
The production or delivery request was not found. |
|
Search delivery request submissions
GET /production/{productionId}/delivery_request_submission/searchThis call searches through indexed delivery request submissions of a production.
Details
Description
Parameters
Path Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✔ |
Long |
Return Type
DeliveryRequestSubmission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeStatus |
✔ |
String |
Is the submission active, or is it archived? |
Enum: Active, Archived, |
allClipsPreDeliveryStatus |
✘ |
String |
Enum: TransferStarted, TransferCompleted, ProbeCompleted, TransferFailed, ProbeFailed, LinkCompleted, LinkFailed, |
|
attachedAnnotations |
✘ |
Set of DeliveryRequestSubmissionAttachedAnnotation |
||
autoValidatedAt |
✘ |
Date |
date-time |
|
autoValidationError |
✘ |
Object |
||
autoValidationReport |
✘ |
Object |
||
autoValidationStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
deliveryError |
✘ |
Object |
||
deliveryReport |
✘ |
Object |
||
deliveryRequest |
✘ |
DeliveryRequest |
||
deliveryRequestId |
✘ |
Long |
int64 |
|
deliveryStatus |
✘ |
String |
Enum: Pending, Delivered, Failed, |
|
deliveryWorkflowId |
✘ |
String |
||
formFieldValues |
✘ |
Object |
||
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 |
|
reviewStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
reviewedAt |
✘ |
Date |
date-time |
|
reviewer |
✘ |
User |
||
skipReview |
✘ |
Boolean |
||
skipValidation |
✘ |
Boolean |
||
submissionComments |
✘ |
Set of DeliveryRequestSubmissionComment |
||
submissionStatus |
✘ |
String |
Enum: Open, Draft, AwaitingProbe, AwaitingAutoValidation, AwaitingDelivery, AwaitingReview, Accepted, Rejected, DraftFailed, DeliveryFailed, |
|
submissionVersion |
✘ |
Long |
int64 |
|
submittedAt |
✘ |
Date |
date-time |
|
submitter |
✘ |
User |
||
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |
Content Type
-
application/json
Responses
| Code | Description | Datatype |
|---|---|---|
200 |
The request was successful. |
|
403 |
The user needs PRODUCTION_VIEW rights. |
|
404 |
The production or delivery request was not found. |
|
Get a single delivery request submission
GET /production/{productionId}/delivery_request_submission/{id}This call retrieves a delivery request submission of a production, based on their ids.
Details
Description
Parameters
Path Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✔ |
Long |
|
|
✔ |
Long |
Return Type
DeliveryRequestSubmission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeStatus |
✔ |
String |
Is the submission active, or is it archived? |
Enum: Active, Archived, |
allClipsPreDeliveryStatus |
✘ |
String |
Enum: TransferStarted, TransferCompleted, ProbeCompleted, TransferFailed, ProbeFailed, LinkCompleted, LinkFailed, |
|
attachedAnnotations |
✘ |
Set of DeliveryRequestSubmissionAttachedAnnotation |
||
autoValidatedAt |
✘ |
Date |
date-time |
|
autoValidationError |
✘ |
Object |
||
autoValidationReport |
✘ |
Object |
||
autoValidationStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
deliveryError |
✘ |
Object |
||
deliveryReport |
✘ |
Object |
||
deliveryRequest |
✘ |
DeliveryRequest |
||
deliveryRequestId |
✘ |
Long |
int64 |
|
deliveryStatus |
✘ |
String |
Enum: Pending, Delivered, Failed, |
|
deliveryWorkflowId |
✘ |
String |
||
formFieldValues |
✘ |
Object |
||
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 |
|
reviewStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
reviewedAt |
✘ |
Date |
date-time |
|
reviewer |
✘ |
User |
||
skipReview |
✘ |
Boolean |
||
skipValidation |
✘ |
Boolean |
||
submissionComments |
✘ |
Set of DeliveryRequestSubmissionComment |
||
submissionStatus |
✘ |
String |
Enum: Open, Draft, AwaitingProbe, AwaitingAutoValidation, AwaitingDelivery, AwaitingReview, Accepted, Rejected, DraftFailed, DeliveryFailed, |
|
submissionVersion |
✘ |
Long |
int64 |
|
submittedAt |
✘ |
Date |
date-time |
|
submitter |
✘ |
User |
||
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |
Content Type
-
application/json
Responses
| Code | Description | Datatype |
|---|---|---|
200 |
The request was successful. |
|
403 |
The user needs PRODUCTION_VIEW rights. |
|
404 |
The production or delivery request submission was not found. |
|
Some data will not be returned unless explicitly requested via the include query parameter.
| Include Flag | Description |
|---|---|
|
The result will have the attachedAnnotations property filled in. |
|
The result will have the deliveryRequest property filled in. |
|
The result will have the submissionComments property filled in. |
Create a new delivery request submission
To be able to submit something on a DeliveryRequest, a DeliveryRequestSubmission has to be created first.
POST /production/{productionId}/delivery_request/{deliveryRequestId}/submissionThis call creates a delivery request submission in a production.
Details
Description
Parameters
Path Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
ID of the production. |
✔ |
Long |
|
✔ |
Long |
Body Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✘ |
DeliveryRequestSubmission |
DeliveryRequestSubmission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeStatus |
✔ |
String |
Is the submission active, or is it archived? |
Enum: Active, Archived, |
allClipsPreDeliveryStatus |
✘ |
String |
Enum: TransferStarted, TransferCompleted, ProbeCompleted, TransferFailed, ProbeFailed, LinkCompleted, LinkFailed, |
|
attachedAnnotations |
✘ |
Set of DeliveryRequestSubmissionAttachedAnnotation |
||
autoValidatedAt |
✘ |
Date |
date-time |
|
autoValidationError |
✘ |
Object |
||
autoValidationReport |
✘ |
Object |
||
autoValidationStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
deliveryError |
✘ |
Object |
||
deliveryReport |
✘ |
Object |
||
deliveryRequest |
✘ |
DeliveryRequest |
||
deliveryRequestId |
✘ |
Long |
int64 |
|
deliveryStatus |
✘ |
String |
Enum: Pending, Delivered, Failed, |
|
deliveryWorkflowId |
✘ |
String |
||
formFieldValues |
✘ |
Object |
||
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 |
|
reviewStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
reviewedAt |
✘ |
Date |
date-time |
|
reviewer |
✘ |
User |
||
skipReview |
✘ |
Boolean |
||
skipValidation |
✘ |
Boolean |
||
submissionComments |
✘ |
Set of DeliveryRequestSubmissionComment |
||
submissionStatus |
✘ |
String |
Enum: Open, Draft, AwaitingProbe, AwaitingAutoValidation, AwaitingDelivery, AwaitingReview, Accepted, Rejected, DraftFailed, DeliveryFailed, |
|
submissionVersion |
✘ |
Long |
int64 |
|
submittedAt |
✘ |
Date |
date-time |
|
submitter |
✘ |
User |
||
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |
Return Type
DeliveryRequestSubmission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeStatus |
✔ |
String |
Is the submission active, or is it archived? |
Enum: Active, Archived, |
allClipsPreDeliveryStatus |
✘ |
String |
Enum: TransferStarted, TransferCompleted, ProbeCompleted, TransferFailed, ProbeFailed, LinkCompleted, LinkFailed, |
|
attachedAnnotations |
✘ |
Set of DeliveryRequestSubmissionAttachedAnnotation |
||
autoValidatedAt |
✘ |
Date |
date-time |
|
autoValidationError |
✘ |
Object |
||
autoValidationReport |
✘ |
Object |
||
autoValidationStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
deliveryError |
✘ |
Object |
||
deliveryReport |
✘ |
Object |
||
deliveryRequest |
✘ |
DeliveryRequest |
||
deliveryRequestId |
✘ |
Long |
int64 |
|
deliveryStatus |
✘ |
String |
Enum: Pending, Delivered, Failed, |
|
deliveryWorkflowId |
✘ |
String |
||
formFieldValues |
✘ |
Object |
||
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 |
|
reviewStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
reviewedAt |
✘ |
Date |
date-time |
|
reviewer |
✘ |
User |
||
skipReview |
✘ |
Boolean |
||
skipValidation |
✘ |
Boolean |
||
submissionComments |
✘ |
Set of DeliveryRequestSubmissionComment |
||
submissionStatus |
✘ |
String |
Enum: Open, Draft, AwaitingProbe, AwaitingAutoValidation, AwaitingDelivery, AwaitingReview, Accepted, Rejected, DraftFailed, DeliveryFailed, |
|
submissionVersion |
✘ |
Long |
int64 |
|
submittedAt |
✘ |
Date |
date-time |
|
submitter |
✘ |
User |
||
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |
Content Type
-
application/json
Responses
| Code | Description | Datatype |
|---|---|---|
200 |
The request was successful. |
|
403 |
The user needs DELIVERY_REQUEST_UPDATE rights. |
|
404 |
The production or delivery request was not found. |
|
The body of the call below will be a DeliveryRequestSubmission.
Note that only one active DeliveryRequestSubmission is allowed for each DeliveryRequest. See this section.
Provide material and information
In the previous section we created a DeliveryRequestSubmission. Here, we look at changing the submission. Typically, this is used to fill in the form fields and attaching material, before actually submitting the DeliveryRequestSubmission.
Filling in the form fields is done by setting the formFieldValues property of the submission, using the PUT or PATCH call below.
Update
Update a delivery request submission
PUT /production/{productionId}/delivery_request_submission/{id}This call updates a delivery request submission of a production, based on their ids.
Details
Description
Parameters
Path Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✔ |
Long |
|
|
✔ |
Long |
Body Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✘ |
DeliveryRequestSubmission |
DeliveryRequestSubmission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeStatus |
✔ |
String |
Is the submission active, or is it archived? |
Enum: Active, Archived, |
allClipsPreDeliveryStatus |
✘ |
String |
Enum: TransferStarted, TransferCompleted, ProbeCompleted, TransferFailed, ProbeFailed, LinkCompleted, LinkFailed, |
|
attachedAnnotations |
✘ |
Set of DeliveryRequestSubmissionAttachedAnnotation |
||
autoValidatedAt |
✘ |
Date |
date-time |
|
autoValidationError |
✘ |
Object |
||
autoValidationReport |
✘ |
Object |
||
autoValidationStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
deliveryError |
✘ |
Object |
||
deliveryReport |
✘ |
Object |
||
deliveryRequest |
✘ |
DeliveryRequest |
||
deliveryRequestId |
✘ |
Long |
int64 |
|
deliveryStatus |
✘ |
String |
Enum: Pending, Delivered, Failed, |
|
deliveryWorkflowId |
✘ |
String |
||
formFieldValues |
✘ |
Object |
||
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 |
|
reviewStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
reviewedAt |
✘ |
Date |
date-time |
|
reviewer |
✘ |
User |
||
skipReview |
✘ |
Boolean |
||
skipValidation |
✘ |
Boolean |
||
submissionComments |
✘ |
Set of DeliveryRequestSubmissionComment |
||
submissionStatus |
✘ |
String |
Enum: Open, Draft, AwaitingProbe, AwaitingAutoValidation, AwaitingDelivery, AwaitingReview, Accepted, Rejected, DraftFailed, DeliveryFailed, |
|
submissionVersion |
✘ |
Long |
int64 |
|
submittedAt |
✘ |
Date |
date-time |
|
submitter |
✘ |
User |
||
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |
Return Type
DeliveryRequestSubmission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeStatus |
✔ |
String |
Is the submission active, or is it archived? |
Enum: Active, Archived, |
allClipsPreDeliveryStatus |
✘ |
String |
Enum: TransferStarted, TransferCompleted, ProbeCompleted, TransferFailed, ProbeFailed, LinkCompleted, LinkFailed, |
|
attachedAnnotations |
✘ |
Set of DeliveryRequestSubmissionAttachedAnnotation |
||
autoValidatedAt |
✘ |
Date |
date-time |
|
autoValidationError |
✘ |
Object |
||
autoValidationReport |
✘ |
Object |
||
autoValidationStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
deliveryError |
✘ |
Object |
||
deliveryReport |
✘ |
Object |
||
deliveryRequest |
✘ |
DeliveryRequest |
||
deliveryRequestId |
✘ |
Long |
int64 |
|
deliveryStatus |
✘ |
String |
Enum: Pending, Delivered, Failed, |
|
deliveryWorkflowId |
✘ |
String |
||
formFieldValues |
✘ |
Object |
||
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 |
|
reviewStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
reviewedAt |
✘ |
Date |
date-time |
|
reviewer |
✘ |
User |
||
skipReview |
✘ |
Boolean |
||
skipValidation |
✘ |
Boolean |
||
submissionComments |
✘ |
Set of DeliveryRequestSubmissionComment |
||
submissionStatus |
✘ |
String |
Enum: Open, Draft, AwaitingProbe, AwaitingAutoValidation, AwaitingDelivery, AwaitingReview, Accepted, Rejected, DraftFailed, DeliveryFailed, |
|
submissionVersion |
✘ |
Long |
int64 |
|
submittedAt |
✘ |
Date |
date-time |
|
submitter |
✘ |
User |
||
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |
Content Type
-
application/json
Responses
| Code | Description | Datatype |
|---|---|---|
200 |
The request was successful. |
|
403 |
The user needs DELIVERY_REQUEST_UPDATE rights. |
|
404 |
The production or delivery request submission was not found. |
|
The body of the call will be the DeliveryRequestSubmission.
Patch a delivery request submission.
PATCH /production/{productionId}/delivery_request_submission/{id}This call patches a delivery request submission of a production based on their ids.
Details
Description
Parameters
Path Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✔ |
Long |
|
|
✔ |
Long |
Body Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✘ |
Object |
body
Field Name |
Required |
Type |
Description |
Format |
Query Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✘ |
Long |
Return Type
DeliveryRequest
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeStatus |
✘ |
String |
Is the request active, or is it archived? |
Enum: Active, Archived, |
allowFlowTransfer |
✘ |
Boolean |
Is the request allowed to transfer material to Limecraft Flow, or should it transfer to a linked VolumeAccess? |
|
allowMultipleSubmissions |
✘ |
Boolean |
Make it possible for multiple submissions to be “active” (not in an end-state APPROVED or REJECTED) at the same time. |
|
assignee |
✘ |
DeliveryRequestAssignee |
||
clientProperties |
✔ |
Object |
||
continueFromPreviousSubmission |
✘ |
Boolean |
This property influences if a new DeliveryRequestSubmission in the request dialog starts empty (if false) or starts from a clone of the last submission (if true). It is not interpreted by the API, but should be implemented by the client UI. |
|
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
deliveryDate |
✘ |
Date |
When should this request be delivered? |
date-time |
deliveryRequestType |
✔ |
String |
This should be a unique identifier of this type of request. When integrating with Limecraft Flow DeliveryRequests, you can use this property to check the type of request you are dealing with (rather than for instance use the group and subGroup fields). We strongly advise to only use alphanumerical characters and dashes to create a deliveryRequestType handle. Special characters, accents etc. should be avoided. |
|
description |
✔ |
String |
A plain-text description of what is expected to be provided in the request. It can be shown to the user as information. |
|
editorialObject |
✘ |
EditorialObject |
||
editorialObjectId |
✘ |
Long |
int64 |
|
expectedDeliveryDate |
✘ |
Date |
When do we expect this request be delivered? |
date-time |
formFieldValues |
✘ |
Object |
||
formFieldsDefinition |
✘ |
FormFieldsDefinition |
||
group |
✔ |
String |
Used to organize DeliveryRequests, but the value itself is not interpreted by the system. |
|
hideDeliveryDate |
✘ |
Boolean |
Is a client user interface not allowed to show the delivery date? |
|
id |
✔ |
Long |
The id of this resource |
int64 |
label |
✔ |
String |
A human readable label for the DeliveryRequest. This can be shown to the user. |
|
lastSubmissionApprovedDate |
✘ |
Date |
Date of approval of the last submission |
date-time |
lastUpdated |
✘ |
Date |
The time when this resource was last updated |
date-time |
layout |
✔ |
Object |
||
metadataOnly |
✘ |
Boolean |
When true, the request will not ask for file uploads. It will only show a metadata form. |
|
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 |
|
productionId |
✘ |
Long |
int64 |
|
reviewer |
✘ |
DeliveryRequestReviewer |
||
showPreviousSubmissions |
✘ |
Boolean |
Influences if the version sidebar in the request dialog is shown or not. |
|
subGroup |
✔ |
String |
Used to organize DeliveryRequests, but the value itself is not interpreted by the system. |
|
submissionStatus |
✘ |
String |
The status the DeliveryRequests last DeliveryRequestSubmission is in. |
Enum: Open, Draft, AwaitingProbe, AwaitingAutoValidation, AwaitingDelivery, AwaitingReview, Accepted, Rejected, DraftFailed, DeliveryFailed, |
submissions |
✘ |
Set of DeliveryRequestSubmission |
||
submitLocked |
✘ |
Boolean |
Marks the request as being "submission locked". This will not allow submit on existing DeliveryRequestSubmissions and will not allow creating new DeliveryRequestSubmissions |
|
tag |
✘ |
Set of string |
||
templateId |
✘ |
String |
||
validationRules |
✔ |
ValidationRules |
||
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |
volumeAccesses |
✘ |
Set of VolumeAccess |
When not uploading to Flow, the transfer will upload to one of the VolumeAccesses in here. |
Content Type
-
application/json
Responses
| Code | Description | Datatype |
|---|---|---|
200 |
The request was successful. |
|
403 |
The user needs DELIVERY_REQUEST_UPDATE rights. |
|
404 |
The production or delivery request was not found. |
|
409 |
The version in the update object does not match with the version stored causing an optimistic lock. |
|
The body of the call will be a JSON Patch. This can be used to do fine-grained updates of only certain properties, while avoiding to overwrite other properties unexpectedly.
Attach material
It is possible to link Annotations to a DeliveryRequestSubmission. This is done using DeliveryRequestSubmissionAttachedAnnotation.
So, to transfer files, you can first follow Create And Upload MediaObjects. Afterwards, you can link the created MediaObjectAnnotation to the DeliveryRequestSubmission using the calls below. This will set the attachedAnnotations property.
See also Transfer Methods.
List the attached annotations of a delivery request submission.
GET /production/{productionId}/delivery_request_submission/{id}/attachedThis call lists delivery request submission annotations of a production.
Details
Description
Parameters
Path Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✔ |
Long |
|
|
✔ |
Long |
Return Type
DeliveryRequestSubmission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeStatus |
✔ |
String |
Is the submission active, or is it archived? |
Enum: Active, Archived, |
allClipsPreDeliveryStatus |
✘ |
String |
Enum: TransferStarted, TransferCompleted, ProbeCompleted, TransferFailed, ProbeFailed, LinkCompleted, LinkFailed, |
|
attachedAnnotations |
✘ |
Set of DeliveryRequestSubmissionAttachedAnnotation |
||
autoValidatedAt |
✘ |
Date |
date-time |
|
autoValidationError |
✘ |
Object |
||
autoValidationReport |
✘ |
Object |
||
autoValidationStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
deliveryError |
✘ |
Object |
||
deliveryReport |
✘ |
Object |
||
deliveryRequest |
✘ |
DeliveryRequest |
||
deliveryRequestId |
✘ |
Long |
int64 |
|
deliveryStatus |
✘ |
String |
Enum: Pending, Delivered, Failed, |
|
deliveryWorkflowId |
✘ |
String |
||
formFieldValues |
✘ |
Object |
||
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 |
|
reviewStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
reviewedAt |
✘ |
Date |
date-time |
|
reviewer |
✘ |
User |
||
skipReview |
✘ |
Boolean |
||
skipValidation |
✘ |
Boolean |
||
submissionComments |
✘ |
Set of DeliveryRequestSubmissionComment |
||
submissionStatus |
✘ |
String |
Enum: Open, Draft, AwaitingProbe, AwaitingAutoValidation, AwaitingDelivery, AwaitingReview, Accepted, Rejected, DraftFailed, DeliveryFailed, |
|
submissionVersion |
✘ |
Long |
int64 |
|
submittedAt |
✘ |
Date |
date-time |
|
submitter |
✘ |
User |
||
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |
Content Type
-
application/json
Responses
| Code | Description | Datatype |
|---|---|---|
200 |
The request was successful. |
|
403 |
The user needs PRODUCTION_VIEW rights. |
|
404 |
The production or delivery request was not found. |
|
Tip: it is also possible to GET the DeliveryRequestSubmission and add include=attachedAnnotations as a query parameter. The result will have the attachedAnnotations property filled in.
Attach an annotation to a delivery request submission.
POST /production/{productionId}/delivery_request_submission/{id}/attachedThis call attaches annotation to delivery request submission of a production.
Details
Description
Parameters
Path Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✔ |
Long |
|
|
✔ |
Long |
Body Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✘ |
List of DeliveryRequestSubmissionAnnotationAttachRequest |
DeliveryRequestSubmissionAnnotationAttachRequest
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
annotationId |
✘ |
Long |
int64 |
|
excludeFromDelivery |
✘ |
Boolean |
||
funnel |
✘ |
String |
||
order |
✘ |
Integer |
int32 |
|
remark |
✘ |
String |
Return Type
DeliveryRequestSubmission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeStatus |
✔ |
String |
Is the submission active, or is it archived? |
Enum: Active, Archived, |
allClipsPreDeliveryStatus |
✘ |
String |
Enum: TransferStarted, TransferCompleted, ProbeCompleted, TransferFailed, ProbeFailed, LinkCompleted, LinkFailed, |
|
attachedAnnotations |
✘ |
Set of DeliveryRequestSubmissionAttachedAnnotation |
||
autoValidatedAt |
✘ |
Date |
date-time |
|
autoValidationError |
✘ |
Object |
||
autoValidationReport |
✘ |
Object |
||
autoValidationStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
deliveryError |
✘ |
Object |
||
deliveryReport |
✘ |
Object |
||
deliveryRequest |
✘ |
DeliveryRequest |
||
deliveryRequestId |
✘ |
Long |
int64 |
|
deliveryStatus |
✘ |
String |
Enum: Pending, Delivered, Failed, |
|
deliveryWorkflowId |
✘ |
String |
||
formFieldValues |
✘ |
Object |
||
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 |
|
reviewStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
reviewedAt |
✘ |
Date |
date-time |
|
reviewer |
✘ |
User |
||
skipReview |
✘ |
Boolean |
||
skipValidation |
✘ |
Boolean |
||
submissionComments |
✘ |
Set of DeliveryRequestSubmissionComment |
||
submissionStatus |
✘ |
String |
Enum: Open, Draft, AwaitingProbe, AwaitingAutoValidation, AwaitingDelivery, AwaitingReview, Accepted, Rejected, DraftFailed, DeliveryFailed, |
|
submissionVersion |
✘ |
Long |
int64 |
|
submittedAt |
✘ |
Date |
date-time |
|
submitter |
✘ |
User |
||
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |
Content Type
-
application/json
Responses
| Code | Description | Datatype |
|---|---|---|
200 |
The request was successful. |
|
403 |
The user needs DELIVERY_REQUEST_UPDATE rights. |
|
404 |
The production or delivery request was not found. |
|
Detach an annotation to a delivery request submission.
DELETE /production/{productionId}/delivery_request_submission/{id}/attached/{annotationId}This call detaches annotation of a delivery request submission of a production.
Details
Description
Parameters
Path Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
ID of the production. |
✔ |
Long |
|
✔ |
Long |
|
|
✔ |
Long |
Body Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✘ |
DeleteRequest |
DeleteRequest
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
force |
✘ |
Boolean |
||
hard |
✘ |
Boolean |
Return Type
DeliveryRequestSubmission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeStatus |
✔ |
String |
Is the submission active, or is it archived? |
Enum: Active, Archived, |
allClipsPreDeliveryStatus |
✘ |
String |
Enum: TransferStarted, TransferCompleted, ProbeCompleted, TransferFailed, ProbeFailed, LinkCompleted, LinkFailed, |
|
attachedAnnotations |
✘ |
Set of DeliveryRequestSubmissionAttachedAnnotation |
||
autoValidatedAt |
✘ |
Date |
date-time |
|
autoValidationError |
✘ |
Object |
||
autoValidationReport |
✘ |
Object |
||
autoValidationStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
deliveryError |
✘ |
Object |
||
deliveryReport |
✘ |
Object |
||
deliveryRequest |
✘ |
DeliveryRequest |
||
deliveryRequestId |
✘ |
Long |
int64 |
|
deliveryStatus |
✘ |
String |
Enum: Pending, Delivered, Failed, |
|
deliveryWorkflowId |
✘ |
String |
||
formFieldValues |
✘ |
Object |
||
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 |
|
reviewStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
reviewedAt |
✘ |
Date |
date-time |
|
reviewer |
✘ |
User |
||
skipReview |
✘ |
Boolean |
||
skipValidation |
✘ |
Boolean |
||
submissionComments |
✘ |
Set of DeliveryRequestSubmissionComment |
||
submissionStatus |
✘ |
String |
Enum: Open, Draft, AwaitingProbe, AwaitingAutoValidation, AwaitingDelivery, AwaitingReview, Accepted, Rejected, DraftFailed, DeliveryFailed, |
|
submissionVersion |
✘ |
Long |
int64 |
|
submittedAt |
✘ |
Date |
date-time |
|
submitter |
✘ |
User |
||
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |
Content Type
-
application/json
Responses
| Code | Description | Datatype |
|---|---|---|
200 |
The request was successful. |
|
403 |
The user needs DELIVERY_REQUEST_UPDATE rights. |
|
404 |
The production or delivery request was not found. |
|
Submit a DeliveryRequestSubmission
Earlier on this page, we learned how to create a DeliveryRequestSubmission, and how to update its form fields and attach clips to it. Now, finally, let’s look at submitting the DeliveryRequestSubmission.
PUT /production/{productionId}/delivery_request_submission/{id}/submitThis call submits a delivery request submission of a production.
Details
Description
Parameters
Path Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✔ |
Long |
|
|
✔ |
Long |
Body Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✘ |
Object |
body
Field Name |
Required |
Type |
Description |
Format |
Return Type
DeliveryRequestSubmission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeStatus |
✔ |
String |
Is the submission active, or is it archived? |
Enum: Active, Archived, |
allClipsPreDeliveryStatus |
✘ |
String |
Enum: TransferStarted, TransferCompleted, ProbeCompleted, TransferFailed, ProbeFailed, LinkCompleted, LinkFailed, |
|
attachedAnnotations |
✘ |
Set of DeliveryRequestSubmissionAttachedAnnotation |
||
autoValidatedAt |
✘ |
Date |
date-time |
|
autoValidationError |
✘ |
Object |
||
autoValidationReport |
✘ |
Object |
||
autoValidationStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
deliveryError |
✘ |
Object |
||
deliveryReport |
✘ |
Object |
||
deliveryRequest |
✘ |
DeliveryRequest |
||
deliveryRequestId |
✘ |
Long |
int64 |
|
deliveryStatus |
✘ |
String |
Enum: Pending, Delivered, Failed, |
|
deliveryWorkflowId |
✘ |
String |
||
formFieldValues |
✘ |
Object |
||
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 |
|
reviewStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
reviewedAt |
✘ |
Date |
date-time |
|
reviewer |
✘ |
User |
||
skipReview |
✘ |
Boolean |
||
skipValidation |
✘ |
Boolean |
||
submissionComments |
✘ |
Set of DeliveryRequestSubmissionComment |
||
submissionStatus |
✘ |
String |
Enum: Open, Draft, AwaitingProbe, AwaitingAutoValidation, AwaitingDelivery, AwaitingReview, Accepted, Rejected, DraftFailed, DeliveryFailed, |
|
submissionVersion |
✘ |
Long |
int64 |
|
submittedAt |
✘ |
Date |
date-time |
|
submitter |
✘ |
User |
||
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |
Content Type
-
application/json
Responses
| Code | Description | Datatype |
|---|---|---|
200 |
The request was successful. |
|
403 |
The user needs DELIVERY_REQUEST_SUBMIT rights. |
|
404 |
The production or delivery request submission was not found. |
|
The body will be an empty object. Optionally, one can provide a submissionComment:
{
"submissionComment": {
"description": "this is a submission comment"
}
}The submit call above will result in starting the submission workflow. The submissionStatus will change while the workflow proceeds, eventually ending up in either DeliveryFailed , AwaitingReview or Rejected.
Review
If the submissionStatus is AwaitingReview, a user with the DELIVERY_REQUEST_REVIEW permission can either reject, or approve the DeliveryRequestSubmission.
Reject a delivery request submission.
PUT /production/{productionId}/delivery_request_submission/{id}/rejectThis call rejects a delivery request submission of a production.
Details
Description
Parameters
Path Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✔ |
Long |
|
|
✔ |
Long |
Body Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✘ |
Object |
body
Field Name |
Required |
Type |
Description |
Format |
Return Type
DeliveryRequestSubmission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeStatus |
✔ |
String |
Is the submission active, or is it archived? |
Enum: Active, Archived, |
allClipsPreDeliveryStatus |
✘ |
String |
Enum: TransferStarted, TransferCompleted, ProbeCompleted, TransferFailed, ProbeFailed, LinkCompleted, LinkFailed, |
|
attachedAnnotations |
✘ |
Set of DeliveryRequestSubmissionAttachedAnnotation |
||
autoValidatedAt |
✘ |
Date |
date-time |
|
autoValidationError |
✘ |
Object |
||
autoValidationReport |
✘ |
Object |
||
autoValidationStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
deliveryError |
✘ |
Object |
||
deliveryReport |
✘ |
Object |
||
deliveryRequest |
✘ |
DeliveryRequest |
||
deliveryRequestId |
✘ |
Long |
int64 |
|
deliveryStatus |
✘ |
String |
Enum: Pending, Delivered, Failed, |
|
deliveryWorkflowId |
✘ |
String |
||
formFieldValues |
✘ |
Object |
||
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 |
|
reviewStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
reviewedAt |
✘ |
Date |
date-time |
|
reviewer |
✘ |
User |
||
skipReview |
✘ |
Boolean |
||
skipValidation |
✘ |
Boolean |
||
submissionComments |
✘ |
Set of DeliveryRequestSubmissionComment |
||
submissionStatus |
✘ |
String |
Enum: Open, Draft, AwaitingProbe, AwaitingAutoValidation, AwaitingDelivery, AwaitingReview, Accepted, Rejected, DraftFailed, DeliveryFailed, |
|
submissionVersion |
✘ |
Long |
int64 |
|
submittedAt |
✘ |
Date |
date-time |
|
submitter |
✘ |
User |
||
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |
Content Type
-
application/json
Responses
| Code | Description | Datatype |
|---|---|---|
200 |
The request was successful. |
|
403 |
The user needs DELIVERY_REQUEST_REVIEW rights. |
|
404 |
The production or delivery request submission was not found. |
|
The body is similar to the body of the submit call explained above. It can also have a submissionComment.
Approve a delivery request submission.
PUT /production/{productionId}/delivery_request_submission/{id}/approveThis call approves a delivery request submission of a production.
Details
Description
Parameters
Path Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✔ |
Long |
|
|
✔ |
Long |
Body Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✘ |
Object |
body
Field Name |
Required |
Type |
Description |
Format |
Return Type
DeliveryRequestSubmission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeStatus |
✔ |
String |
Is the submission active, or is it archived? |
Enum: Active, Archived, |
allClipsPreDeliveryStatus |
✘ |
String |
Enum: TransferStarted, TransferCompleted, ProbeCompleted, TransferFailed, ProbeFailed, LinkCompleted, LinkFailed, |
|
attachedAnnotations |
✘ |
Set of DeliveryRequestSubmissionAttachedAnnotation |
||
autoValidatedAt |
✘ |
Date |
date-time |
|
autoValidationError |
✘ |
Object |
||
autoValidationReport |
✘ |
Object |
||
autoValidationStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
deliveryError |
✘ |
Object |
||
deliveryReport |
✘ |
Object |
||
deliveryRequest |
✘ |
DeliveryRequest |
||
deliveryRequestId |
✘ |
Long |
int64 |
|
deliveryStatus |
✘ |
String |
Enum: Pending, Delivered, Failed, |
|
deliveryWorkflowId |
✘ |
String |
||
formFieldValues |
✘ |
Object |
||
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 |
|
reviewStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
reviewedAt |
✘ |
Date |
date-time |
|
reviewer |
✘ |
User |
||
skipReview |
✘ |
Boolean |
||
skipValidation |
✘ |
Boolean |
||
submissionComments |
✘ |
Set of DeliveryRequestSubmissionComment |
||
submissionStatus |
✘ |
String |
Enum: Open, Draft, AwaitingProbe, AwaitingAutoValidation, AwaitingDelivery, AwaitingReview, Accepted, Rejected, DraftFailed, DeliveryFailed, |
|
submissionVersion |
✘ |
Long |
int64 |
|
submittedAt |
✘ |
Date |
date-time |
|
submitter |
✘ |
User |
||
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |
Content Type
-
application/json
Responses
| Code | Description | Datatype |
|---|---|---|
200 |
The request was successful. |
|
403 |
The user needs DELIVERY_REQUEST_REVIEW rights. |
|
404 |
The production or delivery request submission was not found. |
|
The body is similar to the body of the submit call explained above. It can also have a submissionComment.
Archiving DeliveryRequestSubmissions
When a DeliveryRequestSubmission was created by accident, it can be archived.
PUT /production/{productionId}/delivery_request_submission/{id}/archiveThis call archives a delivery request submission of a production, based on their ids.
Details
Description
This call is reserved for at least the user with the support privilege
Parameters
Path Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✔ |
Long |
|
|
✔ |
Long |
Return Type
DeliveryRequestSubmission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeStatus |
✔ |
String |
Is the submission active, or is it archived? |
Enum: Active, Archived, |
allClipsPreDeliveryStatus |
✘ |
String |
Enum: TransferStarted, TransferCompleted, ProbeCompleted, TransferFailed, ProbeFailed, LinkCompleted, LinkFailed, |
|
attachedAnnotations |
✘ |
Set of DeliveryRequestSubmissionAttachedAnnotation |
||
autoValidatedAt |
✘ |
Date |
date-time |
|
autoValidationError |
✘ |
Object |
||
autoValidationReport |
✘ |
Object |
||
autoValidationStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
deliveryError |
✘ |
Object |
||
deliveryReport |
✘ |
Object |
||
deliveryRequest |
✘ |
DeliveryRequest |
||
deliveryRequestId |
✘ |
Long |
int64 |
|
deliveryStatus |
✘ |
String |
Enum: Pending, Delivered, Failed, |
|
deliveryWorkflowId |
✘ |
String |
||
formFieldValues |
✘ |
Object |
||
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 |
|
reviewStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
reviewedAt |
✘ |
Date |
date-time |
|
reviewer |
✘ |
User |
||
skipReview |
✘ |
Boolean |
||
skipValidation |
✘ |
Boolean |
||
submissionComments |
✘ |
Set of DeliveryRequestSubmissionComment |
||
submissionStatus |
✘ |
String |
Enum: Open, Draft, AwaitingProbe, AwaitingAutoValidation, AwaitingDelivery, AwaitingReview, Accepted, Rejected, DraftFailed, DeliveryFailed, |
|
submissionVersion |
✘ |
Long |
int64 |
|
submittedAt |
✘ |
Date |
date-time |
|
submitter |
✘ |
User |
||
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |
Content Type
-
application/json
Responses
| Code | Description | Datatype |
|---|---|---|
200 |
The request was successful. |
|
403 |
The user needs DELIVERY_REQUEST_ARCHIVE rights. |
|
404 |
The production or delivery request submission was not found. |
|
409 |
The version in the update object does not match with the version stored causing an optimistic lock |
|
The body is an empty object {}. The activeStatus of the DeliveryRequestSubmission will change from Active to Archived.
Note that Archived DeliveryRequestSubmissions will still appear in listing and search calls, and should be filtered out by the client application using them. In the Limecraft Flow UI, Archived submissions are filtered out by default.
It is possible to activate an Archived DeliveryRequestSubmission using the call below.
PUT /production/{productionId}/delivery_request_submission/{id}/activateThis call activates a delivery request submission of a production that was previously archived.
Details
Description
This call is reserved for at least the user with the support privilege
Parameters
Path Parameters
| Name | Description | Required | Type |
|---|---|---|---|
|
✔ |
Long |
|
|
✔ |
Long |
Return Type
DeliveryRequestSubmission
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeStatus |
✔ |
String |
Is the submission active, or is it archived? |
Enum: Active, Archived, |
allClipsPreDeliveryStatus |
✘ |
String |
Enum: TransferStarted, TransferCompleted, ProbeCompleted, TransferFailed, ProbeFailed, LinkCompleted, LinkFailed, |
|
attachedAnnotations |
✘ |
Set of DeliveryRequestSubmissionAttachedAnnotation |
||
autoValidatedAt |
✘ |
Date |
date-time |
|
autoValidationError |
✘ |
Object |
||
autoValidationReport |
✘ |
Object |
||
autoValidationStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
deliveryError |
✘ |
Object |
||
deliveryReport |
✘ |
Object |
||
deliveryRequest |
✘ |
DeliveryRequest |
||
deliveryRequestId |
✘ |
Long |
int64 |
|
deliveryStatus |
✘ |
String |
Enum: Pending, Delivered, Failed, |
|
deliveryWorkflowId |
✘ |
String |
||
formFieldValues |
✘ |
Object |
||
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 |
|
reviewStatus |
✘ |
String |
Enum: Pending, Rejected, Accepted, |
|
reviewedAt |
✘ |
Date |
date-time |
|
reviewer |
✘ |
User |
||
skipReview |
✘ |
Boolean |
||
skipValidation |
✘ |
Boolean |
||
submissionComments |
✘ |
Set of DeliveryRequestSubmissionComment |
||
submissionStatus |
✘ |
String |
Enum: Open, Draft, AwaitingProbe, AwaitingAutoValidation, AwaitingDelivery, AwaitingReview, Accepted, Rejected, DraftFailed, DeliveryFailed, |
|
submissionVersion |
✘ |
Long |
int64 |
|
submittedAt |
✘ |
Date |
date-time |
|
submitter |
✘ |
User |
||
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |
Content Type
-
application/json
Responses
| Code | Description | Datatype |
|---|---|---|
200 |
The request was successful. |
|
403 |
The user needs DELIVERY_REQUEST_ARCHIVE rights. |
|
404 |
The production or delivery request submission was not found. |
|
409 |
The version in the update object does not match with the version stored causing an optimistic lock |
|
The body is an empty object {}. The activeStatus of the DeliveryRequestSubmission will change from Archived to Active.
Delivery Request Submission Life Cycle
See submissionStatus.