List Event Types

get

/system/api/v1/events/types

List event types filtered on properties such as objectType of the event. As there may potentially be a large number of events results can be requested in pages. ## Authorization All logged-in users can search types. ## Filters The following properties are filterable and can be used in the `q` parameter:
Property NameSupported Operators
objectTypeEquals (eq)
categoryEquals (eq)
## Sorting The following properties can be used in the `orderBy` query parameter:
Property NameDescription
idId of the event.
The default sorting is ascending order. The Id field is sorted in ascending order. ## Expansion The following relationships can be used in the `expand` query parameter (a value of `all` will expand all these relationships):
Property NameDescription
categoriesCategories of the events.

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Events
Type: object
List of Events.
Show Source
  • Total number of resources in the response.
    Example: 10
  • Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.
    Example: true
  • items
    Singular resources contained in the collection.
  • Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.
    Example: 10
  • links
  • Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.
    Example: 0
  • Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the `totalResults` parameter is supported and is set to `true` by the client.
    Example: 10
Nested Schema : items
Type: array
Singular resources contained in the collection.
Show Source
Nested Schema : Event
Type: object
Event Information.
Show Source
Nested Schema : categories
Type: array
categories of this event
Show Source
Nested Schema : Category
Type: object
Category Information.
Show Source

304 Response

Not Modified
Body ()
Root Schema : ExceptionDetail
Type: object
Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.
Show Source
Nested Schema : o:errorDetails
Type: array
Multiple errors can be organized in a hierarchical structure.
Show Source
  • ExceptionDetail
    Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

400 Response

Bad Request
Body ()
Root Schema : ExceptionDetail
Type: object
Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.
Show Source
Nested Schema : o:errorDetails
Type: array
Multiple errors can be organized in a hierarchical structure.
Show Source
  • ExceptionDetail
    Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

404 Response

Not Found
Body ()
Root Schema : ExceptionDetail
Type: object
Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.
Show Source
Nested Schema : o:errorDetails
Type: array
Multiple errors can be organized in a hierarchical structure.
Show Source
  • ExceptionDetail
    Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

500 Response

Internal Server Error
Body ()
Root Schema : ExceptionDetail
Type: object
Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.
Show Source
Nested Schema : o:errorDetails
Type: array
Multiple errors can be organized in a hierarchical structure.
Show Source
  • ExceptionDetail
    Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.
Back to Top