PulseCheck

AssociatedObjectId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The object associated with the student's responses to a Pulse Check.

  This field is a relationship field.

• Relationship Name: AssociatedObject
• Refers To: Program

AssociatedRecordTypeId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The record type of the object associated with the student's responses to a Pulse Check.

  This field is a relationship field.

• Relationship Name: AssociatedRecordType
• Refers To: RecordType

Category

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Specifies the category of the Pulse Check.

CurrencyIsoCode

• Type: picklist
• Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
• Description: The ISO code for the currency associated with the Pulse Check.
• Default value: USD
• Possible values:
  • GBP—British Pound
  • USD—U.S. Dollar

DaysOfWeek

• Type: int
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The days of the week for which the pulse check is scheduled. This field contains a bit mask.
  • Monday = 64
  • Tuesday = 32
  • Wednesday = 16
  • Thursday = 8
  • Friday = 4
  • Saturday = 2
  • Sunday = 1

  Multiple days are represented as the sum of their numerical values. For example, Tuesday and Thursday = 32 + 8 = 40.

Description

• Type: textarea
• Properties: Create, Update
• Description: The description of the Pulse Check.

EndDate

• Type: dateTime
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The date and time when the Pulse Check ends.

ExpiryInDays

• Type: int
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The number of days the Pulse Check is active.

Frequency

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
• Description: Specifies the frequency that the Pulse Check occurs.
• Possible values:
  • Biweekly
  • Half-Yearly—Half Yearly
  • Monthly
  • Quarterly
  • Weekly
  • Yearly

IsRecurring

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Indicates whether the Pulse Check is recurring (true) or not (false).
• Default value: false

LastReferencedDate

• Type: dateTime
• Properties: Filter, Nillable, Sort
• Description: The timestamp when the current user last accessed this record, a record related to this record, or a list view.

LastViewedDate

• Type: dateTime
• Properties: Filter, Nillable, Sort
• Description: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it.

Name

• Type: string
• Properties: Create, Filter, Group, idLookup, Sort, Update
• Description: The name for the Pulse Check.

Occurrences

• Type: int
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The number of occurrences of the Pulse Check.

OwnerId

• Type: reference
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: The user who owns this record.

  This field is a polymorphic relationship field.

• Relationship Name: Owner
• Refers To: Group, User

PulseCheckTemplateId

• Type: reference
• Properties: Create, Filter, Group, Sort, Update
• Description: The Pulse Check Template associated with the Pulse Check.

  This field is a relationship field.

• Relationship Name: PulseCheckTemplate
• Refers To: PulseCheckTemplate

Source

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The criteria based sharing rule or flow that triggered the Pulse Check.

StartDate

• Type: dateTime
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The date and time when the Pulse Check starts.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

PulseCheckHistory

History is available for tracked fields of the object.

PulseCheckOwnerSharingRule

Sharing rules are available for the object.

PulseCheckShare

Sharing is available for the object.