OmniAssessmentTask

Represents the information about an assessment task that is associated with an OmniScript. This object is available in API version 55.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

AssessmentId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The assessment record associated with the runtime instance of an assessment task record. The value is null when the record is designed through action plan template and populated when the assessment is taken through associated omni process.

This is a relationship field.
Relationship Name: Assessment
Relationship Type: Lookup
Refers To: Assessment

DefinitionReferenceId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The definition record associated with the runtime record. The value is null if the record is a definition record.

This is a relationship field.
Relationship Name: DefinitionReference
Relationship Type: Lookup
Refers To: OmniAssessmentTask

Description

Type: textarea
Properties: Create, Nillable, Update
Description: The description of the task.

EndDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The end date and time of the task.

IsDefinition

Type: boolean
Properties: Defaulted on create, Filter, Group, Sort
Description: Indicated whether the record is a definition record.
Default value: false

IsMandatoryTask

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Specifies whether the action is mandatory.
Default value: false

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The most recent date on which a user referenced this record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The most recent date on which a user viewed this record.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of the omni assessment task record.

OmniProcessId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Represents the omni process record associated with the assessment task when it is executed.

This is a relationship field.
Relationship Name: OmniProcess
Relationship Type: Lookup
Refers To: OmniProcess

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: ID of the omni assessment task record owner.

This is a polymorphic relationship field.
Relationship Name: Owner
Relationship Type: Lookup
Refers To: Group, User

Sequence

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The sequence in which the task can be performed.

StartDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The start date and time of the task.

Status

Type: picklist
Properties: Create, Filter, Group, Sort, Update
Description: Specifies the status of the task. You must define and update the values manually.
Possible values:
- Completed
- In Progress
- Is Defined
- Not Started

StatusCode

Type: picklist
Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort
Description: Specifies the current status of the task.
Default value: IsDefined
Possible values:
- Completed
- InProgress—In Progress
- IsDefined—Is Defined
- NotStarted—Not Started

TaskRelationId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Represents the relation between an object associated with the action plan target record.

This is a polymorphic relationship field.
Relationship Name: TaskRelation
Relationship Type: Lookup
Refers To: BusinessLicenseApplication, CarePlan, IndividualApplication, PublicComplaint, Visit

UniqueName

Type: Text
Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
Description: The unique name of the omni assessment task used in the Metadata API.

Associated Objects

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.

OmniAssessmentTaskFeed: Feed tracking is available for the object.
OmniAssessmentTaskHistory: History is available for tracked fields of the object.
OmniAssessmentTaskShare: Sharing is available for the object.