Skip to main content

Interface: UpdateRequestOptions<T>

Defined in: service-core/src/routes/ModelRoute.ts:85

The set of options required by update request handlers.

Extends​

Type Parameters​

T​

T extends BaseEntity | SimpleEntity

Properties​

existing?​

optional existing?: T | null

Defined in: service-core/src/routes/ModelRoute.ts:87

The existing object that has already been recently pulled from the datasource.

ignoreACL?​

optional ignoreACL?: boolean

Defined in: service-core/src/models/RepoUtils.ts:39

Set to true to ignore the ACL permissions check.

Inherited from​

RequestOptions.ignoreACL

pushChannels?​

optional pushChannels?: string[]

Defined in: service-core/src/routes/ModelRoute.ts:89

An additional list of channel names to send push notifications to.

Overrides​

RequestOptions.pushChannels

recordEvent?​

optional recordEvent?: boolean

Defined in: service-core/src/models/RepoUtils.ts:43

Indicates if a telemetry event should be broadcast for the request.

Inherited from​

RequestOptions.recordEvent

req?​

optional req?: HttpRequest

Defined in: service-core/src/routes/ModelRoute.ts:25

The originating client request.

Inherited from​

RequestOptions.req

res?​

optional res?: HttpResponse

Defined in: service-core/src/routes/ModelRoute.ts:27

The outgoing client response.

Inherited from​

RequestOptions.res

skipPush?​

optional skipPush?: boolean

Defined in: service-core/src/routes/ModelRoute.ts:91

Set to true to not send a push notification.

Overrides​

RequestOptions.skipPush

transaction?​

optional transaction?: TransactionInfo

Defined in: service-core/src/models/RepoUtils.ts:47

The transactional session to execute the operation within.

Inherited from​

RequestOptions.transaction

user?​

optional user?: JWTUser

Defined in: service-core/src/models/RepoUtils.ts:49

The authenticated user making the request.

Inherited from​

RequestOptions.user

version?​

optional version?: string | number

Defined in: service-core/src/routes/ModelRoute.ts:93

The desired version number of the resource to update.