API DocsRESTRule evaluation service

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 Body

application/jsonRequired

runobject

assetsobject

rulesobject

ruleVersionsobject

reportTemplateobject

annotationOptionsobject

organizationIdOnly required if your user belongs to multiple organizations

reportNamestring

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

curl -X POST "<API_URL>/api/v1/rules/evaluate-rules" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "run": {
      "id": "string",
      "clientKey": "string"
    },
    "assets": {
      "assets": {
        "ids": {
          "ids": [
            "string"
          ]
        },
        "names": {
          "names": [
            "string"
          ]
        }
      },
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z"
    },
    "rules": {
      "rules": {
        "ids": {
          "ids": [
            "string"
          ]
        },
        "clientKeys": {
          "clientKeys": [
            "string"
          ]
        }
      }
    },
    "ruleVersions": {
      "ruleVersionIds": [
        "string"
      ]
    },
    "reportTemplate": {
      "reportTemplate": {
        "id": "string",
        "clientKey": "string"
      }
    },
    "annotationOptions": {
      "tags": {
        "ids": {
          "ids": [
            "string"
          ]
        },
        "names": {
          "names": [
            "string"
          ]
        }
      }
    },
    "organizationId": "string",
    "reportName": "string"
  }'

A successful response.

{
  "createdAnnotationCount": 0,
  "reportId": "string",
  "jobId": "string"
}

Previous

UpdateReportTemplate PATCH

Next

EvaluateRulesPreview POST