Update Eligibility Rule
post
/rest/v16/eligibilityRule/{id}
This operation updates an existing Eligibility Rule.
Request
Path Parameters
-
id(required): integer
The primary key of the Eligibility Rule to update.
Root Schema : Eligibility Rule
Type:
object
Title:
Show Source
Eligibility Rule
-
active:
object active
Title:
active
YES indicates Active and NO indicates Inactive -
condition:
object eligibilityRuleCondition-collection
-
conditionRowGrouping:
string
Title:
conditionRowGrouping
This field holds the Eligibility rule condition row grouping information -
conditionType:
object conditionType
Title:
conditionType
Specifies whether condition is ALWAYS_TRUE or SIMPLE -
dateAdded:
string
Title:
dateAdded
Date record is added -
dateModified:
string
Title:
dateModified
date record is modified -
description:
string
Title:
description
Description of Eligibiltiy Rule -
endDate:
string
Title:
endDate
Eligibility rule end date -
id:
integer
Title:
id
Primary key of BM_Eligibility_rule -
isRuleChanged:
boolean
Title:
isRuleChanged
Yes indicates rule got modified and No indicates Rule did not get modified -
isRuleInvalid:
boolean
Title:
isRuleInvalid
Yes indicates rule is invalid and No indicates rule is valid -
lastDeployedDate:
string
Title:
lastDeployedDate
Eligibility rule deployed date -
name:
string
Title:
name
Name of Eligibility Rule -
processName:
string
Title:
processName
Name of process associated with rule -
ruleType:
object ruleType
Title:
ruleType
Indicates whether AVAILABLE or NOT_AVAILABLE rule -
selection:
object eligibilityRuleSelection-collection
-
selectionRowGrouping:
string
Title:
selectionRowGrouping
This fields holds Eligibility rule selection row grouping information -
selectionType:
object selectionType
Title:
selectionType
This field specifies whether selection is ALL, NONE or SIMPLE -
startDate:
string
Title:
startDate
Eligibility Rule start date -
variableName:
string
Title:
variableName
variable name of Eligibility Rule
Nested Schema : active
Type:
object
Title:
active
YES indicates Active and NO indicates Inactive
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : eligibilityRuleCondition-collection
Type:
Show Source
object
-
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset used in the current page.
-
totalResults:
integer
Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : conditionType
Type:
object
Title:
conditionType
Specifies whether condition is ALWAYS_TRUE or SIMPLE
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : ruleType
Type:
object
Title:
ruleType
Indicates whether AVAILABLE or NOT_AVAILABLE rule
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : eligibilityRuleSelection-collection
Type:
Show Source
object
-
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset used in the current page.
-
totalResults:
integer
Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : selectionType
Type:
object
Title:
selectionType
This field specifies whether selection is ALL, NONE or SIMPLE
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Eligibility Rule Condition
Title:
Eligibility Rule Condition
Nested Schema : Eligibility Rule Condition
Type:
object
Title:
Show Source
Eligibility Rule Condition
-
attributeName:
string
Title:
attributeName
Data source field for condition is stored in this field -
dataType:
object dataType
Title:
dataType
Indicates data type of attributeName -
dateAdded:
string
Title:
dateAdded
date on which this record is added -
dateModified:
string
Title:
dateModified
-
id:
integer
Title:
id
-
operator:
object operator
Title:
operator
opearator for condition is stored in this field -
ruleConditionIndex:
integer
Title:
ruleConditionIndex
row index of Rule condition -
ruleId:
object ruleId
Title:
ruleId
Foreign key field -
value:
string
Title:
value
value for condition is stored in this field
Nested Schema : dataType
Type:
object
Title:
dataType
Indicates data type of attributeName
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : operator
Type:
object
Title:
operator
opearator for condition is stored in this field
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : ruleId
Type:
object
Title:
ruleId
Foreign key field
Show Source
-
id:
integer
Title:
id
Primary key of BM_Eligibility_rule -
variableName:
string
Title:
variableName
variable name of Eligibility Rule
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Eligibility Rule Selection
Title:
Eligibility Rule Selection
Nested Schema : Eligibility Rule Selection
Type:
object
Title:
Show Source
Eligibility Rule Selection
-
dataType:
object dataType
Title:
dataType
Indicates data type of attributeName -
dateAdded:
string
Title:
dateAdded
-
dateModified:
string
Title:
dateModified
-
id:
integer
Title:
id
primary key of selection table -
operator:
object operator
Title:
operator
Operator chosen for selection -
partField:
string
Title:
partField
Part field selected in selection -
ruleId:
object ruleId
Title:
ruleId
Foreign key to rule table -
ruleSelectionIndex:
integer
Title:
ruleSelectionIndex
index of rule selection index -
value:
string
Title:
value
value for selection is stored in this field
Nested Schema : dataType
Type:
object
Title:
dataType
Indicates data type of attributeName
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : operator
Type:
object
Title:
operator
Operator chosen for selection
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : ruleId
Type:
object
Title:
ruleId
Foreign key to rule table
Show Source
-
id:
integer
Title:
id
Primary key of BM_Eligibility_rule -
variableName:
string
Title:
variableName
variable name of Eligibility Rule
Response
Default Response
Root Schema : Eligibility Rule
Type:
object
Title:
Show Source
Eligibility Rule
-
active:
object active
Title:
active
YES indicates Active and NO indicates Inactive -
condition:
object eligibilityRuleCondition-collection
-
conditionRowGrouping:
string
Title:
conditionRowGrouping
This field holds the Eligibility rule condition row grouping information -
conditionType:
object conditionType
Title:
conditionType
Specifies whether condition is ALWAYS_TRUE or SIMPLE -
dateAdded:
string
Title:
dateAdded
Date record is added -
dateModified:
string
Title:
dateModified
date record is modified -
description:
string
Title:
description
Description of Eligibiltiy Rule -
endDate:
string
Title:
endDate
Eligibility rule end date -
id:
integer
Title:
id
Primary key of BM_Eligibility_rule -
isRuleChanged:
boolean
Title:
isRuleChanged
Yes indicates rule got modified and No indicates Rule did not get modified -
isRuleInvalid:
boolean
Title:
isRuleInvalid
Yes indicates rule is invalid and No indicates rule is valid -
lastDeployedDate:
string
Title:
lastDeployedDate
Eligibility rule deployed date -
name:
string
Title:
name
Name of Eligibility Rule -
processName:
string
Title:
processName
Name of process associated with rule -
ruleType:
object ruleType
Title:
ruleType
Indicates whether AVAILABLE or NOT_AVAILABLE rule -
selection:
object eligibilityRuleSelection-collection
-
selectionRowGrouping:
string
Title:
selectionRowGrouping
This fields holds Eligibility rule selection row grouping information -
selectionType:
object selectionType
Title:
selectionType
This field specifies whether selection is ALL, NONE or SIMPLE -
startDate:
string
Title:
startDate
Eligibility Rule start date -
variableName:
string
Title:
variableName
variable name of Eligibility Rule
Nested Schema : active
Type:
object
Title:
active
YES indicates Active and NO indicates Inactive
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : eligibilityRuleCondition-collection
Type:
Show Source
object
-
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset used in the current page.
-
totalResults:
integer
Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : conditionType
Type:
object
Title:
conditionType
Specifies whether condition is ALWAYS_TRUE or SIMPLE
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : ruleType
Type:
object
Title:
ruleType
Indicates whether AVAILABLE or NOT_AVAILABLE rule
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : eligibilityRuleSelection-collection
Type:
Show Source
object
-
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset used in the current page.
-
totalResults:
integer
Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : selectionType
Type:
object
Title:
selectionType
This field specifies whether selection is ALL, NONE or SIMPLE
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Eligibility Rule Condition
Title:
Eligibility Rule Condition
Nested Schema : Eligibility Rule Condition
Type:
object
Title:
Show Source
Eligibility Rule Condition
-
attributeName:
string
Title:
attributeName
Data source field for condition is stored in this field -
dataType:
object dataType
Title:
dataType
Indicates data type of attributeName -
dateAdded:
string
Title:
dateAdded
date on which this record is added -
dateModified:
string
Title:
dateModified
-
id:
integer
Title:
id
-
operator:
object operator
Title:
operator
opearator for condition is stored in this field -
ruleConditionIndex:
integer
Title:
ruleConditionIndex
row index of Rule condition -
ruleId:
object ruleId
Title:
ruleId
Foreign key field -
value:
string
Title:
value
value for condition is stored in this field
Nested Schema : dataType
Type:
object
Title:
dataType
Indicates data type of attributeName
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : operator
Type:
object
Title:
operator
opearator for condition is stored in this field
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : ruleId
Type:
object
Title:
ruleId
Foreign key field
Show Source
-
id:
integer
Title:
id
Primary key of BM_Eligibility_rule -
variableName:
string
Title:
variableName
variable name of Eligibility Rule
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Eligibility Rule Selection
Title:
Eligibility Rule Selection
Nested Schema : Eligibility Rule Selection
Type:
object
Title:
Show Source
Eligibility Rule Selection
-
dataType:
object dataType
Title:
dataType
Indicates data type of attributeName -
dateAdded:
string
Title:
dateAdded
-
dateModified:
string
Title:
dateModified
-
id:
integer
Title:
id
primary key of selection table -
operator:
object operator
Title:
operator
Operator chosen for selection -
partField:
string
Title:
partField
Part field selected in selection -
ruleId:
object ruleId
Title:
ruleId
Foreign key to rule table -
ruleSelectionIndex:
integer
Title:
ruleSelectionIndex
index of rule selection index -
value:
string
Title:
value
value for selection is stored in this field
Nested Schema : dataType
Type:
object
Title:
dataType
Indicates data type of attributeName
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : operator
Type:
object
Title:
operator
Operator chosen for selection
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : ruleId
Type:
object
Title:
ruleId
Foreign key to rule table
Show Source
-
id:
integer
Title:
id
Primary key of BM_Eligibility_rule -
variableName:
string
Title:
variableName
variable name of Eligibility Rule
Examples
The following example shows how to update an Eligibility Rules by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X POST - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v16/eligibilityRule/20471574
Request Body Sample
{ "conditionType": { "lookupCode": "0" }, "name": "Test Eligibility Rule", "ruleType": { "lookupCode": "0" } }
Response Body Sample
{ "startDate": "2021-03-18", "dateModified": "2021-03-18T10:56:11.655Z", "variableName": "testEligibilityRule", "selectionRowGrouping": "1", "conditionType": { "lookupCode": "0", "displayValue": "Always True", "id": 20471574, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22ELIGIBILITY_RULE_COND_TYPE%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/20471574" } ] }, "processName": "Quotes", "dateAdded": "2021-03-18T10:56:11.655Z", "endDate": "2021-08-21", "id": 20510770, "conditionRowGrouping": "1", "isRuleChanged": true, "description": null, "name": "Test Eligibility Rule", "isRuleInvalid": false, "ruleType": { "lookupCode": "0", "displayValue": "Available", "id": 20383423, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22ELIGIBILITY_RULE_TYPE%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/20383423" } ] }, "lastDeployedDate": null, "selectionType": { "lookupCode": "2", "displayValue": "Simple", "id": 20471577, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22ELIGIBILITY_RULE_SEL_TYPE%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/20471577" } ] }, "active": { "lookupCode": "1", "displayValue": "Yes", "id": 20383422, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22ELIGIBILITY_RULE_ACTIVE_CODE%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/20383422" } ] }, "condition": {}, "selection": { "hasMore": false, "items": [{ "dateModified": "2021-03-21T10:56:11.658Z", "dateAdded": "2021-03-18T10:56:11.658Z", "partField": "/part/_custom_attr/field13", "operator": { "lookupCode": "1", "displayValue": "Equal", "id": 20471586, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22ELIGIBILITY_RULE_OPERATOR_TYPE%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/20471586" } ] }, "id": 20510772, "dataType": { "lookupCode": "2", "displayValue": "Text", "id": 20471580, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22ELIGIBILITY_RULE_DATA_TYPE%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/20471580" } ] }, "ruleId": { "id": 20510770, "variableName": "testEligibilityRule", "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/eligibilityRule" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/eligibilityRule/20510770" } ] }, "value": "1", "ruleSelectionIndex": 1, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/eligibilityRule/20510770/selection/20510772" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/eligibilityRule/20510770" } ] } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/eligibilityRule/20510770/selection" } ] }, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/eligibilityRule/20510770" } ] }