Newer Version Available

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

CodeSet

Represents various industry defined codes in the context of their systems and versions of those systems. These codes are used in all sorts of digital records. This object is available in API version 59.0 and later.

Supported Calls

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

Special Access Rules

This object is available if Provider Management is enabled in your org. To access the object, you need the Provider Management Access permission set or the Provider Management permission set license. Partner users need the Provider Management for Partner permission set or permission set license.

Fields

Field Details
Code
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The system-defined code that’s represented by this code set.
CodeDescription
Type
textarea
Properties
Create, Nillable, Update
Description
Additional information associated with the code set.
CodeSetKey
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
Represents a unique key that identifies the concept represented by code sets across different systems and versions. This key isn’t case-sensitive.
CodeSetType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the type of the code set.
EndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The end date of the code set’s effective period.
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the code set is an active code set.
IsCustomCode
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the code set is defined by a specific organization, as opposed to recognized across the industry.
IsPrimary
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the code set is the primary code set for the concept. That is, it was selected manually by a user instead of being selected by an automated process.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The last date that the record was referenced.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The last date that the record was viewed.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The textual representation of the meaning of the code.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
A reference to the person who owns the code set record.
SourceSystem
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The system that sets the context for the code and defines its meaning.
StartDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The start date of the code set’s effective period.
SystemVersion
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The version of the source system the code belongs to.

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.

CodeSetChangeEvent (API version 59.0)
Change events are available for the object.
CodeSetFeed
Feed tracking is available for the object.
CodeSetHistory
History is available for tracked fields of the object.
CodeSetShare
Sharing is available for the object.