RuleEvaluationService

EvaluateRules

Evaluate rules from a designated source against a run or asset and return the total amount of annotations created and the ID of the generated report.

post/api/v1/rules/evaluate-rules

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/rules/evaluate-rules
  • Auth: HTTP bearer

Request body

allApplicableRulesboolean
organizationIdstring
reportNamestring

If this request creates a report, this field will be used as the report name.

Response

A successful response.

createdAnnotationCountinteger required
reportIdstring

A report will be generated if rules were evaluated against a run.

jobIdstring

This will be set if the job has an extended run time and is being processed asynchronously.

Changes

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