List¶
Lists all activity entries associated with a specific object.
1 | |
The type of activity being performed (e.g., "share", "update", "assign").
actor : ( string | Identity )
Specifies the actor (user or system) performing the activity.
attachments : Array<( string | @type : ...
The type of attachment. Defaults to "file".
- "file": Represents a file attachment.
- "link": Represents a URL link.
- "video": Represents a video.
id : ...
The file ID of the attachment. )>
An array of attachments related to the activity. Attachments can be specified as
objectId : string
The ID of the object that the activity is related to. This is a required property.
objectType : string
The type of object that the activity is related to (e.g., "case", "customer"). This is a required property.
publishedAt : DateTimeOffset
The date and time when the activity occurred. Defaults to the current date and time.
targets : Array<@type : ( ... | ... | ... | ... )
Specifies the type of target audience. Defaults to "Identity".
- "Identity": Targets a specific user or group identity.
- "Everyone": Targets all authenticated users.
- "Members": Targets all members of a channel.
- "Public": Targets everyone, regardless of authentication status.
notify : ( ... | ... | ... )
Specifies whether a push notification should be sent to the target audience. Defaults to
targetId : string
The ID of the target identity, used when >
Target audience for the activity.>
Parameters¶
string objectId
The ID of the object for which to fetch activities.
( string | "null" ) objectType
The type of object (e.g., "case", "instance", "process", "version", "workitem"). Optional.
( string | "null" ) type
The type of activity to filter by (e.g., "share", "update", "assign"). Optional.
Returns¶
An array of ActivityEntry objects representing the activities.
Remarks¶
Listing activities¶
1 | |
See Also¶
- Array<
@type: string
The type of activity being performed (e.g., "share", "update", "assign").
actor : ( string | Identity )
Specifies the actor (user or system) performing the activity.
attachments : Array<( string | @type : ...
The type of attachment. Defaults to "file".
- "file": Represents a file attachment.
- "link": Represents a URL link.
- "video": Represents a video.
id : ...
The file ID of the attachment. )>
An array of attachments related to the activity. Attachments can be specified as
objectId : string
The ID of the object that the activity is related to. This is a required property.
objectType : string
The type of object that the activity is related to (e.g., "case", "customer"). This is a required property.
publishedAt : DateTimeOffset
The date and time when the activity occurred. Defaults to the current date and time.
targets : Array<@type : ( ... | ... | ... | ... )
Specifies the type of target audience. Defaults to "Identity".
- "Identity": Targets a specific user or group identity.
- "Everyone": Targets all authenticated users.
- "Members": Targets all members of a channel.
- "Public": Targets everyone, regardless of authentication status.
notify : ( ... | ... | ... )
Specifies whether a push notification should be sent to the target audience. Defaults to
targetId : string
The ID of the target identity, used when >
Target audience for the activity.> * ActivityEntry * ActivityEntryAttachment