AssessmentTask

Perform activities such as planogram check, inventory check, promotion check, in-store survey, or custom task in stores to capture information. This object is available in API version 47.0 and later.

Supported Calls

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

Fields

AssessmentTaskDefinitionId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The assessment task definition that is referenced for the task. This field is available in API version 48.0 and later.

Description

  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Description of task that has to be performed at the store.

EndTime

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Time when the task is completed by a field rep. This field is available in API version 49.0 and later.

IsRequired

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicate whether a task must be completed to complete a visit. This field is available in API version 48.0 and later.
  • 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: Unique identification of the task.

OwnerId

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

ParentId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The visit associated with an assessment task.This field is available in API version 48.0 and later.

SequenceNumber

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The sequence in which the tasks must be performed. This field is available in API version 48.0 and later.

StartTime

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Time when the task is started by a field rep. This field is available in API version 49.0 and later.

Status

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
  • Description: View the status of a task. This field is available in API version 48.0 and later.
  • Possible values:
    • Completed
    • InProgress—In Progress
    • NotStarted—Not Started

TaskDefinitionId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Reference to related records such as signature task, delivery task, other Component task, flow, and SFDC task. This field is a polymorphic relationship field. This field is available in API version 48.0 and later.
  • Relationship Name: TaskDefinition
  • Refers To: DeliveryTask, OtherComponentTask, RecordAction, SignatureTask, Task

TaskType

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort
  • Description: Type of a task that the sales rep can perform during the visit. The task type must match the task type of the assessment task definition.
  • Possible values:
    • ConductInStoreSurveys
    • InventoryCheck
    • Other
    • PlaceOrder
    • PlanogramCheck
    • PromotionCheck

Associated Objects

This object has these associated objects. Unless noted, they’re available in the same API version as this object.