Event Defaults Collection

Description

A collection of event defaults objects.

Properties

Property Description
items

A collection of resources returned in the current result set.

Property Description
created

The creation date of this event defaults object.

id

The identifier for this event defaults object.

isDefault

Whether this is marked as the default event defaults.

links required read-only

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.

name

A descriptive name for these event defaults settings.

type

The type of object represented.

links required read-only

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.

meta read-only

Metadata describing the current result set.

Property Description
currentPage

The current page of results returned.

rows

The number of rows returned per page for the current result set.

totalItems

The total number of items in the result set. This may be affected by active search/filter parameters.

totalPages

The total number of pages in the result set. This is affected by the rows parameter (totalItems / rows == totalPages).

type

The model type for the list response object.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A collection of event defaults objects.",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "description": "An event defaults object as viewed from a collection.",
        "properties": {
          "created": {
            "description": "The creation date of this event defaults object.",
            "format": "date-time",
            "type": "string"
          },
          "id": {
            "description": "The identifier for this event defaults object.",
            "type": "integer"
          },
          "isDefault": {
            "description": "Whether this is marked as the default event defaults.",
            "type": "boolean"
          },
          "links": {
            "$ref": "#/components/schemas/Links"
          },
          "name": {
            "description": "A descriptive name for these event defaults settings.",
            "type": "string"
          },
          "type": {
            "description": "The type of object represented.",
            "enum": [
              "event-defaults"
            ],
            "type": "string"
          }
        },
        "required": [
          "type",
          "links",
          "id",
          "name",
          "isDefault",
          "created"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "meta": {
      "description": "Metadata describing the current result set.",
      "properties": {
        "currentPage": {
          "description": "The current page of results returned.",
          "type": "integer"
        },
        "rows": {
          "description": "The number of rows returned per page for the current result set.",
          "type": "integer"
        },
        "totalItems": {
          "description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
          "type": "integer"
        },
        "totalPages": {
          "description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
          "type": "integer"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "type": {
      "description": "The model type for the list response object.",
      "enum": [
        "event-defaults-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Event Defaults Collection",
  "type": "object"
}