Jump to

• Request
• Response
• Examples

Get a sales territory

get

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

Request

Path Parameters

• id(required): integer
  The unique identifier of the sales territory.

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

• adminVisibleInterfaces: object namedIDs-salesTerritories-adminVisibleInterfaces
  The named ID that can be included in a list.
• comment: [ "string", "null" ]
  Maximum Length: 1333

  The comments or notes associated with the sales territory.
• createdTime: string
  The date and time when the sales territory was created. This attribute is read-only.
• disabled: boolean
  Indicates whether a sales territory is disabled. The default value is false.
• displayOrder: integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The display position of the sales territory relative to other members of the same group.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the sales territory.
• lookupName: string
  Maximum Length: 255

  The name used to look up the sales territory.
• name: string
  Maximum Length: 80

  The name of the sales territory in the language of the current interface. This attribute is read-only.
• names: object 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.
• parent: [ "object", "null" ]
  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: array 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.
• updatedTime: string
  The date and time when the sales territory was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The specific geographical sales region. Sales representatives can be assigned specific territories for opportunity assignment.",
    "properties":{
        "comment":{
            "type":[
                "string",
                "null"
            ],
            "description":"The comments or notes associated with the sales territory.",
            "maxLength":"1333"
        },
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the sales territory was last updated. This attribute is read-only."
        },
        "name":{
            "type":"string",
            "description":"The name of the sales territory in the language of the current interface. This attribute is read-only.",
            "maxLength":"80"
        },
        "parent":{
            "type":[
                "object",
                "null"
            ],
            "description":"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":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"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."
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the sales territory.",
            "maxLength":"255"
        },
        "disabled":{
            "type":"boolean",
            "description":"Indicates whether a sales territory is disabled. The default value is false."
        },
        "names":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The list of names, one for each supported language.",
            "$ref":"#/definitions/salesTerritories-names"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the sales territory was created. This attribute is read-only."
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the sales territory.",
            "maximum":"9223372036854776000"
        },
        "displayOrder":{
            "minimum":"1",
            "type":"integer",
            "description":"The display position of the sales territory relative to other members of the same group.",
            "maximum":"2147483647"
        },
        "adminVisibleInterfaces":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of interfaces on which the category is available for administration use.",
            "$ref":"#/definitions/namedIDs-salesTerritories-adminVisibleInterfaces"
        }
    }
}

Nested Schema : namedIDs-salesTerritories-adminVisibleInterfaces

Type: object

The named ID that can be included in a list.

Show Source

• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the object. This is the key for the list entry.
• lookupName: string
  Maximum Length: 255

  The name used to look up the object.

{
    "type":"object",
    "description":"The named ID that can be included in a list.",
    "properties":{
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the object. This is the key for the list entry.",
            "maximum":"9223372036854776000"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the object.",
            "maxLength":"255"
        }
    }
}

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

• labelText: string
  Maximum Length: 80

  The language-specific label text. The value cannot be null or empty.
• language: object namedIDs-salesTerritories-names-language
  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.

{
    "type":"object",
    "description":"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.",
    "properties":{
        "labelText":{
            "type":"string",
            "description":"The language-specific label text. The value cannot be null or empty.",
            "maxLength":"80"
        },
        "language":{
            "type":"object",
            "description":"The ID of the language. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-salesTerritories-names-language"
        }
    }
}

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

• Array of: object items

{
    "items":{
        "type":"object"
    },
    "type":[
        "array",
        "null"
    ],
    "description":"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."
}

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

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

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