Get all business rule definitions
get
/fscmRestApi/resources/11.13.18.05/businessRuleDefinitions
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- AltKey Finds all the rule definitions that match the alternate key criteria specified.
Finder Variables- RuleCode; string; Unique code for the rule definition.
- CallRuleFinder Finds all the published and latest draft rules that can be called from another rule. The calling rule isn't included in this finder results.
Finder Variables- CategoryId; integer; Category unique identifier. This is used to find all rules which belong to the passed category and its subcategories.
- ExcludeRuleCode; string; Rule code which has to be excluded from the results.
- Keyword; string; Keyword; string; to search in rule name, rule description and rule code.
- CodeFinder Finds all the rules that match with the specified rule code.
Finder Variables- CategoryId; integer; Category unique identifier. This is used to find all rules which belong to the passed category.
- Code; string; Rule definition unique code. This is used to find all rules where code matches the passed value.
- DataContractId; integer; Data contract unique identifier. This is used to find all rules which use the passed data contract.
- LogicLevel; string; Logic level code. This is used to find all the rules which are of the passed logic level.
- RuleType; string; Rule type code.
- Status; string; Rule status code.
- ConsumerRuleFinder Finds all the published and latest draft rule versions that can be called by rules consumers. The user can pass none, one or more categories.
Finder Variables- CategoryCodeOrId; string; Category unique code or identifier. This is used to find all rules which belong to the passed category.
- Keyword; string; Keyword; string; to search in rule name, rule description and rule code.
- TemplateCodes; string; Template rule codes. This is used to find all rules which belong to the passed comma separated list of template rule codes.
- KeywordFinder Finds all the rules that match with the specified keyword in rule name, rule code and rule description.
Finder Variables- Keyword; string; Keyword; string; to search in rule name, rule description and rule code.
- RuleType; string; Rule type code.
- Status; string; Rule status code.
- PrimaryKey Finds all the rule definitions that match the primary key criteria specified.
Finder Variables- RuleId; integer; Unique identifier for the rule definition.
- SubruleFinder Finds all the rules that are used as subrules.
Finder Variables - TemplateFinder Finds all the published templates that can be used by rules, belong to the passed category and logic level.
Finder Variables- CategoryId; integer; Category unique identifier. This is used to find all templates which belongs to the passed category.
- LogicLevel; string; Logic level code. This is used to find all the templates which are of the passed logic level.
- AltKey Finds all the rule definitions that match the alternate key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ArtifactGroupCode; string; The data group unique code, such as ACADSTRUCTUREPROFILE.
- ArtifactGroupId; integer; The unique identifier for the data group associated with this rule.
- ArtifactGroupName; string; The name of the data group.
- CalledBySeedOnlyFlag; boolean; Indicates whether the rule can only be called by other predefined rules. The default value is N.
- CategoryCode; string; The category unique code.
- CategoryId; integer; The category to which this rule belongs to.
- CategoryName; string; The name of the category.
- ContractTypeMeaning; string; The meaning of the contract type code, for example, a data contract, data fetch or rule variables. A list of accepted values is defined in the lookup type ORA_HEY_RULE_DATA_OPTION. The default value is Data contract.
- CurrentVersionNumber; integer; The current version of the rule.
- Description; string; The description of a rule definition.
- LastUpdateDate; string; The date and time when the rule was updated.
- LastUpdatedBy; string; The person who updated the rule.
- LogicLevelCode; string; The logic level of the rule definition, for example, simple logic or complex logic. A list of accepted values is defined in the lookup type ORA_HEY_LOGIC_LEVEL_CODE. The default value is ORA_HEY_SIMPLE_LOGIC.
- LogicLevelMeaning; string; The meaning of the logic level code. A list of accepted values is defined in the lookup type ORA_HEY_LOGIC_LEVEL_CODE. The default value is Simple logic.
- ProcessName; string; The concatenated list of transactions mapped to the rule data contract.
- RuleCode; string; The rule definition unique code, such as ADMEVAL1.
- RuleContractOptionCode; string; The type of the contract, for example, a data contract, data fetch or rule variables. A list of accepted values is defined in the lookup type ORA_HEY_RULE_DATA_OPTION. The default value is ORA_HEY_FROM_CONTRACT.
- RuleId; integer; The unique identifier of a rule definition.
- RuleName; string; The name of a rule definition.
- RuleStatusCode; string; The status of the current rule version, for example, published, unpublished or draft. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.
- RuleStatusMeaning; string; The meaning of the current rule version status code. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.
- RuleTypeCode; string; The type of the rule definition, for example, rule or template. A list of accepted values is defined in the lookup type ORA_HEY_RULE_TYPE_CODE. The default value is ORA_HEY _RULE.
- RuleTypeMeaning; string; The meaning of the rule type code. A list of accepted values is defined in the lookup type ORA_HEY_RULE_TYPE_CODE. The default value is Rule.
- SeedDataLock; integer; Indicates whether the record is predefined. The value 0 means the record isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated. The default value is 0.
- TemplateRuleCode; string; Template rule unique code.
- TemplateRuleId; integer; The unique usage reference identifier that identifies the template mapped to the rule.
- WorkingRuleVersionId; integer; The unique identifier of the rule version which is being worked upon and not yet published.
- WorkingVersionNumber; integer; The version of the rule which is being worked upon and not yet published.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : businessRuleDefinitions
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : businessRuleDefinitions-item-response
Type:
Show Source
object
-
ArtifactGroupCode: string
Title:
Data Group Code
Read Only:true
Maximum Length:50
The data group unique code, such as ACADSTRUCTUREPROFILE. -
ArtifactGroupId: integer
(int64)
Title:
Data Group ID
Read Only:true
The unique identifier for the data group associated with this rule. -
ArtifactGroupName: string
Title:
Data Group Name
Read Only:true
Maximum Length:50
The name of the data group. -
CalledBySeedOnlyFlag: boolean
Title:
Exclusive to Predefined Rules
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether the rule can only be called by other predefined rules. The default value is N. -
CategoryCode: string
Title:
Category Code
Read Only:true
Maximum Length:30
The category unique code. -
CategoryId: integer
(int64)
Title:
Category ID
The category to which this rule belongs to. -
CategoryName: string
Title:
Category Name
Maximum Length:50
The name of the category. -
ContractTypeMeaning: string
Title:
Contract Type
Read Only:true
Maximum Length:80
The meaning of the contract type code, for example, a data contract, data fetch or rule variables. A list of accepted values is defined in the lookup type ORA_HEY_RULE_DATA_OPTION. The default value is Data contract. -
CurrentVersionNumber: integer
(int32)
Title:
Current Version
The current version of the rule. -
Description: string
Title:
Description
Maximum Length:240
The description of a rule definition. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the rule was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The person who updated the rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LogicLevelCode: string
Title:
Logic Level Code
Maximum Length:30
Default Value:ORA_HEY_MODERATE_LOGIC
The logic level of the rule definition, for example, simple logic or complex logic. A list of accepted values is defined in the lookup type ORA_HEY_LOGIC_LEVEL_CODE. The default value is ORA_HEY_SIMPLE_LOGIC. -
LogicLevelMeaning: string
Title:
Logic Level
Read Only:true
Maximum Length:80
The meaning of the logic level code. A list of accepted values is defined in the lookup type ORA_HEY_LOGIC_LEVEL_CODE. The default value is Simple logic. -
ProcessName: string
Title:
Process Names
Read Only:true
The concatenated list of transactions mapped to the rule data contract. -
RuleCode: string
Title:
Code
Maximum Length:50
The rule definition unique code, such as ADMEVAL1. -
RuleContractOptionCode: string
Title:
Contract Type Code
Read Only:true
Maximum Length:30
Default Value:ORA_HEY_FROM_CONTRACT
The type of the contract, for example, a data contract, data fetch or rule variables. A list of accepted values is defined in the lookup type ORA_HEY_RULE_DATA_OPTION. The default value is ORA_HEY_FROM_CONTRACT. -
RuleId: integer
(int64)
Title:
Rule ID
Read Only:true
The unique identifier of a rule definition. -
RuleName: string
Title:
Rule Name
Maximum Length:50
The name of a rule definition. -
RuleStatusCode: string
Title:
Status Code
Read Only:true
Maximum Length:30
The status of the current rule version, for example, published, unpublished or draft. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS. -
RuleStatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
The meaning of the current rule version status code. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS. -
ruleTagAssignments: array
Rule Tag Assignments
Title:
Rule Tag Assignments
Rule tag assignments represent tags assigned to rules. For example, a tuition fee tag and an admissions application fee tag can be assigned to rules. -
ruleTestcases: array
Rule Test Cases
Title:
Rule Test Cases
The resource is used to view, create, modify or delete rule test cases. -
RuleTypeCode: string
Title:
Rule Type Code
Maximum Length:30
Default Value:ORA_HEY_RULE
The type of the rule definition, for example, rule or template. A list of accepted values is defined in the lookup type ORA_HEY_RULE_TYPE_CODE. The default value is ORA_HEY _RULE. -
RuleTypeMeaning: string
Title:
Rule Type
Read Only:true
Maximum Length:80
The meaning of the rule type code. A list of accepted values is defined in the lookup type ORA_HEY_RULE_TYPE_CODE. The default value is Rule. -
ruleVersions: array
Rule Versions
Title:
Rule Versions
The resource is used to view, create, modify, or delete rule versions. -
SeedDataLock: integer
(int32)
Title:
Predefined Data
Default Value:0
Indicates whether the record is predefined. The value 0 means the record isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated. The default value is 0. -
TemplateRuleCode: string
Title:
Base Template Code
Read Only:true
Maximum Length:50
Template rule unique code. -
TemplateRuleId: integer
(int64)
Title:
Base Template ID
Read Only:true
The unique usage reference identifier that identifies the template mapped to the rule. -
WorkingRuleVersionId: integer
(int64)
Title:
Working Rule Version ID
Read Only:true
The unique identifier of the rule version which is being worked upon and not yet published. -
WorkingVersionNumber: integer
(int32)
Title:
Working Rule Version Number
Read Only:true
Default Value:1
The version of the rule which is being worked upon and not yet published.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Rule Tag Assignments
Type:
array
Title:
Rule Tag Assignments
Rule tag assignments represent tags assigned to rules. For example, a tuition fee tag and an admissions application fee tag can be assigned to rules.
Show Source
Nested Schema : Rule Test Cases
Type:
array
Title:
Rule Test Cases
The resource is used to view, create, modify or delete rule test cases.
Show Source
Nested Schema : Rule Versions
Type:
array
Title:
Rule Versions
The resource is used to view, create, modify, or delete rule versions.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : businessRuleDefinitions-ruleTagAssignments-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TagAssignmentId: integer
(int64)
Title:
Tag Assignment ID
Read Only:true
The tag assignment identifier of the rule tag. -
TagCode: string
Title:
Tag Code
Maximum Length:30
The tag code of the rule tag. -
TagDescription: string
Title:
Tag Description
Read Only:true
Maximum Length:240
The tag description of the rule tag. -
TagId: integer
(int64)
Title:
Tag ID
The tag identifier of the rule tag. -
TagName: string
Title:
Tag Name
Read Only:true
Maximum Length:64
The tag name of the rule tag.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : businessRuleDefinitions-ruleTestcases-item-response
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:240
The rule test case description, for example, test data for discount fee test rule. -
InputPayloadJSON: string
(byte)
Title:
Received Payload JSON
The payload received by the rule evaluator. The payload is sent by this test case. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ruleTestcaseRuns: array
Rule Test Case Runs
Title:
Rule Test Case Runs
The resource is used to view, create, modify or delete rule version test case run details. -
RuleTestId: integer
(int64)
Title:
Rule Test Case ID
Read Only:true
The unique identifier of a rule test case. -
RuleTestName: string
Title:
Rule Test Name
Maximum Length:50
The rule test case name, for example, discount fee test rule. -
RuleTestSequenceNumber: integer
(int32)
Title:
Test Sequence Number
Default Value:1
The rule test case sequence number.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Rule Test Case Runs
Type:
array
Title:
Rule Test Case Runs
The resource is used to view, create, modify or delete rule version test case run details.
Show Source
Nested Schema : businessRuleDefinitions-ruleTestcases-ruleTestcaseRuns-item-response
Type:
Show Source
object
-
InputPayloadJSON: string
(byte)
Title:
Received Payload JSON
The payload received by the rule evaluator. The payload is sent by this test run. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessagesJSON: string
(byte)
Title:
Messages JSON
The feedback messages returned by the rule evaluator for this test run. -
OutputPayloadJSON: string
(byte)
Title:
Provided Payload JSON
The provided payload returned by the rule evaluator for this test run. -
RuleJSON: string
(byte)
Title:
Rule Definition
Read Only:true
The rule configuration content. This is in a JSON format. -
RuleTestRunId: integer
(int64)
Title:
Rule Test Case Run ID
Read Only:true
The unique identifier of a rule version test case run. -
RuleVersionId: integer
(int64)
Title:
Rule Version ID
The unique identifier of a rule version. -
RunTimestamp: string
(date-time)
Title:
Run Time Stamp
Read Only:true
The date and time that the test run completed. -
TraceLogJSON: string
(byte)
Title:
Trace Messages JSON
The debug messages returned by the rule evaluator for this test run.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : businessRuleDefinitions-ruleVersions-item-response
Type:
Show Source
object
-
ArtifactGroupCode: string
Title:
Data Group Code
Read Only:true
Maximum Length:50
The data group unique code, such as ACADSTRUCTUREPROFILE. -
ArtifactGroupId: integer
(int64)
Title:
Data Group ID
The unique identifier for a data group. -
ArtifactGroupName: string
Title:
Data Group Name
Maximum Length:50
The name of a data group. -
BaseTypeMeaning: string
Title:
Rule Basis
Read Only:true
Maximum Length:80
The meaning of the base option code, for example, a blank rule or a template. A list of accepted values is defined in the lookup type ORA_HEY_RULE_BASIS_CODE. The default value is blank rule. -
Comments: string
Title:
Comments
Maximum Length:900
The comments entered when creating a new rule version. -
ContractTypeMeaning: string
Title:
Contract Type
Read Only:true
Maximum Length:80
The meaning of the contract type code, for example, a data contract, data fetch or rule variables. A list of accepted values is defined in the lookup type ORA_HEY_RULE_DATA_OPTION. The default value is Data contract. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the rule version was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the rule version was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The person who updated the rule version. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RuleBaseOptionCode: string
Title:
Rule Basis Code
Maximum Length:30
Default Value:ORA_HEY_BLANK_RULE
The base option code indicates if the rule is created from a template or from a blank rule. A list of accepted values is defined in the lookup type ORA_HEY_RULE_BASIS_CODE. The default value is ORA_HEY_BLANK_RULE. -
RuleBuildTimestamp: string
(date-time)
Title:
Build Date and Time
The timestamp when the rule was last compiled. -
RuleContractOptionCode: string
Title:
Contract Type Code
Maximum Length:30
Default Value:ORA_HEY_FROM_CONTRACT
The contract type code, for example, a data contract, data fetch or rule variables. A list of accepted values is defined in the lookup type ORA_HEY_RULE_DATA_OPTION. The default value is ORA_HEY_FROM_CONTRACT. -
ruleExpressions: array
Rule Expressions
Title:
Rule Expressions
The resource is used to view rule expressions. -
RuleJSON: string
(byte)
Title:
Rule Definition
The rule configuration content. This is in a JSON format. -
RuleStatusCode: string
Title:
Status Code
Maximum Length:30
The status of the current rule version, for example, published, unpublished or draft. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS. -
ruleVariables: array
Rule Variables
Title:
Rule Variables
The resource is used to view, create, modify, or delete rule variables. -
RuleVersionId: integer
(int64)
Title:
Rule Version ID
The unique identifier of the rule version. -
StatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
The meaning of the current rule version status code. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS. -
TemplateRuleCode: string
Title:
Base Template Code
Read Only:true
Maximum Length:50
The template definition unique code, such as ADMEVAL1. -
TemplateRuleId: integer
(int64)
Title:
Base Template ID
The unique identifier of the template definition. -
TemplateRuleName: string
Title:
Base Template Name
Maximum Length:50
The name of the template definition. -
VersionDescription: string
Title:
Version Description
Maximum Length:240
The description of the rule definition version. -
VersionName: string
Title:
Version Name
Maximum Length:50
The name of the rule definition version. -
VersionNumber: integer
(int32)
Title:
Version Number
Default Value:1
The version number of the rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Rule Expressions
Type:
array
Title:
Rule Expressions
The resource is used to view rule expressions.
Show Source
Nested Schema : Rule Variables
Type:
array
Title:
Rule Variables
The resource is used to view, create, modify, or delete rule variables.
Show Source
Nested Schema : businessRuleDefinitions-ruleVersions-ruleExpressions-item-response
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:240
The description of the group of rule statements. -
ExpressionCode: string
Title:
Expression Code
Maximum Length:50
The unique code of the expression. -
ExpressionInputCode: string
Title:
Received Expression Code
Maximum Length:200
The code for the received expression value. For example, an element code or attribute code. -
ExpressionInputId: integer
(int64)
Title:
Received Expression ID
The unique identifier of the received expression value. -
ExpressionInputName: string
Title:
Received Expression Name
Read Only:true
Maximum Length:101
The name of the received expression value. -
ExpressionInputSourceCode: string
Title:
Received Expression Source Code
Maximum Length:30
The type of the received expression value. For example, VAR, ELEM or ATTR. This is used internally to identify the source of the received expression code. -
ExpressionName: string
Title:
Expression Name
Read Only:true
Maximum Length:50
The name of the expression. Expression can be, for example, a value for variable, element, or attribute. -
ExpressionOrder: integer
(int32)
Title:
Expression Sequence
The order of the expressions within hierarchy. -
ExpressionOutputCode: string
Title:
Provided Expression Code
Maximum Length:200
The code for the provided expression value. For example, an element code or attribute code. -
ExpressionOutputId: integer
(int64)
Title:
Provided Expression ID
The unique identifier of the provided expression value. -
ExpressionOutputName: string
Title:
Provided Expression Name
Read Only:true
Maximum Length:101
The name of the provided expression value. -
ExpressionOutputSourceCode: string
Title:
Provided Expression Source Code
Maximum Length:30
The type of the provided expression value. For example, VAR, ELEM or ATTR. This is used internally to identify the source of the expression output code. -
HiddenFlag: boolean
Title:
Hidden
Maximum Length:1
Default Value:false
Indicates whether the rule detail line is hidden on UI or not. The default value is N. -
InternalDefinedCode: string
Title:
Internal Variable Code
Maximum Length:60
The internally generated code for the variable. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockedFlag: boolean
Title:
Locked
Maximum Length:1
Default Value:false
Indicates whether the rule detail line is locked for editing or not. The default value is N. -
ParameterBooleanFlag: boolean
Title:
Boolean Parameter Value
Maximum Length:1
The value of a boolean parameter, for example, true or false. -
ParameterDate: string
(date)
Title:
Date Parameter Value
The value of a date parameter, for example, the value can be a date when an admissions application was submitted. -
ParameterDatetime: string
(date-time)
Title:
Date and Time Parameter Value
The value of a date and time parameter, for example, the date and time at which a course started. -
ParameterNumber: number
Title:
Numeric Parameter Value
The value of a number parameter, for example, the value can be a course fee. -
ParameterString: string
Title:
String Parameter Value
Maximum Length:900
The value of a text parameter, for example, the value can be a student name. -
ParameterTypeCode: string
Title:
Rule Parameter Type Code
Maximum Length:30
The data type of the parameter value, for example, String, Date, Boolean or Number. This is used internally to populate the corresponding parameter field. -
ParentSequenceIdentifier: integer
(int32)
Title:
Parent Sequence ID
The internal identifier of the parent detail row. -
RuleDetailId: integer
(int64)
Title:
Rule Detail ID
The unique identifier of a rule version detail. -
SequenceIdentifier: integer
(int32)
Title:
Row Sequence ID
The numeric identifier generated for each detail row of the rule used to link rows. -
StatementGroupName: string
Title:
Name
Maximum Length:50
The name of the group of rule statements. -
TemplateSequenceIdentifier: integer
(int32)
Title:
Template Sequence ID
The numeric identifier of the row in the template from which the rule was created.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : businessRuleDefinitions-ruleVersions-ruleVariables-item-response
Type:
Show Source
object
-
ArtifactCode: string
Title:
Code
Read Only:true
Maximum Length:50
The unique code of the list of values data artifact resource. -
ArtifactName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the list of values data artifact resource. -
AttributeCode: string
Title:
Attribute Code
Maximum Length:200
The rule variable attribute unique code, such as STUDENT_GRADE. -
AttributeCodeAlias: string
Title:
Attribute Alias
Maximum Length:500
The alias name of the rule variable attribute. -
AttributeDataTypeCode: string
Title:
Data Type Code
Maximum Length:30
The rule variable attribute data type code, for example, a string, number or date. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_TYPE. -
AttributeName: string
Title:
Attribute Name
Maximum Length:50
The name of a rule variable attribute. -
AttributeSequence: integer
(int32)
Title:
Attribute Sequence Number
Default Value:1
The sequence of the attribute in the variable. -
DataTypeMeaning: string
Title:
Data Type
Read Only:true
Maximum Length:80
The meaning of the rule variable attribute data type code, for example, a string, number or date. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_TYPE. -
DefaultValue: string
Title:
Default Value
Maximum Length:512
The default value of a rule variable attribute. -
DefaultValueJSON: string
(byte)
Title:
Default Value JSON Format
Default value of the attribute in JSON format. Used by list or multicolumn list variables. -
Description: string
Title:
Description
Maximum Length:240
The description of a rule variable. -
InOutMeaning: string
Title:
Variable Value Usage
Read Only:true
Maximum Length:80
The meaning of the variable value usage code, for example, the code meaning indicates whether the value is received, provided or both received and provided. A list of accepted values is defined in the lookup type ORA_HEY_VARIABLE_USAGE. -
InputOutputTypeCode: string
Title:
Variable Value Usage Code
Maximum Length:30
The code to indicate how the value of rule variable is used, for example, the code indicates whether the value is received, provided or both received and provided. A list of accepted values is defined in the lookup type ORA_HEY_VARIABLE_USAGE. -
InternalVariableCode: string
Title:
Internal Variable Code
Maximum Length:200
The internally generated code for the variable, such as UNIT_GRADE. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupTypeCode: string
Title:
List of Values Lookup Type
Maximum Length:30
The list of values lookup type of a rule variable attribute. -
LovArtifactId: integer
(int64)
Title:
List of Values ID
The list of values data artifact resource ID of a rule variable attribute. -
LovDisplayFields: string
Title:
List of Values Display Fields
Maximum Length:900
The comma separated display field names of the list of values resource associated with this attribute. These field names can be displayed on the UI. -
LovFinder: string
Title:
List of Values Finder Name
Maximum Length:900
The list of values finder of a rule variable attribute. -
LovSourceResourceName: string
Title:
List of Values Source Resource Name
Maximum Length:200
The source resource name for the list of values resource of a rule variable attribute. -
LovValueField: string
Title:
List of Values Field
Maximum Length:900
The field name of the list of values resource associated with this attribute. -
RequiredFlag: boolean
Title:
Required
Maximum Length:1
Indicates whether a rule variable attribute is required or not. -
SourceArtifactCode: string
Title:
Source Artifact Code
Read Only:true
Maximum Length:50
The unique code of the source artifact resource. -
SourceArtifactId: integer
(int64)
Title:
Source Artifact Identifier
Read Only:true
The artifact resource identifier of the corresponding variable in the data contract. -
SourceArtifactName: string
Title:
Source Artifact Name
Read Only:true
Maximum Length:50
The name of the source artifact resource. -
VariableCode: string
Title:
Variable Code
Maximum Length:50
The rule variable unique code, such as UNIT_GRADE. -
VariableId: integer
(int64)
Title:
Variable ID
Read Only:true
The unique identifier of a rule variable. -
VariableLockedFlag: boolean
Title:
Locked
Maximum Length:1
Default Value:false
Indicates whether the rule variable is locked for editing or not. The default value is N. -
VariableName: string
Title:
Name
Maximum Length:50
The name of a rule variable. -
VariableTypeCode: string
Title:
Variable Type Code
Maximum Length:30
Default Value:ORA_HEY_SINGLE_VARIABLE
The rule variable type code, for example, a simple variable, list variable or multicolumn list variable. A list of accepted values is defined in the lookup type ORA_HEY_VARIABLE_TYPE_CODE. The default value is ORA_HEY_SINGLE_VARIABLE. -
VariableTypeMeaning: string
Title:
Variable Type
Read Only:true
Maximum Length:80
The meaning of the rule variable type code, for example, a simple variable, list variable or multicolumn list variable. A list of accepted values is defined in the lookup type ORA_HEY_VARIABLE_TYPE_CODE. The default value is Single variable.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- evaluateRuleJSON
-
Accepts rule JSON data and rule data and returns a JSON string which contains the evaluated rule contract.