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:
## Sorting
The following properties can be used in the `orderBy` query parameter:
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 Name | Supported Operators | |
objectType | Equals (eq) | |
category | Equals (eq) |
Property Name | Description | |
id | Id of the event. |
Property Name | Description | |
categories | Categories of the events. |
Request
Supported Media Types
- application/json
Query Parameters
-
expand(optional): string
Comma-delimited string of field names that you want to expand. Use the value `all` to expand all relationships.
-
orderBy(optional): string
Comma-separated string of field names, each optionally followed by `:asc` or `:desc`, that specifies the order of items returned in the response.
-
q(optional): string
Filtering of the resources.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Events
Type:
object
List of Events.
Show Source
-
count(optional):
integer(int64)
Total number of resources in the response.Example:
10
-
hasMore(optional):
boolean
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(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int64)
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(optional):
array links
Link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
-
offset(optional):
integer(int64)
Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.Example:
0
-
totalResults(optional):
integer(int64)
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
-
Array of:
object Event
Event Information.
Nested Schema : links
Type:
array
Link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
Show Source
-
Array of:
object Link
REST link and related meta data. If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure.
Nested Schema : Event
Type:
object
Event Information.
Show Source
-
categories(optional):
array categories
categories of this event
-
displayName(optional):
string
The display key of the event.Example:
Created
-
id(optional):
integer(int32)
Id of the eventExample:
4032
-
name(optional):
string
Name of the eventExample:
DIGITALASSET_CREATED
-
objectType(optional):
string
Object type of the eventExample:
Digital Asset
Nested Schema : categories
Type:
array
categories of this event
Show Source
-
Array of:
object Category
Category Information.
Nested Schema : Category
Type:
object
Category Information.
Show Source
-
displayName(optional):
string
The display key of the category.Example:
Asset Lifecycle
-
id(optional):
integer(int32)
The id of the category.Example:
123456789
-
name(optional):
string
The name of the category.Example:
ASSET_LIFECYCLE
Nested Schema : Link
Type:
object
REST link and related meta data. If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure.
Show Source
-
href(optional):
string
The target resource URI. URI *RFC3986* or URI Template *RFC6570*. If the value is set to URI Template, then the `templated` property must be set to `true`.
-
mediaType(optional):
string
Link target. Media type, as defined by RFC 2046, describing the link target.
-
method(optional):
string
Link target HTTP method. HTTP method for requesting the target of the link. * `none` - Indicates no valid HTTP method * `OPTIONS` - HTTP OPTIONS * `HEAD` - HTTP HEAD * `GET` - HTTP GET * `POST` - HTTP POST * `PUT` - HTTP PUT * `PATCH` - HTTP PATCH * `DELETE` - HTTP DELETE
-
profile(optional):
string
Link meta data location. Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.
-
rel(optional):
string
Link relation. Name of the link relation that, in addition to the type property, can be used to retrieve link details.
-
templated(optional):
boolean
Link href template flag. Boolean flag that specifies the `href` property is a URI or URI Template. The property can be assumed to be `false` if the property is not present.
304 Response
Not Modified
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
-
detail(optional):
string
Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code.
-
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
-
title(optional):
string
Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
-
type(optional):
string
Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.
Nested Schema : o:errorDetails
Type:
array
Multiple errors can be organized in a hierarchical structure.
Show Source
-
Array of:
object 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
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
-
detail(optional):
string
Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code.
-
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
-
title(optional):
string
Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
-
type(optional):
string
Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.
Nested Schema : o:errorDetails
Type:
array
Multiple errors can be organized in a hierarchical structure.
Show Source
-
Array of:
object 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
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
-
detail(optional):
string
Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code.
-
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
-
title(optional):
string
Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
-
type(optional):
string
Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.
Nested Schema : o:errorDetails
Type:
array
Multiple errors can be organized in a hierarchical structure.
Show Source
-
Array of:
object 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
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
-
detail(optional):
string
Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code.
-
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
-
title(optional):
string
Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
-
type(optional):
string
Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.
Nested Schema : o:errorDetails
Type:
array
Multiple errors can be organized in a hierarchical structure.
Show Source
-
Array of:
object 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.