Create a rule set

post/ruleSets

Internal-Use Only

Creates a new rule set.

Request Samples

application/json
default
1

Response Samples

201
application/json
default
1{
2  "name": "Loan Score Approval",
3  "signature": [
4    {
5      "name": "customerName",
6      "dataType": "string",
7      "direction": "input"
8    },
9    {
10      "name": "creditScore",
11      "dataType": "decimal",
12      "direction": "input"
13    },
14    {
15      "name": "approved",
16      "dataType": "boolean",
17      "direction": "output"
18    }
19  ]
20}

Query Parameters

Name	Type	Required	Description
parentFolderUri	string</folders/folders/{parentFolderId}>	false	The folder in which the new rule set is placed.
fromRevisionUri	string</businessRules/ruleSets/{rulesetId}/revisions/{revisionId}>	false	This value specifies the URI of the rule set revision from which the new rule set is created. This property enables you to trace the lineage of a rule set. The valid format for this parameter is '/businessRules/ruleSets/${rulesetId}/revisions/${revisionId}'

Request Body

The rule set object that should be created.

The definition of a set of rules and the associated signature for them. This represents the application/vnd.sas.business.rule.set media type (version 10).

Example:

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

Name	Type	Required	Description
id	string	false	The system-assigned unique ID for this object.
name	string	true	The name of the rule set.
ruleSetType	string<enumeration>	false	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. Allowed values: assignmentfiltering
description	string	false	The rule set description
createdBy	string	false	The user who created the rule set.
creationTimeStamp	string<date-time>	false	The date and time that the rule set was created.
modifiedBy	string	false	The user ID of the authenticated user who last updated the rule set.
modifiedTimeStamp	string<date-time>	false	The date and time that the rule set was last modified.
majorRevision	integer	false	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.
minorRevision	integer	false	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.
checkout	boolean	false	Flag that indicates that the rule set is a user's working copy of another rule set.
locked	boolean	false	Flag that indicates if the content of the revision being viewed is locked or editable.
signature	array [Signature Term]	true	The set of terms local to this rule set with input and output behavior.
folderType	string	false	Indicates the type of folder where the rule set is housed.
sourceRevisionUri	string	false	The URI of the rule set revision this rule set is being created from.
copyTimeStamp	string<date-time>	false	The time stamp when the ruleset revision was copied.
testCustomContextUri	string	false	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.
links	array [Link]	false	Zero or more links to related resources or operations.
version	integer	false	This media type's schema version number. This representation is version 10.

Responses

Status	Meaning	Description
201	Created	A folder was created.	Headers	Schema
400	Bad Request	The request was invalid.		Schema