Skip to main content
POST
EvaluateRules

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
run
object
assets
object
runTimeRange
object
rules
object
ruleVersions
object
reportTemplate
object
allApplicableRules
boolean
annotationOptions
object
organizationId
string
reportName
string

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

Response

A successful response.

createdAnnotationCount
integer<int32>
required
reportId
string

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

jobId
string

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