Jump to

• Request
• Response
• Examples

Update a program benefit

patch

/crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}

Request

Path Parameters

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

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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: 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: string
  Title: Name

  Maximum Length: 155

  The name of the partner program benefit.

{
    "type":"object",
    "properties":{
        "BenefitListTypeValues":{
            "title":"Benefit List Values",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/partnerProgramBenefits-BenefitListTypeValues-item-patch-request"
            }
        },
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the category of the benefit. For example, Financial, Sales, or Marketing.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DataType":{
            "title":"Value Type",
            "maxLength":30,
            "type":"string",
            "description":"The value type of the benefit. For example, Percent, Amount, or Text.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The text describing the benefit.",
            "nullable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":155,
            "type":"string",
            "description":"The name of the partner program benefit.",
            "nullable":false
        }
    }
}

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

• Array of: object partnerProgramBenefits-BenefitListTypeValues-item-patch-request

{
    "title":"Benefit List Values",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/partnerProgramBenefits-BenefitListTypeValues-item-patch-request"
    }
}

Nested Schema : partnerProgramBenefits-BenefitListTypeValues-item-patch-request

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "ProgramBenefitId":{
            "type":"integer",
            "description":"The unique identifier of the program benefit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ValueName":{
            "title":"Value",
            "maxLength":155,
            "type":"string",
            "description":"The name of the benefit list type value.",
            "nullable":false
        }
    }
}

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 : partnerProgramBenefits-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "BenefitListTypeValues":{
            "title":"Benefit List Values",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/partnerProgramBenefits-BenefitListTypeValues-item-response"
            }
        },
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the category of the benefit. For example, Financial, Sales, or Marketing.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DataType":{
            "title":"Value Type",
            "maxLength":30,
            "type":"string",
            "description":"The value type of the benefit. For example, Percent, Amount, or Text.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the benefit can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The text describing the benefit.",
            "nullable":true,
            "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-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the program benefit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedByName":{
            "title":"Updater Name",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":155,
            "type":"string",
            "description":"The name of the partner program benefit.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramBenefitId":{
            "type":"integer",
            "description":"The system-generated unique identifier and primary key of the benefit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the benefit can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

• Array of: object partnerProgramBenefits-BenefitListTypeValues-item-response

{
    "title":"Benefit List Values",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/partnerProgramBenefits-BenefitListTypeValues-item-response"
    }
}

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 : partnerProgramBenefits-BenefitListTypeValues-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "BenefitListTypeValId":{
            "type":"integer",
            "description":"The system-generated unique identifier and primary key of the benefit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ProgramBenefitId":{
            "type":"integer",
            "description":"The unique identifier of the program benefit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "ValueName":{
            "title":"Value",
            "maxLength":155,
            "type":"string",
            "description":"The name of the benefit list type value.",
            "nullable":false,
            "x-queryable":true
        },
        "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 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

BenefitDataTypes

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

BenefitListTypeValues

Operation: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}/child/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.

Back to Top

Examples

The following example shows how to update a program benefit 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/partnerPrograms/CDRM_12005/child/ProgramBenefitDetails/300100071293762" -d '{ request_payload}'

Example of Request Body

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

{
  "BenefitValue": "123"
}

Example of Response Body

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

{
  "BenefitValue" : "123",
  "CreatedBy" : "CHANNEL_OPERATIONS_MANAGER",
  "CreationDate" : "2016-02-17T16:53:58-08:00",
  "LastUpdateDate" : "2016-02-17T17:05:35-08:00",
  "LastUpdatedBy" : "CHANNEL_OPERATIONS_MANAGER",
  "PartnerProgramId" : 300100071293754,
  "ProgramBenefitDetailId" : 300100071293762,
  "ProgramBenefitId" : 300100071293761,
....
}

Back to Top