Get All Eligibility Rules
get
/rest/v19/eligibilityRule
This operation returns all Eligibility Rule data.
Request
Query Parameters
-
expand: string
Allows expansion of relationships.
-
fields: string
Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
-
limit: integer
The requested page size, which limits the number of elements the collection should max return.
-
offset: integer
The offset of the page. By default, offset is 0, which means first page will be returned.
-
orderby: string
Specifies a comma-separated list of pairs to order the response by.
-
q: string
Allows to specify one or more filtering criteria. By default, no filtering is applied.
-
totalResults: boolean
Specifies that the total count of records should be included in the response when doing pagination.
Response
Default Response
Root Schema : eligibilityRule-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 : items
Type:
Show Source
array-
Array of:
object Eligibility Rule
Title:
Eligibility Rule
Nested Schema : Eligibility Rule
Type:
objectTitle:
Show Source
Eligibility Rule-
active:
object active
Title:
activeYES indicates Active and NO indicates Inactive -
condition:
object eligibilityRuleCondition-collection
-
conditionRowGrouping:
string
Title:
conditionRowGroupingThis field holds the Eligibility rule condition row grouping information -
conditionType:
object conditionType
Title:
conditionTypeSpecifies whether condition is ALWAYS_TRUE or SIMPLE -
dateAdded:
string
Title:
dateAddedDate record is added -
dateModified:
string
Title:
dateModifieddate record is modified -
description:
string
Title:
descriptionDescription of Eligibiltiy Rule -
endDate:
string
Title:
endDateEligibility rule end date -
id:
integer
Title:
idPrimary key of BM_Eligibility_rule -
isRuleChanged:
boolean
Title:
isRuleChangedYes indicates rule got modified and No indicates Rule did not get modified -
isRuleInvalid:
boolean
Title:
isRuleInvalidYes indicates rule is invalid and No indicates rule is valid -
lastDeployedDate:
string
Title:
lastDeployedDateEligibility rule deployed date -
name:
string
Title:
nameName of Eligibility Rule -
processName:
string
Title:
processNameName of process associated with rule -
ruleType:
object ruleType
Title:
ruleTypeIndicates whether AVAILABLE or NOT_AVAILABLE rule -
selection:
object eligibilityRuleSelection-collection
-
selectionRowGrouping:
string
Title:
selectionRowGroupingThis fields holds Eligibility rule selection row grouping information -
selectionType:
object selectionType
Title:
selectionTypeThis field specifies whether selection is ALL, NONE or SIMPLE -
startDate:
string
Title:
startDateEligibility Rule start date -
variableName:
string
Title:
variableNamevariable name of Eligibility Rule
Nested Schema : active
Type:
objectTitle:
activeYES indicates Active and NO indicates Inactive
Show Source
-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage 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:
objectTitle:
conditionTypeSpecifies whether condition is ALWAYS_TRUE or SIMPLE
Show Source
-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Nested Schema : ruleType
Type:
objectTitle:
ruleTypeIndicates whether AVAILABLE or NOT_AVAILABLE rule
Show Source
-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage 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:
objectTitle:
selectionTypeThis field specifies whether selection is ALL, NONE or SIMPLE
Show Source
-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage 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:
objectTitle:
Show Source
Eligibility Rule Condition-
attributeName:
string
Title:
attributeNameData source field for condition is stored in this field -
dataType:
object dataType
Title:
dataTypeIndicates data type of attributeName -
dateAdded:
string
Title:
dateAddeddate on which this record is added -
dateModified:
string
Title:
dateModified -
id:
integer
Title:
id -
operator:
object operator
Title:
operatoropearator for condition is stored in this field -
ruleConditionIndex:
integer
Title:
ruleConditionIndexrow index of Rule condition -
ruleId:
object ruleId
Title:
ruleIdForeign key field -
value:
string
Title:
valuevalue for condition is stored in this field
Nested Schema : dataType
Type:
objectTitle:
dataTypeIndicates data type of attributeName
Show Source
-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Nested Schema : operator
Type:
objectTitle:
operatoropearator for condition is stored in this field
Show Source
-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Nested Schema : ruleId
Type:
objectTitle:
ruleIdForeign key field
Show Source
-
id:
integer
Title:
idPrimary key of BM_Eligibility_rule -
variableName:
string
Title:
variableNamevariable 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:
objectTitle:
Show Source
Eligibility Rule Selection-
dataType:
object dataType
Title:
dataTypeIndicates data type of attributeName -
dateAdded:
string
Title:
dateAdded -
dateModified:
string
Title:
dateModified -
id:
integer
Title:
idprimary key of selection table -
operator:
object operator
Title:
operatorOperator chosen for selection -
partField:
string
Title:
partFieldPart field selected in selection -
ruleId:
object ruleId
Title:
ruleIdForeign key to rule table -
ruleSelectionIndex:
integer
Title:
ruleSelectionIndexindex of rule selection index -
value:
string
Title:
valuevalue for selection is stored in this field
Nested Schema : dataType
Type:
objectTitle:
dataTypeIndicates data type of attributeName
Show Source
-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Nested Schema : operator
Type:
objectTitle:
operatorOperator chosen for selection
Show Source
-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Nested Schema : ruleId
Type:
objectTitle:
ruleIdForeign key to rule table
Show Source
-
id:
integer
Title:
idPrimary key of BM_Eligibility_rule -
variableName:
string
Title:
variableNamevariable name of Eligibility Rule
Examples
The following example shows how to return eligibility data for a all Eligibility Rules by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json" https://sitename.oracle.com/rest/v19/eligibilityRule?expand=all
Response Body Sample
{
"hasMore": false,
"totalResults": 2,
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/eligibilityRule"
}
]
}