Get a resource for a territory
get
/crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryResource/{TerritoryResourceUniqID}
Request
Path Parameters
-
TerritoryResourceUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Resources resource and used to uniquely identify an instance of Resources. The client should not generate the hash key value. Instead, the client should query on the Resources collection resource in order to navigate to a specific instance of Resources to get the hash key.
-
TerritoryVersionId(required): integer(int64)
The unique identifier of the territory version.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : territories-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 territory team member. -
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. -
OwnerFlag: boolean
Title:
Owner
Read Only:true
Indicates whether the territory 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 registry ID of the territory team member. -
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 resource. -
UniqueTerritoryNumber: string
Title:
Unique Territory Number
Maximum Length:30
The unique territory number of the territory team member.
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:
Examples
The following example shows how to get a resource for a territory by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100025000830/child/TerritoryResource/300100025000832
Example of Response Body
The following shows an example of the response body in JSON format.
{ TerrResourceId: 300100025000832 ResourceId: 100010037456577 ResourceName: "Joe Buendia" TerritoryVersionId: 300100025000830 OwnerFlag: "false" FunctionCode: null OrganizationName: "EMEA" RoleName: "Sales Vice President" ... }