v4

latestOpenAPI 3.0.12026-08-041341,046757.6 KB
AmlResolutionRulesApiAgentResource

Create or update a rule in the draft

Creates or updates a single rule in the draft. Omit id to create a new rule: the server assigns the id and appends the rule at the end of the evaluation order. Provide an existing id to update that rule in place; only the fields of this request body are written, everything else is preserved. If no draft exists yet, one is created automatically as a copy of the published revision. The response is the full draft with freshly recomputed notices — review them after every change.

post/resources/api/agent/amlResolutionRules/draft/rules

Request body

descriptionstring

Free-form description of what the rule does.

idstring

Id of the rule, unique within the rule chain. Omit to create a new rule: the server assigns the id and returns it in the response. Provide an existing id to update that rule.

namestring required

Display name of the rule.

Example request

{
  "name": "Auto-clear false positives by date of birth"
}

Response

default response

idstring
revisioninteger

Revision number; increases with each new revision.

revisionStatusstring

Current status of this revision.