Interface RawDataAPIResponse

The response format of a 2XX-status Data API call

interface RawDataAPIResponse {
    data?: Record<string, any>;
    errors?: DataAPIErrorDescriptor[];
    status?: Record<string, any>;
    warnings?: DataAPIWarningDescriptor[];
}

Index

Properties

data? errors? status? warnings?

Properties

`Optional` `Readonly` data

data?: Record<string, any>

Array of objects or null (Error)

`Optional` `Readonly` errors

errors?: DataAPIErrorDescriptor[]

Status objects, generally describe the side effects of commands, such as the number of updated or inserted documents.

`Optional` `Readonly` status

status?: Record<string, any>

A response data holding documents that were returned as the result of a command.

`Optional` `Readonly` warnings

warnings?: DataAPIWarningDescriptor[]

Array of objects or null (Error)