DocumentationCampaign Standard Documentation

Campaign (nms:campaign)

Last update: Tue Mar 22 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Experienced
  • Developer

Object description

Name
Label
Type (length)
Enumeration values
PKey
Main resource ID
string
activities
Activities
collection
builtIn
Built-in application object
boolean
created
Created
date
createdBy (userBase)
Created by
link
desc
Description
string (512)
duration
Campaign duration
number
end
End date
date
geoUnit (geoUnitBase)
Geographical unit
link
isExternal
Is external resource
boolean
isTemplate
Template
boolean
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__
modifiedBy (userBase)
Modified by
link
name
ID
string (64)
orgUnit (orgUnitBase)
Organizational unit
link
program (programBase)
Program
link
realtimeReport
Realtime Reports
item
start
Start date
date
status
Status
enumeration (byte)
  • Started - started - 1
  • Editing - edition - 0
  • Finished - finished - 2
  • INVALID VALUE - __Invalid_value__ - __Invalid_value__
template (campaign)
Campaign template
link
thumbnail
Thumbnail
string (255)
title
Campaign
string (255)

Filters

By logical status (byLogicalStatus)

Name
Type
state
enumeration

By name or label (byText)

Name
Type
text
string

By period (byPeriod)

Name
Type
startDate
date
timePeriod
string

By status (byState)

Name
Type
state
enumeration

Include continuous deliveries from a heterogeneous list (withContinuous)

Name
Type
withContinuous
boolean

Planned for the given period (byPlanning)

Name
Type
startDate
date
endDate
date

Present during given period (byCalendar)

Name
Type
startDate
date
endDate
date
recommendation-more-help
3ef63344-7f3d-48f9-85ed-02bf569c4fff