Newer Version Available

This content describes an older version of this product. View Latest

GoalDefinition

Represents a goal or a business objective that’s used as a reference. When instantiated, GoalDefinition records create GoalAssignment records that serve as goals in care plans.

Supported Calls

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

Fields

Field Details
Category
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The category that the defined goal belongs to.
Description
Type
textarea
Properties
Create, Nillable, Update
Description
The description of the defined goal.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the goal definition record.
OwnerId
Type
Polymorphic lookup
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the owner of this goal definition record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
  • Group
  • User
ParentGoalId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the parent record.
This field is a relationship field.
Relationship Name
ParentGoal
Relationship Type
Lookup
Refers To
GoalDefinition
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The status of the goal defintion.
Possible values are:
  • Active
  • Inactive
The default value is Active.
Type
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the type of the defined goal.
Possible values are:
  • Individual—Intermediate Goal
  • Strategic—Top Goal
The default value is Individual.
UsageType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the usage type of the defined goal.

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.

GoalDefinitionFeed
Feed tracking is available for the object.
GoalDefinitionHistory
History is available for tracked fields of the object.
GoalDefinitionShare
Sharing is available for the object.