Update an objective split
patch
/crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/SalesObjectiveSplits/{ObjectiveSplitId}
Request
Path Parameters
-
ObjectiveId(required): integer(int64)
The unique identifier of the objective.
-
ObjectiveSplitId(required): integer(int64)
The unique identifier of the objective split.
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
-
AccountId: integer
(int64)
Title:
Account
The unique identifier of the account assigned to the objective. -
ActualValue: integer
(int64)
Title:
Attainment
Default Value:0
The actual attainment value for the objective split. -
GeographyName: string
Title:
Geography
Maximum Length:255
The name of the geography, such as JAPAC, EMEA, or Americas. -
TargetValue: integer
(int64)
Title:
Target
Default Value:0
The unique identifier for the target of the objective split.
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 : salesObjectives-SalesObjectiveSplits-item-response
Type:
Show Source
object
-
AccountId: integer
(int64)
Title:
Account
The unique identifier of the account assigned to the objective. -
ActualValue: integer
(int64)
Title:
Attainment
Default Value:0
The actual attainment value for the objective split. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DisplayPeriodName: string
Title:
Period
Maximum Length:15
The display name for the objective split period. -
GeographyId: integer
(int64)
Title:
Geography
The unique identifier for the geography. -
GeographyName: string
Title:
Geography
Maximum Length:255
The name of the geography, such as JAPAC, EMEA, or Americas. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date on which the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectiveId: integer
(int64)
Title:
Objective
The unique identifier of the objective. -
ObjectiveSplitId: integer
(int64)
The unique identifier of the objective split.
-
PartyUniqueName: string
Read Only:
true
Maximum Length:900
The name of the account. -
PeriodType: string
Title:
Period Type Code
Maximum Length:30
The type of period for the objective split. -
ProdGroupName: string
Title:
Product Group
Read Only:true
Maximum Length:250
The name of the product group. -
ProductId: integer
(int64)
Title:
Product Group
The unique identifier for the product. -
TargetValue: integer
(int64)
Title:
Target
Default Value:0
The unique identifier for the target of the objective split.
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.
Examples
The following example shows how to update an objective split by submitting a patch request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/child/SalesObjectiveSplits/300100091619392
Example of Request Body
The following shows an example of the request body in JSON format.
{ "ActualValue":"200", "TargetValue":"101" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "AccountId": null, "ActualValue": 200, "CreatedBy": "SALES_ADMIN", "CreationDate": "2016-11-10T23:26:48-08:00", "GeographyId": null, "LastUpdateDate": "2016-11-11T00:21:16-08:00", "LastUpdateLogin": "4101B34432126FE8E05392D0F00A4D46", "LastUpdatedBy": "SALES_ADMIN", "ObjectiveId": 300100091619347, "ObjectiveSplitId": 300100091619392, "PeriodType": "YEAR", "DisplayPeriodName": null, "TargetValue": 101, "ProdGroupName": null, "ProdGroupId": null, "PartyUniqueName": null, "GeographyName": null, "links":[ {"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/child/SalesObjectiveSplits/300100091619392",…}, {"rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/child/SalesObjectiveSplits/300100091619392",…}, {"rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347",…} ] }