Skip to main content

Interface: IStartOperationRequest

nexus.v1.IStartOperationRequest

Properties of a StartOperationRequest.

Implemented by​

Properties​

callback​

• Optional callback: null | string

Callback URL to call upon completion if the started operation is async.

callbackHeader​

• Optional callbackHeader: null | { [k: string]: string; }

Header that is expected to be attached to the callback request when the operation completes.

• Optional links: null | ILink[]

Links contain caller information and can be attached to the operations started by the handler.

operation​

• Optional operation: null | string

Type of operation to start.

payload​

• Optional payload: null | IPayload

Full request body from the incoming HTTP request.

requestId​

• Optional requestId: null | string

A request ID that can be used as an idempotentency key.

service​

• Optional service: null | string

Name of service to start the operation in.