Skip to main content

EntityCollection Schema

Data structure for Entity Collection objects.

Item Type​

This is a collection (list) of Entity items.

Usage​

# Example: Working with EntityCollection
items = [
    {"deleted":true,"id":1,"name":"name-value-1"},
    {"deleted":true,"id":2,"name":"name-value-2"}
]

# Pass to an action that requires this collection type
resource.some_action(body=items)

JSON Example​

[
  {
    "deleted": true,
    "id": 1,
    "name": "name-value-1"
  },
  {
    "deleted": true,
    "id": 2,
    "name": "name-value-2"
  }
]