onecore/ch.procivis.one.core/HistoryListQuery

HistoryListQuery

data class HistoryListQuery(var page: UInt, var pageSize: UInt, var sort: SortableHistoryColumn?, var sortDirection: SortDirection?, var organisationId: String, var entityIds: List<String>?, var entityTypes: List<HistoryEntityType>?, var actions: List<HistoryAction>?, var createdDateAfter: String?, var createdDateBefore: String?, var identifierId: String?, var credentialId: String?, var credentialSchemaId: String?, var proofId: String?, var proofSchemaId: String?, var trustCollectionId: String?, var search: HistorySearch?, var users: List<String>?)

Constructors

HistoryListQuery

constructor(page: UInt, pageSize: UInt, sort: SortableHistoryColumn?, sortDirection: SortDirection?, organisationId: String, entityIds: List<String>?, entityTypes: List<HistoryEntityType>?, actions: List<HistoryAction>?, createdDateAfter: String?, createdDateBefore: String?, identifierId: String?, credentialId: String?, credentialSchemaId: String?, proofId: String?, proofSchemaId: String?, trustCollectionId: String?, search: HistorySearch?, users: List<String>?)

Types

Companion

object Companion

Properties

actions

var actions: List<HistoryAction>?

Return only events of the specified action types.

createdDateAfter

var createdDateAfter: String?

Return only entries created after this time. Timestamp in RFC 3339 format (for example 2023-06-09T14:19:57.000Z).

createdDateBefore

var createdDateBefore: String?

Return only entries created before this time. Timestamp in RFC 3339 format (for example 2023-06-09T14:19:57.000Z).

credentialId

var credentialId: String?

Return only events associated with the provided credential ID.

credentialSchemaId

var credentialSchemaId: String?

Return only events associated with the provided credential schema ID.

entityIds

var entityIds: List<String>?

Return only events associated with the provided entity IDs.

entityTypes

var entityTypes: List<HistoryEntityType>?

Return only events associated with the provided entity types.

identifierId

var identifierId: String?

Return only events associated with the provided identifier ID.

organisationId

var organisationId: String

Specifies the organizational context for this operation.

page

var page: UInt

Page number to retrieve (0-based indexing).

pageSize

var pageSize: UInt

Number of items to return per page.

proofId

var proofId: String?

Return only events associated with the provided proof ID.

proofSchemaId

var proofSchemaId: String?

Return only events associated with the provided proof schema ID.

var search: HistorySearch?

Search history events by string. Set text to specify the search string and optionally type to restrict which field is searched. When type is omitted, all searchable fields are checked.

sort

var sort: SortableHistoryColumn?

Field value to sort results by.

sortDirection

var sortDirection: SortDirection?

Direction to sort results by.

trustCollectionId

var trustCollectionId: String?

Return only events associated with the provided trust collection D.

users

var users: List<String>?

Return only events triggered by the specified users.