Skip to content

Objects

Dispatch

Returned by dispatch query

  • id
  • orgId
  • orgName
  • userId
  • authorId
  • swimlaneId
  • userName
  • authorName
  • swimlaneName
  • trackerName
  • displayName: materialized name
  • trackerId
  • swimlaneIcon
  • trackerIcon
  • when
  • createdAt
  • updatedAt
  • taskState
  • startTime
  • endTime
  • displayFormat
  • displayExpression
  • data
  • body: body as text
  • blocks: gody as JSON blocks
  • actions
  • 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 org
  • externalId: org configurable id
  • externalStatus: org configurable status
  • role: user | admin
  • labels
  • gender: male | female | other
  • genderDetail: user provided
  • groups
  • lastSignInAt: last sign in date time
  • locationCity
  • locationCountry
  • locationRegion: ISO region code
  • locationContinent
  • title
  • globalTitle

UserTotal

Returned by stats query

  • userId
  • name
  • count
  • first
  • last
  • currentSignInAt

UserStatistic

Returned by stats query

  • userId: system id for the user
  • userName:
  • trackerId: tracker info
  • trackerHandle: tracker info
  • count: entry count
  • latestActivity: most recent created or updated date for the time span
  • latestWhen: date of the post (may differ from creation)

ProgramParticipation

Returned by programs query

  • programName - program name
  • programKind - program kind id
  • programId - program id
  • programGroup - program kind group
  • baseName - program kind name
  • baseHandle - program kind handle
  • cohortId - cohort id
  • cohortName - cohort name
  • state - active | completed | graduated | ..
  • startDate - start
  • endDate - end
  • duration - duration in days
  • programDay - current day
  • participantDay - the user's day (for open programs)
  • mode - fixed | open
  • role - member | trainer | observer
  • userId - user's id
  • email - user's email
  • userName - user's display name
  • firstName - first name
  • lastName - last name
  • gender - user gender
  • dob - dob
  • isActive - if the program is active currently
  • orgStatus - org status
  • sameProgramCompletions
  • allProgramCompletions
  • sameProgramIncomplete
  • allProgramIncomplete
  • userYear - how many years the user has been active
  • phaseState - singleton |
  • phasePosition - start, end, N
  • parentId -
  • programKindParent -
  • priorDuration -
  • flaggedAt - date that activity stopped
  • stoppedAt - date that the user was moved out of 'active'
  • userLocationCity, userLocationCountry, userLocationContinent, userLocationRegion - location
  • title, globalTitle - titles

Org

Org data structure

  • id
  • name
  • parentId
  • createdAt
  • updatedAt
  • displayName

ProgramInfo

Program instance

  • id: program id
  • name: name of the instance
  • createdAt
  • updatedAt
  • startDate
  • duration: in days
  • mode: fixed | open
  • programKind: id of the program kind
  • baseName: name of the program kind
  • baseHandle: handle of the program kind
  • programKindParent: parent id for the kind
  • priority: configurable number priority
  • parentId: parent id for the program
  • schedulingRule: rule for scheduling
  • handle: for the program instance

Program

Program instance

  • .. same fields as ProgramInfo
  • document: full program definition document
  • catalog: catalog defintion

Cohort

Cohort information

  • document: full program definition document
  • catalog: catalog defintion

ProgramTicket

Program tickets represent a right to participate in a program.

  • id:Uuid - ticket id
  • programKindId:Uuid - program kind
  • userId:Uuid - user id
  • programId:Uuid - program id
  • externalId: String - external id of the ticket
  • createdAt: DateTime - created
  • updatedAt: DateTime - updated
  • consumedAt: DateTime - consumed at
  • state: String - ready | consumed | canceled
  • startDate: LocalDate - start of the program
  • endDate: LocalDate - end
  • programDay: Int - today's program day (could be larger than the duration)
  • isActive: Int - 1 if active, 0 if not
  • name: String - program information
  • baseName: String - program information
  • color:String - program information
  • baseHandle: String - program information
  • duration: Int - program information
  • participationRole: String - participation information
  • participationState: String - participation information
  • participationProgramId:Uuid - participation information

DispatchActionStatus

Action status summary

  • event event requested
  • count count of the event
  • payload payload grouping if requested