RecordType

Represents a custom record type.

This object is available in API version 32.0 and later.

Supported SOAP Calls

create(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

Supported REST HTTP Methods

GET, PATCH, POST

Fields

Field Details
BusinessProcessId
Type
ID
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of an associated BusinessProcess.
Description
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The record type description, limited to 255 characters.
EntityDefinitionId
Type
string
Properties
Filter, Group, Sort
Description
The ID of the entity containing the record.
FullName
Type
string
Properties
Create, Group, Nillable
Description
The full name of the associated metadata object in Metadata API.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
IsActive
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether this record is active (true) or not (false). Only active record types can be applied to records.
ManageableState
Type
ManageableState enumerated list
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Indicates the manageable state of the specified component that is contained in a package:
  • beta
  • deleted
  • deprecated
  • deprecatedEditable
  • installed
  • installedEditable
  • released
  • unmanaged
Metadata
Type
RecordTypeMetadata
Properties
Create, Nillable, Update
Description
Record metadata.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
Name
Type
string
Properties
Nillable
Description
The record type name.
NamespacePrefix
Type
string
Properties
Nillable
Description
A unique string to distinguish this type from any others.
SobjectType
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The type of standard object that this record type is derived from.