Resource URL: /platform/<<version=1>>/job/policies

    Overview: This resource applies the standard collection pattern to job
              impact policies.

     Methods: GET, POST

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

Method GET: List job impact policies.

       URL: GET /platform/<<version=1>>/job/policies

Query arguments:
  sort=<string> The field that will be used for sorting.
limit=<integer> Return no more than this many results at once (see resume).
     dir=<enum> Where <enum> is one of ASC, DESC.  The direction of the sort.
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
        }, 
        "policies": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "properties": {
              "system": {
                "required": false, 
                "type": "boolean", 
                "description": "Whether or not this is a read-only system impact policy."
              }, 
              "intervals": {
                "items": {
                  "type": "object", 
                  "properties": {
                    "impact": {
                      "enum": [
                        "Low", 
                        "Medium", 
                        "High", 
                        "Paused"
                      ], 
                      "type": "string", 
                      "description": "Impact for the corresponding time span.", 
                      "required": true
                    }, 
                    "begin": {
                      "required": true, 
                      "type": "string", 
                      "description": "Beginning time for the corresponding impact, in the format 'WWWW HH:MM', where 'WWWW' is the full English name of the day of the week, 'HH' is the hour (00-23), and 'MM' is the minute (00-59)."
                    }, 
                    "end": {
                      "required": true, 
                      "type": "string", 
                      "description": "Ending time for the corresponding impact, in the format 'WWWW HH:MM', where 'WWWW' is the full English name of the day of the week, 'HH' is the hour (00-23), and 'MM' is the minute (00-59)."
                    }
                  }
                }, 
                "required": true, 
                "type": "array"
              }, 
              "description": {
                "required": true, 
                "type": "string", 
                "description": "A helpful human-readable description of the impact policy."
              }, 
              "name": {
                "minLength": 1, 
                "required": true, 
                "type": "string", 
                "description": "The name of the impact policy."
              }, 
              "id": {
                "required": true, 
                "type": "string", 
                "description": "The ID of the impact policy."
              }
            }
          }, 
          "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 new job impact policy.

        URL: POST /platform/<<version=1>>/job/policies

There are no query arguments for this method.

Required POST request body fields:
name

POST request body schema:
{
  "type": "object", 
  "properties": {
    "intervals": {
      "items": {
        "type": "object", 
        "properties": {
          "impact": {
            "enum": [
              "Low", 
              "Medium", 
              "High", 
              "Paused"
            ], 
            "type": "string", 
            "description": "Impact for the corresponding time span.", 
            "required": true
          }, 
          "begin": {
            "required": true, 
            "type": "string", 
            "description": "Beginning time for the corresponding impact, in the format 'WWWW HH:MM', where 'WWWW' is the full English name of the day of the week, 'HH' is the hour (00-23), and 'MM' is the minute (00-59)."
          }, 
          "end": {
            "required": true, 
            "type": "string", 
            "description": "Ending time for the corresponding impact, in the format 'WWWW HH:MM', where 'WWWW' is the full English name of the day of the week, 'HH' is the hour (00-23), and 'MM' is the minute (00-59)."
          }
        }
      }, 
      "required": false, 
      "type": "array"
    }, 
    "description": {
      "required": false, 
      "type": "string", 
      "description": "A helpful human-readable description of the impact policy."
    }, 
    "name": {
      "minLength": 1, 
      "required": true, 
      "type": "string", 
      "description": "The name of the impact policy."
    }
  }
}

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