Jump to

• Request
• Response

Get all rule expressions

get

/fscmRestApi/resources/11.13.18.05/businessRuleDefinitions/{businessRuleDefinitionsUniqID}/child/ruleVersions/{RuleVersionId}/child/ruleExpressions

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 expressions that match the primary key criteria specified.
    Finder Variables
    • RuleDetailId; integer; Unique identifier for the rule expression.
• 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:
  

  • Description; string; The description of the group of rule statements.
  • ExpressionCode; string; The unique code of the expression.
  • ExpressionInputCode; string; The code for the received expression value. For example, an element code or attribute code.
  • ExpressionInputId; integer; The unique identifier of the received expression value.
  • ExpressionInputName; string; The name of the received expression value.
  • ExpressionInputSourceCode; string; 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; The name of the expression. Expression can be, for example, a value for variable, element, or attribute.
  • ExpressionOrder; integer; The order of the expressions within hierarchy.
  • ExpressionOutputCode; string; The code for the provided expression value. For example, an element code or attribute code.
  • ExpressionOutputId; integer; The unique identifier of the provided expression value.
  • ExpressionOutputName; string; The name of the provided expression value.
  • ExpressionOutputSourceCode; string; 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; Indicates whether the rule detail line is hidden on UI or not. The default value is N.
  • InternalDefinedCode; string; The internally generated code for the variable.
  • LockedFlag; boolean; Indicates whether the rule detail line is locked for editing or not. The default value is N.
  • ParameterBooleanFlag; boolean; The value of a boolean parameter, for example, true or false.
  • ParameterDate; string; The value of a date parameter, for example, the value can be a date when an admissions application was submitted.
  • ParameterDatetime; string; The value of a date and time parameter, for example, the date and time at which a course started.
  • ParameterNumber; number; The value of a number parameter, for example, the value can be a course fee.
  • ParameterString; string; The value of a text parameter, for example, the value can be a student name.
  • ParameterTypeCode; string; 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; The internal identifier of the parent detail row.
  • RuleDetailId; integer; The unique identifier of a rule version detail.
  • SequenceIdentifier; integer; The numeric identifier generated for each detail row of the rule used to link rows.
  • StatementGroupName; string; The name of the group of rule statements.
  • TemplateSequenceIdentifier; integer; The numeric identifier of the row in the template from which the rule was created.
• 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 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-ruleVersions-ruleExpressions

Type: object

Show Source

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

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/businessRuleDefinitions-ruleVersions-ruleExpressions-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/businessRuleDefinitions-ruleVersions-ruleExpressions-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 : 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 : 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."
        }
    }
}

Back to Top