Get a rule version
get
/fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleVersions/{RuleVersionId}
Request
Path Parameters
-
RuleVersionId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
businessRuleDefinitionsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Business Rule Definitions resource and used to uniquely identify an instance of Business Rule Definitions. The client should not generate the hash key value. Instead, the client should query on the Business Rule Definitions collection resource in order to navigate to a specific instance of Business Rule Definitions to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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-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 : 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-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
- ArtifactGroupNameLOV
-
Parameters:
- finder:
TypeKeywordFinder%3BArtifactGroupType%3DORA_HEY_CONTRACT_TYPE%2CActive%3Dtrue
The following properties are defined on the LOV link relation:- Source Attribute: ArtifactGroupName; Target Attribute: ArtifactGroupName
- Display Attribute: ArtifactGroupName
- finder:
- RuleBaseOptionCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{RuleBaseOptionCode}%2CLookupType%3DORA_HEY_RULE_BASIS_CODE
The following properties are defined on the LOV link relation:- Source Attribute: RuleBaseOptionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RuleContractOptionCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{RuleContractOptionCode}%2CLookupType%3DORA_HEY_RULE_DATA_OPTION
The following properties are defined on the LOV link relation:- Source Attribute: RuleContractOptionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RuleStatusCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_RULE_STATUS_CODE%2CLookupCode%3D{RuleStatusCode}%2CLookupCode%3D{RuleStatusCode}
The following properties are defined on the LOV link relation:- Source Attribute: RuleStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TemplateRuleNameLOV
-
Parameters:
- finder:
TemplateFinder%3BCategoryId%3D{CategoryId}%2CLogicLevel%3D{LogicLevelCode}
The following properties are defined on the LOV link relation:- Source Attribute: TemplateRuleName; Target Attribute: RuleName
- Display Attribute: RuleName
- finder:
- ruleExpressions
-
Parameters:
- RuleVersionId:
$request.path.RuleVersionId
- businessRuleDefinitionsUniqID:
$request.path.businessRuleDefinitionsUniqID
The resource is used to view rule expressions. - RuleVersionId:
- ruleVariables
-
Parameters:
- RuleVersionId:
$request.path.RuleVersionId
- businessRuleDefinitionsUniqID:
$request.path.businessRuleDefinitionsUniqID
The resource is used to view, create, modify, or delete rule variables. - RuleVersionId: