Jump to

• Request
• Response

Update an existing business rules framework request

patch

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkRequests/{LogId}

Request

Path Parameters

• LogId(required): integer(int64)
  The unique identifier of the log.

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CheckPoint: string
  Maximum Length: 100

  Records the current point of the rule processing at the overall top-level. This information is used in the case of a processing interruption and the rule needs to be retried.
• 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.
• ExecutionRetryCount: integer (int32)
  The number of times the process has been retried aftrer an error.
• ExecutionStatus: string
  Maximum Length: 50

  The status of the current execution. For example, Unprocessed, Warning, Success, or Error.
• Keyset: string (byte)
  Records the list of rules, or keys, that need to be retried in the case of a processing interruption.
• Log: string (byte)
  The log message associated with this log.
• 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 a fee is paid. For example, the operator may be "In," such as "LnpRecordKey In (300000001798129, 300000001812166)". This operator will be used for the RecordSecondKey passed.
• 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.
• TimeA: integer (int64)
  A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.
• TimeB: integer (int64)
  A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.
• TimeC: integer (int64)
  A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.
• TimeD: integer (int64)
  A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.
• TimeE: integer (int64)
  A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.

{
    "type":"object",
    "properties":{
        "ExecutionRetryCount":{
            "type":"integer",
            "description":"The number of times the process has been retried aftrer an error.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "Keyset":{
            "type":"string",
            "description":"Records the list of rules, or keys, that need to be retried in the case of a processing interruption.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "TimeB":{
            "type":"integer",
            "description":"A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "Log":{
            "type":"string",
            "description":"The log message associated with this log.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "TimeA":{
            "type":"integer",
            "description":"A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "TimeD":{
            "type":"integer",
            "description":"A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "TimeC":{
            "type":"integer",
            "description":"A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "TimeE":{
            "type":"integer",
            "description":"A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "RecordSecondKeyOper":{
            "type":"string",
            "description":"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 a fee is paid. For example, the operator may be \"In,\" such as \"LnpRecordKey In (300000001798129, 300000001812166)\". This operator will be used for the RecordSecondKey passed.",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource associated with the business rules framework request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ExecutionStatus":{
            "maxLength":50,
            "type":"string",
            "description":"The status of the current execution. For example, Unprocessed, Warning, Success, or Error.",
            "nullable":true
        },
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier of the event associated with the business rules framework request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ExecutionId":{
            "title":"Execution ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the execution instance associated with the business rules framework request.",
            "nullable":true
        },
        "RequestPayload":{
            "type":"string",
            "description":"The payload sent from the application in the business rules framework request. It has key values, event code, and other details.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CheckPoint":{
            "maxLength":100,
            "type":"string",
            "description":"Records the current point of the rule processing at the overall top-level. This information is used in the case of a processing interruption and the rule needs to be retried.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorBusinessRulesFrameworkRequests-item-response

Type: object

Show Source

• CheckPoint: string
  Maximum Length: 100

  Records the current point of the rule processing at the overall top-level. This information is used in the case of a processing interruption and the rule needs to be retried.
• 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.
• ExecutionRetryCount: integer (int32)
  The number of times the process has been retried aftrer an error.
• 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.
• Keyset: string (byte)
  Records the list of rules, or keys, that need to be retried in the case of a processing interruption.
• 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 a fee is paid. For example, the operator may be "In," such as "LnpRecordKey In (300000001798129, 300000001812166)". This operator will be used for the RecordSecondKey passed.
• 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.
• TimeA: integer (int64)
  A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.
• TimeB: integer (int64)
  A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.
• TimeC: integer (int64)
  A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.
• TimeD: integer (int64)
  A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.
• TimeE: integer (int64)
  A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.

{
    "type":"object",
    "properties":{
        "Keyset":{
            "type":"string",
            "description":"Records the list of rules, or keys, that need to be retried in the case of a processing interruption.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the business rules framework request was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordFifthKeyValue":{
            "type":"string",
            "description":"The fifth key value of the resource associated with the event.",
            "nullable":true,
            "x-queryable":false
        },
        "RuleId":{
            "type":"integer",
            "description":"The unique identifier of the scheduled rule that was run.",
            "nullable":true,
            "x-queryable":false
        },
        "RecordSecondKeyValue":{
            "type":"string",
            "description":"The second key value of the resource associated with the event.",
            "nullable":true,
            "x-queryable":false
        },
        "RecordFourthKeyName":{
            "type":"string",
            "description":"The fourth key name of the resource associated with the event.",
            "nullable":true,
            "x-queryable":false
        },
        "EventCode":{
            "type":"string",
            "description":"The event code of the event that triggered the business rules framework.",
            "nullable":true,
            "x-queryable":true
        },
        "JsonData":{
            "type":"string",
            "description":"The JSON data passed by the application through the Business Rules Framework request.",
            "nullable":true,
            "x-queryable":true
        },
        "StopProcess":{
            "type":"boolean",
            "description":"The Boolean value is true if the calling process must be stopped.",
            "nullable":true,
            "x-queryable":false
        },
        "RecordIdentifier":{
            "type":"string",
            "description":"The identifier passed through the business rules framework request.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordFirstKeyValue":{
            "type":"string",
            "description":"The first key value of the resource associated with the event.",
            "nullable":true,
            "x-queryable":false
        },
        "RecordFourthKeyValue":{
            "type":"string",
            "description":"The fourth key value of the resource associated with the event.",
            "nullable":true,
            "x-queryable":false
        },
        "ExecutionStatus":{
            "maxLength":50,
            "type":"string",
            "description":"The status of the current execution. For example, Unprocessed, Warning, Success, or Error.",
            "nullable":true,
            "x-queryable":true
        },
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier of the event associated with the business rules framework request.",
            "format":"int64",
            "nullable":true,
            "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"
            }
        },
        "NoRules":{
            "type":"boolean",
            "description":"The Boolean value is true if there are no rules associated with the event.",
            "nullable":true,
            "x-queryable":false
        },
        "RecordFifthKeyName":{
            "type":"string",
            "description":"The fifth key name of the resource associated with the event.",
            "nullable":true,
            "x-queryable":false
        },
        "RuleName":{
            "type":"string",
            "description":"The unique name of the rule that was run. This can be a rule triggered by the application or a scheduled rule.",
            "nullable":true,
            "x-queryable":false
        },
        "RequestPayload":{
            "type":"string",
            "description":"The payload sent from the application in the business rules framework request. It has key values, event code, and other details.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CheckPoint":{
            "maxLength":100,
            "type":"string",
            "description":"Records the current point of the rule processing at the overall top-level. This information is used in the case of a processing interruption and the rule needs to be retried.",
            "nullable":true,
            "x-queryable":true
        },
        "ExecutionRetryCount":{
            "type":"integer",
            "description":"The number of times the process has been retried aftrer an error.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RecordSubIdentifier":{
            "type":"string",
            "description":"The subidentifier passed through the business rules framework request.",
            "nullable":true,
            "x-queryable":true
        },
        "TimeB":{
            "type":"integer",
            "description":"A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "Log":{
            "type":"string",
            "description":"The log message associated with this log.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "TimeA":{
            "type":"integer",
            "description":"A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "TimeD":{
            "type":"integer",
            "description":"A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "TimeC":{
            "type":"integer",
            "description":"A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "RecordThirdKeyValue":{
            "type":"string",
            "description":"The third key value of the resource associated with the event.",
            "nullable":true,
            "x-queryable":false
        },
        "TimeE":{
            "type":"integer",
            "description":"A fliexible time field used to store, calculate, and monitor the time required to run an event, rule, and or action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "RecordThirdKeyName":{
            "type":"string",
            "description":"The third key name of the resource associated with the event.",
            "nullable":true,
            "x-queryable":false
        },
        "RecordSecondKeyOper":{
            "type":"string",
            "description":"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 a fee is paid. For example, the operator may be \"In,\" such as \"LnpRecordKey In (300000001798129, 300000001812166)\". This operator will be used for the RecordSecondKey passed.",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource associated with the business rules framework request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecordFirstKeyName":{
            "type":"string",
            "description":"The first key name of the resource associated with the event.",
            "nullable":true,
            "x-queryable":false
        },
        "RecordSecondKeyName":{
            "type":"string",
            "description":"The second key name of the resource associated with the event.",
            "nullable":true,
            "x-queryable":false
        },
        "LogId":{
            "title":"Log ID",
            "type":"integer",
            "description":"The unique identifier of the log.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PayloadOverride":{
            "type":"string",
            "description":"A flag to indicate if the passed payload should be used or overridden.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the business rules framework request was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StopCustomInput":{
            "type":"string",
            "description":"The custom message input configured in the Business Rules Framework interface for the Stop Process action.",
            "nullable":true,
            "x-queryable":true
        },
        "ExecutionId":{
            "title":"Execution ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the execution instance associated with the business rules framework request.",
            "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