Search

Setup Specs 1.6.1

Integration Guide
Core Services
- ID Builder
  - 3.6
  - 3.5
- Deviation Processor
  - 1.10
  - 1.9
  - 1.8
- Multitenant Access Control
  - 1.34.0
  - 1.33.0
  - 1.32.0
- Notification Service
  - 1.27
  - 1.26
- Ticket Management
  - 7.17.1
  - 7.17.0
  - 7.16.0
- Web Portal
  - 5.21
  - 5.20
- Block Management
Shopfloor Management
- Global Production Overview
  - 5.8
  - 5.7
  - 5.6
- Shopfloor Management Essentials
Machine & Equipment
- Condition Monitoring
  - 4.6.0
  - 4.5.1
  - 4.5.0
  - 4.4.1
  - 4.4.0
- Tool Management
  - 2.9
  - 2.8
  - 2.7
- Maintenance Management
Product & Quality
- Product Setup Management
  - 3.10
  - 3.8
- Part Traceability
- Process Quality
- Setup Specs
Execution
- Line Control
- Material Management
  - 3.9
  - 3.8
  - 3.7
- Order Management
  - 5.9
  - 5.8
  - 5.7
Intralogistics
- Transport- & Stockmanagement
  - 4.2.0
  - 4.0.2
Machine & Equipment
- Condition Monitoring
  - 4.6.0
  - 4.5.1
  - 4.5.0
  - 4.4.1
  - 4.4.0
- Maintenance Management
Enterprise & Shopfloor Integration
- Archiving Bridge
- ERP Connectivity
  - 4.12.0
  - 4.11.0
  - 4.10.0
- Data Publisher
- Information Router
- Master Data Management
  - 8.5.1
  - 8.5.0
  - 8.4.2
  - 8.4.1
  - 8.4.0
- Orchestrator

Scopes

Scopes can be used in Setup Specs to define different database sources in the Web-UI and to switch on runtime between these database sources. All rest service calls have therefore a dedicated scope header parameter to define the database source by setting the scope id in the header.

Example: Setting the Scope-ID in the header

To set the Scope-ID in the header for the GET URL /setup/v1/{tenant-id}/areas, you can use the following example. This URL does not require any parameters besides the tenant-id, but if the Scope-ID is set in the header, the data will be fetched from the corresponding database instead of the default database defined in the helm chart.

Request

GET /setup/v1/\{tenant-id}/areas HTTP/1.1
Host: example.com
Scope-ID: 0947D655-AFD7-43DD-A92E-BFCAAC8845DF

Example with cURL

curl -X GET "https://example.com/setup/v1/1991B3AD-A83D-4893-B7E5-ABF2575800B8/areas" -H "Scope-ID: 0947D655-AFD7-43DD-A92E-BFCAAC8845DF"