Custom Evaluator

Summary

Custom Evaluator is a client-defined pattern-matcher which returns true or false, depending on whether the pattern defined in the evaluator matches a specific attribute of the request context, such as URI or request-header. Custom Evaluators are referenced only within the action field of an Eval Script Step

Definition

Name	Schema	Default	Comments
id	integer		unique auto-generated record-ID
name	string		short-code used to uniquely identify evaluator
header_name	string or NULL	NULL	Name of request-header to match on. Can include wildcard (*). If not provided, the URI is used as the match-input.
match	string	string or JSON-array of string	Value or set of values to match to URI or header. Can include wildcard (*). Matcher yields true if the input matches any of the supplied match-strings
operation	string (IN or EQUALS)
negation	string (YES or NO) or NULL	NULL	If YES, negate the result of this rule
description	string		human-readable description

REST Operations

GET custom-evaluator/<resourceId>

Return custom-evaluator resource identified by resourceId

GET custom-evaluator?<query-parameters>

Return custom-evaluator 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)
name	string		name to match (optional)

PUT custom-evaluator/<resourceId>

Update custom-evaluator resource idientied by resourceId

JSON body parameters:

Name	Schema	Default	Comments
name	string		short-code used to uniquely identify evaluator
header_name	string or NULL	NULL	Name of request-header to match on. Can include wildcard (*). If not provided, the URI is used as the input.
match	string	string or JSON-array of string	Value or set of values to match to URI or header. Can include wildcard (*)
operation	string (IN or EQUALS)
negation	string (YES or NO) or NULL	NULL	If YES, negate the result of this rule
description	string		human-readable description

POST custom-evaluator

Create new custom-evaluator resource

JSON body parameters:

Name	Schema	Default	Comments
name	string		short-code used to uniquely identify evaluator
header_name	string or NULL	NULL	Name of request-header to match on. Can include wildcard (*). If not provided, the URI is used as the input.
match	string	string or JSON-array of string	Value or set of values to match to URI or header. Can include wildcard (*)
operation	string (IN or EQUALS)
negation	string (YES or NO) or NULL	NULL	If YES, negate the result of this rule
description	string		human-readable description

DELETE

Delete custom-evaluator resource idientied by resourceId