Download OpenAPI specification:Download
This is the online documentation of FORCE Bridge API. It lists all resources and the related access methods provided by FORCE Bridge API, including call parameters, request and response messages.
read) | deviceName | string The name of the device (e.g. S7 1212C DC), which could also be an abstract device (e.g. Welding 247) |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| physicalQuantity | string The physical quantity that is measured at a device |
Collection of devices found.
Collection of devices not found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
Received subservice error.
read) | deviceId required | string UUID of a device |
Device found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the device for the given deviceId parameter.
Internal server error
Received subservice error.
read) | deviceId required | string UUID of a device |
Device location found.
If no location could be found for the given device id. | Workplace not found for the given device.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the device for the given deviceId parameter.
Internal server error
Received subservice error.
A filtered list of recorded time series is returned. Call parameters allow filtering according to a specific time period. If the device is the programmable logic controller of a machine or a virtual device that combines several programmable logic controllers of a machine, the time series represent the recorded process parameters. In this case, it is also possible to filter according to a specific operation that was executed on the machine.
read) | deviceId required | string UUID of a device |
| endDate | string <date-time> The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| materialNumber | string Unique Material number of a material produced. To use the filter, the device must be assigned to a workplace and an operation must have produced the material at this workplace within the considered time period |
| operationNumber | string Unique Operation number of an executed operation. To use the filter, the device must be assigned to a workplace and the specified operation must have been executed at this workplace within the considered time period |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| productionOrderNumber | string Unique Production Order number of an executed production order. To use the filter, the device must be assigned to a workplace and an operation of the specified production order must have been executed at this workplace within the considered period |
| startDate | string <date-time> Default: "Beginning of the current week" The start date of the considered period |
| tag required | integer <int64> Tag for a specific variable or process parameter |
| workplaceId | string UUID of the workplace. |
Recorded time series of a device, found.
Unable to find the device time series for the given deviceId parameter.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
Received subservice error.
Request details for the file repository.
read) File repository found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
A filtered collection of documents is returned. Call parameters allow for filtering by search terms.
read) | embed | Array of string Names of embeddable resources to be embedded |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
Documents found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
Documents can be, for example, setting parameters, assembly instructions or assembly sketches. In the case of production with NC machines, documents are NC programs that must be transferred to the machine in order to execute an operation. The transmission of the NC programs to the machines is done by the distributed numerical control (DNC) function of the IoT Platform. Every transfer to the machine and every return transfer from the machine is documented. An NC program optimized on the machine is also automatically versioned.
read) | documentId required | string UUID of a document |
| embed | Array of string Names of embeddable resources to be embedded |
Document found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the document for the given documentId parameter.
Internal server error
write) | documentId required | string UUID of a document |
Document deleted.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the document for the given documentId parameter.
Internal server error
read) | documentId required | string UUID of a document |
File found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the document for the given documentId parameter.
Internal server error
Upload the file belonging to a newly created document or update an existing document by uploading a modified file. The document is automatically versioned.
write) | documentId required | string UUID of a document |
| editor required | string Name of the editor |
| fileName required | string Document name in the repository |
| file required | string <binary> File to upload |
Document uploaded.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the document for the given documentId parameter.
Internal server error
A filtered collection of folders is returned. Call parameters allow for filtering by keywords, such as material numbers and operation numbers, in order to find the production folder belonging to an operation.
read) | embed | Array of string Names of embeddable resources to be embedded |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| materialNumber | string If the folder is a production folder that contains the documents for the production of a particular material, you can specify this material here |
| name | string Name of the production folder |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| workplaceNumber | string If the folder is a production folder, and the production documents only apply to a specific workplace, you can specify this workplace here |
Folder found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
The file storage can be used for any documents; typically the production folders with documents from the Product Lifecycle Management system (PLM system) are stored there.
write) | name | string Name of the folder |
| creator | string Person or application that created the folder |
| workplaceId | string UUID of the associated workplace |
| materialNumber | string Number of the associated material |
Folder created.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
A folder is used to group together several documents that belong together. Usually, these are production folders that contain all the documents that are required to execute an operation.
read) | folderId required | string UUID of a folder |
| embed | Array of string Names of embeddable resources to be embedded |
Folder found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the folder for the given folderId parameter.
Internal server error
write) | folderId required | string UUID of a folder |
Folder deleted.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the folder for the given folderId parameter.
Internal server error
read) | folderId required | string UUID of a folder |
| embed | Array of string Names of embeddable resources to be embedded |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
Documents found
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find folder for the given folderId parameter.
Internal server error
write) | folderId required | string UUID of a folder |
| creator | string Person or application that created the document |
| origin | string Enum:"CREATED_INTERNALLY" "CREATED_EXTERNALLY" "OPTIMIZED_AT_THE_MACHINE" "CREATED_AT_THE_MACHINE" Origin of the document, which is either externally created, internally created at the machine or optimized at the machine |
| type | string Type of the document |
Document created.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the folder for the given folderId parameter.
Internal server error
Retrieve the top level resources of FORCE Bridge API.
read) Entry point found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
A filtered collection of callbacks is returned.
read) | limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Callbacks found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
Creates a callback, which corresponds to the registration for a particular event. At least the event type and, for an HTTP callback, the URL to be called respectively a topic for an MQTT callback must be specified. Third party systems that have their own HTTP server can be informed about events via HTTP, whereas MQTT is much more suitable for simple applications, especially those that are executed on mobile devices.
write) | objectFilter | Array of object (callbackObjectFilter) Array of filtering criteria provided by the corresponding domain object |
| eventType required | string Enum:"COMMAND" "SHOP_FLOOR_TERMINAL" "INTERNAL" "OPERATION_CREATED" "OPERATION_UPDATED" "OPERATION_DELETED" "PRODUCTION_ORDER_CREATED" "PRODUCTION_ORDER_DELETED" "PRODUCTION_ORDER_UPDATED" "WORKPLACE_CREATED" "WORKPLACE_DELETED" "WORKPLACE_UPDATED" "STAFF_MEMBER_CREATED" "STAFF_MEMBER_DELETED" "STAFF_MEMBER_UPDATED" "WORKPLACE_SHIFTS_UPDATED" "SCHEDULED_MAINTENANCE_CREATED" "SCHEDULED_MAINTENANCE_DELETED" "SCHEDULED_MAINTENANCE_UPDATED" "OPERATION_FORECAST_RESULT_CREATED" "OPERATION_FORECAST_RESULT_UPDATED" "OPERATION_FORECAST_RESULT_DELETED" "OPERATION_PLANNING_RESULT_CREATED" "OPERATION_PLANNING_RESULT_DELETED" "OPERATION_PLANNING_RESULT_UPDATED" "STAFF_MEMBER_PLANNING_RESULT_CREATED" "STAFF_MEMBER_PLANNING_RESULT_DELETED" "STAFF_MEMBER_PLANNING_RESULT_UPDATED" "PREDICTED_MALFUNCTION_SCENARIO_CREATED" "OBSOLETE_OPERATION_FORECAST_RESULTS" "OBSOLETE_PREDICTED_MALFUNCTION_SCENARIOS" "OPERATION_PLANNING_SCENARIO_CREATED" "STAFF_MEMBER_PLANNING_SCENARIO_CREATED" "OPERATION_PHASE_CHANGED" "WORKPLACE_STAFF_MEMBER_SIGNED_OFF" "WORKPLACE_SHIFT_CHANGED" "OBSOLETE_OPERATION_PLANNING_SCENARIOS" "WORKPLACE_GROUP_MANUFACTURING_VARIANT_RULE_CREATED" "WORKPLACE_GROUP_MANUFACTURING_VARIANT_RULE_UPDATED" "WORKPLACE_GROUP_SETUP_TRANSITION_RULE_CREATED" "WORKPLACE_GROUP_SETUP_TRANSITION_RULE_UPDATED" Event type for which callbacks shall be sent |
| eventName | string Event name for which callbacks shall be sent |
| url required | string URL to be called |
| maxRedeliveryAttempts | integer <int32> Maximum number of redeliver attempts |
| maxUnconfirmedMessages | integer <int32> Maximum number of unconfirmed messages |
Callback created.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
Callbacks are calls directed to interfaces of applications and third party systems that are executed by the IoT platform in response to an event. In order to be notified of a specific event by callback, an application or third party system must first have registered for that event. A new callback is generated with each registration. Both HTTP and MQTT are supported for callbacks. In the case of an HTTP callback, the URL to be called, that is, the fully qualified URI of the external Web service, is returned. In the case of an MQTT callback, the topic for which the subscriber has registered is returned. In both cases, the name and type of the event that triggers the callback is returned.
read) | uuid required | string UUID of a callback |
Callback found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the callback for the given callbackId parameter.
Internal server error
Callbacks are calls directed to interfaces of applications and third party systems that are executed by the IoT platform in response to an event. In order to be notified of a specific event by callback, an application or third party system must first have registered for that event. A new callback is generated with each registration. In order to delete the registration, the callback must be deleted.
write) | uuid required | string UUID of a callback |
Callback deleted.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the callback for the given callbackId parameter.
Internal server error
This POST method allows for informing about a specific event. Any application registered for the corresponding callback will be notified of the event.
write) | data | object |
| eventName | string The name of the event |
| eventType | string Enum:"COMMAND" "SHOP_FLOOR_TERMINAL" "INTERNAL" "OPERATION_CREATED" "OPERATION_UPDATED" "OPERATION_DELETED" "PRODUCTION_ORDER_CREATED" "PRODUCTION_ORDER_DELETED" "PRODUCTION_ORDER_UPDATED" "WORKPLACE_CREATED" "WORKPLACE_DELETED" "WORKPLACE_UPDATED" "STAFF_MEMBER_CREATED" "STAFF_MEMBER_DELETED" "STAFF_MEMBER_UPDATED" "WORKPLACE_SHIFTS_UPDATED" "SCHEDULED_MAINTENANCE_CREATED" "SCHEDULED_MAINTENANCE_DELETED" "SCHEDULED_MAINTENANCE_UPDATED" "OPERATION_FORECAST_RESULT_CREATED" "OPERATION_FORECAST_RESULT_UPDATED" "OPERATION_FORECAST_RESULT_DELETED" "OPERATION_PLANNING_RESULT_CREATED" "OPERATION_PLANNING_RESULT_DELETED" "OPERATION_PLANNING_RESULT_UPDATED" "STAFF_MEMBER_PLANNING_RESULT_CREATED" "STAFF_MEMBER_PLANNING_RESULT_DELETED" "STAFF_MEMBER_PLANNING_RESULT_UPDATED" "PREDICTED_MALFUNCTION_SCENARIO_CREATED" "OBSOLETE_OPERATION_FORECAST_RESULTS" "OBSOLETE_PREDICTED_MALFUNCTION_SCENARIOS" "OPERATION_PLANNING_SCENARIO_CREATED" "STAFF_MEMBER_PLANNING_SCENARIO_CREATED" "OPERATION_PHASE_CHANGED" "WORKPLACE_STAFF_MEMBER_SIGNED_OFF" "WORKPLACE_SHIFT_CHANGED" "OBSOLETE_OPERATION_PLANNING_SCENARIOS" "WORKPLACE_GROUP_MANUFACTURING_VARIANT_RULE_CREATED" "WORKPLACE_GROUP_MANUFACTURING_VARIANT_RULE_UPDATED" "WORKPLACE_GROUP_SETUP_TRANSITION_RULE_CREATED" "WORKPLACE_GROUP_SETUP_TRANSITION_RULE_UPDATED" The type of the event |
| objectId | string |
| objectType | string Enum:"OPERATION" "PRODUCTION_ORDER" "WORKPLACE" "WORKPLACE_GROUP" "STAFF_MEMBER" "TOOL" "MACHINE" "PREDICTED_MALFUNCTION_SCENARIO" "OPERATION_PLANNING_SCENARIO" "STAFF_MEMBER_PLANNING_SCENARIO" "PLANNED_MAINTENANCE" "SHIFTS" |
| timestamp | string <date-time> The timestamp when the event occured |
Created
Event accepted.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
read) Master data found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
read) | limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Document states collection found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
The state of a document can be NEW, WAITING_FOR_RELEASE, RELEASED or LOCKED. If the document is an numerical control (NC) program, it can also be in the CHECKED_OUT_FOR_PROCESSING state if it is currently being executed on a machine.
read) | documentStateId required | string Enum:"LOCKED" "CHECKED_OUT_FOR_PROCESSING" "RELEASED" "NEW" "WAITING_FOR_RELEASE" UUID of a document state |
Document state found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find document state for the given documentStateId parameter.
Internal server error
read) | limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Operating state classes collection found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
Operating state classes represent an arbitrary classification of operating states.
read) | operatingStateClassId required | string UUID of an operating state class |
| embed | Array of string Names of embeddable resources to be embedded |
Operating state class found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find operating state class for the given operatingStateClassId parameter.
Internal server error
read) | embed | Array of string Names of embeddable resources to be embedded |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| operatingStateClassId | string UUID of an operating state class |
| timeBase | string Enum:"PRODUCTION" "SETUP" "SCHEDULED_OPERATING_TIME" "MAINTENANCE" "MALFUNCTION" "SCHEDULED_DOWNTIME" Time base to be filtered for |
| workplaceStateId | string Enum:"DOWNTIME" "PRODUCTION" ID of a workplace state |
Operating states collection found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
Operating states can be arbitrarily defined in any production site and assigned to one or more of the following time bases: SCHEDULED_OPERATING_TIME, PRODUCTION, SETUP, MALFUNCTION and MAINTENANCE. The assignment of the operating states to these time bases determines the calculation of various key performance indicators.
read) | operatingStateId required | string UUID of an operating state |
| embed | Array of string Names of embeddable resources to be embedded |
Operating state found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find operating state for the given operatingStateId parameter.
Internal server error
read) | limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Operation phases collection found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
An operation usually runs through the phases RELEASED, DISPATCHED, SETUP, PROCESSING, COMPLETED and CLOSED. In the meantime, an operation can also be INTERRUPTED once or several times. In individual cases, further phases may be defined for specific machines.
read) | operationPhaseId required | string Enum:"RELEASED" "COMPLETED" "SETUP" "PROCESSING" "DISPATCHED" "TRAINING" "CLOSED" "INTERRUPTED" "WAITING_BEFORE_PROCESSING" "WAITING_AFTER_PROCESSING" UUID of an operation phase |
| embed | Array of string Names of embeddable resources to be embedded |
Operation phase found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find an operation phase for the given operationPhaseId parameter.
Internal server error
read) | code | string The code assigned to the quality detail |
| embed | Array of string Names of embeddable resources to be embedded |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| qualityTypeId | string Enum:"YIELD" "SCRAP" "REWORK" ID of the corresponding quality type |
Quality detail collection found.
Invalid qualityTypeId provided.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
The quality details are used to describe the quality types YIELD, SCRAP and REWORK more precisely or to justify the assignment to one of these quality types.
read) | qualityDetailId required | string UUID of a quality detail |
| embed | Array of string Names of embeddable resources to be embedded |
Quality details found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find quality detail for the given qualityDetailId parameter.
Internal server error
read) | embed | Array of string Names of embeddable resources to be embedded |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Quality type collection found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
The quality type classifies the output quantity of a workplace into YIELD, SCRAP or REWORK. Among other things, this qualification is used to determine the quality rate.
read) | qualityTypeId required | string Enum:"YIELD" "SCRAP" "REWORK" ID of a quality type |
| embed | Array of string Names of embeddable resources to be embedded |
Quality type found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the quality type for the given qualityTypeId parameter.
Internal server error
read) | embed | Array of string Names of embeddable resources to be embedded |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Shift types collection found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
There are usually different types of shifts, such as early shift, late shift, and night shift in a three-shift operation.
read) | shiftTypeId required | string UUID of a shift type |
| embed | Array of string Names of embeddable resources to be embedded |
Shift type found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find shift type for the given shiftTypeId parameter.
Internal server error
read) | limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Skill collection found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
Skills are various qualifications that different staff members may have and that are required to execute certain operations.
read) | skillId required | string UUID of a skill |
Skill found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the skill for the given skillId parameter.
Internal server error
read) | limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Tool assembly order collection found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
The state of a tool assembly order can be INITIATED, ASSEMBLED, PRESET, RELEASED or COMPLETED.
read) | toolAssemblyOrderStateId required | string Enum:"REQUESTED" "INITIATED" "ASSEMBLED" "PRESETTING" "RELEASED" "UNAVAILABLE" UUID of a tool assembly order state |
| embed | Array of string Names of embeddable resources to be embedded |
Tool assembly state found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find tool assembly state for the given toolAssemblyOrderStateId parameter.
Internal server error
read) | limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Workplace states collection found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
The workplace state indicates whether a workplace is either in PRODUCTION or in DOWNTIME. The workplace state can thus be regarded as a dual classification of the much more detailed operating state of a workplace.
read) | workplaceStateId required | string Enum:"DOWNTIME" "PRODUCTION" UUID of a workplace state |
| embed | Array of string Names of embeddable resources to be embedded |
Workplace state found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find workplace state for the given workplaceStateId parameter.
Internal server error
read) | erpSystem | string Identifier for a specific ERP system |
| identifier1 | string Identifier for a specific company code in an ERP system |
| identifier2 | string Identifier for a specific client code in an ERP system |
| identifier3 | string Identifier for a specific plant in an ERP system |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| type | string Enum:"PLANT" "PERSONNEL_AREA" ERP context type |
ERP contexts found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
By assigning a Universally Unique Identifier (UUID) to each entity in an IoT platform, all operations, production orders and workplaces can be uniquely identified in a technical manner. In contrast, a domain-oriented identification of the different entities can be very complicated. Even the order number or the combination of order number and order split is by no means unique. Not only can different production orders have the same number in two different ERP systems, but the same order number can also refer to different production orders in different contexts within an ERP system. As an additional specification for an order number or workplace number, the ERP context describes the context in an ERP system within which this is unique.
read) | erpContextId required | string UUID of an ERP context |
ERP context found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the ERP context for the given erpContextId parameter.
Internal server error
The collection of literals used to describe entities of the IoT platform is returned in all available languages.
read) | identifier1 | string The first literal identifier |
| identifier2 | string The second literal identifier |
| identifier3 | string The third literal identifier |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| type | string Enum:"AUTO" "BUTTON" "ERROR" "GENERIC" "LABEL" "MENU" "MESSAGE" "TITLE" "TOOLTIP" "QUESTION" The literal type |
Literals found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
A list of translations of the literal is returned in all available languages.
read) | literalId required | string UUID of a literal |
Literal found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the literal for the given literalId parameter.
Internal server error
A filtered collection of operations is returned.
Various call parameters enable filtering, for example, according to currently processed operations, plannable operations and dispatched operations or operations carried out in a specific time period. The completed or closed operations are those that are not plannable, are not dispatched and are not currently processed. This means that all these three call parameters must be set to false in order to retrieve only the operations that have already been completed. When calling up the operations filtered according to whatever criteria, it is also always possible to embed most of the sub-resources. This is done using the call parameter embed, for example embed=specification.
read) | embed | Array of string Names of embeddable resources to be embedded |
| endDate | string <date-time> Operations with a later start date are excluded. The start timestamp of an operation is either the actual start date (COMPLETED, CLOSED, PROCESSING, SETUP) or the planned start date (DISPATCHED) or the scheduled start date (RELEASED), depending on the operation phase. |
| isDispatched | boolean If set to true, the operationPhaseId is 'DISPATCHED' |
| isInProgress | boolean If set to true, the operationPhaseId is 'DISPATCHED' |
| isPlannable | boolean If set to true, only plannable operations are returned |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| materialNumber | string Unique Material number of the material produced by the operation |
| operationNumber | string Unique operation number within the ERP system |
| operationPhaseId | string Enum:"RELEASED" "COMPLETED" "SETUP" "PROCESSING" "DISPATCHED" "TRAINING" "CLOSED" "INTERRUPTED" "WAITING_BEFORE_PROCESSING" "WAITING_AFTER_PROCESSING" ID of an operation phase |
| operationSplit | string Split number of the operation |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationIdentifier | string Identifier used for pagination |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| productionOrderId | string UUID of the corresponding production order |
| productionOrderNumber | string Unique Production Order number of the corresponding production order |
| productionOrderSplit | string Split number of the corresponding production order split |
| startDate | string <date-time> Operations with an earlier end date are excluded. The end timestamp of an operation is either the actual end date (COMPLETED, CLOSED) or the planned end date (DISPATCHED) or the scheduled end date (RELEASED), depending on the operation phase. For running operations (PROCESSING, SETUP), the assumed end date is the end of time. |
| workplaceId | string UUID of the workplace at which the operation is or has been executed for operations in the SETUP, PROCESSING, COMPLETED and CLOSED phases. For operations in the DISPATCHED phase, it is the number of the planned workplace. For operations in the RELEASED phase, it is the number of the target workplace |
| workplaceNumber | string Unique Workplace number at which the operation is or has been executed for operations in the SETUP, PROCESSING, COMPLETED and CLOSED phases. For operations in the DISPATCHED phase, it is the number of the planned workplace. For operations in the RELEASED phase, it is the number of the target workplace. |
Collection of operations found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
A filtered collection of operations is returned.
A large number of parameters that can be passed allow filtering according to various criteria. For example, a large number of order numbers can be filtered. In addition, it is possible to filter by operations that are currently being processed, operations that can be planned, and operations that are dispatched or carried out in a specific time period. In contrast to the GET method, the POST method allows the transfer of filter combinations of any length.
write) | embed | Array of string Names of embeddable resources to be embedded |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationIdentifier | string Identifier used for pagination |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| endDate | string <date-time> Operations with a later start date are excluded. The start date of an operation is either the actual start date or the planned start date or the scheduled start date, depending on the operation phase |
| erpContextIds | Array of string UUID of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant |
| isDispatched | boolean True if the operationPhaseId is 'DISPATCHED' |
| isInProgress | boolean |
| isPlannable | boolean “true” or “false”. An operation is plannable if the operation phase is either RELEASED or DISPATCHED and the plannedStartDate is out-side the frozen zone. If no frozen zone has been defined, the first condition is sufficient. If there is an operation block, e.g. in joint production, only the leading operation of the operation block is planned. This means that all operations for which a block number has been defined and which are not themselves leading operations cannot be planned separately |
| materialNumbers | Array of string The material number of the material produced by the operation |
| operationIds | Array of string |
| operationNumbers | Array of string The operation number |
| operationSplits | Array of string The split number of the operation |
| phaseIds | Array of string Items Enum:"RELEASED" "COMPLETED" "SETUP" "PROCESSING" "DISPATCHED" "TRAINING" "CLOSED" "INTERRUPTED" "WAITING_BEFORE_PROCESSING" "WAITING_AFTER_PROCESSING" The identifier of the current operation phase of the operation |
| plannedWorkplaceIds | Array of string |
| plannedWorkplaceNumbers | Array of string The number of the planned workplace that is defined in detailed scheduling and dispatching |
| productionOrderIds | Array of string UUID of an order |
| productionOrderNumbers | Array of string The order number of the corresponding production order |
| productionOrderSplits | Array of string The split number of the corresponding production order split |
| startDate | string <date-time> Operations with an earlier end date are excluded. The end date of an operation is either the actual end date or the planned end date or the scheduled end date, depending on the operation phase (default value: beginning of the current week) |
| targetWorkplaceIds | Array of string |
| targetWorkplaceNumbers | Array of string The number of the target workplace specified by the ERP system |
| workplaceIds | Array of string |
| workplaceNumbers | Array of string The number of the workplace at which the operation is or has been executed for operations in the SETUP, PROCESSING, COMPLETED and CLOSED phases. For operations in the DISPATCHED phase, it is the number of the planned workplace. For operations in the RELEASED phase, it is the number of the target workplace |
Operations found.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
Information is returned for domain-specific identification of the operation and about its current phase.
In addition, the workplace on which the operation is currently being executed is also specified for an operation in progress. Furthermore, most sub-resources of the operation can be embedded.
read) | operationId required | string UUID of an operation |
| embed | Array of string Names of embeddable resources to be embedded |
Operation found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find operation for the given operationId parameter.
Internal server error
read) | operationId required | string UUID of an operation |
Alternative workplaces found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the operation for the given operationId parameter.
Internal server error
A list of components is returned. These components are specified in the routing of the ERP system and are needed to perform the operation.
read) | operationId required | string UUID of an operation |
| embed | Array of string Names of embeddable resources to be embedded |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Components found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the operation for the given operationId parameter.
Internal server error
read) | operationId required | string UUID of an operation |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Manufacturing variants found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find operation for the given operationId parameter.
Internal server error
read) | operationId required | string UUID of an operation |
Material characteristics found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the operation for the given operationId parameter.
Internal server error
The total duration and frequency of the operating states that have occurred are returned. Furthermore execution time, processing time, production time and setup time are summed up and key performance indicators setup reduction and process availability are calculated. The production time is the sum of the durations of all operating states assigned to the PRODUCTION time base. The setup time is the sum of the durations of all operating states assigned to the SETUP time base. Note: The setup time is not necessarily identical to the duration of the setup phase, because operating states that are assigned to the time base SETUP can also occur during the processing phase (e. g. intermediate setup). If such operating states occur during the processing phase, the setup time is longer than the duration of the setup phase and the processing time is shorter than the duration of the processing phase. For further information, please refer to the documentation at https://docs.forcebridge.io/index.html. A definition of the key figures can be found at https://docs.forcebridge.io/appendix/index.html
read) | operationId required | string UUID of an operation |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| operatingStateClassId | string UUID of an operating state class |
| timeBase | string Enum:"PRODUCTION" "SETUP" "SCHEDULED_OPERATING_TIME" "MAINTENANCE" "MALFUNCTION" "SCHEDULED_DOWNTIME" Time base to be filtered for |
| workplaceStateId | string Enum:"DOWNTIME" "PRODUCTION" ID of a workplace state |
Operating state summary found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the operation for the given operationId parameter.
Internal server error
A list of production resources and tools is returned.
These production resources and tools are specified in the routing of the ERP system and are needed to perform the operation.
read) | operationId required | string UUID of an operation |
| embed | Array of string Names of embeddable resources to be embedded |
| group | string Production resource and tool group |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| type | string Type of a production resource |
Production resources and tools found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the operation for the given operationId parameter.
Internal server error
A list of output quantities is returned. All output quantities are summarized according to yield, scrap and rework quantity and the production time used for this is returned. In contrast to the specification, which provides the target durations and quantities, the actual durations and quantities are found here. In addition, the performance and quality rate are derived from this. A definition of the key figures can be found at https://docs.forcebridge.io/appendix/index.html
read) | operationId required | string UUID of an operation |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Operation quantity summary details found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find operation for the given operationId parameters.
Internal server error
A list of the recorded operating states of the relevant workplaces during the execution of the operation is returned. Call parameters allow filtering according to a specific time period. Further call parameters also enable filtering according to certain time bases or the workplace state PRODUCTION and DOWNTIME.
read) | operationId required | string UUID of an operation |
| embed | Array of string Names of embeddable resources to be embedded |
| endDate | string <date-time> Filters out operating states with a later end timestamp |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| operatingStateClassId | string UUID of an operating state class |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| startDate | string <date-time> Filters out operating states with an earlier start timestamp |
| timeBase | string Enum:"PRODUCTION" "SETUP" "SCHEDULED_OPERATING_TIME" "MAINTENANCE" "MALFUNCTION" "SCHEDULED_DOWNTIME" Time base to be filtered for |
| workplaceStateId | string Enum:"DOWNTIME" "PRODUCTION" ID of a workplace state |
Recorded operating states found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the operation for the given operationId parameter.
Internal server error
A list of the recorded operation phases is returned. In addition, the setup phase duration, the processing phase duration and the execution time, which is the sum of both durations, are also returned. Call parameters allow filtering according to a specific time period.
read) | operationId required | string UUID of an operation |
| endDate | string <date-time> Filters out operating phases with a later start timestamp. Default: now |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| startDate | string <date-time> Filters out operating phases with an earlier start timestamp. |
Recorded operation phases found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find operation for the given operationId parameter.
Internal server error
A list of the recorded output quantities with the classification in YIELD, SCRAP and REWORK is returned. Unconfirmed quantities can occur for operations that have not yet been completed. These are indicated separately as such. Call parameters allow for filtering according to specific quality types (YIELD, SCRAP or REWORK).
read) | operationId required | string UUID of an operation |
| endDate | string <date-time> Filters out output quantities with a later start timestamp |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationIdentifier | string Identifier used for pagination |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| qualityTypeId | string Enum:"YIELD" "SCRAP" "REWORK" ID of a quality type |
| startDate | string <date-time> Filters out output quantities with an earlier start timestamp |
Recorded output quantities found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the operation for the given operationId parameter.
Internal server error
The skills required to perform the operation are returned separately for the setup phase and the processing phase. For each skill required, the necessary number of staff members and their minimum qualifications are specified.
read) | operationId required | string UUID of an operation |
Required skills found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find operation for the given operationId parameter.
Internal server error
The tools required to perform the operation
read) | operationId required | string UUID of an operation |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Required tools found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find operation for the given operationId parameter.
Internal server error
read) | operationId required | string UUID of an operation |
Scheduled dates founds.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the operation for the given operationId parameter.
Internal server error
Retrieve the quantities to be produced, the required workplace group and the specified durations, as defined in the routing of the ERP system. In contrast to operating state summary and quantity summary, which reflect the actual durations and quantities, the target durations and target quantities can be found here.
read) | operationId required | string UUID of an operation |
| embed | Array of string Names of embeddable resources to be embedded |
Specification found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the operation for the given operationId parameter.
Internal server error
A filtered list of forecast results for operations is returned. Call parameters allow filtering by a specific forecast period. In addition, the key figures adherence to delivery dates, scheduling efficiency, occupancy rate, and setup reduction are returned. The forecast results provides a realistic forecast of how the original planning results are expected to be realized in terms of time, taking into account the actual progress in order processing. The start dates and end dates of the operations are determined by the planning result. However, due to delays in production, these planned dates usually cannot be adhered to. The forecast results correct the originally planned dates using realizable forecast dates. A bridge-compatible IoT Platform itself determines the forecast results of the ongoing processes online, whereas the forecast results for the dispatched operations must be provided by an application's forecast algorithm. In order to obtain the original results of the forecast algorithm instead of the online forecast results, the call parameter useOriginalValues can be used. For further information, please refer to the documentation at https://docs.forcebridge.io/.
read) | endDate required | string <date-time> The end date of the considered period |
| erpContextId | string UUID of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| startDate | string <date-time> The start date of the considered period Default: Current timestamp |
| useOriginalValues | boolean Default: false If set to true, the original forecast is used instead of the online forecast for operations that are being processed |
| workplaceGroupId | string UUID of a workplace group |
| workplaceGroupNumber | string Number of a workplace group |
| workplaceNumber | string Number of a workplace |
Forecast results founds.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
The method allows forecast algorithms to update the forecast results. For further information, please refer to the documentation at https://docs.forcebridge.io/ .
write) | forecastResults | Array of object (operationAssignment) |
Operation forecast results updated.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
A filtered list of planning results for operations is returned. Call parameters allow filtering by a specific planning period. In addition, the key figures adherence to delivery dates, scheduling efficiency, occupancy rate, and setup reduction are returned. The planning results are the binding specification for order processing in production. The start date and end date of the operations and the workplaces for their execution are determined by the planning result. In the shop floor terminal, the operations dispatched to the relevant workplace are displayed in the sequence of their planned start dates corresponding to the planning result. For further information, please refer to the documentation at https://docs.forcebridge.io/.
read) | endDate required | string <date-time> The end date of the considered period |
| erpContextId | string UUID of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant. |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| startDate | string <date-time> The start date of the considered period Default: Current timestamp |
| workplaceGroupId | string UUID of a workplace group |
| workplaceGroupNumber | string Number of a workplace group |
| workplaceNumber | string Number of a workplace |
Planning results found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
The method allows the user of a graphical planning boards or any other application for detailed order scheduling to dispatch operations to specific workplaces on specified dates. The prerequisite for this is that all operations are plannable, that is, that none of the operations has already been started and no operation has already been dispatched in fixed form. In order to reschedule fixed dispatched operations, the PUT method must be used. For further information, please refer to the documentation at https://docs.forcebridge.io/ .
write) | assignments | Array of object (operationAssignment) Array of operation assignments |
Operation planning results updated.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
A filtered collection of planning scenarios is returned. It can be filtered according to certain time periods in which a planning scenario was generated. The key figures adherence to delivery dates, scheduling efficiency, occupancy rate and setup reduction serve to compare the various planning scenarios. Adherence to delivery dates describes the ratio of on-time planned orders to the total number of planned orders. Scheduling efficiency describes the ratio of the minimum lead time that could have been achieved taking into account all setup losses to the actually planned lead time of all planned orders. Occupancy rate describes the ratio of the planned occupancy time of the workplaces to their scheduled operating time. Setup reduction describes the ratio of the total processing time to the total execution time of all planned operations. Ideally, all key figures have a value of 1 respectively 100 percent. For further information, please refer to the documentation at https://docs.forcebridge.io/. A definition of the key figures can be found at https://docs.forcebridge.io/appendix/
read) | endDate | string <date-time> The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| startDate | string <date-time> The start date of the considered period |
Returned the collection of planning scenarios.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
The method allows graphical planning boards or algorithms for automatic detailed order planning to store different planning scenarios. This can be done at recurring intervals or triggered by the event OBSOLETE_OPERATION_PLANNING_SCENARIOS. For further information, please refer to the documentation at https://docs.forcebridge.io/ .
write) | startDate | string <date-time> Start timestamp of the operation planning scenario |
| endDate | string <date-time> End timestamp of the operation planning scenario |
| creator | string The person or system that has created the operation planning scenario |
| assignments | Array of object (operationAssignment) Array of operation assignments |
Planning scenario created.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
A planning scenario describes a time-based assignment of operations to workplaces. It can be visualized in a graphical planning board and adopted as the planning result or rejected by the order planner. For further information, please refer to the documentation at https://docs.forcebridge.io/.
read) | planningScenarioId required | string UUID of an operation planning scenario |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Operation planning scenario found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the operation planning scenario for the given planningScenarioId parameter.
Internal server error
The forecast result provides a realistic forecast of how the original planning result is expected to be realized in terms of time, taking into account the actual progress in order processing. The start date and time and end date and time of an operation are determined by the planning result. However, due to delays in production, these planned dates usually cannot be adhered to. The forecast result corrects the originally planned dates using realizable forecast dates. A bridge-compatible IoT Platform itself provides the forecast result for an operation in progress, whereas the forecast result for a dispatched operation must be provided by an application's forecast algorithm. For further information, please refer to the documentation at https://docs.forcebridge.io/.
read) | operationId required | string UUID of an operation |
Operation forecast results found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the operation for the given operationId parameter or none are available.
Internal server error
The method allows forecast algorithms to update the forecast result for an individual operation. For further information, please refer to the documentation at https://docs.forcebridge.io/ .
write) | operationId required | string UUID of an operation |
| operationId | string UUID of the assigned operation |
| workplaceId | string UUID of the planned workplace |
| startDate | string <date-time> Planned start timestamp of an operation in the planning scenario |
| endDate | string <date-time> Planned end timestamp of an operation in the planning scenario |
| setupStartDate | string <date-time> Planned start timestamp of the setup phase of an operation in the planning scenario |
| setupEndDate | string <date-time> Planned end timestamp of the setup phase of an operation in the planning scenario |
| processingStartDate | string <date-time> Planned start timestamp of the processing phase of an operation in the planning scenario |
| processingEndDate | string <date-time> Planned end timestamp of the processing phase of an operation in the planning scenario |
| fixed | boolean Boolean to indicate that an operation is fixed and must not be rescheduled during automatic order planning |
Operation forecast results found.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the operation for the given operationId parameter..
Internal server error
write) | operationId required | string UUID of an operation |
Operation forecast result for the given operationId parameter deleted.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to the find the operation for the given operationId parameter.
Internal server error
The planning result specifies when the operation is to be started, when it is to be completed, and at which workplace the operation is to be executed. For further information, please refer to the documentation at https://docs.forcebridge.io/ .
read) | operationId required | string UUID of an operation |
| embed | Array of string Names of embeddable resources to be embedded |
Planning Result returned.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the operation for the given operationId parameter.
Internal server error
The method allows the user of a graphical planning boards or any other application for detailed order scheduling to dispatch the operation to a specific workplace on a specified date. The prerequisite for this is that the operation is plannable, that is, that the execution of the operation has not yet started and that the operation has not already been dispatched in fixed form. The ignoreFixedDispatching flag must be set to reschedule or delete operations that have been dispatched as fixed. This flag is optional and is not set by default. For further information, please refer to the documentation at https://docs.forcebridge.io/ .
write) | operationId required | string UUID of an operation |
| operationId | string UUID of the assigned operation |
| workplaceId | string UUID of the planned workplace |
| startDate | string <date-time> Planned start timestamp of an operation in the planning scenario |
| endDate | string <date-time> Planned end timestamp of an operation in the planning scenario |
| setupStartDate | string <date-time> Planned start timestamp of the setup phase of an operation in the planning scenario |
| setupEndDate | string <date-time> Planned end timestamp of the setup phase of an operation in the planning scenario |
| processingStartDate | string <date-time> Planned start timestamp of the processing phase of an operation in the planning scenario |
| processingEndDate | string <date-time> Planned end timestamp of the processing phase of an operation in the planning scenario |
| fixed | boolean Boolean to indicate that an operation is fixed and must not be rescheduled during automatic order planning |
Updated operation planning result.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the operation for the given operationId parameter.
Internal server error
The method allows the user of a graphical planning boards or any other application for detailed order scheduling to delete the assignment of an operation to a specific workplace on a specified date in the planning result. The ignoreFixedDispatching flag must be set to delete operations that have been dispatched as fixed. This flag is optional and is not set by default. For further information, please refer to the documentation at https://docs.forcebridge.io/ .
write) | operationId required | string UUID of an operation |
Deleted operation planning result.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the operation for the given operationId parameter.
Internal server error
A filtered collection of production orders is returned. Call parameters allow filtering, for example, according to the material produced or according to production orders that are executed within a certain period of time.
read) | embed | Array of string Names of embeddable resources to be embedded |
| endDate | string <date-time> Production orders with a later start timestamp are excluded |
| erpContextId | string UUID of an ERP context in which the combination of an order number and order split number is a unique identifier for a production order |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| materialNumber | string Number of the material produced by a production order |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationIdentifier | string Identifier used for pagination |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| productionOrderNumber | string Number of a production order |
| productionOrderSplit | string Number of a production order split |
| startDate | string <date-time> Production orders with an earlier end timestamp are excluded |
Production orders found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
A filtered collection of production orders is returned. Call parameters allow filtering, for example, according to the material produced or according to production orders that are executed within a certain period of time. In contrast to the GET method, the POST method allows the transfer of filter combinations of any length.
write) | embed | Array of string Names of embeddable resources to be embedded |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationIdentifier | string Identifier used for pagination |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| actualEndDateUntil | string <date-time> |
| actualStartDateFrom | string <date-time> |
| basicEndDateUntil | string <date-time> |
| basicStartDateFrom | string <date-time> |
| endDate | string <date-time> |
| erpContextIds | Array of string |
| materialNumbers | Array of string |
| productionOrderIds | Array of string |
| productionOrderNumbers | Array of string |
| productionOrderSplits | Array of string |
| startDate | string <date-time> |
Production orders found.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
Information is returned for domain-specific identification of the production order.
read) | productionOrderId required | string UUID of a production order |
| embed | Array of string Names of embeddable resources to be embedded |
Production order found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the production order for the given productionOrderId parameter.
Internal server error
Retrieve the predecessor/successor relationships that exist between the individual operations of a production order or in order networks. In addition, intermediate times (move time and wait time) are specified and, in the case of parallel processing (flow or line production), the minimum offset time that is the product of the minimum send ahead quantity and the target time per unit in msec. If a minimum offset time is specified, the successor operation can already be started during the processing phase of the predecessor, at the earliest, however, after the minimum offset time from the start of the processing phase of the predecessor.
read) | productionOrderId required | string UUID of a production order |
| isDispatched | boolean If set to true, only dispatched operations are returned |
| isPlannable | boolean If set to true, only plannable operations are returned |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| materialNumber | string Number of an material produced by the production order |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| operationNumber | string Number of an operation |
| operationPhaseId | string Enum:"RELEASED" "COMPLETED" "SETUP" "PROCESSING" "DISPATCHED" "TRAINING" "CLOSED" "INTERRUPTED" "WAITING_BEFORE_PROCESSING" "WAITING_AFTER_PROCESSING" ID of an operation phase according to which the operations are to be filtered |
| operationSplit | string Number of an operation split |
| workplaceNumber | string Number of a workplace |
Operation sequence found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the production order for the given productionOrderId parameter.
Internal server error
read) | productionOrderId required | string UUID of a production order |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 range[1, 100] |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Scheduled dates of a production order, found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the production order for the given productionOrderId parameter.
Internal server error
write) | productionOrderId required | string UUID of a production order |
| scheduledStartDate | string <date-time> |
| scheduledEndDate | string <date-time> |
| elements | Array of object (ProductionOrderScheduledDatesWSModel) |
Scheduled dates of production orders, updated.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the production order for the given productionOrderId parameter.
Internal server error
Retrieve properties of the production order, such as the quantities to be produced, the basic start and end date of a production order and its priority.
read) | productionOrderId required | string UUID of a production order |
| embed | Array of string Names of embeddable resources to be embedded |
Production order specification found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the production order for the given productionOrderId parameter.
Internal server error
read) | embed | Array of string Names of embeddable resources to be embedded |
| erpContextId | string UUID of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant |
| firstName | string First name of a staff member |
| identificationNumber | string Identification number of the staff member as it is typically found on an employee's ID card |
| lastName | string Last name of a staff member |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| personnelNumber | string Personnel number of a staff member |
| Prefer | string Value:"return=minimal" The Prefer header attribute to request a representation which contains only a subset of properties. |
OK
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
A filtered list of scheduled working times is returned. Call parameters allow filtering according to a specific staff member or a specific time period.
read) | endDate | string <date-time> The end date of the considered period (default value: end of next week) |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| startDate | string <date-time> The start date of the considered period (default value: beginning of the current week) |
Scheduled working times found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
A filtered collection of staff member shifts is returned. Call parameters allow filtering, for example, according to a specific staff member and according to shifts within a certain period of time.
read) | embed | Array of string Names of embeddable resources to be embedded |
| endDate | string <date-time> The end date of the considered period Default: End of the next week |
| firstName | string First name of a staff member |
| lastName | string Last name of a staff member |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationIdentifier | string Identifier used for pagination |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| personnelNumber | string Personnel number of a staff member |
| shiftTypeId | string UUID of a shift type |
| staffMemberId | string UUID of a staff member |
| startDate | string <date-time> The start date of the considered period Default: Beginning of the current week |
Shifts of all staff members, found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find shifts for the given shiftTypeId parameter.
Internal server error
read) | shiftId required | string UUID of a staff member |
| embed | Array of string Names of embeddable resources to be embedded |
Staff member shifts found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find staff member shifts for the given shiftId
Internal server error
Information is returned for domain-specific identification of the staff member. Information on the currently executed operations can be embedded (embed=currentlyExecutedOperations). In addition, some of the sub-resources of the staff member can be embedded.
read) | staffMemberId required | string UUID of a staff member |
| embed | Array of string Names of embeddable resources to be embedded |
| Prefer | string Value:"return=minimal" The Prefer header attribute to request a representation which contains only a subset of properties. |
Staff member found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Could not find the staff member for a given staffMemberId parameter.
Internal server error
A filtered collection of absence times is returned. Call parameters allow filtering according to a specific time period.
read) | staffMemberId required | string UUID of a staff member |
| endDate | string <date-time> The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| startDate | string <date-time> The start date of the considered period (default value: beginning of the current week) |
Staff member absence time collection found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Could not find the absence time for the given staffMemberId parameter.
Internal server error
read) | staffMemberId required | string UUID of a staff member |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
Assigned workplaces of a staff member, found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the assigned workplaces of a staff member, for the given staffMemberId parameter.
Internal server error
read) | staffMemberId required | string UUID of a staff member |
Location of a staff member, found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find location of a staff member, for the given staffMemberId parameter or no data was configured.
Internal server error
A filtered list of activities is returned. It provides information about when the staff member was active at which workplaces, at which operations and at which operation phase.
read) | staffMemberId required | string UUID of a staff member |
| endDate | string <date-time> The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| startDate | string <date-time> The start date of the considered period |
| workplaceId | string UUID of the workplace associated with activity records |
| workplaceNumber | string The number of the workplace associated with activity records |
Staff member recorded activities collection found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Could not find the recorded activities for the given staffMemberId or workplaceId parameter.
Internal server error
A filtered list of scheduled working times is returned. Call parameters allow filtering according to a specific time period.
read) | staffMemberId required | string UUID of a staff member |
| endDate | string <date-time> The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| startDate | string <date-time> The start date of the considered period Default: Beginning of the current week |
Scheduled working times of a staff member, found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the scheduled working times of a staff member, for the given staffMemberId parameter.
Internal server error
A list of skills is returned.
read) | staffMemberId required | string UUID of a staff member |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Skills found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Could not find the staff member for the given staffMemberId parameter.
Internal server error
A filtered list of planning results is returned. Call parameters allow filtering by a certain period of time. The planning results specifies the periods in which the staff members are to be deployed at which workplaces.
read) | endDate | string <date-time> The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| startDate | string <date-time> Default: "Current timestamp" The start date of the considered period |
Planning results collection found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
write) | elements | Array of object (staffMemberAssignment) |
Planning results updated.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
A filtered collection of planning scenarios is returned. It can be filtered according to certain time periods in which a planning scenario was generated. The key figures occupancy rate and coverage of personnel requirements are calculated for each scenario. The occupancy rate is the ratio of the occupancy time of all planned staff members and the scheduled working time of these staff members within the selected time period. The coverage of personnel requirements is the ratio of the occupancy time of all staff members and the total requirement of staff hours within the selected time period. For further information, please refer to the documentation at https://docs.forcebridge.io/ .
read) | endDate | string <date-time> The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| startDate | string <date-time> Default: "Current timestamp" The start date of the considered period |
Planning scenario collection found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
The method allows graphical planning boards or planning algorithms to store different planning scenarios. For further information, please refer to the documentation at https://docs.forcebridge.io/ .
write) | startDate | string <date-time> The start date of the planning scenario |
| endDate | string <date-time> The end date of the planning scenario |
| creator | string The person or system that has created the planning scenario |
| operationsPlanningScenarioId | string UUID of the operation planning scenario |
| elements | Array of object (staffMemberAssignment) Array of staff memmber assignments |
Planning scenario created.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
A planning scenario describes a time-based assignment of staff members to workplaces. It can be visualized in a graphical planning board and adopted as the planning result or rejected by the labor capacity planner. For further information, please refer to the documentation at https://docs.forcebridge.io/ .
read) | planningScenarioId required | string UUID of a staff member planning scenario |
| endDate | string <date-time> The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| startDate | string <date-time> Default: "Current timestamp" The start date of the considered period |
Planning scenario of staff members to workplaces, found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
The start date has to be before the end date.
Internal server error
A filtered list of planning results is returned. Call parameters allow filtering by a certain period of time. The planning result specifies the period in which a staff member is to be deployed at which workplaces.
read) | staffMemberId required | string UUID of a staff member |
| embed | Array of string Names of embeddable resources to be embedded |
| endDate | string <date-time> The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationIdentifier | string Identifier used for pagination |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| startDate | string <date-time> Default: "Current timestamp" The start date of the considered period |
Planning results collection found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the staff member for the given staffMemberId parameter.
Internal server error
read) | shiftId required | string UUID of a staff member shift |
| staffMemberId required | string UUID of a staff member |
Planning result found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the staff member or the shift for the given staffMemberId or shiftId parameters.
Internal server error
write) | shiftId required | string UUID of a staff member shift |
| staffMemberId required | string UUID of a staff member |
| elements | Array of object (staffMemberAssignment) |
Planning result updated.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the staff member or the shift for the given staffMemberId or shiftId parameters.
Internal server error
write) | shiftId required | string UUID of a staff member shift |
| staffMemberId required | string UUID of a staff member |
Planning result deleted.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the staff member or the shift for the given staffMemberId or shiftId parameters.
Internal server error
read) | embed | Array of string Names of embeddable resources to be embedded |
| identifier | string A domain specific identifier of the tool in practice, which is usually the tool number |
| identifier2 | string An additional identifier of the tool in operational practice |
| identifier3 | string An additional identifier of the tool in operational practice |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Collection of tools found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
write) | name | string Technical description of the tool |
| description | string Description of the tool |
| identifier1 required | string A domain specific identifier of the tool in practice, which is usually the tool number |
| identifier2 | string An additional identifier of the tool in operational practice |
| identifier3 | string An additional identifier of the tool in operational practice |
| documentUrl | string URL at which the technical documents for the tool can be found |
| group | object (toolIdentifierValue) |
| class | object (toolIdentifierValue) |
| lifeTime | object (lifeTime) |
| location | object (CreateToolLocationPropertiesWSModel) |
| characteristics | Array of object (characteristicGeneralDefinition) Characteristics of the tool |
Tool created.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
The tool with given identifiers already exists.
Internal server error
read) | embed | Array of string Names of embeddable resources to be embedded |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| operationId | string UUID of a corresponding operation that has triggered the tool assembly order |
Tool assembly order collection found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
write) | targetWorkplaceId | string UUID of the target workplace |
| operationId required | string UUID of the corresponding operation |
Tool assembly order created.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
read) | toolAssemblyOrderId required | string UUID of a tool assembly order |
| embed | Array of string Names of embeddable resources to be embedded |
Individual tool assembly order found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to the tool assembly order for the given toolOrderId parameter.
Internal server error
write) | toolAssemblyOrderId required | string UUID of a tool assembly order |
| toolAssemblyOrderStateId required | string Enum:"UNAVAILABLE" "REQUESTED" "INITIATED" "ASSEMBLED" "PRESETTING" "RELEASED" ID of the tool assembly order state to change to |
State of a tool assembly order updated.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the tool assembly order or tool assembly order state for the given toolOrderId or toolAssemblyOrderStateId parameters.
Internal server error
Information is returned for domain-specific identification of the tool and about its current state. There are up to three identifiers, the first of which is usually the tool number. Other identifiers can be tool type and tool class. Additional characteristics of the tool can be embedded (embed=characteristics).
read) | toolId required | string UUID of a tool |
| embed | Array of string Names of embeddable resources to be embedded |
Tool found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the tool for the given toolId parameter.
Internal server error
write) | toolId required | string UUID of a tool |
Accepted
Tool deleted.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the tool for the given toolId parameter.
Internal server error
read) | toolId required | string UUID of a tool |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Tool characteristics found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the tool for the given toolId parameter.
Internal server error
write) | toolId required | string UUID of a tool |
| name required | string Name of the characteristic |
| identifier | string Technical identifier of the characteristic according to ISO 13399 |
| value required | string Value of characteristic |
| unit | string Unit of the characteristic |
Characteristics of a tool updated.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the tool for the given toolId parameter.
Internal server error
Machine tools for metal-cutting production have one or more cutting edges. A list of these edges is returned.
read) | toolId required | string UUID of a tool |
| identifier | string A domain specific identifier of the edge in practice |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Edges of a tool found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the tool for the given toolId parameter.
Internal server error
write) | toolId required | string UUID of a tool |
| identifier required | string A domain specific description of the cutting edge |
| lifeTime | object (lifeTime) |
| characteristics | Array of object (characteristicGeneralDefinition) Characteristics of the tool edge |
Edge of a tool created.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the tool for the given toolId parameter.
The edge of a tool with given identifiers already exists.
Internal server error
read) | edgeId required | string UUID of a tool edge |
| toolId required | string UUID of a tool |
Individual edge of a tool found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the tool or the edge for the given toolId or edgeId parameters.
Internal server error
write) | edgeId required | string UUID of a tool edge |
| toolId required | string UUID of a tool |
| id required | string UUID of the tool edge |
| identifier required | string A domain specific description of the cutting edge |
| lifeTime | object (lifeTime) |
Individual edge of a tool updated.
Individual edge of a tool updated.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the tool or the edge for the given toolId or edgeId parameters.
Tool edge already exists for other tool
Internal server error
read) | edgeId required | string UUID of a tool edge |
| toolId required | string UUID of a tool |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Characteristics of an edge found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the tool or the edge for the given toolId or edgeId parameters.
Internal server error
write) | edgeId required | string UUID of a tool edge |
| toolId required | string UUID of a tool |
| name required | string Name of the characteristic |
| identifier | string Technical identifier of the characteristic according to ISO 13399 |
| value required | string Value of characteristic |
| unit | string Unit of the characteristic |
Characteristics of an edge updated.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the tool or the edge for the given toolId or edgeId parameters.
Internal server error
read) | toolId required | string UUID of a tool |
Location of a tool found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the tool for the given toolId or no location available.
Internal server error
write) | toolId required | string UUID of a tool |
| geoCoordinates | object (geoCoordinates) |
| magazineNumber | integer <int32> Number of the tool magazine |
| magazinePlace | integer <int32> Place in the tool magazine |
| workplaceId | string UUID of the corresponding workplace |
Tool updated.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the tool for the given toolId or no location available.
Internal server error
write) | toolId required | string UUID of a tool |
OK
Tool deleted.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the tool for the given toolId or no location available.
Internal server error
write) | toolId required | string UUID of a tool |
| toolStateId required | string ID of a tool state |
Tool state found.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the tool or the tool state for given toolId or toolStateId parameters.
Internal server error
A filtered collection of workplaces is returned. Call parameters allow filtering, for example, according to the workplace group number or according to specific workplace number.
read) | embed | Array of string Names of embeddable resources to be embedded |
| erpContextId | string Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant |
| isManual | boolean Boolean to indicate that a workplace is a manual workplace. |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| workplaceGroupId | string UUID of a workplace group |
| workplaceGroupNumber | string Number of a workplace group. |
| workplaceNumber | string The number of the workplace. |
Workplace collection found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
read) | endDate | string <date-time> The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| startDate | string <date-time> Default: "Current timestamp,or if the end date is set, two weeks before the end date." The start date of the considered period |
Collection of predicted malfunction scenarios were found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
Recorded operating states and recorded quantities from the past can be used as a basis for predicting malfunctions. In the simplest case, the mean time between failures is calculated for each stoppage reason. More elaborate prognoses also take into account the materials produced in the past, past maintenance intervals and maintenance tasks planned for the future. For machines equipped with the necessary sensors, the recorded time series of sensory measured values before and after a failure can be analyzed in order to obtain information about imminent malfunctions based on the current time series.
write) | elements | Array of object (imminentMalfunction) Array of imminent malfunctions |
| creator | string The person or system that has created the malfunction scenario |
| startDate | string <date-time> The start date of the predicted malfunction scenario |
| endDate | string <date-time> The end date of the predicted malfunction scenario |
Predicted malfunction scenario created.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
A malfunction scenario describes predictions for technical malfunctions. The predicted malfunctions serve to prevent imminent downtimes within the framework of predictive maintenance. A malfunction scenario includes all malfunctions that can be predicted at the workplaces based on current information at the time of the prognosis. If new maintenance tasks are then planned in order to prevent the predicted malfunctions, the scenario usually becomes obsolete. The event OBSOLETE_PREDICTED_MALFUNCTION_SCENARIOS informs about this. An early warning date and a critical date are specified for each predicted malfunction. The first is the date from which the probability of the machine malfunction increases significantly, the latter is the date from which the machine malfunction is highly likely to occur. If maintenance tasks are planned between both dates, the critical date is discarded.
read) | predictedMalfunctionScenarioId required | string UUID of a predicted malfunction scenario |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Predicted malfunction scenario found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find predicted malfunction scenario for the given predictedMalfunctionScenarioId or workplaceId parameter.
Internal server error
A filtered collection of workplace shifts is returned. Call parameters allow filtering, for example, according to a specific workplace and according to shifts within a certain period of time.
read) | associatedDay | string <date-time> Associated day of the workplace shift |
| embed | Array of string Names of embeddable resources to be embedded |
| endDate | string <date-time> The end date of the considered period Default: End of the next week Pattern: yyyy-MM-dd'T'HH:mm:ss.SSSZ |
| erpContextId | string Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant |
| isWorkingShift | boolean Boolean to indicate if a shift is a working shift |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationIdentifier | string Identifier used for pagination |
| paginationTimestamp | string <date-time> Timestamp used for pagination Pattern: yyyy-MM-dd'T'HH:mm:ss.SSSZ |
| shiftTypeId | string ID of a shift type |
| startDate | string <date-time> The start date of the considered period Default: Beginning of the current week Pattern: yyyy-MM-dd'T'HH:mm:ss.SSSZ |
| workplaceGroupNumber | string Unique number of workplace group |
| workplaceId | string UUID of a workplace |
| workplaceNumber | string Number of the workplace |
Collection of workplace shifts found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
read) | shiftId required | string UUID of a shift |
| embed | Array of string Names of embeddable resources to be embedded |
Workplace shift found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the shift for the given shiftId parameter.
Internal server error
Information is returned for domain-specific identification of the workplace and about its current state. Information on the operations that are currently being executed at the workplace can be embedded (embed=currentOperations). In addition, most sub-resources of the workplace can be embedded.
read) | workplaceId required | string UUID of a workplace |
| embed | Array of string Names of embeddable resources to be embedded |
Workplace found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace for the given workplaceId parameter.
Internal server error
These can be embedded systems or individual programmable logic controllers of a machine or several controllers, which are combined to a virtual device. The devices record time series of process parameters and other sensory measured values. The recorded time series are used, among other things, for predictive maintenance. If applicable, sensory measurement time series may also be evaluated in the context of a predictive quality assurance system.
read) | workplaceId required | string UUID of a workplace |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Devices of a workplace were found.
Devices of a workplace were not found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace for the given workplaceId parameter.
Internal server error
Received subservice server error.
read) | workplaceId required | string UUID of a workplace |
Location of a workplace found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to the workplace for the given workplaceId parameter.
Internal server error
The total duration and frequency of the operating states that have occurred are returned. Furthermore scheduled operating time, occupancy time, processing time, production time and setup time are summed up and the key performance indicators occupancy rate, setup reduction, process availability and availability are calculated. The production time is the sum of the durations of all operating states assigned to the PRODUCTION time base. The setup time is the sum of the durations of all operating states assigned to the SETUP time base. The scheduled operating time is the sum of the durations of all operating states assigned to the SCHEDULED OPERATING TIME time base. Note: The setup time is not necessarily identical to the duration of the setup phase, because operating states that are assigned to the time base SETUP can also occur during the processing phase (e. g. intermediate setup). If such operating states occur during the processing phase, the setup time is longer than the duration of the setup phase and the processing time is shorter than the duration of the processing phase. The scheduled operating time is also not necessarily identical to the duration of the originally scheduled operating time, since operating states that are not assigned to the SCHEDULED OPERATING TIME time base can also occur within the originally scheduled operating time (e.g. spontaneous works council meeting). Such operating states do not reduce the availability of a workplace. For further information, please refer to the documentation at https://docs.forcebridge.io/index.html. A definition of the key figures can be found at https://docs.forcebridge.io/appendix/ .
read) | workplaceId required | string UUID of a workplace |
| endDate | string <date-time> Default: "Current timestamp" The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| operatingStateClassId | string UUID of an operating state class |
| shiftId | string UUID of a shift of the corresponding workplace |
| startDate | string <date-time> Default: "Beginning of the current week" The start date of the considered period |
| timeBase | string Enum:"PRODUCTION" "SETUP" "SCHEDULED_OPERATING_TIME" "MAINTENANCE" "MALFUNCTION" "SCHEDULED_DOWNTIME" Time base to be filtered for |
| workplaceStateId | string Enum:"DOWNTIME" "PRODUCTION" ID of a workplace state |
Operating state summary of a workplace were found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace for the given workplaceId parameter.
Internal server error
A list of output quantities is returned for each material produced. All output quantities are summarized according to yield, scrap and rework quantity and the production time used for this is returned. In contrast to the specification, which provides the target durations and quantities, the actual durations and quantities are found here. In addition, the performance, the time-based and the quantity-based quality rate are derived from this. A definition of the key figures can be found at https://docs.forcebridge.io/appendix/ .
read) | workplaceId required | string UUID of a workplace |
| endDate | string <date-time> The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| materialNumber | string Unique Material number to be produced at the workplace |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| shiftId | string UUID of a shift of the corresponding workplace |
| startDate | string <date-time> Default: "Beginning of the current week" The start date of the considered period |
Quantity summary of a workplace found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace for the given workplaceId parameter.
Internal server error
A list of the recorded operating states is returned. Call parameters allow filtering according to a specific time period. Further call parameters also enable filtering according to certain time bases or the workplace state PRODUCTION and DOWNTIME.
read) | workplaceId required | string UUID of a workplace |
| embed | Array of string Names of embeddable resources to be embedded |
| endDate | string <date-time> The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| operatingStateClassId | string UUID of an operating state class |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| shiftId | string UUID of a shift of the corresponding workplace |
| startDate | string <date-time> Default: "Beginning of the current week" The start date of the considered period |
| timeBase | string Enum:"PRODUCTION" "SETUP" "SCHEDULED_OPERATING_TIME" "MAINTENANCE" "MALFUNCTION" "SCHEDULED_DOWNTIME" Time base to be filtered for |
| workplaceStateId | string Enum:"DOWNTIME" "PRODUCTION" ID of a workplace state |
Recorded operating states of a workplace, found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace for the given workplaceId parameter.
Internal server error
The time series of the recorded operation phases is returned. In addition, the setup phase duration, the processing phase duration and the occupancy time, which is the sum of both durations, are also returned. Call parameters allow filtering according to a specific time period.
read) | workplaceId required | string UUID of a workplace |
| endDate | string <date-time> The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| startDate | string <date-time> The start date of the considered period Default: Beginning of the current week |
Recorded operating phases of a workplace were found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace for the given workplaceId parameter.
Internal server error
A list of the recorded output quantities with the classification in YIELD, SCRAP and REWORK is returned. If operations are currently performed at the workplace, unconfirmed quantities can also occur in the current time period. These are indicated separately as such. Call parameters allow filtering according to a specific time period. Further call parameters also enable filtering according to specific quality types (YIELD, SRCAP or REWORK).
read) | workplaceId required | string UUID of a workplace |
| endDate | string <date-time> Default: "Current timestamp" The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationIdentifier | string Identifier used for pagination |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| shiftId | string UUID of a shift of the corresponding workplace |
| startDate | string <date-time> Default: "Beginning of the current week" The start date of the considered period |
Recorded output quantities of a workplace were found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace for the given workplaceId parameter.
Internal server error
A filtered list of required skills is returned. Call parameters allow filtering according to a specific time period and the basis of determination. The basis of determination plays a role if the personnel requirements at the workplace are to be based on the dispatched operations. Filter values can be CURRENT_PLANNING or CURRENT_FORECAST or PLANNING_SCENARIO. If a planning scenario is the basis for determining personnel requirements, its ID must also be specified.
read) | workplaceId required | string UUID of a workplace |
| basisOfDetermination required | string Default: "CURRENT_FORECAST" Enum:"CURRENT_PLANNING" "CURRENT_FORECAST" "PLANNING_SCENARIO" Basis of Determination |
| embed | Array of string Names of embeddable resources to be embedded |
| endDate | string <date-time> Default: "End of the next week" The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| planningScenarioId | string If the basis of determination is PLANNING SCENARIO, a planningScenarioId is required |
| startDate | string <date-time> Default: "Current timestamp" The start date of the considered period |
Required skills found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace for the given workplaceId parameter.
Internal server error
A filtered list of scheduled maintenance times is returned. Call parameters allow filtering according to a specific time period.
read) | workplaceId required | string UUID of a workplace |
| endDate | string <date-time> The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| startDate | string <date-time> Default: "Beginning of the current week" The start date of the considered period |
Scheduled maintenance times of a workplace were found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace for the given workplaceId parameter.
Internal server error
A filtered list of scheduled operating times is returned. These are the operating times scheduled in advance, which include work shifts minus the planned shift breaks. Scheduled maintenance times also do not count towards the scheduled operating times. Call parameters allow filtering according to a specific time period.
read) | workplaceId required | string UUID of a workplace |
| endDate | string <date-time> Default: "End of the next week" The end date of the considered period |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| paginationDirection | string Default: "NEXT" Enum:"NEXT" "PREVIOUS" Direction on how to navigate through the response pages |
| paginationTimestamp | string <date-time> Timestamp used for pagination |
| startDate | string <date-time> Default: "Beginning of the current week" The start date of the considered period |
Scheduled operating times of a workplace were found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace for the given workplaceId parameter.
Internal server error
A filtered collection of workplaces is returned. Call parameters allow filtering according to the workplace group number or the type of workplace group, which can be either a capacity group or a production line. A capacity group is the grouping of functionally identical workplaces. Because these often belong to the same cost center, they are usually mapped as a single work center in an ERP system. Production lines are functionally different workplaces whose spatial sequence enables flow production or line production. They, too, are usually mapped in an ERP system as a single work center.
read) | embed | Array of string Names of embeddable resources to be embedded |
| erpContextId | string Universally unique identifier of the ERP context in which the workplace number is a unique identifier for a workplace or a workplace group. In SAP ERP, for example, this context is defined by the client, the company code, and the plant |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| type | string Enum:"CAPACITY_GROUP" "PRODUCTION_LINE" Type of a workplace group, which is either 'CAPACITY_GROUP' or 'PRODUCTION_LINE' |
| workplaceGroupNumber | string Number of a workplace group |
Collection of workplace groups found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
Information is returned for domain-specific identification of the workplace group.
read) | workplaceGroupId required | string UUID of a workplace group |
| embed | Array of string Names of embeddable resources to be embedded |
Workplace group found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace group for the given workplaceGroupId parameter.
Internal server error
Retrieve a collection of workplaces assigned to the workplace group.
read) | workplaceGroupId required | string UUID of a workplace group |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
Assigned workplaces of workplace group found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Internal server error
Retrieve the rules to calculate the execution time of an operation using a specific manufacturing variant. Rules can be specified explicitly for a particular material or can be formulated using conditions relating to any of the characteristics of a material. Conditions can be defined using the RSQL.
read) | workplaceGroupId required | string UUID of a workplace group |
| criterion | string Enum:"MATERIAL_NUMBER" "MATERIAL_CHARACTERISTIC" The criterion that affects the setup time, which can be MATERIAL_NUMBER or MATERIAL_CHARACTERISTICS |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| materialNumber | string The number of a material |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| origin | string Enum:"MANUAL_DATA_MAINTENANCE" "AUTOMATIC_EVALUATION_SYSTEM" The origin of the entry that is either 'MANUAL_DATA_MAINTENANCE' if the entry was created by manual data maintenance or 'AUTOMATIC_EVALUATION_SYSTEM' if an evaluation system has generated the entry |
| workplaceNumber | string The number of a workplace |
Manufacturing variant rule found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace group for the given workplaceGroupId parameter.
Internal server error
Create a rule to calculate the execution time of an operation using a specific manufacturing variant. Rules can be specified explicitly for a particular material or can be formulated using conditions relating to any of the characteristics of a material. Conditions can be defined using the RSQL. The rules can be created on the basis of manual data maintenance or automatically on the basis of an analysis of the execution times recorded in the past.
write) | workplaceGroupId required | string UUID of a workplace group |
| origin | string Enum:"MANUAL_DATA_MAINTENANCE" "AUTOMATIC_EVALUATION_SYSTEM" |
| criterion | string Enum:"MATERIAL_NUMBER" "MATERIAL_CHARACTERISTIC" |
| conditions | string |
| workplaceIds | Array of string |
| toolIds | Array of string |
| additionalsConditions | string |
| forecastedDelays | object (WorkplaceGroupManufacturingVariantRuleForecastRequestBody) |
Manufacturing variant rule created.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace group for the given workplaceGroupId parameter.
Internal server error
Retrieve a specific rule to calculate the execution time of an operation using a specific manufacturing variant. Rules can be specified explicitly for a particular material or can be formulated using conditions relating to any of the characteristics of a material. Conditions can be defined using the RSQL.
read) | manufacturingVariantRuleId required | string UUID of a manufacturing variant rule |
| workplaceGroupId required | string UUID of a workplace group |
Manufacturing variant rule found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace group or the manufacturing variant rule for the given workplaceGroupId or manufacturingVariantRuleId parameters.
Internal server error
Update a specific rule to calculate the execution time of an operation using a specific manufacturing variant. Rules can be specified explicitly for a particular material or can be formulated using conditions relating to any of the characteristics of a material. Conditions can be defined using the RSQL.
write) | manufacturingVariantRuleId required | string UUID of a manufacturing variant rule |
| workplaceGroupId required | string UUID of a workplace group |
| origin | string Enum:"MANUAL_DATA_MAINTENANCE" "AUTOMATIC_EVALUATION_SYSTEM" |
| criterion | string Enum:"MATERIAL_NUMBER" "MATERIAL_CHARACTERISTIC" |
| conditions | string |
| workplaceIds | Array of string |
| toolIds | Array of string |
| additionalsConditions | string |
| forecastedDelays | object (WorkplaceGroupManufacturingVariantRuleForecastRequestBody) |
Manufacturing variant rule updated.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace group or the manufacturing variant rule for the given workplaceGroupId or manufacturingVariantRuleId parameters.
Internal server error
Delete a specific rule to calculate the execution time of an operation using a specific manufacturing variant.
write) | manufacturingVariantRuleId required | string UUID of a manufacturing variant rule |
| workplaceGroupId required | string UUID of a workplace group |
OK
Manufacturing variant rule deleted.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace group or the manufacturing variant rule for the given workplaceGroupId or manufacturingVariantRuleId parameters.
Internal server error
Retrieve the rules for calculating the durations required for different setup transitions. The duration of the setup transitions is determined on the basis of the rules stored here. It is possible to explicitly specify the setup transition from one material to another in a rule. Alternatively, rules for the setup transitions can be specified on the basis of conditions related to any characteristics of the material. Conditions can be defined using the RSQL syntax.
read) | workplaceGroupId required | string UUID of a workplace group |
| criterion | string Enum:"MATERIAL_NUMBER" "MATERIAL_CHARACTERISTICS" Criterion that affects the setup time, that can either be the number or the characteristic of a material |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| materialNumber | string The number of a material |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| origin | string Enum:"MANUAL_DATA_MAINTENANCE" "AUTOMATIC_EVALUATION_SYSTEM" Origin of an entry that was created either manually or by an automatic evaluation system |
| workplaceNumber | string The number of the workplace |
Setup transition rules found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find setup transition rules for the given workplaceGroupId or workplaceNumber parameter.
Internal server error
Create a rule for calculating the durations required for different setup transitions. The duration of the setup transitions is determined on the basis of the rules stored here. It is possible to explicitly specify the setup transition from one material to another in a rule. Alternatively, rules for the setup transitions can be specified on the basis of conditions related to any characteristics of the material. Conditions can be defined using the RSQL syntax. The rules can be created on the basis of manual data maintenance or automatically on the basis of an analysis of the setup times recorded in the past.
write) | workplaceGroupId required | string UUID of a workplace group |
| origin | string Enum:"MANUAL_DATA_MAINTENANCE" "AUTOMATIC_EVALUATION_SYSTEM" The origin of the entry that is either “MANUAL_DATA_MAINTENANCE” if the entry was created by manual data maintenance, or “AUTOMATIC_EVALUATION_SYSTEM” if an evaluation system has generated the entry |
| workplace | object (workplaceGeneralDefinition) |
| criterion | string Enum:"MATERIAL_NUMBER" "MATERIAL_CHARACTERISTICS" The criterion that affects the setup time, which can be MATERIAL_NUMBER or MATERIAL_CHARACTERISTICS |
| predecessorConditions | string If the material number is the criterion, a specification of the predecessor material by the material number (the UUID of the ERP context is not required because the material number is unique in the context of a workplace group). If a material characteristic is the criterion: A condition relating to the characteristics of the material that is produced at the workplace before the setup transition (e.g. color==black;width=lt=40) |
| successorConditions | string If the material number is the criterion, a specification of the successor material by the material number (the UUID of the ERP context is not required because the material number is unique in the context of a workplace group). If a material characteristic is the criterion: A condition relating to the characteristics of the material that is produced at the workplace after the setup transition (e.g. color==white;width=gt=40) |
| setupTimeIncrement | integer <int64> The increase of the setup time in msec if predecessor and successor meet the conditions with respect to the criterion (not to be specified for the criterion MATERIAL_NUMBER) |
| setupTime | integer <int64> The absolute setup time for the transition from the specified predecessor material to the specified successor material (only to be specified for the criterion MATERIAL_NUMBER) |
Setup transition rule created.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find workplace group for the given workplaceGroupId parameter.
Internal server error
Retrieve a specific rule for calculating the durations required for different setup transitions. The duration of the setup transitions is determined on the basis of the rules stored here. It is possible to explicitly specify the setup transition from one material to another in a rule. Alternatively, rules for the setup transitions can be specified on the basis of conditions related to any characteristics of the material. Conditions can be defined using the RSQL syntax.
read) | setupTransitionRuleId required | string UUID of a setup transition rule |
| workplaceGroupId required | string UUID of a workplace group |
Setup transition rule found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace group or the setup transition rule for the given workplaceGroupId or setupTransitionRuleId parameters.
Internal server error
Update a specific rule for calculating the durations required for different setup transitions. The duration of the setup transitions is determined on the basis of the rules stored here. It is possible to explicitly specify the setup transition from one material to another in a rule. Alternatively, rules for the setup transitions can be specified on the basis of conditions related to any characteristics of the material. Conditions can be defined using the RSQL syntax.
write) | setupTransitionRuleId required | string UUID of a setup transition rule |
| workplaceGroupId required | string UUID of a workplace group |
| origin | string Enum:"MANUAL_DATA_MAINTENANCE" "AUTOMATIC_EVALUATION_SYSTEM" The origin of the entry that is either “MANUAL_DATA_MAINTENANCE” if the entry was created by manual data maintenance, or “AUTOMATIC_EVALUATION_SYSTEM” if an evaluation system has generated the entry |
| workplace | object (workplaceGeneralDefinition) |
| criterion | string Enum:"MATERIAL_NUMBER" "MATERIAL_CHARACTERISTICS" The criterion that affects the setup time, which can be MATERIAL_NUMBER or MATERIAL_CHARACTERISTICS |
| predecessorConditions | string If the material number is the criterion, a specification of the predecessor material by the material number (the UUID of the ERP context is not required because the material number is unique in the context of a workplace group). If a material characteristic is the criterion: A condition relating to the characteristics of the material that is produced at the workplace before the setup transition (e.g. color==black;width=lt=40) |
| successorConditions | string If the material number is the criterion, a specification of the successor material by the material number (the UUID of the ERP context is not required because the material number is unique in the context of a workplace group). If a material characteristic is the criterion: A condition relating to the characteristics of the material that is produced at the workplace after the setup transition (e.g. color==white;width=gt=40) |
| setupTimeIncrement | integer <int64> The increase of the setup time in msec if predecessor and successor meet the conditions with respect to the criterion (not to be specified for the criterion MATERIAL_NUMBER) |
| setupTime | integer <int64> The absolute setup time for the transition from the specified predecessor material to the specified successor material (only to be specified for the criterion MATERIAL_NUMBER) |
Setup transition rule updated.
Malformed request
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace group or the setup transition rule for the given workplaceGroupId or setupTransitionRuleId parameters.
Internal server error
Delete a specific rule for calculating the durations required for different setup transitions.
write) | setupTransitionRuleId required | string UUID of a setup transition rule |
| workplaceGroupId required | string UUID of a workplace group |
Setup transition rule deleted.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace group or the setup transition rule for the given workplaceGroupId or setupTransitionRuleId parameters.
Internal server error
Retrieve the setup transitions that are valid for all workplaces of a workplace group.A filtered list of setup transitions is returned. It contains only the materials produced by the operations that have not yet been completed. You can use a setup matrix to model setup times that depend on the sequence in which operations are executed at a workplace. Such setup times can occur when the material to be produced at a workplace changes.
read) | workplaceGroupId required | string UUID of a workplace group |
| limit | integer <int32> [ 1 .. 100 ] Default: 100 Size of the requested page |
| offset | integer <int32> >= 0 Default: 0 Offset used for pagination |
| predecessorMaterial | string Number of the material that is produced at the workplace before the setup transition |
| successorMaterial | string Number of the material that is produced at the workplace after the setup transition |
Setup transitions found.
No or an invalid request token was returned
Request requires higher privileges than provided by the access token
Unable to find the workplace group for the given workplaceGroupId parameter.
Internal server error