Global

Type Definitions

CommandResult

Source:
Properties:
Name Type Description
commandId string

The auto-generated unique id of the command.
response object | string

The response of the command. If a command is sent asynchronously, this will simply be the string "ack". In synchronous mode, this will usually be an object consisting of the primary key of the data that was affected by the command.
result object

Contains success flag and detailed error information when available.

Properties
Name Type Description
errors array

Will contain error information when appropriate.
ok array

Contains details of each successfully commited document.
Type:
  • object

DatasetData

Source:
Properties:
Name Type Description
metaData object

The dataset metadata (see nqmMeta option in getDatasetData).
metaDataUrl string

The URL to the dataset metadata (see nqmMeta option in getDatasetData.
data Array.<object>

The dataset documents.
Type:
  • object

FailureObject

Source:
Properties:
Name Type Description
code string

the TDX short error code, e.g. NotFound, PermissionDenied etc.
message string | array

details of the failure. For simple cases this will be a string, e.g. resource not found: KDiEI3k_. In other instances this will be an array of objects describing each error. See the example below showing a failed attempt to update 2 documents. One of the errors is a simple document not found and the other is a validation error giving details of the exact path in the document that failed validation.

Error information as received from the TDX

Type:
  • object

GetDataOptions

Source:
Properties:
Name Type Attributes Description
nqmMeta boolean <optional>

When set, the resource metadata will be returned along with the dataset data. Can be used to avoid a second call to getResource. Otherwise a URL to the metadata is provided.
limit number <optional>

Limit, the number of entries to get.
skip number <optional>

Skip, the number of entries to skip. Prefer to use filters if possible, instead of large skips, as they are slow on the TDX.
sort object <optional>

MongoDB Sort object. See https://docs.mongodb.com/manual/reference/method/cursor.sort/ for more information.

A mongodb options object. Can be used to limit, skip, sort etc. Note a default limit of 1000 is applied if none is given here.

Type:
  • object

Resource

Source:
Properties:
Name Type Description
description string
id string
name string
parents Array.<string>
schemaDefinition object
tags Array.<string>
Type:
  • object

ResourceAccess

Source:
Properties:
Name Type Description
aid string

account id that is the subject of this access
by string

comma-delimited list of attribution for this access
rid string

resource id to which this access refers
grp string

indicates the share mode (user groups only)
own string

account that owns the resource
par Array.<string>

the parent(s) of the resource
typ string

the base type of the resource
r Array.<string>

array of resource ids that are the source of read access (e.g. parent)
w Array.<string>

array of resource ids that are the source of write access
Type:
  • object

Zone

Source:
Properties:
Name Type Description
accountType string
displayName string
username string
Type:
  • object