Viridem icon

Viridem

Interact's with Viridem

Actions77

Document Anchors → Get By Id Document Anchor

AI-generated

Overview

This node operation retrieves a specific Document Anchor by its ID within a given company. It is useful for scenarios where detailed information about a particular document anchor is needed, such as fetching metadata or external data fields associated with the document anchor. For example, a user might want to get the details of a document anchor to display or process it further in a workflow.

Use Case Examples

  1. Retrieve a document anchor by its ID to display its details in a dashboard.
  2. Fetch a document anchor's external data fields for integration with another system.

Properties

Name Meaning
Company Id The unique identifier of the company to which the document anchor belongs.
Document Anchor Id The unique identifier of the document anchor to retrieve.
Include Fields External Data Whether to include external data fields related to the document anchor in the response.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings.

Output

JSON

  • documentAnchorId - The unique identifier of the retrieved document anchor.
  • companyId - The company identifier associated with the document anchor.
  • fieldsExternalData - External data fields included in the document anchor if requested.
  • otherProperties - Additional properties of the document anchor returned by the API.

Dependencies

  • An API key credential for authentication to the Viridem API

Troubleshooting

  • Ensure the Company Id and Document Anchor Id are correct and exist in the system to avoid 'not found' errors.
  • If 'Include Fields External Data' is set to true, verify that the external data fields exist and are accessible.
  • Check network settings such as proxy and SSL options if requests fail due to connectivity or certificate issues.
  • Timeout errors can occur if the server is slow to respond; adjust the timeout setting accordingly.

Discussion