Delivery (nms:delivery)

Last update: 2022-03-22
  • Created for:
  • Experienced
    Developer

Object description

Name Label Type (length) Enumeration values
FCP Proof boolean  
PKey Main resource ID string  
abTesting A/B Testing item  
advanced Advanced delivery boolean  
advancedParameters Advanced parameters item  
aemContents Adobe Experience Manager contents collection  
alertMessage Warning message string  
alertMode Warning type string  
attachment Attached files collection  
branding (brandingBase) Brand link  
broadLogs Delivery logs collection  
builtIn Built-in application object boolean  
campaign (campaignBase) Campaign link  
cmsAccount (extAccountAEMBase) Adobe Experience Manager account link  
commands Commands item  
content Content item  
contentSource Content source enumeration (byte)
  • Adobe Experience Manager - aem - 1
  • Adobe Campaign - campaign - 0
  • INVALID VALUE - __Invalid_value__ - __Invalid_value__
contextResourceType Resource type string  
created Created date  
createdBy (userBase) Created by link  
deliveryMode Delivery mode enumeration (byte)
  • Bulk delivery - bulk - 1
  • Mid-sourcing - midSourcing - 4
  • Description - descriptive - 2
  • INVALID VALUE - __Invalid_value__ - __Invalid_value__
  • External - external - 0
deliveryProvider (extAccountBase) Routing link  
desc Description string (512)  
emailPreview Email preview item  
excludeLogs Exclusion logs collection  
exclusions Exclusion causes collection  
execution Delivery execution parameters item  
executionType Execution type enumeration (byte)
  • Unique - oneTime - 0
  • Continuous - continuous - 1
  • Message Center - messageCenter - 2
  • INVALID VALUE - __Invalid_value__ - __Invalid_value__
forecastLogs ForecastLog collection  
geoUnit (geoUnitBase) Geographical unit link  
hasAttachments Add attached files boolean  
icon Icon enumeration (byte)
  • Transactional email - emailLightning - 60
  • Fax - fax - 4
  • Mobile (SMS) - sms - 1
  • Recurring email - emailRefresh - 30
  • Direct mail - paper - 3
  • Phone - phone - 2
  • Other - other - 120
  • Recurring SMS - smsRefresh - 31
  • Mobile application - pushNotification - 40
  • Transactional SMS - smsLightning - 61
  • Email - email - 0
  • INVALID VALUE - __Invalid_value__ - __Invalid_value__
isExternal Is external resource boolean  
isMaster Master boolean  
isTemplate Template boolean  
iterations Deliveries collection  
job Job collection  
jobLogs Logs collection  
kpis Indicators item  
label Label string (128)  
lastModified Last modified date  
logicalStatus Execution status enumeration (string) (255)
  • In progress - started - started
  • Editing - edition - edition
  • Finished - finished - finished
  • Warning - warning - warning
  • Erroneous - error - error
  • INVALID VALUE - __Invalid_value__ - __Invalid_value__
mailParameters Email header parameters item  
mainDate Date date  
mapping (deliveryMapping) Target mapping link  
master (deliveryBase) Master instance link  
masterKpis Master indicators item  
messageType Channel enumeration (byte)
  • Fax - fax - 4
  • Mobile (SMS) - sms - 1
  • Email - email - 0
  • Phone - phone - 2
  • Direct mail - paper - 3
  • Mobile application - pushNotification - 40
  • Other - other - 120
  • INVALID VALUE - __Invalid_value__ - __Invalid_value__
modifiedBy (userBase) Modified by link  
name ID string (64)  
offerManagement Offer Management item  
orgUnit (orgUnitBase) Organizational unit link  
parent (deliveryBase) Parent delivery link  
priority Delivery priority enumeration (byte)
  • High - high - 20
  • INVALID VALUE - __Invalid_value__ - __Invalid_value__
  • Normal - normal - 10
program (programBase) Program link  
proofs Proofs collection  
pushNotificationPreview Push notification preview item  
pushnotificationParameters PushNotification parameters item  
realtimeReport Realtime Reports item  
resourceVersion Resource version string (255)  
ribbonMessage Ribbon message string  
scenario Delivery template parameters item  
scheduling Delivery scheduling item  
smsParameters SMS parameters item  
smsPreview SMS preview item  
state Status enumeration (byte)
  • Start pending - startPending - 51
  • Ready to be delivered - ready - 45
  • Retry pending - retryPending - 61
  • Retry in progress - retryInProgress - 62
  • Failed - failed - 87
  • In progress - started - 55
  • Targeting pending - targetPrepPending - 11
  • Personalization pending - messagePrepPending - 21
  • Paused - paused - 75
  • Editing - edition - 0
  • Finished - finished - 95
  • Counting in progress - targetSelection - 12
  • Message finalized - messageReady - 25
  • Personalization or count failed - preparationError - 37
  • Stopped - cancelled - 85
  • Personalization in progress - messagePreparation - 22
  • Target ready - targetReady - 15
  • INVALID VALUE - __Invalid_value__ - __Invalid_value__
  • Arbitration in progress - targetArbitration - 13
targets Delivery target population item  
template (deliveryTemplateSummary) Delivery template link  
thumbnail Delivery thumbnail string (255)  
title Delivery string (255)  
tracking Tracking parameters item  
trackingLogs Tracking logs collection  
trackingUrls Tracked URLs collection  
triggerMessage Parameters of the transactional message item  
typology (typologyBase) Typology link  
workflow (workflowBase) Targeting workflow link  
workflowStatus Workflow status enumeration (string) (255)
  • In progress - started - started
  • Editing - edition - edition
  • Finished - finished - finished
  • Warning - warning - warning
  • Erroneous - error - error
  • INVALID VALUE - __Invalid_value__ - __Invalid_value__

Filters

By channel type (byChannel)

Name Type
channel enumeration

By execution type (byExecutionType)

Name Type
executionType enumeration

By logical status (byLogicalStatus)

Name Type
state enumeration

By name or label (byText)

Name Type
text string
mc string

By period (byPeriod)

Name Type
timePeriod string

By period (byStartPeriod)

Name Type
startDate date
timePeriod string

By publication status (byPublicationStatus)

Name Type
pStatus enumeration

By status (byState)

Name Type
state enumeration

Follow-up messages (showFollowup)

Name Type
followup boolean

Include advanced deliveries (withAdvanced)

Name Type
advanced boolean

Include continuous deliveries from a heterogeneous list (withContinuous)

Name Type
withContinuous boolean

Include proofs (withFCP)

Name Type
withFCP boolean

Planned during the given period (byPlanning)

Name Type
startDate date
endDate date

Present during given period (byCalendar)

Name Type
startDate date
endDate date

Show out-of-the-box (showOob)

Name Type
oob boolean
Previous page
Next page

On this page