Create a territory resource
post
/crmRestApi/resources/11.13.18.05/salesTerritories/{UniqueTerritoryNumber}/child/TerritoryResource
Request
Path Parameters
-
UniqueTerritoryNumber(required): string
The unique identification number for the territory.
Header Parameters
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AdministratorFlag: boolean
Title:
Team Member Administrator
Maximum Length:1
Indicates whether the resource is an administrator of the territory. -
FunctionCode: string
Title:
Team Member Function
Maximum Length:30
The code for the function of the resource associated with the territory. -
ManageForecastFlag: boolean
Title:
Forecasting Delegate
Maximum Length:1
Indicates whether a territory resource has been given the responsibility to manage the territory forecast on behalf of the owner of the territory. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the resource from the resource manager. -
TerritoryVersionId: integer
(int64)
Title:
Territory Version ID
The unique identifier of the territory version. -
TerrResourceId: integer
(int64)
Title:
Territory Resource ID
The unique identifier of the territory team member. -
UniqueTerritoryNumber: string
Title:
Unique Territory Number
Maximum Length:30
The public unique identifier of the territory.
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.
Root Schema : salesTerritories-TerritoryResource-item-response
Type:
Show Source
object
-
AdministratorFlag: boolean
Title:
Team Member Administrator
Maximum Length:1
Indicates whether the resource is an administrator of the territory. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the territory team member. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the territory team member was created. -
Email: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the resource. -
FunctionCode: string
Title:
Team Member Function
Maximum Length:30
The code for the function of the resource associated with the territory. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the territory team member was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the territory team member. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the territory team member. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManageForecastFlag: boolean
Title:
Forecasting Delegate
Maximum Length:1
Indicates whether a territory resource has been given the responsibility to manage the territory forecast on behalf of the owner of the territory. -
Manager: string
Read Only:
true
Maximum Length:360
The name of the manager. -
OrganizationName: string
Title:
Organization
Read Only:true
Maximum Length:240
The name of the organization of the resource. -
OwnerFlag: boolean
Title:
Owner
Read Only:true
Indicates whether the team member is the owner. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the resource from the resource manager. -
ResourceName: string
Title:
Resource Name
Read Only:true
Maximum Length:360
The name of the resource associated with the territory. -
ResourceNumber: string
Title:
Resource Registry ID
Read Only:true
Maximum Length:30
The public unique identifier of the territory resource from the resource manager. -
RoleName: string
Title:
Team Member Role
Read Only:true
Maximum Length:60
The name of the team member role associated with the resource. -
TerritoryVersionId: integer
(int64)
Title:
Territory Version ID
The unique identifier of the territory version. -
TerrResourceId: integer
(int64)
Title:
Territory Resource ID
The unique identifier of the territory team member. -
UniqueTerritoryNumber: string
Title:
Unique Territory Number
Maximum Length:30
The public unique identifier of the territory.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- LookupFunctionCodeViewAccessor
-
Parameters:
- finder:
LookupTypeIsEnabledFinder%3BBindLookupType%3DMOT_TEAM_MEMBER_FUNCTION
The list of values for the role or function of the resource associated with the territory, such as Legal or Salesperson.
The following properties are defined on the LOV link relation:- Source Attribute: FunctionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LookupYesNoViewAccessor
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DYES_NO
The list of values to indicate whether the resource is an administrator of the territory or not. The valid values are Yes and No.
The following properties are defined on the LOV link relation:- Source Attribute: AdministratorFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: