Eval-Script-Step
Summary
An Eval-Script-Step consists of a script-name, a sequence-id, and an action. Eval-Script-Steps with the same script-name form an Eval-Script. The action-string refers to a Custom Evaluator-name, a Rule Set-alias, or specifies a filter, directly (i.e. l(es))
Definition
| Field | Value | Description |
|---|---|---|
| ID | integer | unique auto-generated record-ID |
| ScriptName | string | short-code used in es filter (not unique – shared by other steps in the script) |
| SequenceID | int | denotes order of Eval-Script within group of steps (must be unique for same Name)` |
| Action | string | RuleSet-alias, CustomEvaluator-name, or single filter to process – cannot be NULL |
REST Operations
GET eval-script-set/<resourceId>
Return eval-script-set resource identified by resourceId
GET eval-script-set?<query-parameters>
Return eval-script-set resources identified by query paramters:
Query Parameters:
| parameter | type | default | comments |
|---|---|---|---|
| page | integer | 0 | zero indexed page of results to return (optional) |
| page_size | integer | items-per-page to return (required) | |
| script_name_prefix | string | script-name-prefix to match (optional) | |
| script_name | string | exact script-name to match (optional) |
PUT eval-script-set/<resourceId>
Update eval-script-set resource idientied by resourceId
JSON body parameters:
| Name | Schema | Comments |
|---|---|---|
| script_name | string | unique alphanumeric code which groups steps into an EvalScript eval-script-set filter |
| sequence_id | string | denotes order of Eval-Script within group of steps (must be unique for same script_name)` |
| action | string | RuleSet-alias, CustomEvaluator-name, or single filter to process – cannot be NULL |
POST eval-script-set
Create new eval-script-set resource
JSON body parameters:
| Name | Schema | Comments |
|---|---|---|
| script_name | string | unique alphanumeric code which groups steps into an EvalScript eval-script-set filter |
| sequence_id | string | denotes order of Eval-Script within group of steps (must be unique for same script_name)` |
| action | string | RuleSet-alias, CustomEvaluator-name, or single filter to process – cannot be NULL |
DELETE
Delete eval-script-set resource idientied by resourceId