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

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

     Methods: GET, POST

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

Method GET: List parameters.

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

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": {
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }, 
        "parameters": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Parameter and Value", 
            "properties": {
              "id": {
                "type": "string", 
                "description": "Unique identifier"
              }, 
              "value": {
                "type": "string", 
                "description": "Value of parameter"
              }, 
              "name": {
                "type": "string", 
                "description": "Unique identifier - same as id"
              }
            }
          }, 
          "type": "array", 
          "maxItems": 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: Create a parameter.

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

There are no query arguments for this method.

Required POST request body fields:
value, name

POST request body schema:
{
  "type": "object", 
  "description": "Parameter and Value", 
  "properties": {
    "id": {
      "type": "string", 
      "description": "Unique identifier"
    }, 
    "value": {
      "required": true, 
      "type": "string", 
      "description": "Value of parameter"
    }, 
    "name": {
      "required": true, 
      "type": "string", 
      "description": "Unique identifier - same as id"
    }
  }
}

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
        }
      }
    }
  ]
}
