Actions58
- Address Actions
- Agentslog Actions
- Appointment Actions
- E-Mail Actions
- Estate Actions
- File Actions
- Relation Actions
- Search Criterion Actions
- Setting Actions
- Task Actions
- Template Actions
Relation → Get
AI-generatedOverview
This node operation retrieves relation data from the onOffice system based on a specified relation type. It is useful for querying various types of relationships between entities such as estates, addresses, users, files, mails, projects, tasks, and more within the onOffice platform. For example, it can fetch buyers linked to estates, officers assigned to estates, files attached to estates, or contacts related to addresses.
Use Case Examples
- Retrieve all buyers related to a specific estate by specifying the relation type '[Estate & Address] Buyer' and providing parent IDs of estates.
- Get all files attached to an estate by selecting the relation type '[Estate & File] All Files' and specifying the estate's parent ID.
Properties
| Name | Meaning |
|---|---|
| Relation Type | The specific type of relation to query within the onOffice system, such as buyers, tenants, owners, officers, files, mails, and other categorized relations. This determines the nature of the linked data retrieved. |
| Parent IDs | An array of IDs to look for linked IDs on the other side (child IDs). If parent IDs are specified, child IDs must not be set. Comma-separated numbers. |
| Child IDs | An array of IDs to look for linked IDs on the other side (parent IDs). If child IDs are specified, parent IDs must not be set. Comma-separated numbers. |
Output
JSON
relationData- The retrieved relation data based on the specified relation type and IDs.
Dependencies
- An API key credential for onOffice API authentication.
Troubleshooting
- Ensure that only one of 'Parent IDs' or 'Child IDs' is specified, not both, to avoid parameter conflicts.
- Verify that the selected relation type matches the intended query to get accurate results.
- Check API credentials and permissions if the node fails to retrieve data.
- Common error messages may include invalid relation type or unauthorized access, which can be resolved by selecting a valid relation type and ensuring proper API authentication.