PlantScanner - BEAS Service Layer icon

PlantScanner - BEAS Service Layer

Interact with BEAS Service Layer API

Actions32

Resource → Get All

AI-generated

Overview

This node interacts with the BEAS Service Layer API to retrieve all records of the 'Resource' type. It supports filtering, sorting, pagination, field selection, and expansion of related entities using OData query parameters. This is useful for scenarios where users need to fetch multiple resource records with specific criteria, such as filtering resources by status or sorting them by creation date.

Use Case Examples

  1. Retrieve all resources with status 'Active' and sort them by creation date descending.
  2. Fetch the first 10 resources, skipping the first 5, and select only the ResourceID and Description fields.
  3. Get all resources and expand related entities like ResourceDetails.

Properties

Name Meaning
Filters OData filter string to filter the records, e.g., Status eq 'Open' or CreationDate ge '2024-03-20'.
Sort OData sort string to order the records, e.g., CreationDate desc or Status asc.
Skip Number of records to skip for pagination.
Top Maximum number of records to return.
Select Comma-separated list of fields to select in the response. Leave empty to get all fields.
Expand Comma-separated list of related entities to expand in the response. Leave empty for no expansion.

Output

JSON

  • json - The JSON response data from the BEAS Service Layer API containing the list of 'Resource' records matching the query parameters.

Dependencies

  • Requires BEAS Service Layer API credentials including the service URL and service password for authentication.

Troubleshooting

  • If the node fails with 'Failed to get session cookie', check the service URL and service password credentials.
  • Invalid JSON errors may occur if the input parameters for body or patch operations are malformed, but this is not applicable for 'Get All' operation.
  • Ensure the OData filter and sort strings are correctly formatted to avoid API errors.
  • If no records are returned, verify the filter criteria and pagination parameters.

Discussion