Resource URL: /platform/<<version=3>>/healthcheck/evaluations

    Overview: This resource applies the standard collection pattern to
              evaluations.

     Methods: GET, POST

********************************************************************************

Method GET: List evaluations.

       URL: GET /platform/<<version=3>>/healthcheck/evaluations

Query arguments:
limit=<integer> Return no more than this many results at once (see resume).
resume=<string> Continue returning results from previous call using this token
                (token should come from the previous call, resume cannot be
                used with other options).

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "evaluations": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Evaluation Request/Result", 
            "properties": {
              "parameters": {
                "type": "object", 
                "description": "Parameters supplied for this evaluation"
              }, 
              "overrides": {
                "items": {
                  "type": "object", 
                  "description": "Overrides for item pass_status, freshness and thresholds", 
                  "properties": {
                    "thresholds": {
                      "type": "object", 
                      "description": "Overrides for status thresholds", 
                      "properties": {
                        "warning": {
                          "minimum": 0, 
                          "type": "integer", 
                          "description": "Minimum value for WARNING - must be > critical", 
                          "maximum": 100
                        }, 
                        "critical": {
                          "minimum": 0, 
                          "type": "integer", 
                          "description": "Minimum value for CRITICAL - below this EMERGENCY", 
                          "maximum": 100
                        }, 
                        "ok": {
                          "minimum": 0, 
                          "type": "integer", 
                          "description": "Minimum value for OK - must be > warning", 
                          "maximum": 100
                        }
                      }
                    }, 
                    "freshness": {
                      "minimum": 0, 
                      "type": "integer", 
                      "description": "Optional freshness override"
                    }, 
                    "id": {
                      "type": "string", 
                      "description": "Id of Item to which override applies"
                    }, 
                    "pass_status": {
                      "enum": [
                        "OK", 
                        "WARNING", 
                        "CRITICAL", 
                        "EMERGENCY"
                      ], 
                      "type": "string", 
                      "description": "Optional pass status override"
                    }
                  }
                }, 
                "type": "array", 
                "description": "Optional overrides for thresholds etc."
              }, 
              "checklist_id": {
                "type": "string", 
                "description": "Checklist to be run"
              }, 
              "result": {
                "enum": [
                  "PASS", 
                  "FAIL"
                ], 
                "type": "string", 
                "description": "Overall result of evaluation - only if COMPLETED"
              }, 
              "run_status": {
                "type": "string", 
                "enum": [
                  "QUEUED", 
                  "RUNNING", 
                  "PAUSED", 
                  "FAILED", 
                  "COMPLETED"
                ], 
                "desciption": "Execution status"
              }, 
              "id": {
                "type": "string", 
                "description": "Unique identifier"
              }, 
              "details": {
                "items": {
                  "type": "object", 
                  "description": "The result of an item evaluation", 
                  "properties": {
                    "node": {
                      "type": "string", 
                      "description": "Either 'cluster' or an lnn"
                    }, 
                    "status": {
                      "enum": [
                        "OK", 
                        "WARNING", 
                        "CRITICAL", 
                        "EMERGENCY", 
                        "UNSUPPORTED", 
                        "ERROR"
                      ], 
                      "type": "string", 
                      "description": "Health status based on default thresholds"
                    }, 
                    "hash": {
                      "type": "string", 
                      "description": "Unique identifier"
                    }, 
                    "parameters": {
                      "type": "object", 
                      "description": "The parameters used in this item evaluation"
                    }, 
                    "value": {
                      "minimum": 0, 
                      "type": "integer", 
                      "description": "Normalised measured value 0 (bad) to 100 (perfect)", 
                      "maximum": 100
                    }, 
                    "details": {
                      "type": "object", 
                      "description": "Optional details of the evaluation - raw data"
                    }, 
                    "id": {
                      "type": "string", 
                      "description": "Unique identifier of item"
                    }
                  }
                }, 
                "type": "array", 
                "description": "Evaluation results by item - only if COMPLETED"
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }, 
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }, 
        "resume": {
          "minLength": 0, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options)."
        }
      }
    }
  ]
}

********************************************************************************

Method POST: Request an evaluation.

        URL: POST /platform/<<version=3>>/healthcheck/evaluations

There are no query arguments for this method.

Required POST request body fields:
checklist_id

POST request body schema:
{
  "type": "object", 
  "description": "Evaluation Request/Result", 
  "properties": {
    "overrides": {
      "items": {
        "type": "object", 
        "description": "Overrides for item pass_status, freshness and thresholds", 
        "properties": {
          "thresholds": {
            "type": "object", 
            "description": "Overrides for status thresholds", 
            "properties": {
              "warning": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Minimum value for WARNING - must be > critical", 
                "maximum": 100
              }, 
              "critical": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Minimum value for CRITICAL - below this EMERGENCY", 
                "maximum": 100
              }, 
              "ok": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Minimum value for OK - must be > warning", 
                "maximum": 100
              }
            }
          }, 
          "freshness": {
            "minimum": 0, 
            "type": "integer", 
            "description": "Optional freshness override"
          }, 
          "id": {
            "type": "string", 
            "description": "Id of Item to which override applies"
          }, 
          "pass_status": {
            "enum": [
              "OK", 
              "WARNING", 
              "CRITICAL", 
              "EMERGENCY"
            ], 
            "type": "string", 
            "description": "Optional pass status override"
          }
        }
      }, 
      "type": "array", 
      "description": "Optional overrides for thresholds etc."
    }, 
    "checklist_id": {
      "required": true, 
      "type": "string", 
      "description": "Checklist to be run"
    }, 
    "parameters": {
      "type": "object", 
      "description": "Parameters supplied for this evaluation"
    }
  }
}

POST response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "id": {
          "minLength": 0, 
          "required": true, 
          "type": "string", 
          "description": "ID of created item that can be used to refer to item in the collection-item resource path.", 
          "maxLength": 255
        }
      }
    }
  ]
}
