Viridem icon

Viridem

Interact's with Viridem

Actions77

Fields → List Field

AI-generated

Overview

This node operation lists fields associated with a specified company in the Viridem system. It supports filtering by keywords and pagination options, making it useful for retrieving manageable chunks of field data for a company. Typical use cases include fetching field metadata for display, processing, or integration with other systems.

Use Case Examples

  1. Retrieve the first page of fields for a company with ID 123, showing 15 fields per page.
  2. Search for fields containing specific keywords within a company and paginate through the results.

Properties

Name Meaning
Company Id The unique identifier of the company whose fields are to be listed.
Keywords Optional search keywords to filter the fields by name or other attributes.
Page The page number of results to retrieve, used for pagination.
Per Page The number of fields to return per page, controlling the size of each paginated result set.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and request timeout.

Output

JSON

  • fields - An array of field objects returned from the API, representing the fields associated with the specified company.
  • pagination
    • page - The current page number of the results.
    • per_page - The number of fields returned per page.
    • total - The total number of fields available for the company.

Dependencies

  • Viridem OAuth2 API credential for authentication

Troubleshooting

  • Ensure the Company Id is valid and the user has access rights to the company's data to avoid authorization errors.
  • If no fields are returned, verify that the keywords filter is correct or try removing it to get all fields.
  • Timeout errors may occur if the server is slow or unresponsive; increase the timeout setting in Request Options if needed.
  • SSL certificate errors can be bypassed by enabling the 'Ignore SSL Issues' option, but use this with caution as it reduces security.

Discussion