Get all rule variables
get
/fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleVersions/{RuleVersionId}/child/ruleVariables
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 -
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- PrimaryKey Finds all the rule variables that match the primary key criteria specified.
Finder Variables- VariableId; integer; Unique identifier for the rule variable.
- PrimaryKey Finds all the rule variables that match the primary 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:- ArtifactCode; string; The unique code of the list of values data artifact resource.
- ArtifactName; string; The name of the list of values data artifact resource.
- AttributeCode; string; The rule variable attribute unique code, such as STUDENT_GRADE.
- AttributeCodeAlias; string; The alias name of the rule variable attribute.
- AttributeDataTypeCode; string; 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; The name of a rule variable attribute.
- AttributeSequence; integer; The sequence of the attribute in the variable.
- DataTypeMeaning; string; 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; The default value of a rule variable attribute.
- Description; string; The description of a rule variable.
- InOutMeaning; string; 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; 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; The internally generated code for the variable, such as UNIT_GRADE.
- LookupTypeCode; string; The list of values lookup type of a rule variable attribute.
- LovArtifactId; integer; The list of values data artifact resource ID of a rule variable attribute.
- LovDisplayFields; string; 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; The list of values finder of a rule variable attribute.
- LovSourceResourceName; string; The source resource name for the list of values resource of a rule variable attribute.
- LovValueField; string; The field name of the list of values resource associated with this attribute.
- RequiredFlag; boolean; Indicates whether a rule variable attribute is required or not.
- SourceArtifactCode; string; The unique code of the source artifact resource.
- SourceArtifactId; integer; The artifact resource identifier of the corresponding variable in the data contract.
- SourceArtifactName; string; The name of the source artifact resource.
- VariableCode; string; The rule variable unique code, such as UNIT_GRADE.
- VariableId; integer; The unique identifier of a rule variable.
- VariableLockedFlag; boolean; Indicates whether the rule variable is locked for editing or not. The default value is N.
- VariableName; string; The name of a rule variable.
- VariableTypeCode; string; 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; 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.
-
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-ruleVersions-ruleVariables
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-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
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.