Benefit Guards
Subcategories: Attachments, Notes
The benefit guards resource is used to view, create, update, replace, and delete details of a benefit for use in negotiation.
|
Resource Plural Label |
Benefit Guards |
|
Resource Name |
__ORACO__BenefitGuard_c |
Get All Benefit Guards
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__BenefitGuard_c
Request Path Parameters
There are no request path parameters for this task.
Request Query Parameters
Use these finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
Primary Key |
Finds a benefit guard with the specified primary key. Finder Variables:
|
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Create a Benefit Guard
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__BenefitGuard_c
Request Path Parameters
There are no request path parameters for this task.
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Replace a Benefit Guard
Request: POST
URI:/crmRestApi/resources/11.13.18.05/__ORACO__BenefitGuard_c
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the benefit guard. |
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Get a Benefit Guard
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__BenefitGuard_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the benefit guard. |
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Update a Benefit Guard
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/__ORACO__BenefitGuard_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the benefit guard. |
Request Body
This table summarizes the request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Delete a Benefit Guard
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/__ORACO__BenefitGuard_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the benefit guard. |
Request Body
There are no elements in the request body for this task.
Response Body
There are no elements in the response body for this task.
List of Values
This table lists all the list of values of the resource.
| LOV Name | Source Attribute in LOV | Target Attribute in Resource |
|---|---|---|
|
ViewAccessor_CurrencyCode |
CurrencyCode |
CurrencyCode |
|
FK_LOVVA_For___ORACO__Benefit_c |
Id |
__ORACO__Benefit_Id_c |
|
LOVVA_For___ORACO__Benefit_c |
RecordName |
__ORACO__Benefit_c |
|
LOVVA_For___ORACO__GuardType_c |
LookupCode |
__ORACO__GuardType_c |
|
FK_LOVVA_For___ORACO__OraZcxOwner_c |
ResourceProfileId |
__ORACO__OraZcxOwner_Id_c |
|
LOVVA_For___ORACO__OraZcxOwner_c |
PartyName |
__ORACO__OraZcxOwner_c |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
number |
The unique identifier of the benefit guard. UI Label: ID |
|
RecordName |
string |
The name of the benefit guard. Properties: The maximum length is 80. UI Label: Name |
|
CreatedBy |
string |
The user who created the benefit guard. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
The date when the benefit guard was created. UI Label: Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the benefit guard. Properties: The maximum length is 32. UI Label: Last Updated By |
|
LastUpdateDate |
datetime |
The date when the benefit guard was last updated. UI Label: Last Update Date |
|
RecordNumber |
string |
The alternate key identifier of the benefit guard. Properties: The maximum length is 64. UI Label: Record Number |
|
LastUpdateLogin |
string |
The login of the user who last updated the benefit guard. Properties: The maximum length is 32. |
|
UserLastUpdateDate |
datetime |
The date and time of the last user update made from a personal device. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database (a different mobile database or the server). |
|
CurrencyCode |
string |
The currency code associated with the benefit guard. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. UI Label: Currency Code |
|
CurcyConvRateType |
string |
The currency conversion rate type. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. |
|
CorpCurrencyCode |
string |
The corporate currency code associated with the benefit guard. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. Properties: The maximum length is 15. |
|
__ORACO__Benefit_Id_c |
number |
The unique identifier of the benefit. UI Label: Benefit |
|
__ORACO__Benefit_c |
string |
The name of the benefit guard. Properties: The maximum length is 1500. UI Label: Benefit |
|
__ORACO__MinimumAmount_c |
number |
The minimum benefit discount amount. UI Label: Minimum Discount Amount |
|
__ORACO__MaximumAmount_c |
number |
The maximum benefit discount amount. UI Label: Maximum Discount Amount |
|
__ORACO__MinimumPrice_c |
number |
The minimum benefit discount price. UI Label: Minimum Discounted Price |
|
__ORACO__MaximumPrice_c |
number |
The maximum benefit discount price. UI Label: Maximum Discounted Price |
|
__ORACO__MinimumPercentage_c |
number |
The minimum benefit discount percentage. UI Label: Minimum Discount Percentage |
|
__ORACO__MaximumPercentage_c |
number |
The maximum benefit discount percentage. UI Label: Maximum Discount Percentage |
|
__ORACO__SelectedRow |
string |
A field used for internal logic. UI Label: SelectedRow |
|
__ORACO__GuardType_c |
string |
The type of benefit guard. Properties: The maximum length is 1500. UI Label: Guard Type |
|
__ORACO__OraZcxOwner_Id_c |
number |
The unique identifier of the owner of the benefit guard. UI Label: Owner |
|
__ORACO__OraZcxOwner_c |
string |
The name of the owner of the benefit guard. Properties: The maximum length is 1500. UI Label: Owner |
|
Extn__ORACO__BenefitGuard_cFuseCreateLayout_1904TgtORACODCLayout_1557401462886Expr |
string |
|
|
Extn__ORACO__BenefitGuard_cFuseCreateLayout_1904ORACOPDLayout_1557401697751Expr |
string |