"status" data structure and output

The status block is the part of the JSON output that is always created/written, even if  other blocks are turned off or everything else during Quick Check execution goes wrong.

Output of the "status" block:

"status": {
      "time_needed_sec" : 0.05233,
      "result" : "incomplete",
      "level" : "error",
      "error" : [
            { "code": 24, "msg": "Invalid operator in content stream" }
      ],
}

Description of "status" entries:

  • time_needed_sec: time needed (in seconds) from launching Quick Check to its completion; "status" is created/written as the last Quick Check execution step
  • result: an indication of the quality of the result:
    • complete: the usually expected result – everything was analyzed and delivered according to the configuration
    • incomplete: only some of the requested output was created/written; for example, creating output stopped in the middle of a content stream analysis, but document info/metadata was already collected
    • none: except for the "status" block, no output was created
  • level: the 'worst' level that was encountered (none → info → warning → error)
  • info: an array of info messages, each consisting of a return code and a (non-localized) text briefly describing the info
  • warning: an array of warning messages, each consisting of a return code and a (non-localized) text briefly describing the warning
  • error: an array of error messages, each consisting of a return code and a (non-localized) text briefly describing the error

0 Comments

Send Your Comment

E-Mail me when someone replies to this comment