Jump to

• Request
• Response

Get a business rule definition

get

/fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}

Request

Path Parameters

• 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 Top

Response

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.

Body ()

Root Schema : businessRuleDefinitions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category Code",
            "maxLength":30,
            "type":"string",
            "description":"The category unique code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryId":{
            "title":"Category ID",
            "type":"integer",
            "description":"The category to which this rule belongs to.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "CategoryName"
                ]
            },
            "x-queryable":true
        },
        "ProcessName":{
            "title":"Process Names",
            "type":"string",
            "description":"The concatenated list of transactions mapped to the rule data contract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a rule definition.",
            "nullable":true,
            "x-queryable":true
        },
        "ArtifactGroupCode":{
            "title":"Data Group Code",
            "maxLength":50,
            "type":"string",
            "description":"The data group unique code, such as ACADSTRUCTUREPROFILE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleId":{
            "title":"Rule ID",
            "type":"integer",
            "description":"The unique identifier of a rule definition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RuleTypeMeaning":{
            "title":"Rule Type",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkingVersionNumber":{
            "title":"Working Rule Version Number",
            "type":"integer",
            "description":"The version of the rule which is being worked upon and not yet published.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RuleStatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractTypeMeaning":{
            "title":"Contract Type",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ruleVersions":{
            "title":"Rule Versions",
            "type":"array",
            "description":"The resource is used to view, create, modify, or delete rule versions.",
            "items":{
                "$ref":"#/components/schemas/businessRuleDefinitions-ruleVersions-item-response"
            }
        },
        "ArtifactGroupName":{
            "title":"Data Group Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the data group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ruleTestcases":{
            "title":"Rule Test Cases",
            "type":"array",
            "description":"The resource is used to view, create, modify or delete rule test cases.",
            "items":{
                "$ref":"#/components/schemas/businessRuleDefinitions-ruleTestcases-item-response"
            }
        },
        "RuleName":{
            "title":"Rule Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a rule definition.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrentVersionNumber":{
            "title":"Current Version",
            "type":"integer",
            "description":"The current version of the rule.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The person who updated the rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleContractOptionCode":{
            "title":"Contract Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_HEY_FROM_CONTRACT",
            "x-queryable":true
        },
        "TemplateRuleCode":{
            "title":"Base Template Code",
            "maxLength":50,
            "type":"string",
            "description":"Template rule unique code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "title":"Predefined Data",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "RuleTypeCode":{
            "title":"Rule Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"ORA_HEY_RULE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ruleTagAssignments":{
            "title":"Rule Tag Assignments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/businessRuleDefinitions-ruleTagAssignments-item-response"
            }
        },
        "RuleStatusMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the current rule version status code. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplateRuleId":{
            "title":"Base Template ID",
            "type":"integer",
            "description":"The unique usage reference identifier that identifies the template mapped to the rule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LogicLevelCode":{
            "title":"Logic Level Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"ORA_HEY_MODERATE_LOGIC",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ArtifactGroupId":{
            "title":"Data Group ID",
            "type":"integer",
            "description":"The unique identifier for the data group associated with this rule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CalledBySeedOnlyFlag":{
            "title":"Exclusive to Predefined Rules",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rule can only be called by other predefined rules. The default value is N.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "WorkingRuleVersionId":{
            "title":"Working Rule Version ID",
            "type":"integer",
            "description":"The unique identifier of the rule version which is being worked upon and not yet published.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the category.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LogicLevelMeaning":{
            "title":"Logic Level",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleCode":{
            "title":"Code",
            "maxLength":50,
            "type":"string",
            "description":"The rule definition unique code, such as ADMEVAL1.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the rule was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object businessRuleDefinitions-ruleTagAssignments-item-response

{
    "title":"Rule Tag Assignments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/businessRuleDefinitions-ruleTagAssignments-item-response"
    }
}

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

• Array of: object businessRuleDefinitions-ruleTestcases-item-response

{
    "title":"Rule Test Cases",
    "type":"array",
    "description":"The resource is used to view, create, modify or delete rule test cases.",
    "items":{
        "$ref":"#/components/schemas/businessRuleDefinitions-ruleTestcases-item-response"
    }
}

Nested Schema : Rule Versions

Type: array

Title: Rule Versions

The resource is used to view, create, modify, or delete rule versions.

Show Source

• Array of: object businessRuleDefinitions-ruleVersions-item-response

{
    "title":"Rule Versions",
    "type":"array",
    "description":"The resource is used to view, create, modify, or delete rule versions.",
    "items":{
        "$ref":"#/components/schemas/businessRuleDefinitions-ruleVersions-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : businessRuleDefinitions-ruleTagAssignments-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"The tag identifier of the rule tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TagAssignmentId":{
            "title":"Tag Assignment ID",
            "type":"integer",
            "description":"The tag assignment identifier of the rule tag.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"The tag code of the rule tag.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":64,
            "type":"string",
            "description":"The tag name of the rule tag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TagDescription":{
            "title":"Tag Description",
            "maxLength":240,
            "type":"string",
            "description":"The tag description of the rule tag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : businessRuleDefinitions-ruleTestcases-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The rule test case description, for example, test data for discount fee test rule.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleTestId":{
            "title":"Rule Test Case ID",
            "type":"integer",
            "description":"The unique identifier of a rule test case.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InputPayloadJSON":{
            "title":"Received Payload JSON",
            "type":"string",
            "description":"The payload received by the rule evaluator. The payload is sent by this test case.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleTestName":{
            "title":"Rule Test Name",
            "maxLength":50,
            "type":"string",
            "description":"The rule test case name, for example, discount fee test rule.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleTestSequenceNumber":{
            "title":"Test Sequence Number",
            "type":"integer",
            "description":"The rule test case sequence number.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ruleTestcaseRuns":{
            "title":"Rule Test Case Runs",
            "type":"array",
            "description":"The resource is used to view, create, modify or delete rule version test case run details.",
            "items":{
                "$ref":"#/components/schemas/businessRuleDefinitions-ruleTestcases-ruleTestcaseRuns-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object businessRuleDefinitions-ruleTestcases-ruleTestcaseRuns-item-response

{
    "title":"Rule Test Case Runs",
    "type":"array",
    "description":"The resource is used to view, create, modify or delete rule version test case run details.",
    "items":{
        "$ref":"#/components/schemas/businessRuleDefinitions-ruleTestcases-ruleTestcaseRuns-item-response"
    }
}

Nested Schema : businessRuleDefinitions-ruleTestcases-ruleTestcaseRuns-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TraceLogJSON":{
            "title":"Trace Messages JSON",
            "type":"string",
            "description":"The debug messages returned by the rule evaluator for this test run.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "RuleJSON":{
            "title":"Rule Definition",
            "type":"string",
            "description":"The rule configuration content. This is in a JSON format.",
            "format":"byte",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RuleVersionId":{
            "title":"Rule Version ID",
            "type":"integer",
            "description":"The unique identifier of a rule version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "InputPayloadJSON":{
            "title":"Received Payload JSON",
            "type":"string",
            "description":"The payload received by the rule evaluator. The payload is sent by this test run.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "RuleTestRunId":{
            "title":"Rule Test Case Run ID",
            "type":"integer",
            "description":"The unique identifier of a rule version test case run.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OutputPayloadJSON":{
            "title":"Provided Payload JSON",
            "type":"string",
            "description":"The provided payload returned by the rule evaluator for this test run.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RunTimestamp":{
            "title":"Run Time Stamp",
            "type":"string",
            "description":"The date and time that the test run completed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessagesJSON":{
            "title":"Messages JSON",
            "type":"string",
            "description":"The feedback messages returned by the rule evaluator for this test run.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : businessRuleDefinitions-ruleVersions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the rule version was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ArtifactGroupCode":{
            "title":"Data Group Code",
            "maxLength":50,
            "type":"string",
            "description":"The data group unique code, such as ACADSTRUCTUREPROFILE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplateRuleName":{
            "title":"Base Template Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the template definition.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BaseTypeMeaning":{
            "title":"Rule Basis",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleBuildTimestamp":{
            "title":"Build Date and Time",
            "type":"string",
            "description":"The timestamp when the rule was last compiled.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RuleStatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContractTypeMeaning":{
            "title":"Contract Type",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleJSON":{
            "title":"Rule Definition",
            "type":"string",
            "description":"The rule configuration content. This is in a JSON format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "RuleBaseOptionCode":{
            "title":"Rule Basis Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"ORA_HEY_BLANK_RULE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ArtifactGroupName":{
            "title":"Data Group Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a data group.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "VersionName":{
            "title":"Version Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the rule definition version.",
            "nullable":false,
            "x-queryable":true
        },
        "ruleVariables":{
            "title":"Rule Variables",
            "type":"array",
            "description":"The resource is used to view, create, modify, or delete rule variables.",
            "items":{
                "$ref":"#/components/schemas/businessRuleDefinitions-ruleVersions-ruleVariables-item-response"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The person who updated the rule version.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleContractOptionCode":{
            "title":"Contract Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"ORA_HEY_FROM_CONTRACT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VersionDescription":{
            "title":"Version Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the rule definition version.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleVersionId":{
            "title":"Rule Version ID",
            "type":"integer",
            "description":"The unique identifier of the rule version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":900,
            "type":"string",
            "description":"The comments entered when creating a new rule version.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateRuleCode":{
            "title":"Base Template Code",
            "maxLength":50,
            "type":"string",
            "description":"The template definition unique code, such as ADMEVAL1.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionNumber":{
            "title":"Version Number",
            "type":"integer",
            "description":"The version number of the rule.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TemplateRuleId":{
            "title":"Base Template ID",
            "type":"integer",
            "description":"The unique identifier of the template definition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "TemplateRuleName"
                ]
            },
            "x-queryable":true
        },
        "ruleExpressions":{
            "title":"Rule Expressions",
            "type":"array",
            "description":"The resource is used to view rule expressions.",
            "items":{
                "$ref":"#/components/schemas/businessRuleDefinitions-ruleVersions-ruleExpressions-item-response"
            }
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the current rule version status code. A list of accepted values is defined in the lookup type ORA_HEY_VERSION_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ArtifactGroupId":{
            "title":"Data Group ID",
            "type":"integer",
            "description":"The unique identifier for a data group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ArtifactGroupName"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the rule version was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Rule Expressions

Type: array

Title: Rule Expressions

The resource is used to view rule expressions.

Show Source

• Array of: object businessRuleDefinitions-ruleVersions-ruleExpressions-item-response

{
    "title":"Rule Expressions",
    "type":"array",
    "description":"The resource is used to view rule expressions.",
    "items":{
        "$ref":"#/components/schemas/businessRuleDefinitions-ruleVersions-ruleExpressions-item-response"
    }
}

Nested Schema : Rule Variables

Type: array

Title: Rule Variables

The resource is used to view, create, modify, or delete rule variables.

Show Source

• Array of: object businessRuleDefinitions-ruleVersions-ruleVariables-item-response

{
    "title":"Rule Variables",
    "type":"array",
    "description":"The resource is used to view, create, modify, or delete rule variables.",
    "items":{
        "$ref":"#/components/schemas/businessRuleDefinitions-ruleVersions-ruleVariables-item-response"
    }
}

Nested Schema : businessRuleDefinitions-ruleVersions-ruleExpressions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the group of rule statements.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpressionOrder":{
            "title":"Expression Sequence",
            "type":"integer",
            "description":"The order of the expressions within hierarchy.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "ParentSequenceIdentifier":{
            "title":"Parent Sequence ID",
            "type":"integer",
            "description":"The internal identifier of the parent detail row.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ParameterNumber":{
            "title":"Numeric Parameter Value",
            "type":"number",
            "description":"The value of a number parameter, for example, the value can be a course fee.",
            "nullable":true,
            "x-queryable":true
        },
        "ParameterString":{
            "title":"String Parameter Value",
            "maxLength":900,
            "type":"string",
            "description":"The value of a text parameter, for example, the value can be a student name.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpressionName":{
            "title":"Expression Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the expression. Expression can be, for example, a value for variable, element, or attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleDetailId":{
            "title":"Rule Detail ID",
            "type":"integer",
            "description":"The unique identifier of a rule version detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ParameterBooleanFlag":{
            "title":"Boolean Parameter Value",
            "maxLength":1,
            "type":"boolean",
            "description":"The value of a boolean parameter, for example, true or false.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpressionOutputName":{
            "title":"Provided Expression Name",
            "maxLength":101,
            "type":"string",
            "description":"The name of the provided expression value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExpressionInputId":{
            "title":"Received Expression ID",
            "type":"integer",
            "description":"The unique identifier of the received expression value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InternalDefinedCode":{
            "title":"Internal Variable Code",
            "maxLength":60,
            "type":"string",
            "description":"The internally generated code for the variable.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpressionInputCode":{
            "title":"Received Expression Code",
            "maxLength":200,
            "type":"string",
            "description":"The code for the received expression value. For example, an element code or attribute code.",
            "nullable":true,
            "x-queryable":true
        },
        "ParameterTypeCode":{
            "title":"Rule Parameter Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The data type of the parameter value, for example, String, Date, Boolean or Number. This is used internally to populate the corresponding parameter field.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpressionCode":{
            "title":"Expression Code",
            "maxLength":50,
            "type":"string",
            "description":"The unique code of the expression.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExpressionOutputSourceCode":{
            "title":"Provided Expression Source Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpressionOutputId":{
            "title":"Provided Expression ID",
            "type":"integer",
            "description":"The unique identifier of the provided expression value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParameterDate":{
            "title":"Date Parameter Value",
            "type":"string",
            "description":"The value of a date parameter, for example, the value can be a date when an admissions application was submitted.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "HiddenFlag":{
            "title":"Hidden",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rule detail line is hidden on UI or not. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "LockedFlag":{
            "title":"Locked",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rule detail line is locked for editing or not. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ParameterDatetime":{
            "title":"Date and Time Parameter Value",
            "type":"string",
            "description":"The value of a date and time parameter, for example, the date and time at which a course started.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StatementGroupName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the group of rule statements.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpressionInputSourceCode":{
            "title":"Received Expression Source Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpressionInputName":{
            "title":"Received Expression Name",
            "maxLength":101,
            "type":"string",
            "description":"The name of the received expression value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SequenceIdentifier":{
            "title":"Row Sequence ID",
            "type":"integer",
            "description":"The numeric identifier generated for each detail row of the rule used to link rows.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TemplateSequenceIdentifier":{
            "title":"Template Sequence ID",
            "type":"integer",
            "description":"The numeric identifier of the row in the template from which the rule was created.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ExpressionOutputCode":{
            "title":"Provided Expression Code",
            "maxLength":200,
            "type":"string",
            "description":"The code for the provided expression value. For example, an element code or attribute code.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : businessRuleDefinitions-ruleVersions-ruleVariables-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LovSourceResourceName":{
            "title":"List of Values Source Resource Name",
            "maxLength":200,
            "type":"string",
            "description":"The source resource name for the list of values resource of a rule variable attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a rule variable.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceArtifactCode":{
            "title":"Source Artifact Code",
            "maxLength":50,
            "type":"string",
            "description":"The unique code of the source artifact resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VariableName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a rule variable.",
            "nullable":false,
            "x-queryable":true
        },
        "LookupTypeCode":{
            "title":"List of Values Lookup Type",
            "maxLength":30,
            "type":"string",
            "description":"The list of values lookup type of a rule variable attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LovDisplayFields":{
            "title":"List of Values Display Fields",
            "maxLength":900,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDataTypeCode":{
            "title":"Data Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ArtifactCode":{
            "title":"Code",
            "maxLength":50,
            "type":"string",
            "description":"The unique code of the list of values data artifact resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeCodeAlias":{
            "title":"Attribute Alias",
            "maxLength":500,
            "type":"string",
            "description":"The alias name of the rule variable attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "InputOutputTypeCode":{
            "title":"Variable Value Usage Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DefaultValue":{
            "title":"Default Value",
            "maxLength":512,
            "type":"string",
            "description":"The default value of a rule variable attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LovValueField":{
            "title":"List of Values Field",
            "maxLength":900,
            "type":"string",
            "description":"The field name of the list of values resource associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceArtifactId":{
            "title":"Source Artifact Identifier",
            "type":"integer",
            "description":"The artifact resource identifier of the corresponding variable in the data contract.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InternalVariableCode":{
            "title":"Internal Variable Code",
            "maxLength":200,
            "type":"string",
            "description":"The internally generated code for the variable, such as UNIT_GRADE.",
            "nullable":false,
            "x-queryable":true
        },
        "DataTypeMeaning":{
            "title":"Data Type",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceArtifactName":{
            "title":"Source Artifact Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the source artifact resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "title":"Attribute Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a rule variable attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeSequence":{
            "title":"Attribute Sequence Number",
            "type":"integer",
            "description":"The sequence of the attribute in the variable.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LovArtifactId":{
            "title":"List of Values ID",
            "type":"integer",
            "description":"The list of values data artifact resource ID of a rule variable attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ArtifactName"
                ]
            },
            "x-queryable":true
        },
        "VariableCode":{
            "title":"Variable Code",
            "maxLength":50,
            "type":"string",
            "description":"The rule variable unique code, such as UNIT_GRADE.",
            "nullable":false,
            "x-queryable":true
        },
        "VariableLockedFlag":{
            "title":"Locked",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rule variable is locked for editing or not. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "VariableTypeMeaning":{
            "title":"Variable Type",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValueJSON":{
            "title":"Default Value JSON Format",
            "type":"string",
            "description":"Default value of the attribute in JSON format. Used by list or multicolumn list variables.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ArtifactName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the list of values data artifact resource.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AttributeCode":{
            "title":"Attribute Code",
            "maxLength":200,
            "type":"string",
            "description":"The rule variable attribute unique code, such as STUDENT_GRADE.",
            "nullable":false,
            "x-queryable":true
        },
        "LovFinder":{
            "title":"List of Values Finder Name",
            "maxLength":900,
            "type":"string",
            "description":"The list of values finder of a rule variable attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a rule variable attribute is required or not.",
            "nullable":true,
            "x-queryable":true
        },
        "VariableId":{
            "title":"Variable ID",
            "type":"integer",
            "description":"The unique identifier of a rule variable.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "VariableTypeCode":{
            "title":"Variable Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"ORA_HEY_SINGLE_VARIABLE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InOutMeaning":{
            "title":"Variable Value Usage",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

CategoryNameLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentManagementCategories

The following properties are defined on the LOV link relation:

• Source Attribute: CategoryName; Target Attribute: CategoryName
• Display Attribute: CategoryName

LogicLevelCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{LogicLevelCode}%2CLookupType%3DORA_HEY_LOGIC_LEVEL_CODE

The following properties are defined on the LOV link relation:

• Source Attribute: LogicLevelCode; Target Attribute: LookupCode
• Display Attribute: Meaning

RuleTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{RuleTypeCode}%2CLookupType%3DORA_HEY_RULE_TYPE_CODE

The following properties are defined on the LOV link relation:

• Source Attribute: RuleTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

ruleTagAssignments

Operation: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTagAssignments

Parameters:

• businessRuleDefinitionsUniqID: $request.path.businessRuleDefinitionsUniqID

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

Operation: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleTestcases

Parameters:

• businessRuleDefinitionsUniqID: $request.path.businessRuleDefinitionsUniqID

The resource is used to view, create, modify or delete rule test cases.

ruleVersions

Operation: /fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleVersions

Parameters:

• businessRuleDefinitionsUniqID: $request.path.businessRuleDefinitionsUniqID

The resource is used to view, create, modify, or delete rule versions.

Back to Top