Get Document (Lookup) v1.0.0 Help ​

Retrieves a specified document from a Lookup collection.

How can I use the Step? ​

Use this Step when you need to fetch detailed information about specific documents within a collection, such as for content review, metadata assessment, or integration with other data-driven processes.

How does the Step work? ​

The Step requires the collection and the document names as inputs. It communicates with the Lookup system to retrieve the document, providing comprehensive details about the document, including its metadata and associated collection information.

Prerequisites ​

  • For custom authentication, ensure proper cross-account settings with Super Admin permission level for account and Flow and the necessary account ID or authentication token.

Input settings ​

  • Collection: a Lookup collection. Required.
  • Document: a document within the selected Lookup collection to retrieve. Required.

Cross-account settings ​

To access the Lookup service of another Onereach account, take these steps:

  1. Enable Use custom authentication token.
  2. Choose one of the following access types:
    • Authentication token
    • Account ID
  3. Enter the token or account ID (depending on the chosen access type).

Merge field settings ​

The Step returns the result as a JSON object and stores it under the Merge field name. To learn more about Merge fields and how to work with them, see our Merge fields guide.

Output example ​

The output object has the following properties:

  • id: [string] the id of the document.
  • collection: [string] the id of the collection that the document belongs to.
  • name: [string] the name of the document.
  • description: [string] the description of the document.
  • createdAt: [object] the timestamp when the document was created.
  • updatedAt: [object] the timestamp when the document was last updated.
  • countPassages: [number] the number of passages in the document.
  • status: [string] the status of the document.
json
{
  "id": "string",
  "collection": "string",
  "name": "string",
  "description": "string",
  "createdAt": {},
  "updatedAt": {},
  "countPassages": 1,
  "status": "string"
}
{
  "id": "string",
  "collection": "string",
  "name": "string",
  "description": "string",
  "createdAt": {},
  "updatedAt": {},
  "countPassages": 1,
  "status": "string"
}

Error handling ​

By default, the Step handles errors using a separate exit. So if any error occurs during the Step execution, the Flow proceeds down the error exit. For more information, see Error and timeout handling.

Reporting ​

The Step automatically generates Reporting events during its execution, allowing for real-time tracking and analysis of its performance and user interactions. To learn more, see Reporting events

Service dependencies ​

  • flow builder - v2.28.3
  • event-manager - v2.3.0
  • deployer - v2.6.0
  • library v2.11.3
  • studio v2.64.1

Release notes ​

v1.0.0

  • Initial release