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

EvaluateRules

cURL

curl --request POST \
  --url https://api.siftstack.com/api/v1/rules/evaluate-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "run": {
    "id": "<string>",
    "clientKey": "<string>"
  },
  "runTimeRange": {
    "run": {
      "id": "<string>",
      "clientKey": "<string>"
    },
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z"
  },
  "allApplicableRules": true,
  "organizationId": "<string>",
  "reportName": "<string>",
  "runFamilyAlignmentConfigs": [
    {
      "familyAlignmentName": "<string>"
    }
  ]
}
'

200

{
  "createdAnnotationCount": 123,
  "reportId": "<string>",
  "jobId": "<string>"
}

Authorizations

Authorization · string · header · required

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

Body

application/json

run · object

Show child attributes

assets · object

Show child attributes

runTimeRange · object

Show child attributes

rules · object

Show child attributes

ruleVersions · object

Show child attributes

reportTemplate · object

Show child attributes

allApplicableRules · boolean

annotationOptions · object

Show child attributes

organizationId · string

reportName · string

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

runFamilyAlignmentConfigs · If evaluating a run against a family stat, this field will be used to provide alignment configuration for the run under test · object[]

Show child attributes

Response

200

application/json

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.