Jump to

• Request
• Response
• Examples

Update a rule for a territory

patch

/crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}

Request

Path Parameters

• TerrRuleId(required): integer(int64)
  The unique identifier of the territory rule.
• TerritoryVersionId(required): integer(int64)
  The unique identifier of the territory version.

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• RuleNumber: integer (int64)
  Title: Coverage Number

  The coverage number for the territory.
• RuleOperatorCode: string
  Title: Customer Coverage Code

  Maximum Length: 30

  Default Value: INCLUSION

  The code for identifying whether the coverage adds to or removes from the territory's jurisdiction. The accepted values are: EXCLUSION (for rule type EXCLUSION and PARTNER_EXCLUSION) and INCLUSION (for all other rule types, such as REGULAR, INCLUSION, PARTNER_REGULAR, PARTNER_INCLUSION, and INHERITANCE_OVERRIDE).
• RuleTypeCode: string
  Title: Coverage

  Maximum Length: 30

  Default Value: REGULAR

  The code for the territory coverage type. If the territory coverage model is sales account centric, the accepted values are: -REGULAR (for coverage based on sales account dimensionality or named accounts) -INCLUSION (for manually included account coverage) -EXCLUSION (for manually excluded account coverage) If the territory coverage model is partner centric, the accepted values are: -PARTNER_REGULAR (for coverage based on partner dimensionality) -PARTNER_INCLUSION (for manually included partner coverage) -PARTNER_EXCLUSION (for manually excluded partner coverage) In case of inheritance, if the coverage is for a recipient territory, then the accepted value is INHERITANCE_OVERRIDE which indicates that the coverage overrides some of the inherited dimensionality.
• TerritoryRuleBoundary1: array Rule Boundaries
  Title: Rule Boundaries

  The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage.
• TerritoryVersionId: integer (int64)
  Title: Territory Number

  The unique identifier of the territory version.

{
    "type":"object",
    "properties":{
        "RuleNumber":{
            "title":"Coverage Number",
            "type":"integer",
            "description":"The coverage number for the territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RuleOperatorCode":{
            "title":"Customer Coverage Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for identifying whether the coverage adds to or removes from the territory's jurisdiction. The accepted values are: EXCLUSION (for rule type EXCLUSION and PARTNER_EXCLUSION) and INCLUSION (for all other rule types, such as REGULAR, INCLUSION, PARTNER_REGULAR, PARTNER_INCLUSION, and INHERITANCE_OVERRIDE).",
            "nullable":true,
            "default":"INCLUSION"
        },
        "RuleTypeCode":{
            "title":"Coverage",
            "maxLength":30,
            "type":"string",
            "description":"The code for the territory coverage type.\n\nIf the territory coverage model is sales account centric, the accepted values are:\n-REGULAR (for coverage based on sales account dimensionality or named accounts)\n-INCLUSION (for manually included account coverage)\n-EXCLUSION (for manually excluded account coverage)\n\nIf the territory coverage model is partner centric, the accepted values are:\n-PARTNER_REGULAR (for coverage based on partner dimensionality)\n-PARTNER_INCLUSION (for manually included partner coverage)\n-PARTNER_EXCLUSION (for manually excluded partner coverage)\n\nIn case of inheritance, if the coverage is for a recipient territory, then the accepted value is INHERITANCE_OVERRIDE which indicates that the coverage overrides some of the inherited dimensionality.",
            "nullable":true,
            "default":"REGULAR"
        },
        "TerritoryRuleBoundary1":{
            "title":"Rule Boundaries",
            "type":"array",
            "description":"The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage.",
            "items":{
                "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-item-patch-request"
            }
        },
        "TerritoryVersionId":{
            "title":"Territory Number",
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Rule Boundaries

Type: array

Title: Rule Boundaries

The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage.

Show Source

• Array of: object territories-TerritoryRule-TerritoryRuleBoundary1-item-patch-request

{
    "title":"Rule Boundaries",
    "type":"array",
    "description":"The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage.",
    "items":{
        "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-item-patch-request"
    }
}

Nested Schema : territories-TerritoryRule-TerritoryRuleBoundary1-item-patch-request

Type: object

Show Source

• TerritoryRuleBndryValue1: array Rule Boundary Values
  Title: Rule Boundary Values

  The rule boundary values resource is used to view the rule boundary values associated with a sales territory. The equivalent functional term for rule boundary value is coverage dimension member. The rule boundary values object contains records for the dimension members for each coverage dimension.
• TerrRuleId: integer (int64)
  Title: Territory Number

  The identifier of the territory rule.

{
    "type":"object",
    "properties":{
        "TerrRuleId":{
            "title":"Territory Number",
            "type":"integer",
            "description":"The identifier of the territory rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TerritoryRuleBndryValue1":{
            "title":"Rule Boundary Values",
            "type":"array",
            "description":"The rule boundary values resource is used to view the rule boundary values associated with a sales territory. The equivalent functional term for rule boundary value is coverage dimension member. The rule boundary values object contains records for the dimension members for each coverage dimension.",
            "items":{
                "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-patch-request"
            }
        }
    }
}

Nested Schema : Rule Boundary Values

Type: array

Title: Rule Boundary Values

The rule boundary values resource is used to view the rule boundary values associated with a sales territory. The equivalent functional term for rule boundary value is coverage dimension member. The rule boundary values object contains records for the dimension members for each coverage dimension.

Show Source

• Array of: object territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-patch-request

{
    "title":"Rule Boundary Values",
    "type":"array",
    "description":"The rule boundary values resource is used to view the rule boundary values associated with a sales territory. The equivalent functional term for rule boundary value is coverage dimension member. The rule boundary values object contains records for the dimension members for each coverage dimension.",
    "items":{
        "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-patch-request"
    }
}

Nested Schema : territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-patch-request

Type: object

Show Source

• AddrElementAttribute1: string
  Title: Additional Attribute 1

  Maximum Length: 150

  Additional address element to support flexible address format.
• AddrElementAttribute2: string
  Title: Additional Attribute 2

  Maximum Length: 150

  Additional address element to support flexible address format.
• AddrElementAttribute3: string
  Title: Additional Attribute 3

  Maximum Length: 150

  Additional address element to support flexible address format.
• AddrElementAttribute4: string
  Title: Additional Attribute 4

  Maximum Length: 150

  Additional address element to support flexible address format.
• AddrElementAttribute5: string
  Title: Additional Attribute 5

  Maximum Length: 150

  Additional address element to support flexible address format.
• AddressCity: string
  Title: City

  Maximum Length: 60

  City.
• AddressCountry: string
  Title: Country

  Maximum Length: 2

  Country.
• AddressCounty: string
  Title: County

  Maximum Length: 60

  County.
• AddressPostalCode: string
  Title: Postal Code

  Maximum Length: 60

  Postal Code.
• AddressProvince: string
  Title: Province

  Maximum Length: 60

  Province.
• AddressState: string
  Title: State

  Maximum Length: 60

  State.
• DimensionMember: string
  The name of the territory dimension member.
• IncludeHierarchyFlag: boolean
  Title: Include Hierarchy

  Maximum Length: 1

  Indicates whether the dimension member is included along with its hierarchy or not. The default value is true.
• TerrRuleBoundaryId: integer (int64)
  Title: Territory Number

  The identifier of the territory rule boundary.

{
    "type":"object",
    "properties":{
        "AddrElementAttribute1":{
            "title":"Additional Attribute 1",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Attribute 2",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "AddrElementAttribute3":{
            "title":"Additional Attribute 3",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "AddrElementAttribute4":{
            "title":"Additional Attribute 4",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "AddrElementAttribute5":{
            "title":"Additional Attribute 5",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true
        },
        "AddressCity":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"City.",
            "nullable":true
        },
        "AddressCountry":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"Country.",
            "nullable":true
        },
        "AddressCounty":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"County.",
            "nullable":true
        },
        "AddressPostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"Postal Code.",
            "nullable":true
        },
        "AddressProvince":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"Province.",
            "nullable":true
        },
        "AddressState":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"State.",
            "nullable":true
        },
        "DimensionMember":{
            "type":"string",
            "description":"The name of the territory dimension member.",
            "nullable":true
        },
        "IncludeHierarchyFlag":{
            "title":"Include Hierarchy",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the dimension member is included along with its hierarchy or not. The default value is true.",
            "nullable":true
        },
        "TerrRuleBoundaryId":{
            "title":"Territory Number",
            "type":"integer",
            "description":"The identifier of the territory rule boundary.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : territories-TerritoryRule-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the territory rule.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the territory rule was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the territory rule was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the territory rule.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 255

  The login of the user who last updated the territory rule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RuleNumber: integer (int64)
  Title: Coverage Number

  The coverage number for the territory.
• RuleOperatorCode: string
  Title: Customer Coverage Code

  Maximum Length: 30

  Default Value: INCLUSION

  The code for identifying whether the coverage adds to or removes from the territory's jurisdiction. The accepted values are: EXCLUSION (for rule type EXCLUSION and PARTNER_EXCLUSION) and INCLUSION (for all other rule types, such as REGULAR, INCLUSION, PARTNER_REGULAR, PARTNER_INCLUSION, and INHERITANCE_OVERRIDE).
• RuleTypeCode: string
  Title: Coverage

  Maximum Length: 30

  Default Value: REGULAR

  The code for the territory coverage type. If the territory coverage model is sales account centric, the accepted values are: -REGULAR (for coverage based on sales account dimensionality or named accounts) -INCLUSION (for manually included account coverage) -EXCLUSION (for manually excluded account coverage) If the territory coverage model is partner centric, the accepted values are: -PARTNER_REGULAR (for coverage based on partner dimensionality) -PARTNER_INCLUSION (for manually included partner coverage) -PARTNER_EXCLUSION (for manually excluded partner coverage) In case of inheritance, if the coverage is for a recipient territory, then the accepted value is INHERITANCE_OVERRIDE which indicates that the coverage overrides some of the inherited dimensionality.
• TerritoryRuleBoundary1: array Rule Boundaries
  Title: Rule Boundaries

  The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage.
• TerritoryVersionId: integer (int64)
  Title: Territory Number

  The unique identifier of the territory version.
• TerrRuleId: integer (int64)
  Title: Coverage ID

  The unique identifier of the territory rule.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the territory rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the territory rule was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory rule was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":255,
            "type":"string",
            "description":"The login of the user who last updated the territory rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the territory rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleNumber":{
            "title":"Coverage Number",
            "type":"integer",
            "description":"The coverage number for the territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RuleOperatorCode":{
            "title":"Customer Coverage Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for identifying whether the coverage adds to or removes from the territory's jurisdiction. The accepted values are: EXCLUSION (for rule type EXCLUSION and PARTNER_EXCLUSION) and INCLUSION (for all other rule types, such as REGULAR, INCLUSION, PARTNER_REGULAR, PARTNER_INCLUSION, and INHERITANCE_OVERRIDE).",
            "nullable":true,
            "default":"INCLUSION",
            "x-queryable":true
        },
        "RuleTypeCode":{
            "title":"Coverage",
            "maxLength":30,
            "type":"string",
            "description":"The code for the territory coverage type.\n\nIf the territory coverage model is sales account centric, the accepted values are:\n-REGULAR (for coverage based on sales account dimensionality or named accounts)\n-INCLUSION (for manually included account coverage)\n-EXCLUSION (for manually excluded account coverage)\n\nIf the territory coverage model is partner centric, the accepted values are:\n-PARTNER_REGULAR (for coverage based on partner dimensionality)\n-PARTNER_INCLUSION (for manually included partner coverage)\n-PARTNER_EXCLUSION (for manually excluded partner coverage)\n\nIn case of inheritance, if the coverage is for a recipient territory, then the accepted value is INHERITANCE_OVERRIDE which indicates that the coverage overrides some of the inherited dimensionality.",
            "nullable":true,
            "default":"REGULAR",
            "x-queryable":true
        },
        "TerrRuleId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"The unique identifier of the territory rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TerritoryRuleBoundary1":{
            "title":"Rule Boundaries",
            "type":"array",
            "description":"The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage.",
            "items":{
                "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-item-response"
            }
        },
        "TerritoryVersionId":{
            "title":"Territory Number",
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Rule Boundaries

Type: array

Title: Rule Boundaries

The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage.

Show Source

• Array of: object territories-TerritoryRule-TerritoryRuleBoundary1-item-response

{
    "title":"Rule Boundaries",
    "type":"array",
    "description":"The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage.",
    "items":{
        "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : territories-TerritoryRule-TerritoryRuleBoundary1-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the territory rule boundary.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the territory rule boundary was created.
• Dimension: string
  Title: Dimension

  Read Only: true

  Maximum Length: 60

  The name of the dimension.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the territory rule boundary was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the territory rule boundary.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the territory rule boundary.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TerrDimensionCode: string
  Title: Dimension

  Maximum Length: 5

  The code indicating the territory dimension, such as Geo for Geography Dimension, Prod for Product Dimension, and so on.
• TerritoryRuleBndryValue1: array Rule Boundary Values
  Title: Rule Boundary Values

  The rule boundary values resource is used to view the rule boundary values associated with a sales territory. The equivalent functional term for rule boundary value is coverage dimension member. The rule boundary values object contains records for the dimension members for each coverage dimension.
• TerrRuleBoundaryId: integer (int64)
  Title: Territory Dimension ID

  The unique identifier of the territory rule boundary.
• TerrRuleId: integer (int64)
  Title: Territory Number

  The identifier of the territory rule.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the territory rule boundary.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the territory rule boundary was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Dimension":{
            "title":"Dimension",
            "maxLength":60,
            "type":"string",
            "description":"The name of the dimension.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory rule boundary was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the territory rule boundary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the territory rule boundary.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerrDimensionCode":{
            "title":"Dimension",
            "maxLength":5,
            "type":"string",
            "description":"The code indicating the territory dimension, such as Geo for Geography Dimension, Prod for Product Dimension, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "TerrRuleBoundaryId":{
            "title":"Territory Dimension ID",
            "type":"integer",
            "description":"The unique identifier of the territory rule boundary.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TerrRuleId":{
            "title":"Territory Number",
            "type":"integer",
            "description":"The identifier of the territory rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TerritoryRuleBndryValue1":{
            "title":"Rule Boundary Values",
            "type":"array",
            "description":"The rule boundary values resource is used to view the rule boundary values associated with a sales territory. The equivalent functional term for rule boundary value is coverage dimension member. The rule boundary values object contains records for the dimension members for each coverage dimension.",
            "items":{
                "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Rule Boundary Values

Type: array

Title: Rule Boundary Values

The rule boundary values resource is used to view the rule boundary values associated with a sales territory. The equivalent functional term for rule boundary value is coverage dimension member. The rule boundary values object contains records for the dimension members for each coverage dimension.

Show Source

• Array of: object territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-response

{
    "title":"Rule Boundary Values",
    "type":"array",
    "description":"The rule boundary values resource is used to view the rule boundary values associated with a sales territory. The equivalent functional term for rule boundary value is coverage dimension member. The rule boundary values object contains records for the dimension members for each coverage dimension.",
    "items":{
        "$ref":"#/components/schemas/territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-response"
    }
}

Nested Schema : territories-TerritoryRule-TerritoryRuleBoundary1-TerritoryRuleBndryValue1-item-response

Type: object

Show Source

• AddrElementAttribute1: string
  Title: Additional Attribute 1

  Maximum Length: 150

  Additional address element to support flexible address format.
• AddrElementAttribute2: string
  Title: Additional Attribute 2

  Maximum Length: 150

  Additional address element to support flexible address format.
• AddrElementAttribute3: string
  Title: Additional Attribute 3

  Maximum Length: 150

  Additional address element to support flexible address format.
• AddrElementAttribute4: string
  Title: Additional Attribute 4

  Maximum Length: 150

  Additional address element to support flexible address format.
• AddrElementAttribute5: string
  Title: Additional Attribute 5

  Maximum Length: 150

  Additional address element to support flexible address format.
• AddressCity: string
  Title: City

  Maximum Length: 60

  City.
• AddressCountry: string
  Title: Country

  Maximum Length: 2

  Country.
• AddressCounty: string
  Title: County

  Maximum Length: 60

  County.
• AddressPostalCode: string
  Title: Postal Code

  Maximum Length: 60

  Postal Code.
• AddressProvince: string
  Title: Province

  Maximum Length: 60

  Province.
• AddressState: string
  Title: State

  Maximum Length: 60

  State.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the territory rule boundary value.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the territory rule boundary value was created.
• DimensionMember: string
  The name of the territory dimension member.
• DimensionMemberHigh: string
  Title: Territory Dimension Member High

  Read Only: true

  Maximum Length: 360

  The name of the territory dimension member with a high sequence number.
• IncludeHierarchyFlag: boolean
  Title: Include Hierarchy

  Maximum Length: 1

  Indicates whether the dimension member is included along with its hierarchy or not. The default value is true.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the territory rule boundary value was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the territory rule boundary value.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the territory rule boundary value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TerrDimensionCode: string
  Title: Dimension

  Maximum Length: 5

  The code indicating the territory dimension. For example, AcTyp, Acct, Aux1, Aux2, Aux3, BUnit, CSize, Geo, Indst, OrgTp, Prod, Prtnr, or SChnl.
• TerrDimHighIntgId: string
  Title: Dimension Value Range

  Maximum Length: 80

  The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube with a high sequence number.
• TerrDimIntgId: string
  Title: Dimension Value

  Maximum Length: 80

  The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube.
• TerrRuleBndryValueId: integer (int64)
  Title: Territory Dimension Member ID

  The unique identifier of the territory rule boundary value.
• TerrRuleBoundaryId: integer (int64)
  Title: Territory Number

  The identifier of the territory rule boundary.

{
    "type":"object",
    "properties":{
        "AddrElementAttribute1":{
            "title":"Additional Attribute 1",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Attribute 2",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute3":{
            "title":"Additional Attribute 3",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute4":{
            "title":"Additional Attribute 4",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute5":{
            "title":"Additional Attribute 5",
            "maxLength":150,
            "type":"string",
            "description":"Additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCity":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"City.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCountry":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"Country.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCounty":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"County.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressPostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"Postal Code.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressProvince":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"Province.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressState":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"State.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the territory rule boundary value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the territory rule boundary value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DimensionMember":{
            "type":"string",
            "description":"The name of the territory dimension member.",
            "nullable":true,
            "x-queryable":true
        },
        "DimensionMemberHigh":{
            "title":"Territory Dimension Member High",
            "maxLength":360,
            "type":"string",
            "description":"The name of the territory dimension member with a high sequence number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeHierarchyFlag":{
            "title":"Include Hierarchy",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the dimension member is included along with its hierarchy or not. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the territory rule boundary value was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the territory rule boundary value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the territory rule boundary value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerrDimHighIntgId":{
            "title":"Dimension Value Range",
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube with a high sequence number.",
            "nullable":true,
            "x-queryable":true
        },
        "TerrDimIntgId":{
            "title":"Dimension Value",
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the common member of Oracle Business Intelligence (OBI), Territory Management, and Cube.",
            "nullable":true,
            "x-queryable":true
        },
        "TerrDimensionCode":{
            "title":"Dimension",
            "maxLength":5,
            "type":"string",
            "description":"The code indicating the territory dimension. For example, AcTyp, Acct, Aux1, Aux2, Aux3, BUnit, CSize, Geo, Indst, OrgTp, Prod, Prtnr, or SChnl.",
            "nullable":false,
            "x-queryable":true
        },
        "TerrRuleBndryValueId":{
            "title":"Territory Dimension Member ID",
            "type":"integer",
            "description":"The unique identifier of the territory rule boundary value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TerrRuleBoundaryId":{
            "title":"Territory Number",
            "type":"integer",
            "description":"The identifier of the territory rule boundary.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

TerritoryRuleBoundary1

Operation: /crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryRule/{TerrRuleId}/child/TerritoryRuleBoundary1

Parameters:

• TerrRuleId: $request.path.TerrRuleId
• TerritoryVersionId: $request.path.TerritoryVersionId

The rule boundaries resource is used to view the rule boundaries associated with a sales territory. The equivalent functional term for rule boundary is coverage dimension. The rule boundaries object contains records for each of the dimensions defined for a given territory coverage.

Back to Top

Examples

The following example shows how to create a rule boundary for a territory by submitting a POST request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryRule/300100091635545/child/TerritoryRuleBoundary1

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
  "TerrDimensionCode":"Indst",
  "TerritoryRuleBndryValue1":[
     {
        "TerrDimIntgId":"ONE VOICE~1100",
        "TerrDimensionCode":"Indst"
      }]
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"TerrRuleBoundaryId": 300100091635549,
"TerrRuleId": 300100091635545,
"Dimension": "Industry",
"TerrDimensionCode": "Indst",
"TerritoryRuleBndryValue1":[
{"TerrRuleBndryValueId": 300100091635550, "TerrRuleBoundaryId": 300100091635549, "DimensionMember": "Automotive", "DimensionMemberHigh": null,…}
],
"links":[
{"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryRule/300100091635545/child/TerritoryRuleBoundary1/300100091635549",...},
{"rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryRule/300100091635545/child/TerritoryRuleBoundary1/300100091635549",...},
{"rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryRule/300100091635545",...}
]
}

Back to Top