Update a benefit list type value
/crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}/child/BenefitListTypeValues/{BenefitListTypeValId}
Request
-
BenefitListTypeValId(required): integer(int64)
The system-generated unique identifier and primary key of the benefit.
-
ProgramBenefitId(required): integer(int64)
The system-generated unique identifier and primary key of the benefit.
-
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.
- application/json
object
-
ProgramBenefitId: integer
(int64)
The unique identifier of the program benefit.
-
ValueName: string
Title:
Value
Maximum Length:155
The name of the benefit list type value.
Response
- application/json
Default Response
-
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.
object
-
BenefitListTypeValId: integer
(int64)
The system-generated unique identifier and primary key of the benefit.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date and time the row was created. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the benefit list type value should be deleted. If the value is true, then the benefit list type value can be deleted. The default value is true. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramBenefitId: integer
(int64)
The unique identifier of the program benefit.
-
UpdateFlag: boolean
Read Only:
true
Indicates whether the benefit list type value can be updated. If the value is true, then the benefit list type value can be updated. The default value is true. -
ValueName: string
Title:
Value
Maximum Length:155
The name of the benefit list type value.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to update a benefit list type value by submitting a patch request on the REST resource using cURL.
cURL Command
curl -v -u Username:Password
curl -v -u Username:Password -H "content-type:application/vnd.oracle.adf.resourceitem+json"
-X PATCH "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partnerProgramBenefits/300100071293831/child/BenefitListTypeValues/300100071293833"
-d '{ request_payload}'
Example of Request Body
The following shows an example of the request body in JSON format.
{ ValueName": "List Value 2 Updated" }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "BenefitListTypeValId" : 300100071293833, "ProgramBenefitId" : 300100071293831, "ValueName" : "List Value 2 Updated", "CreatedBy" : "CHANNEL_OPERATIONS_MANAGER", "CreationDate" : "2016-02-18T10:51:21-08:00", "LastUpdateDate" : "2016-02-18T11:01:09-08:00", "LastUpdatedBy" : "CHANNEL_OPERATIONS_MANAGER", "DeleteFlag" : "true", "UpdateFlag" : "true", ... }