Retrieve an instance of salesTerritories

get

/services/rest/connect/latest/salesTerritories/{id}

Request

Path Parameters

Response

Supported Media Types

Default Response

Body ()
A specific geographical sales region
Root Schema : salesTerritories
Type: object
A specific geographical sales region
Show Source
Nested Schema : namedIDs-salesTerritories-adminVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : salesTerritories-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
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

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"
    }
  ]
}