FORCE Bridge API Documentation

You can find a thorough definition of the entire API here:

API Definition

Application Development Kits

An application development kit (ADK) for Java is available, which can be downloaded here: Download FORCE Bridge ADK for Java (Link coming soon).

Use Swagger Hub to generate ADKs for many languages.

The specific languages can be chosen in the menu item Generate Client.

However, the automatically generated ADK does not support the dynamic embedding mechanism. This must be implemented manually in the generated ADK afterwards.

Table of Contents

• 1. Introduction
  • 1.1. Technical Base Knowledge
    • 1.1.1. Explorable API
    • 1.1.2. Revisioning
    • 1.1.3. HTTP Requests
    • 1.1.4. HTTP Status Codes
    • 1.1.5. Authentication
  • 1.2. How to Use FORCE Bridge API
    • 1.2.1. How to Request OAuth Token
    • 1.2.2. How to Send POST Requests
• 2. FORCE Bridge API as a Digital Image of a Production Sites
  • 2.1. Basic Concepts and Objects in Manufacturing
    • 2.1.1. Entities from the Field of Manufacturing
    • 2.1.2. The Digital Image in FORCE Bridge API
    • 2.1.3. Using the Application Development Kit
    • 2.1.4. Tutorials
  • 2.2. Shifts and Scheduled Operating Times of Workplaces
    • 2.2.1. Domain-Specific Knowledge
    • 2.2.2. The Digital Image in FORCE Bridge API
    • 2.2.3. Tutorials
  • 2.3. Operation Sequences and Dates of a Production Order
    • 2.3.1. Domain-Specific Knowledge
    • 2.3.2. The Digital Image in FORCE Bridge API
    • 2.3.3. Tutorials
  • 2.4. Sub-Resources of Operations Including Information from the Routing
    • 2.4.1. Tutorials
  • 2.5. Machine and Plant Data Collection and their Performance Indicators
    • 2.5.1. Domain-Specific Knowledge
    • 2.5.2. The Digital Image in FORCE Bridge API
    • 2.5.3. Tutorials
• 3. FORCE Bridge as an Integration Platform
  • 3.1. Applications for Manufacturing Operations Management (MOM)
  • 3.2. Events and Callbacks
    • 3.2.1. Callbacks
    • 3.2.2. Event Types
    • 3.2.3. Receiving Events
    • 3.2.4. Sending Self-Defined Events to Applications or Third Party Systems
  • 3.3. Dynamic Scheduling
• 4. Appendix
  • 4.1. Formulas
    • 4.1.1. Durations
    • 4.1.2. Key Performance Indicators
  • 4.2. Glossary

Todo

Implement using workplaces/{workplaceId}/recordedOperationPhases

(The original entry is located in docs/basics/tutorials/examples05.rst, line 137.)

Todo

Implement example calculating the OEE for both operation and workplace!

(The original entry is located in docs/basics/tutorials/examples05.rst, line 245.)