onecore/ch.procivis.one.core/CredentialListQuery

CredentialListQuery

data class CredentialListQuery(var page: UInt, var pageSize: UInt, var sort: SortableCredentialColumn?, var sortDirection: SortDirection?, var organisationId: String, var name: String?, var profiles: List<String>?, var searchText: String?, var searchType: List<CredentialListQuerySearchType>?, var exact: List<CredentialListQueryExactColumn>?, var roles: List<CredentialRole>?, var ids: List<String>?, var states: List<CredentialState>?, var include: List<CredentialListIncludeEntityType>?, var credentialSchemaIds: List<String>?, var createdDateAfter: String?, var createdDateBefore: String?, var lastModifiedAfter: String?, var lastModifiedBefore: String?, var issuanceDateAfter: String?, var issuanceDateBefore: String?, var revocationDateAfter: String?, var revocationDateBefore: String?)

Constructors

CredentialListQuery

constructor(page: UInt, pageSize: UInt, sort: SortableCredentialColumn?, sortDirection: SortDirection?, organisationId: String, name: String?, profiles: List<String>?, searchText: String?, searchType: List<CredentialListQuerySearchType>?, exact: List<CredentialListQueryExactColumn>?, roles: List<CredentialRole>?, ids: List<String>?, states: List<CredentialState>?, include: List<CredentialListIncludeEntityType>?, credentialSchemaIds: List<String>?, createdDateAfter: String?, createdDateBefore: String?, lastModifiedAfter: String?, lastModifiedBefore: String?, issuanceDateAfter: String?, issuanceDateBefore: String?, revocationDateAfter: String?, revocationDateBefore: String?)

Types

Companion

object Companion

Properties

createdDateAfter

var createdDateAfter: String?

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

createdDateBefore

var createdDateBefore: String?

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

credentialSchemaIds

var credentialSchemaIds: List<String>?

Return only credentials with the specified credential schema(s).

exact

var exact: List<CredentialListQueryExactColumn>?

Set which filters apply in an exact way.

ids

var ids: List<String>?

Filter by one or more UUIDs.

include

var include: List<CredentialListIncludeEntityType>?

Additional fields to include in response objects. Omitting this keeps responses shorter.

issuanceDateAfter

var issuanceDateAfter: String?

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

issuanceDateBefore

var issuanceDateBefore: String?

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

lastModifiedAfter

var lastModifiedAfter: String?

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

lastModifiedBefore

var lastModifiedBefore: String?

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

name

var name: String?

Return only credentials with a name starting with this string.

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.

profiles

var profiles: List<String>?

Filter by one or more country profiles.

revocationDateAfter

var revocationDateAfter: String?

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

revocationDateBefore

var revocationDateBefore: String?

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

roles

var roles: List<CredentialRole>?

Filter credentials by one or more roles: issued by the system, verified by the system, or held by the system as a wallet.

searchText

var searchText: String?

Search for a string.

searchType

var searchType: List<CredentialListQuerySearchType>?

Changes where searchText is searched. Choose one or more searchTypes and pass a searchText.

sort

var sort: SortableCredentialColumn?

Field value to sort results by.

sortDirection

var sortDirection: SortDirection?

Direction to sort results by.

states

var states: List<CredentialState>?

Filter by one or more credential states.