Skip to main content

Interface: IAuditableItemStreamListRequest

Get a list of the streams.

Properties

headers?

optional headers?: object

The headers which can be used to determine the response data type.

accept

accept: "application/json" | "application/ld+json"


query?

optional query?: object

The query parameters.

conditions?

optional conditions?: string

The conditions to filter the streams, JSON stringified EntityCondition<IAuditableItemStream>.

orderBy?

optional orderBy?: "dateCreated" | "dateModified"

The order for the results, default to created.

orderByDirection?

optional orderByDirection?: SortDirection

The direction for the order, defaults to desc.

properties?

optional properties?: string

The properties to return as a comma separated list, defaults to "id,object".

cursor?

optional cursor?: string

The optional cursor to get next chunk.

limit?

optional limit?: string

Limit the number of entities to return.