onOffice icon

onOffice

onOffice custom node for n8n

Search Criterion → Read

AI-generated

Overview

This node reads search criteria from the onOffice system based on specified modes and IDs. It supports different modes such as internal, external, search criteria, and filter, allowing users to retrieve specific search criteria records by providing comma-separated IDs. It also supports pagination and sorting options to control the number of records returned and their order. This node is useful for workflows that need to fetch and process search criteria data from onOffice, such as filtering real estate listings or managing search configurations.

Use Case Examples

  1. Retrieve specific search criteria by providing their IDs in internal mode.
  2. Fetch a paginated list of search criteria with sorting by a specific field in ascending order.

Properties

Name Meaning
Mode Type of transmitted IDs, determining the mode of reading search criteria (internal, external, searchcriteria, filter).
IDs Comma-separated list of IDs to specify which search criteria to read, applicable in internal, external, and searchcriteria modes.
Additional Options Additional parameters to control the list output, including list limit (max 500), list offset for pagination, sort by field, and sort order (ascending or descending).

Output

JSON

  • searchCriteria
    • id - Unique identifier of the search criterion.
    • name - Name of the search criterion.
    • description - Description of the search criterion.
    • mode - Mode type used for the search criterion.
    • createdAt - Timestamp when the search criterion was created.
    • updatedAt - Timestamp when the search criterion was last updated.

Dependencies

  • Requires an API key credential for onOffice API authentication.

Troubleshooting

  • Ensure the provided IDs are valid and correspond to existing search criteria in the onOffice system.
  • Check that the API key credential is correctly configured and has the necessary permissions.
  • If pagination parameters are used, verify that the list limit does not exceed the maximum allowed (500).
  • Common error messages may include authentication failures, invalid ID format, or exceeding API rate limits. Resolving these involves verifying credentials, input formats, and adhering to API usage policies.

Discussion