Rule Sets

Update a rule set

Updates the rule set with the provided content.

put/ruleSets/{ruleSetId}

Request

  • Base URL: https://example.com/businessRules
  • URL: https://example.com/businessRules/ruleSets/{ruleSetId}
  • Auth: none declared. Required headers: If-Unmodified-Since

Path parameters

ruleSetIdstring required

The rule set ID.

Headers

If-Unmodified-Sincestring date-time required

The date and time that the rule set was last modified.

Request body

idstring

The system-assigned unique ID for this object.

namestring required

The name of the rule set.

ruleSetType'assignment' | 'filtering' enumeration

The type of rule set. Assignment rule sets enable users to specify variable assignment actions within business rules. Filtering rule sets contain business rules that are only conditions that must be matched for the data to be retained within the resulting output. Assignment is the default if not specified.

descriptionstring

The rule set description

createdBystring

The user who created the rule set.

creationTimeStampstring date-time

The date and time that the rule set was created.

modifiedBystring

The user ID of the authenticated user who last updated the rule set.

modifiedTimeStampstring date-time

The date and time that the rule set was last modified.

majorRevisioninteger

Major version number of the revision being viewed of the rule set. This value is assigned by the service, the user only has control on whether the major number or minor number is incremented when creating a new revision. This is a derived field that is generated on PUT/POST.

minorRevisioninteger

Minor version number of the current revision of the rule set. This value is assigned by the service. The user only has control on whether the major number or minor number is incremented when creating a new revision. This is a derived field that is generated on PUT/POST.

checkoutboolean

Flag that indicates that the rule set is a user's working copy of another rule set.

lockedboolean

Flag that indicates if the content of the revision being viewed is locked or editable.

folderTypestring

Indicates the type of folder where the rule set is housed.

sourceRevisionUristring

The URI of the rule set revision this rule set is being created from.

copyTimeStampstring date-time

The time stamp when the ruleset revision was copied.

testCustomContextUristring

The URI of a Custom Context DS2 code file that provides a custom context to this rule set. The ruleset's custom context is usually provided by the decision that uses it. For syntax validation of rule expressions and for testing purposes, you can specify a testing-only custom context.

versioninteger

This media type's schema version number. This representation is version 10.

Example request

{
  "name": "Loan Score Approval",
  "signature": [
    {
      "name": "customerName",
      "dataType": "string",
      "direction": "input"
    },
    {
      "name": "creditScore",
      "dataType": "decimal",
      "direction": "input"
    },
    {
      "name": "approved",
      "dataType": "boolean",
      "direction": "output"
    }
  ]
}

Response

The request succeeded.

idstring

The system-assigned unique ID for this object.

namestring required

The name of the rule set.

ruleSetType'assignment' | 'filtering' enumeration

The type of rule set. Assignment rule sets enable users to specify variable assignment actions within business rules. Filtering rule sets contain business rules that are only conditions that must be matched for the data to be retained within the resulting output. Assignment is the default if not specified.

descriptionstring

The rule set description

createdBystring

The user who created the rule set.

creationTimeStampstring date-time

The date and time that the rule set was created.

modifiedBystring

The user ID of the authenticated user who last updated the rule set.

modifiedTimeStampstring date-time

The date and time that the rule set was last modified.

majorRevisioninteger

Major version number of the revision being viewed of the rule set. This value is assigned by the service, the user only has control on whether the major number or minor number is incremented when creating a new revision. This is a derived field that is generated on PUT/POST.

minorRevisioninteger

Minor version number of the current revision of the rule set. This value is assigned by the service. The user only has control on whether the major number or minor number is incremented when creating a new revision. This is a derived field that is generated on PUT/POST.

checkoutboolean

Flag that indicates that the rule set is a user's working copy of another rule set.

lockedboolean

Flag that indicates if the content of the revision being viewed is locked or editable.

folderTypestring

Indicates the type of folder where the rule set is housed.

sourceRevisionUristring

The URI of the rule set revision this rule set is being created from.

copyTimeStampstring date-time

The time stamp when the ruleset revision was copied.

testCustomContextUristring

The URI of a Custom Context DS2 code file that provides a custom context to this rule set. The ruleset's custom context is usually provided by the decision that uses it. For syntax validation of rule expressions and for testing purposes, you can specify a testing-only custom context.

versioninteger

This media type's schema version number. This representation is version 10.

Example response

{
  "name": "Loan Score Approval",
  "signature": [
    {
      "name": "customerName",
      "dataType": "string",
      "direction": "input"
    },
    {
      "name": "creditScore",
      "dataType": "decimal",
      "direction": "input"
    },
    {
      "name": "approved",
      "dataType": "boolean",
      "direction": "output"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.