Skip to main content

CustomOptionsCollection Schema

Data structure for Custom Options Collection objects.

Item Type​

This is a collection (list) of CustomOptions items.

Usage​

# Example: Working with CustomOptionsCollection
items = [
    {"code":"code-value-1","name":"name-value-1","type":"type-value-1","value":[]},
    {"code":"code-value-2","name":"name-value-2","type":"type-value-2","value":[]}
]

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

JSON Example​

[
  {
    "code": "code-value-1",
    "name": "name-value-1",
    "type": "type-value-1",
    "value": []
  },
  {
    "code": "code-value-2",
    "name": "name-value-2",
    "type": "type-value-2",
    "value": []
  }
]