Skip to main content
GET
Retrieves a single workbench resource by its ID

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

id
string<uuid>
required
Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Response

Represents a workbench resource.

id
string<uuid>

This workbench resource's unique ID.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

number
string

This workbench resource's unique number.

name
string

This workbench resource's name.

description
string

This workbench resource's description.

workbenchResourceTypeId
string<uuid>

The ID of the resource type assigned to this workbench resource.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

hostName
string

The name of the host assigned to this workbench resource.

warehouseId
string<uuid>

The ID of the warehouse assigned to this workbench resource.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

reservationMode
enum<integer>

The reservation mode of this workbench resource.

Available options:
0,
1,
2
autoShowProcessParameterValuesInProduction
boolean

Specifies whether the dialog for displaying and/or capturing process parameter values in the context of production should be displayed automatically when process parameter values can/must be displayed or captured.

expiredComponentsUsage
enum<integer>

Specifies whether and to what extent the use of expired components is permitted.

Available options:
0,
1
replenishmentCreationStockReservationMode
enum<integer>

Specifies wthether and how available stock should be reserved when creating a replenishment order.

Available options:
0,
1,
2