1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Partner Programs
  4. Program Benefit Details

Get all program benefits for a partner program

get

/crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramBenefitDetails

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds details of a program tier benefit within a partner program using the program benefit detail ID.
      Finder Variables:
      • ProgramBenefitDetailId; integer; The system-generated unique identifier and primary key of the program tier benefit.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BenefitListValue; string; The list value of the program tier benefit when the value type of program benefit is "List".
    • BenefitValue; string; The value of a program tier benefit in a format appropriate for the program benefit's value type.
    • CategoryCode; string; The code indicating the category of the program benefit. A list of valid values is defined in the lookup ORA_ZPM_BENEFIT_CATEGORY.
    • CreatedBy; string; The user who created the row.
    • CreationDate; string; The date and time the row was created.
    • DataType; string; The value type of the program benefit.
    • Description; string; The text describing the program benefit.
    • LastUpdateDate; string; The date and time the row was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the program benefit detail.
    • LastUpdatedBy; string; The user who last updated the row.
    • Name; string; The name of the program tier benefit.
    • PartnerProgramId; integer; The unique identifier for the partner program to which the program tier benefit has been added.
    • ProgramBenefitDetailId; integer; The system-generated unique identifier and primary key of the program tier benefit.
    • ProgramBenefitId; integer; The unique identifier for a program benefit added to a program or program tier.
    • TierId; integer; The unique identifier for a tier to which a program tier benefit applies.
    • TierName; string; The name of a tier to which a program tier benefit applies.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : partnerPrograms-ProgramBenefitDetails
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : partnerPrograms-ProgramBenefitDetails-item-response
Type: object
Show Source
  • The list value of the program tier benefit when the value type of program benefit is "List".
  • Title: Benefit Value
    Maximum Length: 150
    The value of a program tier benefit in a format appropriate for the program benefit's value type.
  • Title: Category
    Read Only: true
    Maximum Length: 30
    The code indicating the category of the program benefit. A list of valid values is defined in the lookup ORA_ZPM_BENEFIT_CATEGORY.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the row.
  • Title: Creation Date
    Read Only: true
    The date and time the row was created.
  • Title: Value Type
    Read Only: true
    Maximum Length: 30
    The value type of the program benefit.
  • Read Only: true
    Indicates whether the program benefit can be deleted. If the value is Y, then the program benefit can be deleted. The default value is N.
  • Title: Benefits Description
    Read Only: true
    Maximum Length: 1000
    The text describing the program benefit.
  • Title: Last Updated Date
    Read Only: true
    The date and time the row was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the row.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the program benefit detail.
  • Links
  • Title: Name
    Maximum Length: 155
    The name of the program tier benefit.
  • Title: Program
    The unique identifier for the partner program to which the program tier benefit has been added.
  • Title: Program Benefit Details
    The system-generated unique identifier and primary key of the program tier benefit.
  • Title: Benefit
    The unique identifier for a program benefit added to a program or program tier.
  • Title: Tier
    The unique identifier for a tier to which a program tier benefit applies.
  • Title: Name
    Read Only: true
    Maximum Length: 155
    The name of a tier to which a program tier benefit applies.
  • Read Only: true
    Indicates whether the program benefit can be updated. If the value is Y, then the program benefit can be updated. The default value is N.
Back to Top

Examples

The following example shows how to get all program benefits for a partner program by submitting a get request on the REST resource using cURL.

cURL Command

curl -v -u Username:Password -X GET "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partnerPrograms/CDRM_12005/child/ProgramBenefitDetails"

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "items" : [ {
    "BenefitValue" : null,
    "CreatedBy" : "CHANNEL_OPERATIONS_MANAGER",
    "CreationDate" : "2016-02-17T16:53:58-08:00",
    "LastUpdateDate" : "2016-02-17T16:53:58-08:00",
    "LastUpdatedBy" : "CHANNEL_OPERATIONS_MANAGER",
    "PartnerProgramId" : 300100071293754,
    "ProgramBenefitDetailId" : 300100071293762,
    "ProgramBenefitId" : 300100071293761,
    "TierId" : null,
    "DataType" : "ORA_NUMBER",
    "Name" : "Discount Sale",
    "Description" : null,
    "TierName" : null,
    "CategoryCode" : null,
    "BenefitListValue" : null,
    "UpdateFlag" : "true",
    "DeleteFlag" : "true",
....
}
Back to Top