PlantScanner - BEAS Service Layer icon

PlantScanner - BEAS Service Layer

Interact with BEAS Service Layer API

Actions32

Reservation → Get All

AI-generated

Overview

This node interacts with the BEAS Service Layer API to retrieve all reservation records based on optional OData query parameters. It supports filtering, sorting, pagination (skip and top), selecting specific fields, and expanding related entities. This is useful for scenarios where users need to fetch multiple reservation records with specific criteria, such as retrieving all open reservations created after a certain date or sorting reservations by creation date.

Use Case Examples

  1. Fetch all reservations with status 'Open' and creation date after '2024-03-20'.
  2. Retrieve the top 10 reservations sorted by creation date descending.
  3. Get all reservations but only select specific fields like ReservationID, Status, and CreationDate.
  4. Expand related entities such as WorkOrderLines or WorkOrderComponents for each reservation.

Properties

Name Meaning
Filters OData filter string to filter the reservations (e.g., Status eq 'Open' or CreationDate ge '2024-03-20').
Sort OData sort string to order the reservations (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 containing the list of reservation records retrieved from the BEAS Service Layer API.

Dependencies

  • BEAS Service Layer API
  • API authentication via service password to obtain session cookie

Troubleshooting

  • Failed to get session cookie: Ensure the service password is correct and the BEAS Service Layer API URL is reachable.
  • Invalid OData filter or sort string: Verify the syntax of the OData query parameters.
  • Invalid JSON in parameters (not applicable for Get All but relevant for other operations): Ensure JSON strings are properly formatted.
  • API request failures: Check network connectivity and API endpoint availability.

Discussion