Jump to

• Request
• Response
• Examples

Get a program benefit for a partner program

get

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

Request

Path Parameters

• ProgramBenefitDetailId(required): integer
  The system-generated unique identifier and primary key of the program tier benefit.
• ProgramNumber(required): string
  The alternate key identifier generated for each program.

Query Parameters

• dependency: string
  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>
• expand: string
  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).
• fields: string
  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
• links: string
  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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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

• 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.

Body ()

Root Schema : partnerPrograms-ProgramBenefitDetails-item-response

Type: object

Show Source

• BenefitListValue: string
  The list value of the program tier benefit when the value type of program benefit is "List".
• BenefitValue: string
  Title: Benefit Value

  Maximum Length: 150

  The value of a program tier benefit in a format appropriate for the program benefit's value type.
• CategoryCode: string
  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.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time the row was created.
• DataType: string
  Title: Value Type

  Read Only: true

  Maximum Length: 30

  The value type of the program benefit.
• DeleteFlag: boolean
  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.
• Description: string
  Title: Benefits Description

  Read Only: true

  Maximum Length: 1000

  The text describing the program 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.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the program benefit detail.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 155

  The name of the program tier benefit.
• PartnerProgramId: integer (int64)
  Title: Program

  The unique identifier for the partner program to which the program tier benefit has been added.
• ProgramBenefitDetailId: integer
  Title: Program Benefit Details

  The system-generated unique identifier and primary key of the program tier benefit.
• ProgramBenefitId: integer (int64)
  Title: Benefit

  The unique identifier for a program benefit added to a program or program tier.
• TierId: integer (int64)
  Title: Tier

  The unique identifier for a tier to which a program tier benefit applies.
• TierName: string
  Title: Name

  Read Only: true

  Maximum Length: 155

  The name of a tier to which a program tier benefit applies.
• UpdateFlag: boolean
  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.

{
    "type":"object",
    "properties":{
        "BenefitListValue":{
            "type":"string",
            "description":"The list value of the program tier benefit when the value type of program benefit is \"List\".",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "BenefitValue":{
            "title":"Benefit Value",
            "maxLength":150,
            "type":"string",
            "description":"The value of a program tier benefit in a format appropriate for the program benefit's value type.",
            "nullable":true,
            "x-hints":{
                "ExtnEventActionProperty":"UpdateInFieldUpdate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the category of the program benefit. A list of valid values is defined in the lookup ORA_ZPM_BENEFIT_CATEGORY.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "DataType":{
            "title":"Value Type",
            "maxLength":30,
            "type":"string",
            "description":"The value type of the program benefit.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Benefits Description",
            "maxLength":1000,
            "type":"string",
            "description":"The text describing the program benefit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the program benefit detail.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate;HideInEmailTemplate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":155,
            "type":"string",
            "description":"The name of the program tier benefit.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PartnerProgramId":{
            "title":"Program",
            "type":"integer",
            "description":"The unique identifier for the partner program to which the program tier benefit has been added.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.partnerMgmt.partnerProgram.management.partnerProgramService.view.PartnerProgramsVO",
                "precision":18,
                "ExtnEventActionProperty":"HideInFieldUpdate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"ProgramName",
                "fnd:FND_AUDIT_FK_WHEREATTR":"PartnerProgramId"
            },
            "x-queryable":true
        },
        "ProgramBenefitDetailId":{
            "title":"Program Benefit Details",
            "type":"integer",
            "description":"The system-generated unique identifier and primary key of the program tier benefit.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ExtnEventActionProperty":"HideInFieldUpdate;",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "ProgramBenefitId":{
            "title":"Benefit",
            "type":"integer",
            "description":"The unique identifier for a program benefit added to a program or program tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "fnd:FND_AUDIT_USER_KEY":"true",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.partnerMgmt.partnerProgram.management.partnerProgramService.view.ProgramBenefitsVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Name",
                "fnd:FND_AUDIT_FK_WHEREATTR":"ProgramBenefitId"
            },
            "x-queryable":true
        },
        "TierId":{
            "title":"Tier",
            "type":"integer",
            "description":"The unique identifier for a tier to which a program tier benefit applies.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.partnerMgmt.partnerProgram.management.partnerProgramService.view.TierVO",
                "precision":18,
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Name",
                "fnd:FND_AUDIT_FK_WHEREATTR":"TierId"
            },
            "x-queryable":true
        },
        "TierName":{
            "title":"Name",
            "maxLength":155,
            "type":"string",
            "description":"The name of a tier to which a program tier benefit applies.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

BenefitCategoryCodes

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZPM_BENEFIT_CATEGORY%2CBindLookupCode%3D{CategoryCode}

The list of values indicating the category of the partner program or program-tier 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

BenefitListTypeValues

Operation: /crmRestApi/resources/11.13.18.05/benefitListTypeValuesLOV

The list of values indicating the program or program-tier benefit when the value type of the program benefit is List. List values are created previously by user as part of the benefit definition.

The following properties are defined on the LOV link relation:

• Source Attribute: BenefitListValue; Target Attribute: BenefitListTypeValId
• Display Attribute: ValueName

Benefits

Operation: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits

The list of values indicating the partner program benefit name, such as Additional Discount or Welcome Kit. No out-of-the-box values. The benefits are created by the user.

The following properties are defined on the LOV link relation:

• Source Attribute: Name; Target Attribute: Name
• Display Attribute: Name

ProgramTiers

Operation: /crmRestApi/resources/11.13.18.05/programTiersLOV

The list of values indicating the partner program tier to which a program-tier benefit applies, such as Platinum, Gold, or Silver. The tiers are created by the user.

The following properties are defined on the LOV link relation:

• Source Attribute: TierId; Target Attribute: TierId
• Display Attribute: Name

Back to Top

Examples

The following example shows how to get a program benefit 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/300100071293762"

Example of Response Body

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

{
  "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