Delete Document (Lookup) v1.0.0 Help ​

Removes a document from the specified Lookup collection.

How can I use the Step? ​

Use this Step to remove an individual document from a Lookup collection. It's useful for content management, especially when certain documents are outdated, irrelevant, or were added incorrectly.

How does the Step work? ​

The Step verifies and then deletes the specified document from the Lookup system, handling validations, timeouts, and errors for a smooth deletion process.

Warning

Deleting a document is permanent and irretrievable.

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 delete. 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 deleted document.
  • createdAt: [string] the timestamp that indicates when the document was created.
  • updatedAt: [string] the timestamp that indicates when the document was last updated.
  • countPassages: [number] the number of passages in the deleted document.
  • collection: [array] an array of objects representing the collection to which the document belongs. Each object has two properties:
    • beacon: [string] a unique identifier or locator for the collection within a specific system or database.
    • href: [string] the href value of the collection, valid for direct access or reference.
  • description: [string] the document description.
  • name: [string] the name of the document.
  • properties: [array] an array of properties assotiated with deleted document
  • status: [string] the status of the document.

Example:

json
{
  "id": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "countPassages": 0,
  "collection": [
    {
      "beacon": "string",
      "href": "string"
    }
  ],
  "description": "string",
  "name": "string",
  "properties": [],
  "status": "string"
}
{
  "id": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "countPassages": 0,
  "collection": [
    {
      "beacon": "string",
      "href": "string"
    }
  ],
  "description": "string",
  "name": "string",
  "properties": [],
  "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