Get a Category Definition

Description

Access a single category definition.

Definition

http://localhost:8080/engine/v2/results/<jobId>/categorydefinitions/<categoryId>
jobId:The unique identifier of the job.
categoryId:The identifier of the category definition of interest.

Method

GET

Returns

A JSON formatted document containing the results for the category definition of interest. For example, a JSON response will take the form:

{
  "documentId" : "3",
  "exists" : true,
  "type" : "categoryDefinition",
  "document" : {
    "categoryId" : "3",
    "terms" : "User logged in host",
    "regex" : ".*?User.+?logged.+?in.+?host.*",
    "maxMatchingLength" : 37,
    "examples" : ["User foo logged in host 127.0.0.1", "User bar logged in host 127.0.0.2"]
  }
}

For a detailed description of the output see Category Definition Resource.

Errors

See the Error Codes documentation for the full list of errors that may be returned by the API.