Get Category Definitions

Description

Access the result category definitions of an analytic job.

Definition

http://localhost:8080/engine/v2/results/<jobId>/categorydefinitions
jobId:The job unique identifier

Parameters

skip & take:See Pagination.

Method

GET

Returns

A JSON formatted document containing the category definition objects for the job instance object of interest. For example, a sample JSON response will take the form:

{
  "hitCount" : 157,
  "skip" : 0,
  "take" : 100,
  "nextPage" : "http://localhost:8080/engine/v2/results/job001/categorydefinitions?skip=100&take=100",
  "previousPage" : null,
  "documents" : [ {
    "categoryId" : "1",
    "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"]
  }, {
    "categoryId" : "2",
    "terms" : "File deleted successfully",
    "regex" : ".*?File.+?deleted.+?successfully.*",
    "maxMatchingLength" : 40,
    "examples" : ["File foo.dat deleted successfully", "File bar.dat deleted successfully", "File foobar.dat deleted successfully"]
  }, {
  ...
  }]
}

Errors

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