scrollSpecifications

Since Kuzzle v1.0.0

URL: http://kuzzle:7512/validations/_scroll/<scrollId>[?scroll=<time to live>]
Method: GET

Query

{
  "controller": "collections",
  "action": "scrollSpecifications",
  "scrollId": "<scrollId>",
  "scroll": "<time to live>"
}

Response

{
  "status": 200,
  "error": null,
  "action": "scrollSpecifications",
  "controller": "collection",
  "requestId": "<unique request identifier>",
  "result": {
    // scroll requests may return a new scroll identifier
    // only the most recent scrollId should be used
    "scrollId": "<new scroll id>",

    // An array of objects containing your retrieved documents
    "hits": [
      {
        "_id": "myIndex#myCollection",
        "_index": "%kuzzle",
        "_score": 1,
        "_source": {
          "collection": "myCollection",
          "index": "myIndex",
          "validation": {
            "fields": {
              "fieldName": {
                "defaultValue": "a default value",
                "mandatory": true,
                "multivalued": {
                  "maxCount": 5,
                  "minCount": 1,
                  "value": true
                },
                "type": "string",
                "typeOptions": {
                  "length": {
                    "max": 12,
                    "min": 2
                  }
                }
              }
            },
            "strict": true
          }
        },
        "_type": "validations"
      },
      {
        ...
      }
    ],
    "total": <number of found specifications>
  }
}

This method moves forward a result set cursor created by a searchSpecifications query with the scroll argument provided.

The response may contain a different cursor identifier, pointing to the next page of results.

The optional scroll argument allows to refresh the cursor duration, with a new time to live value.