Skip to main content

EntityResponseCollection Schema

Data structure for Entity Response Collection objects.

Item Type​

This is a collection (list) of EntityResponse items.

Usage​

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

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

JSON Example​

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