Resource URL: /platform/<<version=1>>/sync/reports-rotate

    Overview: Force rotation in the database(s).

     Methods: GET, POST

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

Method GET: Whether the rotation is still running or not.

       URL: GET /platform/<<version=1>>/sync/reports-rotate

There are no query arguments for this method.

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", 
      "description": "Force rotation of reports.", 
      "properties": {
        "message": {
          "required": true, 
          "type": "string", 
          "description": "A message about the status of the task."
        }, 
        "running": {
          "required": true, 
          "type": "boolean", 
          "description": "Whether this task is running or not."
        }
      }
    }
  ]
}

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

Method POST: Rotate the records in the database(s).

        URL: POST /platform/<<version=1>>/sync/reports-rotate

There are no query arguments for this method.

POST request body schema:
{
  "type": [
    "null", 
    "object"
  ], 
  "description": "Null or any empty JSON object.", 
  "properties": {}
}

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", 
      "description": "Force rotation of reports.", 
      "properties": {
        "message": {
          "required": true, 
          "type": "string", 
          "description": "A message about the status of the task."
        }
      }
    }
  ]
}
