Update a line of business for a territory
patch
/crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryLineOfBusiness/{TerrLobId}
Request
Path Parameters
-
TerrLobId(required): integer(int64)
The unique identifier of the line of business.
-
TerritoryVersionId(required): integer(int64)
The unique identifier of the territory version.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
LobCode: string
Title:
Line of Business Code
Maximum Length:30
The code for the line of business. -
TerritoryVersionId: integer
(int64)
Title:
Territory Version ID
The unique identifier of the territory version.
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 : territories-TerritoryLineOfBusiness-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the territory line of business. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the territory line of business was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the territory line of business was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the territory line of business. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the territory line of business. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LobCode: string
Title:
Line of Business Code
Maximum Length:30
The code for the line of business. -
Meaning: string
Title:
Line of Business
Read Only:true
Maximum Length:80
The meaning of the line of business. -
TerritoryVersionId: integer
(int64)
Title:
Territory Version ID
The unique identifier of the territory version. -
TerrLobId: integer
(int64)
Title:
Line of Business ID
The unique identifier of the line of business. -
UniqueTerritoryNumber: string
Title:
Unique Territory Number
Maximum Length:30
The unique territory number of the territory line of business.
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
- ValidLobCodeViewAccessor
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DMOT_LINE_OF_BUSINESS
The list of values for the line of business associated with the territory, such as Support or Hardware.
The following properties are defined on the LOV link relation:- Source Attribute: LobCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
Examples
The following example shows how to update a line of business for a territory by submitting a PATCH request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X
-X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100128873880/child/TerritoryLineOfBusinesss/child/TerritoryLineOfBusiness/300100091635538
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "LobCode" : "SOFTWARE" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "LobCode": "SOFTWARE", "TerrLobId": 300100091635538, "TerritoryVersionId": 300100091635502, "Meaning": "Software", "links":[ {"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryLineOfBusiness/300100091635538",…}, {"rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryLineOfBusiness/300100091635538",…}, {"rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502",…}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100091635502/child/TerritoryLineOfBusiness/300100091635538/lov/ValidLobCodeViewAccessor",…} ] }