Create a program benefit
post
/crmRestApi/resources/11.13.18.05/partnerProgramBenefits
Request
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
-
BenefitListTypeValues: array
Benefit List Values
Title:
Benefit List Values
The benefit list values resource is used to view, create, update, and delete the benefit list values that are required to associate a program benefit with a partner program. -
CategoryCode: string
Title:
Category
Maximum Length:30
The code indicating the category of the benefit. For example, Financial, Sales, or Marketing. -
DataType(required): string
Title:
Value Type
Maximum Length:30
The value type of the benefit. For example, Percent, Amount, or Text. -
Description: string
Title:
Description
Maximum Length:1000
The text describing the benefit. -
Name(required): string
Title:
Name
Maximum Length:155
The name of the partner program benefit. -
ProgramBenefitId: integer
(int64)
The system-generated unique identifier and primary key of the benefit.
Nested Schema : Benefit List Values
Type:
array
Title:
Benefit List Values
The benefit list values resource is used to view, create, update, and delete the benefit list values that are required to associate a program benefit with a partner program.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
BenefitListTypeValId: integer
(int64)
The system-generated unique identifier and primary key of the benefit.
-
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
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 : partnerProgramBenefits-item-response
Type:
Show Source
object
-
BenefitListTypeValues: array
Benefit List Values
Title:
Benefit List Values
The benefit list values resource is used to view, create, update, and delete the benefit list values that are required to associate a program benefit with a partner program. -
CategoryCode: string
Title:
Category
Maximum Length:30
The code indicating the category of the benefit. For example, Financial, Sales, or Marketing. -
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. -
DataType: string
Title:
Value Type
Maximum Length:30
The value type of the benefit. For example, Percent, Amount, or Text. -
DeleteFlag: boolean
Read Only:
true
Indicates if the benefit can be deleted. The default value is true. -
Description: string
Title:
Description
Maximum Length:1000
The text describing the benefit. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
LastUpdatedByName: string
Title:
Updater Name
Read Only:true
The name of the user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the program benefit. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:155
The name of the partner program benefit. -
ProgramBenefitId: integer
(int64)
The system-generated unique identifier and primary key of the benefit.
-
UpdateFlag: boolean
Read Only:
true
Indicates if the benefit can be updated. The default value is true.
Nested Schema : Benefit List Values
Type:
array
Title:
Benefit List Values
The benefit list values resource is used to view, create, update, and delete the benefit list values that are required to associate a program benefit with a partner program.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partnerProgramBenefits-BenefitListTypeValues-item-response
Type:
Show Source
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.
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
- BenefitCategoryCodes
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZPM_BENEFIT_CATEGORY%2CBindLookupCode%3D{CategoryCode}
The list of values indicating the category of the benefit, such as Financial, Sales, or Marketing.
The following properties are defined on the LOV link relation:- Source Attribute: CategoryCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- BenefitDataTypes
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZPM_BENEFIT_DATA_TYPE%2CBindLookupCode%3D{DataType}
The list of values indicating the value type of the benefit, such as Amount, List, Number, Percent, or Text.
The following properties are defined on the LOV link relation:- Source Attribute: DataType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- BenefitListTypeValues
-
Parameters:
- ProgramBenefitId:
$request.path.ProgramBenefitId
The benefit list values resource is used to view, create, update, and delete the benefit list values that are required to associate a program benefit with a partner program. - ProgramBenefitId:
Examples
The following example shows how to create a program benefit by submitting a post request on the REST resource using cURL.
cURL Command
curl -v -u Username:Password
-H "content-type:application/vnd.oracle.adf.resourceitem+json" -X
POST "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partnerProgramBenefits/"
-d '{request_payload}'
Example of Request Body
The following shows an example of the request body in JSON format.
{ "Name":"Discount Sale", "DataType":"ORA_NUMBER" }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "ProgramBenefitId" : 300100071293747, "DataType" : "ORA_NUMBER", "Name" : "Discount Sale", "Description" : "". "CreatedBy" : "CHANNEL_OPERATIONS_MANAGER", "CreationDate" : "2016-02-17T12:28:14-08:00", "LastUpdateDate" : "2016-02-17T12:28:14-08:00", "LastUpdatedBy" : "CHANNEL_OPERATIONS_MANAGER", "DeleteFlag" : "true", "UpdateFlag" : "true", ... }