@serenity-is/corelib / RetrieveRequest

Interface: RetrieveRequest

Defined in: src/base/servicetypes.ts:238

Request DTO for Retrieve handlers (single-entity fetch).

Extends

• ServiceRequest

Properties

ColumnSelection?

optional ColumnSelection: RetrieveColumnSelection

Defined in: src/base/servicetypes.ts:242

Preset that controls which columns are returned. See RetrieveColumnSelection.

---

EntityId?

optional EntityId: any

Defined in: src/base/servicetypes.ts:240

Primary key of the entity to retrieve.

---

ExcludeColumns?

optional ExcludeColumns: string[]

Defined in: src/base/servicetypes.ts:246

Explicit deny-list of columns to exclude.

---

IncludeColumns?

optional IncludeColumns: string[]

Defined in: src/base/servicetypes.ts:244

Explicit allow-list of columns to include.