FORCAM FORCE Bridge (Preview)
FORCAM FORCE is a IIoT platform solution for data driven manufacturing. It supports manufacturing companies to significantly increase their productivity. Its semantic data layer creates a uniform production data model and connects the shop- and top floor. The platform's open web interface form the bridge to in-house and third-party applications, thus enabling the free composition and collaboration of solutions. Connect today with FORCE to empower your workforce for digital transformation.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | FORCAM FORCE Bridge Support |
URL | https://forcam.com/en/contact/ |
forcebridge@forcam.com |
Connector Metadata | |
---|---|
Publisher | FORCAM GmbH |
Website | https://forcam.com |
Privacy policy | https://forcam.com/en/privacy-policy/ |
Categories | Collaboration;Internet of Things |
FORCAM FORCE Bridge is the first IIoT-Platform with out of the box MESA-Applications. The FORCAM FORCE Bridge Connector provides the ability to build workflows wich supports the daily life in manufacturing. For example it is possible to build a flow which sends a notification if a machine stops or a key figure (e.g Overall Equipment Effectiveness) falls below a limit.
Prerequisites
To use the Connector you need a valid FORCAM FORCE installation (SaaS, PaaS or On-Prem) including the Bridge API module with Version 3 or higher. Your technical consultant is able to connect your instance with our Gateway-Service. This service is the bridge between your FORCE-Instance and Power Automate.
How to get credentials
To get a valid access token, please contact your FORCAM contact person.
Creating a connection
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
API-Key | securestring | The API-Key for your FORCE Bridge instance | True |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Change state of ticket |
Change state of ticket |
Create a new ticket |
Create a new ticket |
Get current staff members of the workplace |
Get current staff members of the workplace |
Get dispatched operations |
Get operations that are dispatched |
Get hitlist by material |
Get a hitlist of operating states |
Get hitlist by workplace |
Get a hitlist of operating states by its workplace Id |
Get hitlist by workplace |
Get a hitlist of operating states by its workplace Id |
Get material quality details |
Get the material quality details |
Get operating state by Id |
Get the operating states by its state Id |
Get operation by Id |
get an operation by the Id |
Get operations in progress |
Get operations that are in progress |
Get overall equipment efficiency (OEE) |
Get overall equipment efficiency (OEE) |
Get overall process efficiency (OPE) |
Get the overall process efficiency (OPE) |
Get plannable operations |
Get operations that are plannable |
Get ticket activities by ticket Id |
Get ticket activities by the ticket Id |
Get ticket activity attachment by Id |
Get ticket activity attachment by the ticket, activity and attachmentId |
Get ticket activity attachments by Id |
Get ticket activity attachments by the ticket, activity and attachmentId |
Get ticket activity by Id |
Get ticket activity by the ticket and activity Id |
Get ticket activity remark by Id |
Get ticket activity remark by the remark Id |
Get ticket activity remarks by activity Id |
Get ticket activity remarks by the activity Id |
Get ticket attachment by attachment Id |
Get ticket attachment by the ticket and attachmentId |
Get ticket attachments by ticket Id |
Get ticket attachments by the ticket Id |
Get ticket by Id |
Get ticket by Id |
Get ticket by number |
Get ticket by the ticket number |
Get ticket class by Id |
Get ticket class by Id |
Get ticket classes |
Get ticket classes |
Get ticket state by Id |
Get ticket state by Id |
Get ticket states |
Get ticket states |
Get tickets |
Get tickets |
Get total quantity details |
Get total quantity details |
Get workplace |
Get workplace |
Get workplace quality details |
Get workplace quality details by its workplaceId and materialId |
Change state of ticket
Change state of ticket
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Ticket Id
|
ticketId | True | string |
Id of ticket |
New ticket state
|
newTicketState | True | string |
New ticket state for ticket |
Returns
- Body
- Ticket
Create a new ticket
Create a new ticket
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
title
|
title | True | string | |
description
|
description | True | string | |
rootCause
|
rootCause | string | ||
priority
|
priority | True | string | |
ticketStateId
|
ticketStateId | True | string | |
ticketClassId
|
ticketClassId | string | ||
operationId
|
operationId | string | ||
materialNumber
|
materialNumber | string | ||
WorkplaceId
|
workplaceId | string | ||
shiftId
|
shiftId | string |
Returns
- Body
- Ticket
Get current staff members of the workplace
Get current staff members of the workplace
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
WorkplaceId
|
workplaceId | True | string |
Id of workplace |
Returns
Get dispatched operations
Get operations that are dispatched
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
WorkplaceId
|
workplaceId | True | string |
Id of workplace |
Returns
- Body
- OperationList
Get hitlist by material
Get a hitlist of operating states
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start date
|
startDate | True | date-time |
Filter start date |
MaterialId
|
materialId | True | string |
Id of a material |
End date
|
endDate | date-time |
Filter end date |
Returns
Get hitlist by workplace
Get a hitlist of operating states by its workplace Id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start date
|
startDate | True | date-time |
Filter start date |
WorkplaceId
|
workplaceId | True | string |
Id of a workplace |
End date
|
endDate | date-time |
Filter end date |
Returns
Get hitlist by workplaceGroup
Get a hitlist of operating states by its workplace Id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start date
|
startDate | True | date-time |
Filter start date |
WorkplaceGroupId
|
workplaceGroupId | True | string |
Id of a workplace group |
End date
|
endDate | date-time |
Filter end date |
Returns
Get material quality details
Get the material quality details
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start date
|
startDate | True | date-time |
Filter start date |
MaterialId
|
materialId | True | string |
Id of a material |
End date
|
endDate | date-time |
Filter end date |
Returns
Get operating state by Id
Get the operating states by its state Id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
The Id of the operatingState
|
operatingStatesId | True | string |
The Id of the operatingState |
Returns
Get operation by Id
get an operation by the Id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Operation Id
|
operationId | True | string |
Id of an operation |
Returns
- Body
- Operation
Get operations in progress
Get operations that are in progress
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
WorkplaceId
|
workplaceId | True | string |
Id of workplace |
Returns
- Body
- OperationList
Get overall equipment efficiency (OEE)
Get overall equipment efficiency (OEE)
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start date
|
startDate | True | date-time |
Filter start date |
WorkplaceId
|
workplaceId | string |
Id of a workplace |
|
WorkplaceGroupId
|
workplaceGroupId | string |
Id of a workplace group |
|
End date
|
endDate | date-time |
Filter end date |
Returns
Get overall process efficiency (OPE)
Get the overall process efficiency (OPE)
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start date
|
startDate | True | date-time |
Filter start date |
MaterialId
|
materialId | string |
Id of a material |
|
Order Id
|
orderId | string |
Id of a order |
|
End date
|
endDate | date-time |
Filter end date |
Returns
Get plannable operations
Get operations that are plannable
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
WorkplaceId
|
workplaceId | True | string |
Id of workplace |
Returns
- Body
- OperationList
Get ticket activities by ticket Id
Get ticket activities by the ticket Id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Ticket Id
|
ticketId | True | string |
Id of the ticket |
Returns
- Body
- TicketActivityList
Get ticket activity attachment by Id
Get ticket activity attachment by the ticket, activity and attachmentId
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Ticket Id
|
ticketId | True | string |
Id of the ticket |
Id of the Activity
|
activityId | True | string |
Id of the activity |
Id of the attachment
|
attachmentId | True | string |
Id of the attachment |
Returns
Get ticket activity attachments by Id
Get ticket activity attachments by the ticket, activity and attachmentId
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Ticket Id
|
ticketId | True | string |
Id of the ticket |
Id of the Activity
|
activityId | True | string |
Id of the activity |
Returns
Get ticket activity by Id
Get ticket activity by the ticket and activity Id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Ticket Id
|
ticketId | True | string |
Id of the ticket |
Id of the Activity
|
activityId | True | string |
Id of the Activity |
Returns
- Body
- TicketActivity
Get ticket activity remark by Id
Get ticket activity remark by the remark Id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Ticket Id
|
ticketId | True | string |
Id of the ticket |
Id of the Activity
|
activityId | True | string |
Id of the Activity |
Id of the Activity
|
remarkId | True | string |
Id of the Activity |
Returns
- Body
- TicketActivityRemark
Get ticket activity remarks by activity Id
Get ticket activity remarks by the activity Id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Ticket Id
|
ticketId | True | string |
Id of the ticket |
Id of the Activity
|
activityId | True | string |
Id of the Activity |
Returns
Get ticket attachment by attachment Id
Get ticket attachment by the ticket and attachmentId
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Ticket Id
|
ticketId | True | string |
Id of the ticket |
Id of the attachment
|
attachmentId | True | string |
Id of the attachment |
Returns
- Body
- TicketAttachment
Get ticket attachments by ticket Id
Get ticket attachments by the ticket Id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Ticket Id
|
ticketId | True | string |
Id of the ticket |
Returns
- Body
- TicketAttachmentList
Get ticket by Id
Get ticket by Id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Ticket Id
|
ticketId | True | string |
Id of the ticket |
Returns
- Body
- Ticket
Get ticket by number
Get ticket by the ticket number
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Ticketnumber
|
ticketNumber | True | string |
Number of the ticket |
Returns
- Body
- Ticket
Get ticket class by Id
Get ticket class by Id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
TicketClassId
|
ticketClassId | True | string |
Id of ticketClass |
Returns
- Body
- TicketClass
Get ticket classes
Get ticket classes
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Limit
|
limit | string |
Limit |
|
Offset
|
offset | string |
Offset |
Returns
- Body
- TicketClassList
Get ticket state by Id
Get ticket state by Id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Ticket state
|
ticketStateId | True | string |
Ticket state |
Returns
- Body
- TicketState
Get ticket states
Get ticket states
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Limit
|
limit | string |
Limit |
|
Offset
|
offset | string |
Offset |
Returns
- Body
- TicketStateList
Get tickets
Get tickets
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Ticketnumber
|
ticketNumber | string |
Number of the ticket |
|
Ticket state
|
ticketStateId | string |
Ticket state |
|
TicketClassId
|
ticketClassId | string |
class of the ticket |
|
WorkplaceId
|
workplaceId | string |
Id of workplace that tickets have to belong to |
Returns
- Body
- TicketList
Get total quantity details
Get total quantity details
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start date
|
startDate | True | date-time |
Filter start date |
End date
|
endDate | date-time |
Filter end date |
|
WorkplaceId
|
workplaceId | string |
Id of a workplace |
|
WorkplaceGroupId
|
workplaceGroupId | string |
Id of a workplace group |
Returns
Get workplace
Get workplace
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
WorkplaceId
|
workplaceId | True | string |
Id of workplace |
Returns
- Body
- Workplace
Get workplace quality details
Get workplace quality details by its workplaceId and materialId
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start date
|
startDate | True | date-time |
Filter start date |
MaterialId
|
materialId | string |
Id of a material |
|
WorkplaceId
|
workplaceId | string |
Id of a workplace |
|
WorkplaceGroupId
|
workplaceGroupId | string |
Id of a workplace group |
|
End date
|
endDate | date-time |
Filter end date |
Returns
Triggers
When a customized action occured |
When a customized action occured |
When a customized action occured (raw) |
When a customized action occured (raw) |
When a new ticket has been created |
When a new ticket has been created |
When a new workplace has been created |
When a new workplace has been created |
When a process data rule has been violated |
When a process data rule has been violated |
When a ticket activity attachment has been created |
When a ticket activity attachment has been created |
When a ticket activity attachment has been deleted |
When a ticket activity attachment has been deleted |
When a ticket activity has been created |
When a ticket activity has been created |
When a ticket activity has been deleted |
When a ticket activity has been deleted |
When a ticket activity has been updated |
When a ticket activity has been updated |
When a ticket activity remark has been created |
When a ticket activity remark has been created |
When a ticket activity remark has been deleted |
When a ticket activity remark has been deleted |
When a ticket activity state has been changed |
When a ticket activity state has been changed |
When a ticket attachment has been created |
When a ticket attachment has been created |
When a ticket attachment has been deleted |
When a ticket attachment has been deleted |
When a ticket has been deleted |
When a ticket has been deleted |
When a workplace has been deleted |
When a workplace has been deleted |
When a workplace has been updated |
When a workplace has been updated |
When an existing ticket has been updated |
When an existing ticket has been updated |
When the operating state of a workplace has been changed |
When the operating state of a workplace has been changed |
When the state of a ticket has been changed |
When the state of a ticket has been changed |
When a customized action occured
When a customized action occured
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name of the event
|
eventName | True | string |
Name of the event |
Returns
- Body
- CustomCallback
When a customized action occured (raw)
When a customized action occured (raw)
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name of the event
|
eventName | True | string |
Name of the event |
Returns
- Body
- CustomCallbackRaw
When a new ticket has been created
When a new ticket has been created
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of object to filter
|
filterId | string |
Id of object to filter |
Returns
- Body
- TicketEvent
When a new workplace has been created
When a new workplace has been created
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
WorkplaceId
|
filterId | string |
Id of object to filter |
Returns
- Body
- Workplace
When a process data rule has been violated
When a process data rule has been violated
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name of the rule
|
eventName | True | string |
Name of the rule |
Returns
When a ticket activity attachment has been created
When a ticket activity attachment has been created
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of object to filter
|
filterId | string |
Id of object to filter |
Returns
When a ticket activity attachment has been deleted
When a ticket activity attachment has been deleted
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of object to filter
|
filterId | string |
Id of object to filter |
Returns
- Body
- DeleteEvent
When a ticket activity has been created
When a ticket activity has been created
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of object to filter
|
filterId | string |
Id of object to filter |
Returns
- Body
- TicketActivityEvent
When a ticket activity has been deleted
When a ticket activity has been deleted
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of object to filter
|
filterId | string |
Id of object to filter |
Returns
- Body
- DeleteEvent
When a ticket activity has been updated
When a ticket activity has been updated
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of object to filter
|
filterId | string |
Id of object to filter |
Returns
- Body
- TicketActivityEvent
When a ticket activity remark has been created
When a ticket activity remark has been created
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of object to filter
|
filterId | string |
Id of object to filter |
Returns
When a ticket activity remark has been deleted
When a ticket activity remark has been deleted
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of object to filter
|
filterId | string |
Id of object to filter |
Returns
- Body
- DeleteEvent
When a ticket activity state has been changed
When a ticket activity state has been changed
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of object to filter
|
filterId | string |
Id of object to filter |
Returns
When a ticket attachment has been created
When a ticket attachment has been created
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of object to filter
|
filterId | string |
Id of object to filter |
Returns
When a ticket attachment has been deleted
When a ticket attachment has been deleted
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of object to filter
|
filterId | string |
Id of object to filter |
Returns
- Body
- DeleteEvent
When a ticket has been deleted
When a ticket has been deleted
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of object to filter
|
filterId | string |
Id of object to filter |
Returns
- Body
- DeleteEvent
When a workplace has been deleted
When a workplace has been deleted
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
WorkplaceId
|
filterId | string |
Id of object to filter |
Returns
- Body
- DeleteEvent
When a workplace has been updated
When a workplace has been updated
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
WorkplaceId
|
filterId | string |
Id of object to filter |
Returns
- Body
- Workplace
When an existing ticket has been updated
When an existing ticket has been updated
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of object to filter
|
filterId | string |
Id of object to filter |
Returns
- Body
- TicketEvent
When the operating state of a workplace has been changed
When the operating state of a workplace has been changed
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
WorkplaceId
|
filterId | string |
Id of object to filter |
Returns
When the state of a ticket has been changed
When the state of a ticket has been changed
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of object to filter
|
filterId | string |
Id of object to filter |
Returns
Definitions
CustomCallback
Name | Path | Type | Description |
---|---|---|---|
callbackID
|
callbackID | string | |
timestamp
|
timestamp | string | |
key1
|
key1 | string | |
key2
|
key2 | string | |
key3
|
key3 | string | |
key4
|
key4 | string | |
key5
|
key5 | string |
CustomCallbackRaw
Name | Path | Type | Description |
---|---|---|---|
callbackID
|
callbackID | string | |
timestamp
|
timestamp | string |
WorkplaceOperatingStateChangedEvent
Name | Path | Type | Description |
---|---|---|---|
callbackID
|
callbackID | string | |
timestamp
|
timestamp | string | |
workplaceNumber
|
workplaceNumber | string | |
workplaceId
|
workplaceId | string | |
workplaceDescription
|
workplaceDescription | string | |
newStateCode
|
newStateCode | string | |
newStateId
|
newStateId | string | |
newStateDescription
|
newStateDescription | string | |
oldStateCode
|
oldStateCode | string | |
oldStateId
|
oldStateId | string |
TicketEvent
Name | Path | Type | Description |
---|---|---|---|
callbackID
|
callbackID | string | |
timestamp
|
timestamp | string | |
eventType
|
eventType | string | |
eventName
|
eventName | string | |
ticketID
|
ticketID | string | |
ticketNumber
|
ticketNumber | string | |
ticketTitle
|
ticketTitle | string |
TicketStateChangeEvent
Name | Path | Type | Description |
---|---|---|---|
callbackID
|
callbackID | string | |
timestamp
|
timestamp | string | |
eventType
|
eventType | string | |
eventName
|
eventName | string | |
ticketID
|
ticketID | string | |
ticketNumber
|
ticketNumber | string | |
ticketTitle
|
ticketTitle | string | |
ticketStateID
|
ticketStateID | string | |
ticketState
|
ticketState | string | |
ticketStateColor
|
ticketStateColor | string |
TicketAttachmentEvent
Name | Path | Type | Description |
---|---|---|---|
callbackID
|
callbackID | string | |
timestamp
|
timestamp | string | |
eventType
|
eventType | string | |
eventName
|
eventName | string | |
ticketID
|
ticketID | string | |
ticketNumber
|
ticketNumber | string | |
ticketTitle
|
ticketTitle | string | |
attachmentId
|
attachmentId | string | |
attachmentDescription
|
attachmentDescription | string |
TicketActivityEvent
Name | Path | Type | Description |
---|---|---|---|
callbackID
|
callbackID | string | |
timestamp
|
timestamp | string | |
eventType
|
eventType | string | |
eventName
|
eventName | string | |
ticketID
|
ticketID | string | |
ticketNumber
|
ticketNumber | string | |
ticketTitle
|
ticketTitle | string | |
activityID
|
activityID | string | |
activityTitle
|
activityTitle | string |
TicketActivityStateChangedEvent
Name | Path | Type | Description |
---|---|---|---|
callbackID
|
callbackID | string | |
timestamp
|
timestamp | string | |
eventType
|
eventType | string | |
eventName
|
eventName | string | |
ticketID
|
ticketID | string | |
ticketNumber
|
ticketNumber | string | |
ticketTitle
|
ticketTitle | string | |
activityID
|
activityID | string | |
activityTitle
|
activityTitle | string | |
activityStateID
|
activityStateID | string |
TicketActivityRemarkEvent
Name | Path | Type | Description |
---|---|---|---|
callbackID
|
callbackID | string | |
timestamp
|
timestamp | string | |
eventType
|
eventType | string | |
eventName
|
eventName | string | |
ticketID
|
ticketID | string | |
ticketNumber
|
ticketNumber | string | |
ticketTitle
|
ticketTitle | string | |
activityID
|
activityID | string | |
activityTitle
|
activityTitle | string | |
activityRemarkID
|
activityRemarkID | string | |
activityRemark
|
activityRemark | string | |
activityRemarkEditor
|
activityRemarkEditor | string | |
activityRemarkCreatedAt
|
activityRemarkCreatedAt | string |
TicketActivityAttachmentEvent
Name | Path | Type | Description |
---|---|---|---|
callbackID
|
callbackID | string | |
timestamp
|
timestamp | string | |
eventType
|
eventType | string | |
eventName
|
eventName | string | |
ticketID
|
ticketID | string | |
ticketNumber
|
ticketNumber | string | |
ticketTitle
|
ticketTitle | string | |
activityID
|
activityID | string | |
activityTitle
|
activityTitle | string | |
attachmentID
|
attachmentID | string | |
attachmentDescription
|
attachmentDescription | string |
ProcessDataRuleViolated
Name | Path | Type | Description |
---|---|---|---|
callbackID
|
callbackID | string | |
objectID
|
objectID | string | |
timestamp
|
timestamp | string | |
eventType
|
eventType | string | |
eventName
|
eventName | string | |
signalName
|
signalInfo.signalName | string | |
baseSignalValue
|
signalInfo.baseSignalValue | string | |
signalGroup
|
signalInfo.signalGroup | string | |
deliveredSignalValue
|
signalInfo.deliveredSignalValue | string | |
controller
|
signalInfo.controller | string | |
baseUnitSymbol
|
unitInfo.baseUnitSymbol | string | |
baseUnitMnemonic
|
unitInfo.baseUnitMnemonic | string | |
deliveredUnitSymbol
|
unitInfo.deliveredUnitSymbol | string | |
physicalUnitMnemonic
|
unitInfo.physicalUnitMnemonic | string | |
deliveredUnitMnemonic
|
unitInfo.deliveredUnitMnemonic | string | |
priority
|
violationRuleInfo.priority | string | |
level
|
violationRuleInfo.level | string | |
text
|
violationRuleInfo.text | string | |
ruleName
|
violationRuleInfo.ruleName | string | |
violationValue
|
violationRuleInfo.violationValue | string | |
range
|
violationRuleInfo.range | string | |
subject
|
violationRuleInfo.subject | string | |
violationMaxValue
|
violationRuleInfo.violationMaxValue | string |
DeleteEvent
Name | Path | Type | Description |
---|---|---|---|
callbackID
|
callbackID | string | |
timestamp
|
timestamp | string | |
objectID
|
objectID | string | |
eventType
|
eventType | string | |
eventName
|
eventName | string |
MasterDataOperatingState
Name | Path | Type | Description |
---|---|---|---|
operatingStateId
|
operatingStateId | string | |
description
|
description | string | |
shortDescription
|
shortDescription | string | |
code
|
code | string | |
color
|
color | string | |
recodable
|
recodable | boolean | |
splittable
|
splittable | boolean | |
annotatable
|
annotatable | boolean | |
customerCode
|
customerCode | string | |
workplaceStateId
|
workplaceStateId | string | |
operatingStateClassId
|
operatingStateClassId | string |
OperationWorkplace
Name | Path | Type | Description |
---|---|---|---|
workplaceId
|
workplaceId | string | |
operationErpKey
|
operationErpKey | string | |
workplaceNumber
|
workplaceNumber | string | |
workplaceDescription
|
workplaceDescription | string | |
productionLineNumber
|
productionLineNumber | string | |
productionLineDescription
|
productionLineDescription | string | |
workplaceType
|
workplaceType | string | |
operationId
|
operationId | string | |
operationName
|
operationName | string | |
operationSequenceNumber
|
operationSequenceNumber | string | |
operationDescription
|
operationDescription | string | |
operationPhase
|
operationPhase | string | |
productionOrderId
|
productionOrderId | string | |
productionOrderName
|
productionOrderName | string | |
productionOrderSplit
|
productionOrderSplit | string | |
productionOrderDescription
|
productionOrderDescription | string | |
productionOrderMaterialNumber
|
productionOrderMaterialNumber | string | |
productionOrderMaterialDescription
|
productionOrderMaterialDescription | string | |
productionOrderMaterialType
|
productionOrderMaterialType | string |
OperationList
Name | Path | Type | Description |
---|---|---|---|
numberOfOperations
|
numberOfOperations | number | |
operationList
|
operationList | array of OperationWorkplace |
Operation
Name | Path | Type | Description |
---|---|---|---|
operationErpKey
|
operationErpKey | string | |
operationId
|
operationId | string | |
operationName
|
operationName | string | |
operationSequenceNumber
|
operationSequenceNumber | string | |
operationDescription
|
operationDescription | string | |
operationPhase
|
operationPhase | string | |
productionOrderId
|
productionOrderId | string | |
productionOrderName
|
productionOrderName | string | |
productionOrderSplit
|
productionOrderSplit | string | |
productionOrderDescription
|
productionOrderDescription | string | |
productionOrderMaterialNumber
|
productionOrderMaterialNumber | string | |
productionOrderMaterialDescription
|
productionOrderMaterialDescription | string | |
productionOrderMaterialType
|
productionOrderMaterialType | string |
SemanticHitListOperatingStateMaterial
Name | Path | Type | Description |
---|---|---|---|
absoluteDurationPercentage
|
absoluteDurationPercentage | number | |
duration
|
duration | number | |
durationPercentage
|
durationPercentage | number | |
frequency
|
frequency | number | |
materialId
|
materialId | string | |
operationStateId
|
operationStateId | string |
SemanticHitListOperatingStateMaterialList
Name | Path | Type | Description |
---|---|---|---|
numberOfMaterialOperationStates
|
numberOfMaterialOperationStates | number | |
materialOperationStates
|
materialOperationStates | array of SemanticHitListOperatingStateMaterial |
SemanticHitListOperatingStateWorkplace
Name | Path | Type | Description |
---|---|---|---|
absoluteDurationPercentage
|
absoluteDurationPercentage | number | |
duration
|
duration | number | |
durationPercentage
|
durationPercentage | number | |
frequency
|
frequency | number | |
workplaceId
|
workplaceId | string | |
operatingStateId
|
operatingStateId | string |
SemanticHitListOperatingStateWorkplaceList
Name | Path | Type | Description |
---|---|---|---|
numberOfWorkplaceOperatingStates
|
numberOfWorkplaceOperatingStates | number | |
workplaceOperatingStates
|
workplaceOperatingStates | array of SemanticHitListOperatingStateWorkplace |
SemanticOverallEquipmentEfficiency
Name | Path | Type | Description |
---|---|---|---|
availability
|
availability | number | |
oee
|
oee | number | |
performance
|
performance | number | |
quality
|
quality | number |
SemanticOverallProcessEfficiency
Name | Path | Type | Description |
---|---|---|---|
ope
|
ope | number | |
performance
|
performance | number | |
processAvailability
|
processAvailability | number | |
productionProcessRatio
|
productionProcessRatio | number | |
quality
|
quality | number | |
schedulingEfficiency
|
schedulingEfficiency | number | |
setupReduction
|
setupReduction | number |
SemanticQualityDetailsMaterial
Name | Path | Type | Description |
---|---|---|---|
qualityTypeId
|
qualityTypeId | string | |
qualityDetailId
|
qualityDetailId | string | |
materialId
|
materialId | string | |
quantity
|
quantity | number |
SemanticQualityDetailsMaterialList
Name | Path | Type | Description |
---|---|---|---|
numberOfMaterialQualityDetails
|
numberOfMaterialQualityDetails | number | |
materialQualityDetails
|
materialQualityDetails | array of SemanticQualityDetailsMaterial |
SemanticQualityDetailsWorkplace
Name | Path | Type | Description |
---|---|---|---|
qualityTypeId
|
qualityTypeId | string | |
qualityDetailsId
|
qualityDetailsId | string | |
workplaceId
|
workplaceId | string | |
quantity
|
quantity | number |
SemanticQualityDetailsWorkplaceList
Name | Path | Type | Description |
---|---|---|---|
numberOfWorkplaceQualityDetails
|
numberOfWorkplaceQualityDetails | number | |
workplaceQualityDetails
|
workplaceQualityDetails | array of SemanticQualityDetailsWorkplace |
SemanticTotalQuantity
Name | Path | Type | Description |
---|---|---|---|
endDate
|
endDate | date-time | |
materialId
|
materialId | string | |
reworkQuantity
|
reworkQuantity | number | |
scrapQuantity
|
scrapQuantity | number | |
startDate
|
startDate | date-time | |
targetQuantity
|
targetQuantity | number | |
totalQuantity
|
totalQuantity | number | |
workplaceId
|
workplaceId | string | |
yieldQuantity
|
yieldQuantity | number |
SemanticTotalQuantityList
Name | Path | Type | Description |
---|---|---|---|
numberOfTotalQuantities
|
numberOfTotalQuantities | number | |
totalQuantities
|
totalQuantities | array of SemanticTotalQuantity |
Ticket
Name | Path | Type | Description |
---|---|---|---|
ticketId
|
ticketId | string | |
ticketNumber
|
ticketNumber | string | |
title
|
title | string | |
description
|
description | string | |
rootCause
|
rootCause | string | |
priority
|
priority | string | |
creationDate
|
creationDate | date-time | |
editor
|
editor | string | |
ticketStateId
|
ticketStateId | string | |
ticketClassId
|
ticketClassId | string | |
operationId
|
operationId | string | |
materialId
|
materialId | string | |
materialNumber
|
materialNumber | string | |
materialDescription
|
materialDescription | string | |
materialType
|
materialType | string | |
workplaceId
|
workplaceId | string | |
workplaceNumber
|
workplaceNumber | string | |
workplaceDescription
|
workplaceDescription | string | |
workplaceErpContextId
|
workplaceErpContextId | string | |
shiftId
|
shiftId | string |
TicketList
Name | Path | Type | Description |
---|---|---|---|
numberOfTickets
|
numberOfTickets | number | |
tickets
|
tickets | array of Ticket |
TicketAttachment
Name | Path | Type | Description |
---|---|---|---|
id
|
id | string | |
attachment
|
attachment | binary | |
editor
|
editor | string | |
description
|
description | string | |
creationDate
|
creationDate | date-time | |
mimeType
|
mimeType | string | |
size
|
size | number |
TicketAttachmentList
Name | Path | Type | Description |
---|---|---|---|
numberOfTicketAttachments
|
numberOfTicketAttachments | number | |
ticketAttachments
|
ticketAttachments | array of TicketAttachment |
TicketActivity
Name | Path | Type | Description |
---|---|---|---|
ticketActivityId
|
ticketActivityId | string | |
ticketActivityTitle
|
ticketActivityTitle | string | |
ticketActivityEditor
|
ticketActivityEditor | string | |
ticketActivityDescription
|
ticketActivityDescription | string | |
ticketActivityDueDate
|
ticketActivityDueDate | date-time | |
ticketActivityStateId
|
ticketActivityStateId | string |
TicketActivityList
Name | Path | Type | Description |
---|---|---|---|
numberOfTicketActivities
|
numberOfTicketActivities | number | |
ticketActivities
|
ticketActivities | array of TicketActivity |
TicketState
Name | Path | Type | Description |
---|---|---|---|
id
|
id | string | |
name
|
name | string | |
color
|
color | string |
TicketStateList
Name | Path | Type | Description |
---|---|---|---|
numberOfTicketStates
|
numberOfTicketStates | number | |
ticketStates
|
ticketStates | array of TicketState |
TicketActivityRemark
Name | Path | Type | Description |
---|---|---|---|
ticketActivityRemarkId
|
ticketActivityRemarkId | string | |
ticketActivityRemark
|
ticketActivityRemark | string | |
ticketActivityRemarkEditor
|
ticketActivityRemarkEditor | string | |
ticketActivityRemarkCreationDate
|
ticketActivityRemarkCreationDate | date-time |
TicketActivityRemarkList
Name | Path | Type | Description |
---|---|---|---|
numberOfTicketActivityRemarks
|
numberOfTicketActivityRemarks | number | |
ticketActivityRemarks
|
ticketActivityRemarks | array of TicketActivityRemark |
TicketClass
Name | Path | Type | Description |
---|---|---|---|
id
|
id | string | |
shortDescription
|
shortDescription | string | |
description
|
description | string | |
sequence
|
sequence | number | |
code
|
code | string |
TicketClassList
Name | Path | Type | Description |
---|---|---|---|
numberOfTicketClasses
|
numberOfTicketClasses | number | |
ticketClasses
|
ticketClasses | array of TicketClass |
TicketActivityAttachment
Name | Path | Type | Description |
---|---|---|---|
ticketActivityAttachmentId
|
ticketActivityAttachmentId | string | |
ticketActivityAttachmentData
|
ticketActivityAttachmentData | binary | |
ticketActivityAttachmentName
|
ticketActivityAttachmentName | string | |
ticketActivityAttachmentEditor
|
ticketActivityAttachmentEditor | string | |
ticketActivityAttachmentDescription
|
ticketActivityAttachmentDescription | string | |
ticketActivityAttachmentCreationDate
|
ticketActivityAttachmentCreationDate | date-time | |
ticketActivityAttachmentMimeType
|
ticketActivityAttachmentMimeType | string | |
ticketActivityAttachmentSize
|
ticketActivityAttachmentSize | number |
TicketActivityAttachmentList
Name | Path | Type | Description |
---|---|---|---|
numberOfTicketActivityAttachments
|
numberOfTicketActivityAttachments | number | |
ticketActivityAttachments
|
ticketActivityAttachments | array of TicketActivityAttachment |
Workplace
Name | Path | Type | Description |
---|---|---|---|
Id of the workplace
|
id | string |
Id of the workplace |
Erp key linked with the workplace
|
erpKey | string |
Erp key linked with the workplace |
Name of the workplace
|
name | string |
Name of the workplace |
Description of the workplace
|
description | string |
Description of the workplace |
Type of the workplace
|
type | string |
Type of the workplace |
Production line number of a workplace
|
productionLineNumber | string |
Production line number of a workplace |
Production line description of a workplace
|
productionLineDescription | string |
Production line description of a workplace |
Operation state id of a workplace
|
operatingStateId | string |
Operation state id of a workplace |
Operation state code of a workplace
|
operatingStateCode | string |
Operation state code of a workplace |
Operation state description of a workplace
|
operatingStateDescription | string |
Operation state description of a workplace |
Operation state short description of a workplace
|
operatingStateShortDescription | string |
Operation state short description of a workplace |
Operation state color of a workplace
|
operatingStateColor | string |
Operation state color of a workplace |
WorkplaceStuffMemberList
Name | Path | Type | Description |
---|---|---|---|
numberOfStaffMembers
|
numberOfStaffMembers | number | |
staffMembers
|
staffMembers | array of WorkplaceStuffMember |
WorkplaceStuffMember
Name | Path | Type | Description |
---|---|---|---|
id
|
id | string | |
erpContextId
|
erpContextId | string | |
firstName
|
firstName | string | |
lastName
|
lastName | string | |
identificationNumber
|
identificationNumber | string | |
staffNumber
|
staffNumber | string |