Get all business rules framework requests
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRequests
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a business rules framework request log with a specified log identifier
Finder Variables:- LogId; integer; The unique identifier of the business rules framework request log
- PrimaryKey: Finds a business rules framework request log with a specified log identifier
-
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:- CreationDate; string; The date and time at which the business rules framework request was created.
- EventCode; string; The event code of the event that triggered the business rules framework.
- EventId; integer; The unique identifier of the event associated with the business rules framework request.
- ExecutionId; string; The unique identifier of the execution instance associated with the business rules framework request.
- JsonData; string; The JSON data passed by the application through the Business Rules Framework request.
- LastUpdateDate; string; The date and time at which the business rules framework request was last updated.
- LogId; integer; The unique identifier of the log.
- PayloadOverride; string; A flag to indicate if the passed payload should be used or overridden.
- RecordIdentifier; string; The identifier passed through the business rules framework request.
- RecordSubIdentifier; string; The sub identifier passed through the business rules framework request.
- ResourceId; integer; The unique identifier of the resource associated with the business rules framework request.
- StopCustomInput; string; The custom message input configured in the Business Rules Framework interface for the Stop Process action.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorBusinessRulesFrameworkRequests
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorBusinessRulesFrameworkRequests-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
The date and time at which the business rules framework request was created. -
EventCode: string
The event code of the event that triggered the business rules framework.
-
EventId: integer
(int64)
Title:
Event ID
The unique identifier of the event associated with the business rules framework request. -
ExecutionId: string
Title:
Execution ID
Maximum Length:50
The unique identifier of the execution instance associated with the business rules framework request. -
JsonData: string
The JSON data passed by the application through the Business Rules Framework request.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time at which the business rules framework request was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Log: string
(byte)
The log message associated with this log.
-
LogId: integer
(int64)
Title:
Log ID
The unique identifier of the log. -
NoRules: boolean
Boolean value true if there are no rules associated with the event.
-
PayloadOverride: string
A flag to indicate if the passed payload should be used or overridden.
-
RecordFifthKeyName: string
The fifth key name of the resource associated with the event.
-
RecordFifthKeyValue: string
The fifth key value of the resource associated with the event.
-
RecordFirstKeyName: string
The first key name of the resource associated with the event.
-
RecordFirstKeyValue: string
The first key value of the resource associated with the event.
-
RecordFourthKeyName: string
The fourth key name of the resource associated with the event.
-
RecordFourthKeyValue: string
The fourth key value of the resource associated with the event.
-
RecordIdentifier: string
The identifier passed through the business rules framework request.
-
RecordSecondKeyName: string
The second key name of the resource associated with the event.
-
RecordSecondKeyOper: string
An operator is passed by the requesting application to filter the data in the rule framework processor to iterate objects to advance the workflow once fee is paid. For example, the operator may be "In", such as "LnpRecordKey In (300000001798129, 300000001812166)."
-
RecordSecondKeyValue: string
The second key value of the resource associated with the event.
-
RecordSubIdentifier: string
The sub identifier passed through the business rules framework request.
-
RecordThirdKeyName: string
The third key name of the resource associated with the event.
-
RecordThirdKeyValue: string
The third key value of the resource associated with the event.
-
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the resource associated with the business rules framework request. -
RuleId: integer
The unique identifier of the scheduled rule that was run.
-
RuleName: string
The unique name of the rule that was run. This can be a rule triggered by the application or a scheduled rule.
-
StopCustomInput: string
The custom message input configured in the Business Rules Framework interface for the Stop Process action.
-
StopProcess: boolean
Boolean value true if calling process must be stopped.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.