Get

🚧

New site!

All content has been migrated to docs.dash.org. You will be automatically redirected momentarily.

Usage: client.platform.documents.get(typeLocator, opts)
Description: This method will allow you to fetch back documents matching the provided parameters.

Parameters:

parameters	type	required	Description
typeLocator	string	yes	Field of a specific application, under the form appName.fieldName
opts	object	no (default: {})	Query options of the request

Queries options:

parameters	type	required	Description
where	array	no	Mongo-like where query
orderBy	array	no	Mongo-like orderBy query
limit	integer	no	how many objects to fetch
startAt	integer	no	number of objects to skip
startAfter	integer	no	exclusive skip

Learn more about query syntax.

Example:

JavaScript

   const queryOpts = {
         where: [
             ['normalizedLabel', '==', 'alice'],
             ['normalizedParentDomainName', '==', 'dash'],
         ],
     };
  await client.platform.documents.get('dpns.domain', queryOpts);