Get a sales territory

get

/services/rest/connect/v1.4/salesTerritories/{id}

Request

Path Parameters
Back to Top

Response

Default Response

Body ()
Root Schema : salesTerritories
Type: object
The specific geographical sales region. Sales representatives can be assigned specific territories for opportunity assignment.
Show Source
  • namedIDs-salesTerritories-adminVisibleInterfaces
    The named ID that can be included in a list.
  • Maximum Length: 1333
    The comments or notes associated with the sales territory.
  • The date and time when the sales territory was created. This attribute is read-only.
  • Indicates whether a sales territory is disabled. The default value is false.
  • Minimum Value: 1
    Maximum Value: 2147483647
    The display position of the sales territory relative to other members of the same group.
  • Minimum Value: 1
    Maximum Value: 9223372036854776000
    The unique identifier of the sales territory.
  • Maximum Length: 255
    The name used to look up the sales territory.
  • Maximum Length: 80
    The name of the sales territory in the language of the current interface. This attribute is read-only.
  • salesTerritories-names
    The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
  • The specific geographical sales region. Sales representatives can be assigned specific territories for opportunity assignment. It is the reference to a resource in 'salesTerritories' collection. Only ID or lookupName can be provided to specify the resource.
  • territoryHierarchy
    The specific geographical sales region. Sales representatives can be assigned specific territories for opportunity assignment. It is the reference to a resource in 'salesTerritories' collection. Only ID or lookupName can be provided to specify the resources.
  • The date and time when the sales territory was last updated. This attribute is read-only.
Nested Schema : namedIDs-salesTerritories-adminVisibleInterfaces
Type: object
The named ID that can be included in a list.
Show Source
  • Minimum Value: 1
    Maximum Value: 9223372036854776000
    The unique identifier of the object. This is the key for the list entry.
  • Maximum Length: 255
    The name used to look up the object.
Nested Schema : salesTerritories-names
Type: object
The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
Show Source
Nested Schema : territoryHierarchy
Type: array
The specific geographical sales region. Sales representatives can be assigned specific territories for opportunity assignment. It is the reference to a resource in 'salesTerritories' collection. Only ID or lookupName can be provided to specify the resources.
Show Source
Nested Schema : namedIDs-salesTerritories-names-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : items
Type: object
Back to Top

Examples

Use GET with the following syntax to retrieve a specific sales territory:

https://your_site_interface/services/rest/connect/version/salesTerritories/territory_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/salesTerritories/7

Response body example

{
  "id": 7,
  "lookupName": "California",
  "adminVisibleInterfaces": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/salesTerritories/7/adminVisibleInterfaces"
      }
    ]
  },
  "comment": null,
  "disabled": false,
  "displayOrder": 1,
  "name": "California",
  "names": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/salesTerritories/7/names"
      }
    ]
  },
  "parent": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/salesTerritories/6"
      },
      {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/salesTerritories/6"
      },
      {
        "rel": "describedby",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/salesTerritories",
        "mediaType": "application/schema+json"
      }
    ]
  },
  "territoryHierarchy": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/salesTerritories/7/territoryHierarchy"
      }
    ]
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/salesTerritories/7"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/salesTerritories/7"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/salesTerritories",
      "mediaType": "application/schema+json"
    }
  ]
}
Back to Top