Resource URL: /platform/<<version=1>>/snapshot/pending

    Overview: This resource allows listing scheduled snapshots that will be
              taken during a given time frame.

     Methods: GET

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

Method GET: Return list of snapshots to be taken.

       URL: GET /platform/<<version=1>>/snapshot/pending

Query arguments:
    end=<integer> Unix Epoch time to end generating matches. Default is forever.
  begin=<integer> Unix Epoch time to start generating matches. Default is now.
schedule=<string> Limit output only to the named schedule.
  limit=<integer> Return no more than this many result 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"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "pending": {
          "items": {
            "type": "object", 
            "properties": {
              "path": {
                "required": true, 
                "type": "string", 
                "description": "The /ifs path that will snapshotted."
              }, 
              "time": {
                "required": true, 
                "type": "integer", 
                "description": "The Unix Epoch time the snapshot will be created."
              }, 
              "snapshot": {
                "required": true, 
                "type": "string", 
                "description": "The system snapshot name formed from the schedule formate."
              }, 
              "id": {
                "required": true, 
                "type": "string", 
                "description": "The system supplied unique ID used for sorting and paging."
              }, 
              "schedule": {
                "required": true, 
                "type": "string", 
                "description": "The name of the schedule used to create this snapshot."
              }
            }
          }, 
          "type": "array"
        }, 
        "resume": {
          "type": [
            "string", 
            "null"
          ], 
          "description": "Resume token value to use in subsequent calls for continuation."
        }
      }
    }
  ]
}
