Create a business rules framework request
post
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRequests
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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. -
ExecutionStatus: string
Maximum Length:
50
The status of the current execution. For example, Unprocessed, Warning, Success, or Error. -
JsonData: string
The JSON data passed by the application through the Business Rules Framework request.
-
Log: string
(byte)
The log message associated with this log.
-
LogId: integer
(int64)
Title:
Log ID
The unique identifier of the log. -
NoRules: boolean
The Boolean value is 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 subidentifier 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.
-
RequestPayload: string
(byte)
The payload sent from the application in the business rules framework request. It has key values, event code, and other details.
-
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
The Boolean value is true if the calling process must be stopped.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : publicSectorBusinessRulesFrameworkRequests-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
The date and time when 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. -
ExecutionStatus: string
Maximum Length:
50
The status of the current execution. For example, Unprocessed, Warning, Success, or Error. -
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 when 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
The Boolean value is 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 subidentifier 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.
-
RequestPayload: string
(byte)
The payload sent from the application in the business rules framework request. It has key values, event code, and other details.
-
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
The Boolean value is true if the 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.