SDK PHP v3.x

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

getSpecifications #

Retrieves the specifications linked to the collection object.

getSpecifications([options], callback) #

Arguments Type Description
options JSON Object Optional parameters
callback function Callback handling the response

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true

Usage #

Copied to clipboard!
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
$dataCollection = $kuzzle->collection('collection', 'index');
try {
  $specifications = $dataCollection->getSpecifications();
catch (ErrorException $e) {

Callback response

Copied to clipboard!
  "validation": {
    "strict": "true",
    "fields": {
      "foo": {
        "mandatory": "true",
        "type": "string",
        "defaultValue": "bar"
  "index": "index",
  "collection": "collection"