Metadata API Developer’s Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

RoleOrTerritory

Represents the common base type and valid values for role or territory.

Version

RoleOrTerritory components are available in API version 24.0 and later.

You can’t create a RoleOrTerritory component directly. Use the Role or Territory metadata types instead.

Note

Fields

Field Name Field Type Description
caseAccessLevel string Specifies whether a user can access other users’ cases that are associated with accounts the user owns. Valid values are:
  • Read
  • Edit
  • None

This field is not visible if your organization’s sharing model for cases is Public Read/Write.

If no value is set for this field, this field value uses the default access level that is specified in the Manage Territory page in Manage Territories | Settings from Setup.
contactAccessLevel string Specifies whether a user can access other users’ contacts that are associated with accounts the user owns. Valid values are:
  • Read
  • Edit
  • None

This field is not visible if your organization’s sharing model for contacts is Public Read/Write or Controlled by Parent.

If no value is set for this field, this field value uses the default access level that is specified in the Manage Territory page in Manage Territories | Settings from Setup.
description string The description of the role or territory.
fullName string The unique identifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is inherited from the Metadata component.
mayForecastManagerShare boolean Indicates whether the forecast manager can manually share their own forecast.
name string Required. The name of the role or territory.
opportunityAccessLevel string Specifies whether a user can access other users’ opportunities that are associated with accounts the user owns. Valid values are:
  • Read
  • Edit
  • None

This field is not visible if your organization’s sharing model for opportunities is Public Read/Write.

If no value is set for this field, this field value uses the default access level that is specified in the Manage Territory page in Manage Territories | Settings from Setup.

Declarative Metadata Sample Definition

The following is the definition of a role.
1<?xml version="1.0" encoding="UTF-8"?>
2<Role xmlns="http://soap.sforce.com/2006/04/metadata">
3    <caseAccessLevel>Edit</caseAccessLevel>
4    <contactAccessLevel>Edit</contactAccessLevel>
5    <description>Sample Role</description>
6    <mayForecastManagerShare>false</mayForecastManagerShare>
7    <name>R22</name>
8    <opportunityAccessLevel>Read</opportunityAccessLevel>
9</Role>
The following is the definition of a territory.
1<?xml version="1.0" encoding="UTF-8"?>
2<Territory xmlns="http://soap.sforce.com/2006/04/metadata">
3    <accountAccessLevel>Edit</accountAccessLevel>
4    <caseAccessLevel>Edit</caseAccessLevel>
5    <contactAccessLevel>Edit</contactAccessLevel>
6    <description>Sample Territory</description>
7    <mayForecastManagerShare>false</mayForecastManagerShare>
8    <name>T22name</name>
9    <opportunityAccessLevel>Read</opportunityAccessLevel>
10</Territory>