DataSourceRequest

Request object for interacting with the API using a connection id

Request object for interacting with the API using a connection id.

Extends

• BaseDataSourceRequest<DataSourceRequestInput>

Constructors

Constructor

new DataSourceRequest(data): DataSourceRequest

Parameters

data

DataSourceRequestInput

Returns

DataSourceRequest

Inherited from

BaseDataSourceRequest<DataSourceRequestInput>.constructor

Methods

data()

data(): DataSourceRequestInput

Returns data encapsulated by the Request

Returns

DataSourceRequestInput

Inherited from

BaseDataSourceRequest.data

---

toJSON()

toJSON(): DataSourceRequestInput

Method to allow JSON serializers to only serialize the wrapped request data without serializing any of the Request object data

Returns

DataSourceRequestInput

See

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#description

Inherited from

BaseDataSourceRequest.toJSON

---

validate()

validate(): BWellTransactionResult<null, ValidationError>

Validate the request.

Returns

BWellTransactionResult<null, ValidationError>

a BWellTransactionResult describing any validation errors found

Inherited from

BaseDataSourceRequest.validate