Search Activities
get
/system/api/v1/auditlog/activities
Search activities with filters for objectCategory, objectID, variationSetID etc. As there may be a large number of activity results that can be requested on pages.
## Authorization
All logged-in users can search activities.
## Filters
The following properties are filterable and can be used in the `q` parameter:
By Default, objectType or eventCategory or eventName filter is required. If objectType or eventCategory or eventName is not set in the request, then request will be rejected.The objectType, eventName and objectId filters only accepts one or more values with 'and' as the operator.For example, to list all activities with object type either as "Digital Asset" or "Content Item", the filter criteria to use is : /system/api/v1/auditlog/activities?q=objectType eq Digital Asset and objectType eq Content Item. For data range filter, registeredAt filter is expected to have From(ge) and To(le) range.
## Sorting
The following properties can be used in the `orderBy` query parameter:
The default sorting is descending order. The registeredAt field is sorted in descending order.
## Expansion
The following relationships can be used in the `expand` query parameter (a value of `all` will expand all these relationships):
## Links
A successful response will include one or more of the following links:
| Property Name | Supported Operators | |
| objectType | Equals (eq) | |
| eventCategory | Equals (eq) | |
| eventName | Equals (eq) | |
| variationSetId | Equals (eq) | |
| objectId | Equals(eq) | |
| registeredAt | Greater than or equal to(ge) and Less than or equal to(le) | |
| activityDetails.{path-to-element} | Equals (eq) |
| Property Name | Description | |
| registeredAt | Date and time at which the activity was registered. |
| Property Name | Description | |
| activityDetails | Activity details which is processed for the object. | |
| activityBy | User that performed the activity. |
| Link Relationship | Description | |
| self | Describes the current returned representation of the resource. | |
| prev | Describes the previous page of results, if a previous page exists. | |
| next | Describes the next page of results, if a next page exists. |
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.
-
limit(optional): integer(int64)
A positive integer value specifies the maximum number of items returned in the response.
-
offset(optional): integer(int64)
Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at `0`. The default offset is `0`, which returns all items starting from the first item in the collection.
-
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 : Activities
Type:
objectList of Activities.
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:
arraySingular resources contained in the collection.
Show Source
-
Array of:
object Activity
Activity Information.
Nested Schema : links
Type:
arrayLink 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 : Activity
Type:
objectActivity Information.
Show Source
-
activityDetails(optional):
object activityDetails
Additional Properties Allowed: additionalPropertiesHolds the processed details for the activity.
-
entity(optional):
object entity
Additional Properties Allowed: IdNameThe primary object(s) in the event which has triggered this activity
-
event(optional):
object Activity Event
Activity Event Information.
-
id(optional):
string
The unique activity id.Example:
12233335454545 -
initiatedBy(optional):
object User
User Metadata Model.
-
registeredAt(optional):
string
Date and time at which the activity was registered. Date and time values are in ISO 8601 `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'` format using a UTC timezone.Example:
2019-01-01T10:00:11.842Z
Nested Schema : activityDetails
Type:
objectAdditional Properties Allowed
Show Source
Holds the processed details for the activity.
Nested Schema : entity
Type:
objectAdditional Properties Allowed
Show Source
The primary object(s) in the event which has triggered this activity
Example:
{"asset": {"id": "FC7F4C73571ACD99DECA99D9T0000ASEDVFV123456789","name": "My Asset Name","variationSetId": "FC7F4C73571ACD99DECA99D9T000012121","version": "v0.1","language": "en-US","type": "simpleType1"}}Nested Schema : Activity Event
Type:
objectActivity Event Information.
Show Source
-
categories(optional):
array categories
The categories of the event.
-
name(optional):
string
The name of the event.Example:
DIGITALASSET_CREATED
Nested Schema : User
Type:
objectUser Metadata Model.
Show Source
-
displayName(optional):
string
The display name of the user.Example:
My Display Name -
id(optional):
string
The id of the user.Example:
10002 -
name(optional):
string
The name of the user.Example:
example@myorg.com
Nested Schema : additionalProperties
Type:
objectNested Schema : IdName
Type:
Show Source
object-
id(optional):
string
The id of the entity.Example:
FC7F4C73571ACD99DECA99D9T0000DEFAULT00000000 -
name(optional):
string
The name of the entity.Example:
My Name
Nested Schema : categories
Type:
arrayThe categories of the event.
Show Source
-
Array of:
object Category
Category Information.
Nested Schema : Category
Type:
objectCategory 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:
objectREST 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:
objectError 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:
arrayMultiple 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:
objectError 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:
arrayMultiple 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:
objectError 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:
arrayMultiple 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:
objectError 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:
arrayMultiple 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.
Examples
The objectType, eventName, and objectId filters only accepts one or more values with 'and' as the operator. For example, to list all activities with object type either as "Digital Asset" or "Content Item", the filter criteria to use is: /system/api/v1/auditlog/activities?q=objectType eq Digital Asset and objectType eq Content Item .
The following example shows search activities for objectType, objectId, and eventName, etc filters:
curl -X GET -H 'Accept: application/json' 'https://host:port/system/api/v1/auditlog/activities'
Example 1:
This lists all activities with object type as Digital Asset.
/system/api/v1/auditlog/activities?q=objectType eq Digital Asset
Response Body
{
"hasMore": true,
"offset": 0,
"count": 1,
"limit": 100,
"totalResults": 1,
"items": [
{
"id": "1588",
"event": {
"name": "DIGITALASSET_REFERENCED",
"categories": [
{
"id": 3002,
"name": "ASSET_LIFECYCLE"
}
]
},
"entity": {
"digitalasset": {
"variationSetId": null,
"version": null,
"language": null,
"type": null,
"id": "CONT291BD3BCBB2A4CC5AF05BE6209B924BD",
"name": "DAM_ocicecsuser1005.jpg"
}
},
"message": {
"key": "cec.event.digitalasset.referenced.name",
"parameters": [
"DAM_ocicecsuser1005.jpg"
],
"text": "Digital Asset Item DAM_ocicecsuser1005.jpg was referenced by item {1}."
},
"registeredAt": "2021-09-06T05:02:48.196Z"
}
]
}
Example 2:
/system/api/v1/auditlog/activities?q=objectType eq Digital Asset and activityDetails.objectId
eq CONT6A620DAAD7CD4F62938451CC0489C329
This lists all activities with object type as Digital Asset and objectId equal to CONT6A620DAAD7CD4F62938451CC0489C329.
Response Body
{
"hasMore": false,
"offset": 0,
"count": 1,
"limit": 100,
"totalResults": 1,
"items": [
{
"id": "1206",
"event": {
"name": "DIGITALASSET_UPDATED",
"categories": [
{
"id": 3002,
"name": "ASSET_LIFECYCLE"
}
]
},
"entity": {
"digitalasset": {
"variationSetId": "F64C015A288D34D2E053020011ACE84E",
"version": "0.2",
"language": "en-GB",
"type": "File",
"id": "CONT6A620DAAD7CD4F62938451CC0489C329",
"name": "asset.pdf"
}
},
"message": {
"key": "cec.event.digitalasset.updated.name",
"parameters": null,
"text": null
},
"registeredAt": "2023-03-10T02:25:59.161Z"
}
]
}
Example 3:
/system/api/v1/auditlog/activities?q=objectType eq Digital Asset and registeredAt ge
2022-01-02T07:14:34.888Z and registeredAt le 2023-02-05T07:14:34.888Z4
This lists all activities with object type as Digital Asset and date and time at which the activity was registered.
Response Body
{
"hasMore": true,
"offset": 0,
"count": 1,
"limit": 100,
"totalResults": 1,
"items": [
{
"id": "2524",
"event": {
"name": "DIGITALASSET_REFERENCED",
"categories": [
{
"id": 3002,
"name": "ASSET_LIFECYCLE"
}
]
},
"entity": {
"digitalasset": {
"variationSetId": null,
"version": null,
"language": null,
"type": null,
"id": "CONT8B3C157F1B5E4990BD8867B5BBCC1DCB",
"name": "DAM_ocicecsuser1005_Jul1_18.jpg"
}
},
"message": {
"key": "cec.event.digitalasset.referenced.name",
"parameters": [
"DAM_ocicecsuser1005_Jul1_18.jpg"
],
"text": "Digital Asset Item DAM_ocicecsuser1005_Jul1_18.jpg was referenced by item {1}."
},
"registeredAt": "2019-09-06T05:21:34.552Z"
}
]
}
Example 4:
/system/api/v1/auditlog/activities?q=eventName eq DIGITALASSET_CREATED and eventName eq
DIGITALASSET_UPDATED
This lists all activities whose event name is DIGITALASSET_CREATED and DIGITALASSET_UPDATED.
Response Body
{
"hasMore": false,
"offset": 0,
"count": 2,
"limit": 100,
"totalResults": 2,
"items": [
{
"id": "1207",
"event": {
"name": "DIGITALASSET_UPDATED",
"categories": [
{
"id": 3002,
"name": "ASSET_LIFECYCLE"
}
]
},
"entity": {
"digitalasset": {
"variationSetId": "F64C015A288D34D2E053020011ACE84E",
"version": "0.3",
"language": "en-GB",
"type": "File",
"id": "CONT6A620DAAD7CD4F62938451CC0489C329",
"name": "asset.pdf"
}
},
"message": {
"key": "cec.event.digitalasset.updated.name",
"parameters": null,
"text": null
},
"registeredAt": "2023-03-10T02:26:17.730Z"
},
{
"id": "1202",
"event": {
"name": "DIGITALASSET_CREATED",
"categories": [
{
"id": 3002,
"name": "ASSET_LIFECYCLE"
}
]
},
"entity": {
"digitalasset": {
"variationSetId": "F64C015A288D34D2E053020011ACE84E",
"version": "0.1",
"language": "en-GB",
"type": "File",
"id": "CONT6A620DAAD7CD4F62938451CC0489C329",
"name": "asset1.pdf"
}
},
"message": {
"key": "cec.event.digitalasset.created.name",
"parameters": null,
"text": null
},
"registeredAt": "2023-03-07T08:14:49.207Z"
}
]
}