API DocsRESTRule service

EvaluateRules

Evaluates the provided rules and generate annotations based on the result.

POST
/api/v1/rules/evaluate

Request Body

application/jsonRequired

Deprecated - use RuleEvaluationService instead.

ruleIds
Required
array<string>

annotationOptionsobject

runIdstring

timeRangeobject

dryRunboolean

curl -X POST "<API_URL>/api/v1/rules/evaluate" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "ruleIds": [
      "string"
    ],
    "annotationOptions": {
      "tagIds": [
        "string"
      ]
    },
    "runId": "string",
    "timeRange": {
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z"
    },
    "dryRun": true
  }'

A successful response.

{
  "createdAnnotationCount": 0,
  "dryRunAnnotations": [
    {
      "conditionId": "string",
      "name": "string",
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "conditionVersionId": "string"
    }
  ],
  "jobId": "string",
  "reportId": "string"
}

Previous

DeleteRule POST

Next

GetRule GET