Metadata API Developer’s Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Newer Version Available
Territory2Settings
Represents the metadata for the default settings
for Territory Management 2.0 users to access and modify records associated with sales
territories. The standard record access settings apply to accounts and opportunities. If your
organization uses Private default internal access for contacts or cases, you can also set access
for those records.
This type extends the Metadata
metadata type and inherits its fullName field. Available only if
Territory Management 2.0 has been enabled for your organization.
File Suffix and Directory Location
Territory2Settings components have the suffix settings and are stored in the Settings folder.
Version
Territory2Settings components are available in API version 32.0 and later.
Special Access Rules
The Territory2Model object has a State field
in the SOAP API. States include Planning,
Active, Archived, and a number
of other states, such as Cloning, that indicate that a
process is underway. Users who do not have the “Manage Territories” permission can access
only territories that belong to the model in Active state.
The “Manage Territories” permission is required for deploy() calls for all territory management entities, in addition to the
“Modify All Data” permission required by Metadata API. Using retrieve() without the “Manage Territories” permission will return only
entities that belong to a Territory2Model in Active state. We
recommend against retrieving without the “Manage Territories” permission because the call
will retrieve only partial data.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| defaultAccountAccessLevel | string | The default level of access users will have to account records in territories: view and edit accounts assigned to territories or view, edit, transfer, and delete accounts assigned to territories. |
| defaultCaseAccessLevel | string | The default level of access users will have to case records in territories: view and edit accounts assigned to territories or view, edit, transfer, and delete accounts assigned to territories. |
| defaultContactAccessLevel | string | The default level of access users will have to contact records in territories: view and edit accounts assigned to territories or view, edit, transfer, and delete accounts assigned to territories. |
| defaultOpportunityAccessLevel | string | The default level of access users will have to opportunity records in territories: view and edit accounts assigned to territories or view, edit, transfer, and delete accounts assigned to territories. |
Declarative Metadata Sample Definition
The following example shows the definition of a Territory2Settings component.
Usage
Territory Management 2.0 components don’t support packaging or change sets and aren’t supported in CRUD calls.