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