Collections List Object
Properties
| Name | Type | Description |
| total | integer | Total number of collections documents that matched your query. |
| collections | collection[] | List of collections. |
Examples
JSON
{
"total": 5,
"collections": {
"$id": "5e5ea5c16897e",
"$read": [
"role:all"
],
"$write": [
"user:608f9da25e7e1"
],
"name": "My Collection",
"enabled": false,
"permission": "document",
"attributes": [
{
"key": "isEnabled",
"type": "boolean",
"status": "available",
"required": true,
"array": false,
"default": false
},
{
"key": "count",
"type": "integer",
"status": "available",
"required": true,
"array": false,
"min": 1,
"max": 10,
"default": 10
},
{
"key": "percentageCompleted",
"type": "double",
"status": "available",
"required": true,
"array": false,
"min": 1.5,
"max": 10.5,
"default": 2.5
},
{
"key": "userEmail",
"type": "string",
"status": "available",
"required": true,
"array": false,
"format": "email",
"default": "default@example.com"
},
{
"key": "status",
"type": "string",
"status": "available",
"required": true,
"array": false,
"elements": [
"element"
],
"format": "enum",
"default": "element"
},
{
"key": "githubUrl",
"type": "string",
"status": "available",
"required": true,
"array": false,
"format": "url",
"default": "http:\/\/example.com"
},
{
"key": "ipAddress",
"type": "string",
"status": "available",
"required": true,
"array": false,
"format": "ip",
"default": "192.0.2.0"
},
{
"key": "fullName",
"type": "string",
"status": "available",
"required": true,
"array": false,
"size": 128,
"default": "default"
}
],
"indexes": {
"key": "index1",
"type": "primary",
"status": "available",
"attributes": [],
"orders": []
}
}
}