Salesforce Docs Portal

Codeset

Represents various industry defined codes in the context of their systems and versions of those systems. This object is available in API version 58.0 and later.

Supported Calls

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

Special Access Rules

Automotive and Warranty Lifecycle Management must be enabled.

Fields

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: A unique key that identifies the concept represented by code sets across different systems and versions. This key is not case sensitive.

CodeSetType

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: 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 (true) or not (false). The default value is false.

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. The default value is false.

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 (true) or not (false). That is, it was selected manually by a user instead of being selected by an automated process. The default value is false.

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp for when the current user last viewed a record related to this record.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not 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. This field is a polymorphic relationship field.
  • Relationship Name: Owner
  • Relationship Type: Lookup
  • Refers To: Group, User

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.