latestOpenAPI 3.0.32026-08-10119559584.8 KB

6d091bc86a33

Activities

Returns activities matching the given search criteria.

Returns activities matching the given search criteria.Only parameters that are specified in this request and have not <code>null</code> values are used for filtering.All other parameters are ignored.The returned activities satisfy all constraints that are specified in this search criteria.By default a result containing 100 activities is returned.

get/activities

Query parameters

offsetinteger

The first result to retrieve. If not set (offset = <code>0</code>), results will be retrieved starting from row <code>0</code>.

limitinteger

The maximum number of results to retrieve. If not set (limit = <code>0</code>), the default limit will be used. The maximum allowed limit is 1000.

countLimitinteger

Parameter not used in the context of activities, for performance reasons they are not counted.

taskIdstring uuid

The ID of the task which contains the basic find activities request.

contextIdstring uuid

The ID of the context which the activities should be searched for.

involvedPeopleIdsstring[]

The list of IDs of the people that should be involved in searched activities.

involvedRoleIdsstring[]

The list of IDs of the roles that should be involved in searched activities.

performedByUserIdstring uuid

The ID of the user who performed searched activities.

performedByRoleIdsstring[]

The list of IDs of the roles assigned to users who performed searched activities.

activityType'ADD' | 'UPDATE' | 'DELETE'

The type of the activity.

callIdstring

The ID of the call.

categoriesstring[]

The set of the categories of activities that should be searched. One of [ATTRIBUTE, ATTACHMENT, RELATION, COMMENT,<br/>STATUS, WORKFLOW, RESPONSIBILITY, USER, USER_GROUP, ROLE, TAGS, OTHERS].

resourceTypesstring[]

The set of the resource types that searched activities refer to, i.e. [Community, Asset, Domain, Attribute,<br/>Relation, WorkflowInstance]. This parameter is deprecated. Use resourceDiscriminators instead.

resourceDiscriminatorsstring[]

The set of the resource discriminators that searched activities refer to, i.e. [Community, Asset, Domain, Attribute,<br/> Relation, WorkflowInstance].

startDateinteger

The start date of the searched activities, expressed as a Unix timestamp in milliseconds.

endDateinteger

The end date of the searched activities, expressed as a Unix timestamp in milliseconds.

callCountEnabledboolean

Flag to indicate if the number of calls standing behind the activity should be returned or not.<br/>Note that by default that count will be not calculated as it brings an important performance penalty.

Response

The paged response with found Activity information. The total number of results is not calculated and should be ignored