Properties
| NAME | TYPE | DESCRIPTION |
key | string | Attribute Key. |
type | string | Attribute type. |
status | string | Attribute status. Possible values: |
error | string | Error message. Displays error generated on failure of creating or deleting an attribute. |
required | boolean | Is attribute required? |
array | boolean | Is attribute an array? |
$createdAt | string | Attribute creation date in ISO 8601 format. |
$updatedAt | string | Attribute update date in ISO 8601 format. |
relatedCollection | string | The ID of the related collection. |
relationType | string | The type of the relationship. |
twoWay | boolean | Is the relationship two-way? |
twoWayKey | string | The key of the two-way relationship. |
onDelete | string | How deleting the parent document will propagate to child documents. |
side | string | Whether this is the parent or child side of the relationship |
Example
JSON
{
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"relatedCollection": "collection",
"relationType": "oneToOne|oneToMany|manyToOne|manyToMany",
"twoWay": false,
"twoWayKey": "string",
"onDelete": "restrict|cascade|setNull",
"side": "parent|child"
}
JSON
{
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"_createdAt": "2020-10-15T06:38:00.000+00:00",
"_updatedAt": "2020-10-15T06:38:00.000+00:00",
"relatedCollection": "collection",
"relationType": "oneToOne|oneToMany|manyToOne|manyToMany",
"twoWay": false,
"twoWayKey": "string",
"onDelete": "restrict|cascade|setNull",
"side": "parent|child"
}