PlantScanner - BEAS Service Layer icon

PlantScanner - BEAS Service Layer

Interact with BEAS Service Layer API

Actions32

Resource → Get

AI-generated

Overview

This node interacts with the BEAS Service Layer API to retrieve a single record of the specified resource type. It is useful for scenarios where you need to fetch detailed information about a specific entity by its ID, such as retrieving a particular resource, work order, or item. For example, you can use it to get the details of a resource by providing its ID, optionally selecting specific fields and expanding related entities for more comprehensive data.

Use Case Examples

  1. Retrieve a resource record by its ID to display detailed information in a dashboard.
  2. Fetch a work order by ID to check its status and related components.
  3. Get an item record with selected fields and expanded related entities for inventory management.

Properties

Name Meaning
ID The unique identifier of the record to retrieve. This is required to specify which record to fetch.
Select Comma-separated list of fields to include in the response. If left empty, all fields are returned.
Expand Comma-separated list of related entities to expand in the response. If left empty, no related entities are expanded.

Output

JSON

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

Dependencies

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

Troubleshooting

  • Ensure the provided ID is valid and exists in the BEAS system; otherwise, the API will return an error.
  • Check that the service URL and service password credentials are correctly configured to obtain a session cookie for authentication.
  • If the 'Select' or 'Expand' parameters are incorrectly formatted, the API may return an error or incomplete data.
  • Common error messages include failure to get session cookie (authentication issue) and invalid JSON in parameters (for other operations). Verify input parameters and credentials to resolve these.

Discussion