Object Reference for Salesforce and Force.com

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

WorkBadgeDefinition

The attributes of a badge including the badge name, description, and image. Each WorkBadge record must have a lookup to a WorkBadgeDefinition as badge attributes, such as badge name, badge description, and badge image, are derived from the WorkBadgeDefinition object.

Supported Calls

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

Additional Considerations and Related Objects

WorkBadgeDefinition has a field called ImageURL that references a DocumentID. This is a required field for creating a Badge.

To grant “giver” access to WorkBadgeDefinitions, you must also create the WorkAccess (and the related WorkAccessShare) records.

Documents is required to create WorkBadgeDefinition records (“badges”). WorkBadgeDefinition has an ImageURL field that must be populated with a DocumentID of the Document record containing the badge image.

Fields

Field Name Details
Description
Type
textarea
Properties
Create, Update
Description
Required. Limit: 4000 characters. The description of the badge and what it means to receive this badge.
Label: Description.
ImageUrl
Type
url
Properties
Create, Filter, Group, Sort, Update
Description
Required. This is the badge image that will be displayed in the UI. Use DocumentID or ImageURL.
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Represents whether a BadgeDefinition is active and available in the UI.
IsCompanyWide
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Represents a special class of badges known as a Company Badge. Company badges are visible to the entire company and visible in specific list view filters.
Name
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. Name of the Badge. Label: Badge Title.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Salesforce User ID for User who is the Owner of the BadgeDefinition record (usually the creator of the record)
RewardFundId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Salesforce unique ID for the RewardFund associated with this BadgeDefinition. BadgeDefinition records with a RewardFundID indicate a Reward Badge.