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

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

     Methods: GET, POST

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

Method GET: List all changelists.

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

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": {
        "changelists": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "properties": {
              "snap1": {
                "required": true, 
                "type": "integer", 
                "description": "The lower snapid used to compute the changelist."
              }, 
              "status": {
                "required": true, 
                "type": "string", 
                "description": "Status of changelist."
              }, 
              "snap2": {
                "required": true, 
                "type": "integer", 
                "description": "The higher snapid used to compute the changelist."
              }, 
              "job_id": {
                "required": true, 
                "type": "integer", 
                "description": "The ID of the job which created the changelist."
              }, 
              "root_path": {
                "required": true, 
                "type": "string", 
                "description": "Root path of all LINs in changelist."
              }, 
              "num_entries": {
                "required": false, 
                "type": "integer", 
                "description": "Number of LIN entries in changelist."
              }, 
              "id": {
                "required": true, 
                "type": "string", 
                "description": "The system ID given to the changelist."
              }
            }
          }, 
          "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: Create a new changelist.

        URL: POST /platform/<<version=1>>/snapshot/changelists

There are no query arguments for this method.

Required POST request body fields:
snap1, status, snap2, job_id, root_path, id

POST request body schema:
{
  "type": "object", 
  "properties": {
    "snap1": {
      "required": true, 
      "type": "integer", 
      "description": "The lower snapid used to compute the changelist."
    }, 
    "status": {
      "required": true, 
      "type": "string", 
      "description": "Status of changelist."
    }, 
    "snap2": {
      "required": true, 
      "type": "integer", 
      "description": "The higher snapid used to compute the changelist."
    }, 
    "job_id": {
      "required": true, 
      "type": "integer", 
      "description": "The ID of the job which created the changelist."
    }, 
    "root_path": {
      "required": true, 
      "type": "string", 
      "description": "Root path of all LINs in changelist."
    }, 
    "num_entries": {
      "required": false, 
      "type": "integer", 
      "description": "Number of LIN entries in changelist."
    }, 
    "id": {
      "required": true, 
      "type": "string", 
      "description": "The system ID given to the changelist."
    }
  }
}

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": {
        "snap1": {
          "required": true, 
          "type": "integer", 
          "description": "The lower snapid used to compute the changelist."
        }, 
        "status": {
          "required": true, 
          "type": "string", 
          "description": "Status of changelist."
        }, 
        "snap2": {
          "required": true, 
          "type": "integer", 
          "description": "The higher snapid used to compute the changelist."
        }, 
        "job_id": {
          "required": true, 
          "type": "integer", 
          "description": "The ID of the job which created the changelist."
        }, 
        "root_path": {
          "required": true, 
          "type": "string", 
          "description": "Root path of all LINs in changelist."
        }, 
        "num_entries": {
          "required": false, 
          "type": "integer", 
          "description": "Number of LIN entries in changelist."
        }
      }
    }
  ]
}
