PathAssistant

Represents a Path. Available in Tooling API version 36.0 and later.

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name.

Important

Supported SOAP Calls

retrieve(), query()

Supported REST HTTP Methods

DELETE, GET, PATCH, POST

Fields

Field Details
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The unique name of the path in the API.
FullName
Type
string
Properties
Group, Nillable
Description
The name of the path in the Metadata API.

Query this field only if the query result contains no more than 1 record. Otherwise, an error is returned. If more than 1 record exists, use multiple queries to retrieve the records. This limit protects performance.

IsActive
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the path is active (true) or inactive (false).
IsDeleted
Type
boolean
Properties
Sort
Description
Indicates whether the record has been moved to the Recycle Bin (true) or not (false).
IsMasterRecordType
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether this path is for the main record type (true) or not (false).
Language
Type
string
Properties
Filter, Group, Restricted picklist, Sort
Description
The language of the path. Valid values are:
  • Chinese (Simplified): zh_CN
  • Chinese (Traditional): zh_TW
  • Danish: da
  • Dutch: nl_NL
  • English: en_US
  • Finnish: fi
  • French: fr
  • German: de
  • Italian: it
  • Japanese: ja
  • Korean: ko
  • Norwegian: no
  • Portuguese (Brazil): pt_BR
  • Russian: ru
  • Spanish: es
  • Spanish (Mexico): es_MX Spanish (Mexico) defaults to Spanish for customer-defined translations.
  • Swedish: sv
  • Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English.
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
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
Label for this path.
Metadata
Type
msn:PathAssistant
Properties
Create, Nillable, Update
Description
Path metadata from the msn namespace.

Query this field only if the query result contains no more than 1 record. Otherwise, an error is returned. If more than 1 record exists, use multiple queries to retrieve the records. This limit protects performance.

NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values.

  • In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer.
  • In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.

This field can’t be accessed unless the logged-in user has the “Customize Application” permission.

RecordTypeId
Type
ID
Properties
Filter, Group, Nillable, Sort
Description
The unique identifier for a record type.
SobjectProcessField
Type
string
Properties
Filter, Group, Restricted picklist, Sort
Description
Name of the picklist field which determines the steps you can use in the path.

For example, OpportunityStage in the case of opportunities or LeadStatus in the case of leads.

SobjectType
Type
string
Properties
Filter, Group, Restricted picklist, Sort
Description
The object this path relates to. Valid values are: Opportunity, Lead, Quote, or the API name of a custom object.