RecordType
Represents a custom record type.
Turn on source tracking in your sandboxes in order for the picklist values to appear correctly in the Metadata.picklistValues field when you query RecordType. Without source tracking, custom field picklist values can be omitted. You can also use the Metadata API request with object and field inputs to fetch the picklist values of a record type.
Introduced in API version 32.0.
create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert()
GET, HEAD, PATCH, POST, Query
-
Type: reference
-
Required: No
-
Properties: Filter, Group, Nillable, Sort
-
Description: ID of an associated BusinessProcess.
-
Relationship name: BusinessProcessId
-
Relationship type: relationship
-
Refers to: BusinessProcess
-
Type: string
-
Required: No
-
Properties: Filter, Group, Nillable, Sort
-
Description: The record type description, limited to 255 characters.
-
Type: string
-
Required: No
-
Properties: Filter, Group, Sort
-
Introduced: API version 32.0
-
Description: The ID of the entity containing the record.
-
Type: string
-
Required: No
-
Properties: Create, Group, Nillable
-
Introduced: API version 32.0
-
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.
-
Type: boolean
-
Required: No
-
Properties: Defaulted on create, Filter, Group, Sort
-
Introduced: API version 33.0
-
Description: Indicates whether this record is active (
true) or not (false). Only active record types can be applied to records. -
Default value: false
-
Type: boolean
-
Required: No
-
Properties: Defaulted on create, Filter, Group, Sort
-
Introduced: API version 42.0
-
Default value: false
-
Type: picklist
-
Required: No
-
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 -
Possible values:
-
beta — beta
-
deleted — deleted
-
deprecated — deprecated
-
deprecatedEditable — deprecatedEditable
-
installed — installed
-
installedEditable — installedEditable
-
released — released
-
unmanaged — unmanaged
-
-
Type: complexvalue
-
Required: No
-
Properties: Create, Nillable, Update
-
Introduced: API version 32.0
-
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.
-
Type: string
-
Required: No
-
Properties: Filter, Group, idLookup, Sort
-
Description: The record type name.
-
Type: string
-
Required: No
-
Properties: Filter, Group, Nillable, Sort
-
Introduced: API version 14.0
-
Description: A unique string to distinguish this type from any others.
-
Type: picklist
-
Required: No
-
Properties: Filter, Group, Restricted picklist, Sort
-
Description: The type of standard object that this record type is derived from.