PlantScanner - BEAS Service Layer icon

PlantScanner - BEAS Service Layer

Interact with BEAS Service Layer API

Actions32

Reservation → Get

AI-generated

Overview

This node interacts with the BEAS Service Layer API to retrieve a single Reservation record by its ID. It is useful in scenarios where you need to fetch detailed information about a specific reservation in a manufacturing or resource planning context. For example, you might use this node to get the status, details, or related entities of a reservation for further processing or reporting.

Use Case Examples

  1. Retrieve a reservation record by its unique ID to check its current status.
  2. Fetch specific fields of a reservation by using the 'Select' parameter to optimize data retrieval.
  3. Expand related entities of a reservation to get comprehensive details in one request.

Properties

Name Meaning
ID The unique identifier of the reservation record to retrieve. This is a required field for the 'Get' operation on the Reservation resource.
Select Comma-separated list of fields to include in the response. If left empty, all fields are returned. This helps in fetching only the necessary data.
Expand Comma-separated list of related entities to expand in the response. If left empty, no related entities are expanded. Useful for retrieving related data in a single request.

Output

JSON

  • json - The JSON response containing the reservation record data retrieved from the BEAS Service Layer API.

Dependencies

  • BEAS Service Layer API
  • An API key credential for authentication

Troubleshooting

  • Ensure the provided ID is valid and exists in the BEAS system; otherwise, the node will throw an error indicating the record was not found.
  • If the session cookie cannot be obtained during login, the node will fail with a 'Failed to get session cookie' error. Verify API credentials and service URL.
  • Invalid JSON in 'Select' or 'Expand' parameters may cause request failures; ensure these are properly formatted comma-separated strings.

Links

Discussion