Objects
Dispatch
Returned by dispatch query
id
orgId
orgName
userId
authorId
swimlaneId
userName
authorName
swimlaneName
trackerName
displayName
: materialized nametrackerId
swimlaneIcon
trackerIcon
when
createdAt
updatedAt
taskState
startTime
endTime
displayFormat
displayExpression
data
body
: body as textblocks
: gody as JSON blocksactions
attachments
serviceId
batchId
linkedId
orgTitle
globalTitle
programId
security
status
User
Returned by user query
id
email
first
last
name
mobile
timezone
createdAt
: when added to the orgexternalId
: org configurable idexternalStatus
: org configurable statusrole
: user | adminlabels
gender
: male | female | othergenderDetail
: user providedgroups
lastSignInAt
: last sign in date timelocationCity
locationCountry
locationRegion
: ISO region codelocationContinent
UserTotal
Returned by stats query
userId
name
count
first
last
currentSignInAt
UserStatistic
Returned by stats query
userId
: system id for the useruserName
:trackerId
: tracker infotrackerHandle
: tracker infocount
: entry countlatestActivity
: most recent created or updated date for the time spanlatestWhen
: date of the post (may differ from creation)
ProgramParticipation
Returned by programs query
programName
- program nameprogramKind
- program kind idprogramId
- program idprogramGroup
- program kind groupbaseName
- program kind namebaseHandle
- program kind handlecohortId
cohortName
state
startDate
endDate
duration
mode
role
userId
email
userName
orgStatus
sameProgramCompletions
allProgramCompletions
sameProgramIncomplete
allProgramIncomplete
userYear
Org
Org data structure
id
name
parentId
createdAt
updatedAt
displayName
ProgramInfo
Program instance
id
: program idname
: name of the instancecreatedAt
updatedAt
startDate
duration
: in daysmode
: fixed | openprogramKind
: id of the program kindbaseName
: name of the program kindbaseHandle
: handle of the program kindprogramKindParent
: parent id for the kindpriority
: configurable number priorityparentId
: parent id for the programschedulingRule
: rule for schedulinghandle
: for the program instance
Program
Program instance
- .. same fields as ProgramInfo
document
: full program definition documentcatalog
: catalog defintion
Cohort
Cohort information
document
: full program definition documentcatalog
: catalog defintion
ProgramTicket
Program tickets represent a right to participate in a program.
id:Uuid
- ticket idprogramKindId:Uuid
- program kinduserId:Uuid
- user idprogramId:Uuid
- program idexternalId: String
- external id of the ticketcreatedAt: DateTime
- createdupdatedAt: DateTime
- updatedconsumedAt: DateTime
- consumed atstate: String
- ready | consumed | canceledstartDate: LocalDate
- start of the programendDate: LocalDate
- endprogramDay: Int
- today's program day (could be larger than the duration)isActive: Int
- 1 if active, 0 if notname: String
- program informationbaseName: String
- program informationcolor:String
- program informationbaseHandle: String
- program informationduration: Int
- program informationparticipationRole: String
- participation informationparticipationState: String
- participation informationparticipationProgramId:Uuid
- participation informatio