DeliveryRequestTemplate

A DeliveryRequestTemplate describes a single type of request. For example it describes "a Season level Visuals request". Note that it is not a DeliveryRequest, but rather the blueprint for creating such a DeliveryRequest.

It contains the definition of form fields, whether the DeliveryRequest should expect file transfers (and if those should go via Limecraft Flow or through a VolumeAccess) etc.

Property Reference

This is a table of the properties of a DeliveryRequestTemplate object. You’ll notice that most properties are similar to DeliveryRequest. For those properties, we refer to DeliveryRequest for a more detailed explanation.

Field Name	Required	Type	Description	Format
allowFlowTransfer	✘	Boolean
allowMultipleSubmissions	✘	Boolean
assignee	✘	DeliveryRequestAssignee
clientProperties	✘	Object
continueFromPreviousSubmission	✘	Boolean
created	✘	Date	The time when this resource was created	date-time
createdBy	✘	String	The request or process that created this resource
deliveryDate	✘	Date	When should this request be delivered?	date-time
deliveryRequestTemplateInstances	✘	List of DeliveryRequestTemplateInstance
deliveryRequestType	✘	String
description	✘	String
expectedDeliveryDate	✘	Date	When do we expect this request be delivered?	date-time
formFieldValues	✘	Object
formFieldsDefinition	✘	FormFieldsDefinition
group	✘	String
handle	✘	String
hideDeliveryDate	✘	Boolean
id	✔	Long	The id of this resource	int64
label	✘	String
lastUpdated	✘	Date	The time when this resource was last updated	date-time
layout	✘	Object
metadataOnly	✘	Boolean
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
reviewer	✘	DeliveryRequestReviewer
showPreviousSubmissions	✘	Boolean
subGroup	✘	String
tag	✘	List of string
templateGroup	✘	DeliveryRequestTemplateGroup
validationRules	✘	ValidationRules
version	✔	Long	The version of this resource, used for Optimistic Locking	int64
volumeAccessQuery	✘	ObjectFilter

Field Name

Required

Type

Description

Format

allowFlowTransfer

✘

Boolean

allowMultipleSubmissions

✘

Boolean

assignee

✘

DeliveryRequestAssignee

clientProperties

✘

Object

continueFromPreviousSubmission

✘

Boolean

created

✘

Date

The time when this resource was created

date-time

createdBy

✘

String

The request or process that created this resource

deliveryDate

✘

Date

When should this request be delivered?

date-time

deliveryRequestTemplateInstances

✘

List of DeliveryRequestTemplateInstance

deliveryRequestType

✘

String

description

✘

String

expectedDeliveryDate

✘

Date

When do we expect this request be delivered?

date-time

formFieldValues

✘

Object

formFieldsDefinition

✘

FormFieldsDefinition

group

✘

String

handle

✘

String

hideDeliveryDate

✘

Boolean

✔

Long

The id of this resource

int64

label

✘

String

lastUpdated

✘

Date

The time when this resource was last updated

date-time

layout

✘

Object

metadataOnly

✘

Boolean

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

reviewer

✘

DeliveryRequestReviewer

showPreviousSubmissions

✘

Boolean

subGroup

✘

String

tag

✘

List of string

templateGroup

✘

DeliveryRequestTemplateGroup

validationRules

✘

ValidationRules

version

✔

Long

The version of this resource, used for Optimistic Locking

int64

volumeAccessQuery

✘

ObjectFilter

handle

A unique string identifying the DeliveryRequestTemplate and its purpose. E.g. "seasonVisuals".

We strongly advise to only use alphanumerical characters, dashes and underscores to create a deliveryRequestType handle. Special characters, accents etc. should be avoided.

volumeAccessQuery

Can be used to fill in the volumeAccesses of the DeliveryRequest dynamically.

Example

{
    "key": "handle",
    "@values": [
        "context.parameters.volumeAccessHandle"
    ]
}