Connectors Reference

FORCAM FORCE Bridge

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.

 

Status: Preview

Tier: Premium

Version: 1.0.3

 

Actions:

Name

Summary

DeleteTrigger (string callbackId, [Optional]string event)

Deleted a trigger

OperatingStatesById (string operatingStatesId)

Get operating state by Id

GetMaterials ()

Get materials

OperationsInProgress (string workplaceId)

Get operations in progress

OperationsDispatched (string workplaceId)

Get dispatched operations

OperationsPlannable (string workplaceId)

Get plannable operations

OperationByOperationId (string operationId)

Get operation by Id

HitListOperatingStateByMaterialId (string startDate, string materialId, [Optional]string endDate)

Get hitlist by material

HitListOperatingStateWorkplace (string startDate, string workplaceId, [Optional]string endDate)

Get hitlist by workplace

HitListOperatingStateWorkplaceGroup (string startDate, string workplaceGroupId, [Optional]string endDate)

Get hitlist by workplaceGroup

OverallEquipmentEfficiency (string startDate, [Optional]string workplaceId, [Optional]string workplaceGroupId, [Optional]string endDate)

Get overall equipment efficiency (OEE)

OverallProcessEfficiency (string startDate, [Optional]string materialId, [Optional]string orderId, [Optional]string endDate)

Get overall process efficiency (OPE)

QualityDetailsByMaterialId (string startDate, string materialId, [Optional]string endDate)

Get material quality details

QualityDetailsByWorkplace (string startDate, [Optional]string materialId, [Optional]string workplaceId, [Optional]string workplaceGroupId, [Optional]string endDate)

Get workplace quality details

TotalQuantity (string startDate, [Optional]string endDate, [Optional]string workplaceId, [Optional]string workplaceGroupId)

Get total quantity details

Tickets ([Optional]string ticketNumber, [Optional]string ticketStateId, [Optional]string ticketClassId, [Optional]string workplaceId)

Get tickets

TicketCreate (TicketCreateParameterNewTicket newTicket)

Create a new ticket

TicketByTicketId (string ticketId)

Get ticket by Id

TicketByNumber (string ticketNumber)

Get ticket by number

TicketAttachmentById (string ticketId, string attachmentId)

Get ticket attachment by attachment Id

TicketAttachmentsByTicketId (string ticketId)

Get ticket attachments by ticket Id

TicketActivityById (string ticketId, string activityId)

Get ticket activity by Id

TicketActivityByTicketId (string ticketId)

Get ticket activities by ticket Id

TicketClasses ([Optional]string limit, [Optional]string offset)

Get ticket classes

TicketClassByClassId (string ticketClassId)

Get ticket class by Id

TicketActivityRemarkById (string ticketId, string activityId, string remarkId)

Get ticket activity remark by Id

TicketStates ([Optional]string limit, [Optional]string offset)

Get ticket states

TicketActivityRemarkByActivityId (string ticketId, string activityId)

Get ticket activity  remarks by activity Id

TicketStatesChange (string ticketId, string newTicketState)

Change state of ticket

TicketActivityAttachmentById (string ticketId, string activityId, string attachmentId)

Get ticket activity attachment by Id

TicketStatesByStateId (string ticketStateId)

Get ticket state by Id

TicketActivityAttachmentsByActivityId (string ticketId, string activityId)

Get ticket activity attachments by Id

GetWorkplace (string workplaceId)

Get workplace

getWorkplaces ()

Get workplace

WorkplaceStuffMember (string workplaceId)

Get current staff members of the workplace

getWorkplaceGroups ()

Get workplace groups

 

Triggers:

Name

Summary

TicketCreatedTrigger (RegisterHookPayload body, [Optional]string filterId)

When a new ticket has been created

TicketUpdatedTrigger (RegisterHookPayload body, [Optional]string filterId)

When an existing ticket has been updated

TicketDeletedTrigger (RegisterHookPayload body, [Optional]string filterId)

When a ticket has been deleted

TicketStateChangedTrigger (RegisterHookPayload body, [Optional]string filterId)

When the state of a ticket has been changed

TicketAttachmentCreatedTrigger (RegisterHookPayload body, [Optional]string filterId)

When a ticket attachment has been created

TicketAttachmentDeletedTrigger (RegisterHookPayload body, [Optional]string filterId)

When a ticket attachment has been deleted

TicketActivityCreatedTrigger (RegisterHookPayload body, [Optional]string filterId)

When a ticket activity has been created

TicketActivityUpdatedTrigger (RegisterHookPayload body, [Optional]string filterId)

When a ticket activity has been updated

TicketActivityDeletedTrigger (RegisterHookPayload body, [Optional]string filterId)

When a ticket activity has been deleted

TicketActivityStateChangedTrigger (RegisterHookPayload body, [Optional]string filterId)

When a ticket activity state has been changed

TicketActivityRemarkCreatedTrigger (RegisterHookPayload body, [Optional]string filterId)

When a ticket activity remark has been created

TicketActivityRemarkDeletedTrigger (RegisterHookPayload body, [Optional]string filterId)

When a ticket activity remark has been deleted

TicketActivityAttachmentCreatedTrigger (RegisterHookPayload body, [Optional]string filterId)

When a ticket activity attachment has been created

TicketActivityAttachmentDeletedTrigger (RegisterHookPayload body, [Optional]string filterId)

When a ticket activity attachment has been deleted

WorkplaceCreatedTrigger (RegisterHookPayload body, [Optional]string filterId)

When a new workplace has been created

WorkplaceUpdatedTrigger (RegisterHookPayload body, [Optional]string filterId)

When a workplace has been updated

WorkplaceOperatingStateChangedTrigger (RegisterHookPayload body, [Optional]string filterId)

When the operating state of a workplace has been changed

WorkplaceDeletedTrigger (RegisterHookPayload body, [Optional]string filterId)

When a workplace has been deleted

ProcessDataRuleViolatedEventTrigger (string eventName, RegisterHookPayload body)

When a process data rule has been violated

CustomizedTrigger (RegisterHookPayload body, string eventName)

When a customized action occured

CustomizedRawTrigger (RegisterHookPayload body, string eventName)

When a customized action occured (raw)

Webhook-trigger (RegisterHookPayload body, string eventRegisterName, [Optional]string eventName, [Optional]string filterId)

Triggers when a PUSH event occurs

 

Objects:

Name

Summary

MasterDataOperatingState

 

Material

 

MaterialList

 

MaterialsListFilter

 

Operation

 

OperationList

 

OperationWorkplace

 

RegisterHookPayload

 

SemanticHitListOperatingStateMaterial

 

SemanticHitListOperatingStateMaterialList

 

SemanticHitListOperatingStateWorkplace

 

SemanticHitListOperatingStateWorkplaceList

 

SemanticOverallEquipmentEfficiency

 

SemanticOverallProcessEfficiency

 

SemanticQualityDetailsMaterial

 

SemanticQualityDetailsMaterialList

 

SemanticQualityDetailsWorkplace

 

SemanticQualityDetailsWorkplaceList

 

SemanticTotalQuantity

 

SemanticTotalQuantityList

 

Ticket

 

TicketActivity

 

TicketActivityAttachment

 

TicketActivityAttachmentList

 

TicketActivityList

 

TicketActivityRemark

 

TicketActivityRemarkList

 

TicketAttachment

 

TicketAttachmentList

 

TicketClass

 

TicketClassList

 

TicketCreateParameterNewTicket

 

TicketList

 

TicketState

 

TicketStateList

 

Workplace

 

WorkplaceFilter

 

WorkplaceGroup

 

WorkplaceGroupList

 

WorkplaceGroupListFilter

 

WorkplaceList

 

WorkplaceStuffMember

 

WorkplaceStuffMemberList

 

 

Actions:

DeleteTrigger

Summary: Deleted a trigger

Description: Deleted a trigger

 

Syntax:

FORCAMFORCEBridge.DeleteTrigger (string callbackId, [Optional]string event)

 

Parameters:

Name

Type

Summary

Required

Related Action

callbackId

string

 

Id of the callback

True

event

string

 

event identifier

False

 

Returns:

 

OperatingStatesById

Summary: Get operating state by Id

Description: Get the operating states by its state Id

 

Syntax:

FORCAMFORCEBridge.OperatingStatesById (string operatingStatesId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operatingStatesId

string

(The Id of the operatingState)

The Id of the operatingState

True

 

Returns:

          Type:MasterDataOperatingState

 

GetMaterials

Summary: Get materials

Description: Get materials

 

Syntax:

FORCAMFORCEBridge.GetMaterials ()

 

Returns:

          Type:MaterialsListFilter

 

OperationsInProgress

Summary: Get operations in progress

Description: Get operations that are in progress

 

Syntax:

FORCAMFORCEBridge.OperationsInProgress (string workplaceId)

 

Parameters:

Name

Type

Summary

Required

Related Action

workplaceId

string

(WorkplaceId)

Id of workplace

True

getWorkplaces

 

Returns:

          Type:OperationList

 

OperationsDispatched

Summary: Get dispatched operations

Description: Get operations that are dispatched

 

Syntax:

FORCAMFORCEBridge.OperationsDispatched (string workplaceId)

 

Parameters:

Name

Type

Summary

Required

Related Action

workplaceId

string

(WorkplaceId)

Id of workplace

True

getWorkplaces

 

Returns:

          Type:OperationList

 

OperationsPlannable

Summary: Get plannable operations

Description: Get operations that are plannable

 

Syntax:

FORCAMFORCEBridge.OperationsPlannable (string workplaceId)

 

Parameters:

Name

Type

Summary

Required

Related Action

workplaceId

string

(WorkplaceId)

Id of workplace

True

getWorkplaces

 

Returns:

          Type:OperationList

 

OperationByOperationId

Summary: Get operation by Id

Description: get an operation by the Id

 

Syntax:

FORCAMFORCEBridge.OperationByOperationId (string operationId)

 

Parameters:

Name

Type

Summary

Required

Related Action

operationId

string

(Operation Id)

Id of an operation

True

 

Returns:

          Type:Operation

 

HitListOperatingStateByMaterialId

Summary: Get hitlist by material

Description: Get a hitlist of operating states

 

Syntax:

FORCAMFORCEBridge.HitListOperatingStateByMaterialId (string startDate, string materialId, [Optional]string endDate)

 

Parameters:

Name

Type

Summary

Required

Related Action

startDate

string(date-time)

(Start date)

Filter start date

True

materialId

string

(MaterialId)

Id of a material

True

GetMaterials

endDate

string(date-time)

(End date)

Filter end date

False

 

Returns:

          Type:SemanticHitListOperatingStateMaterialList

 

HitListOperatingStateWorkplace

Summary: Get hitlist by workplace

Description: Get a hitlist of operating states by its workplace Id

 

Syntax:

FORCAMFORCEBridge.HitListOperatingStateWorkplace (string startDate, string workplaceId, [Optional]string endDate)

 

Parameters:

Name

Type

Summary

Required

Related Action

startDate

string(date-time)

(Start date)

Filter start date

True

workplaceId

string

(WorkplaceId)

Id of a workplace

True

getWorkplaces

endDate

string(date-time)

(End date)

Filter end date

False

 

Returns:

          Type:SemanticHitListOperatingStateWorkplaceList

 

HitListOperatingStateWorkplaceGroup

Summary: Get hitlist by workplaceGroup

Description: Get a hitlist of operating states by its workplace Id

 

Syntax:

FORCAMFORCEBridge.HitListOperatingStateWorkplaceGroup (string startDate, string workplaceGroupId, [Optional]string endDate)

 

Parameters:

Name

Type

Summary

Required

Related Action

startDate

string(date-time)

(Start date)

Filter start date

True

workplaceGroupId

string

(WorkplaceGroupId)

Id of a workplace group

True

getWorkplaceGroups

endDate

string(date-time)

(End date)

Filter end date

False

 

Returns:

          Type:SemanticHitListOperatingStateWorkplaceList

 

OverallEquipmentEfficiency

Summary: Get overall equipment efficiency (OEE)

Description: Get overall equipment efficiency (OEE)

 

Syntax:

FORCAMFORCEBridge.OverallEquipmentEfficiency (string startDate, [Optional]string workplaceId, [Optional]string workplaceGroupId, [Optional]string endDate)

 

Parameters:

Name

Type

Summary

Required

Related Action

startDate

string(date-time)

(Start date)

Filter start date

True

workplaceId

string

(WorkplaceId)

Id of a workplace

False

getWorkplaces

workplaceGroupId

string

(WorkplaceGroupId)

Id of a workplace group

False

getWorkplaceGroups

endDate

string(date-time)

(End date)

Filter end date

False

 

Returns:

          Type:SemanticOverallEquipmentEfficiency

 

OverallProcessEfficiency

Summary: Get overall process efficiency (OPE)

Description: Get the overall process efficiency (OPE)

 

Syntax:

FORCAMFORCEBridge.OverallProcessEfficiency (string startDate, [Optional]string materialId, [Optional]string orderId, [Optional]string endDate)

 

Parameters:

Name

Type

Summary

Required

Related Action

startDate

string(date-time)

(Start date)

Filter start date

True

materialId

string

(MaterialId)

Id of a material

False

GetMaterials

orderId

string

(Order Id)

Id of a order

False

endDate

string(date-time)

(End date)

Filter end date

False

 

Returns:

          Type:SemanticOverallProcessEfficiency

 

QualityDetailsByMaterialId

Summary: Get material quality details

Description: Get the material quality details

 

Syntax:

FORCAMFORCEBridge.QualityDetailsByMaterialId (string startDate, string materialId, [Optional]string endDate)

 

Parameters:

Name

Type

Summary

Required

Related Action

startDate

string(date-time)

(Start date)

Filter start date

True

materialId

string

(MaterialId)

Id of a material

True

GetMaterials

endDate

string(date-time)

(End date)

Filter end date

False

 

Returns:

          Type:SemanticQualityDetailsMaterialList

 

QualityDetailsByWorkplace

Summary: Get workplace quality details

Description: Get workplace quality details by its workplaceId and materialId

 

Syntax:

FORCAMFORCEBridge.QualityDetailsByWorkplace (string startDate, [Optional]string materialId, [Optional]string workplaceId, [Optional]string workplaceGroupId, [Optional]string endDate)

 

Parameters:

Name

Type

Summary

Required

Related Action

startDate

string(date-time)

(Start date)

Filter start date

True

materialId

string

(MaterialId)

Id of a material

False

GetMaterials

workplaceId

string

(WorkplaceId)

Id of a workplace

False

getWorkplaces

workplaceGroupId

string

(WorkplaceGroupId)

Id of a workplace group

False

getWorkplaceGroups

endDate

string(date-time)

(End date)

Filter end date

False

 

Returns:

          Type:SemanticQualityDetailsWorkplaceList

 

TotalQuantity

Summary: Get total quantity details

Description: Get total quantity details

 

Syntax:

FORCAMFORCEBridge.TotalQuantity (string startDate, [Optional]string endDate, [Optional]string workplaceId, [Optional]string workplaceGroupId)

 

Parameters:

Name

Type

Summary

Required

Related Action

startDate

string(date-time)

(Start date)

Filter start date

True

endDate

string(date-time)

(End date)

Filter end date

False

workplaceId

string

(WorkplaceId)

Id of a workplace

False

getWorkplaces

workplaceGroupId

string

(WorkplaceGroupId)

Id of a workplace group

False

getWorkplaceGroups

 

Returns:

          Type:SemanticTotalQuantityList

 

Tickets

Summary: Get tickets

Description: Get tickets

 

Syntax:

FORCAMFORCEBridge.Tickets ([Optional]string ticketNumber, [Optional]string ticketStateId, [Optional]string ticketClassId, [Optional]string workplaceId)

 

Parameters:

Name

Type

Summary

Required

Related Action

ticketNumber

string

(Ticketnumber)

Number of the ticket

False

ticketStateId

string

(Ticket state)Values: [NEW, IN_PROGRESS, DONE, CONFIRMED, REOPENED]

Ticket state

False

ticketClassId

string

(TicketClassId)

class of the ticket

False

TicketClasses

workplaceId

string

(WorkplaceId)

Id of workplace that tickets have to belong to

False

getWorkplaces

 

Returns:

          Type:TicketList

 

TicketCreate

Summary: Create a new ticket

Description: Create a new ticket

 

Syntax:

FORCAMFORCEBridge.TicketCreate (TicketCreateParameterNewTicket newTicket)

 

Parameters:

Name

Type

Summary

Required

Related Action

newTicket

TicketCreateParameterNewTicket

 

 

True

 

Returns:

          Type:Ticket

 

TicketByTicketId

Summary: Get ticket by Id

Description: Get ticket by Id

 

Syntax:

FORCAMFORCEBridge.TicketByTicketId (string ticketId)

 

Parameters:

Name

Type

Summary

Required

Related Action

ticketId

string

(Ticket Id)

Id of the ticket

True

 

Returns:

          Type:Ticket

 

TicketByNumber

Summary: Get ticket by number

Description: Get ticket by the ticket number

 

Syntax:

FORCAMFORCEBridge.TicketByNumber (string ticketNumber)

 

Parameters:

Name

Type

Summary

Required

Related Action

ticketNumber

string

(Ticketnumber)

Number of the ticket

True

 

Returns:

          Type:Ticket

 

TicketAttachmentById

Summary: Get ticket attachment by attachment Id

Description: Get ticket attachment by the ticket and attachmentId

 

Syntax:

FORCAMFORCEBridge.TicketAttachmentById (string ticketId, string attachmentId)

 

Parameters:

Name

Type

Summary

Required

Related Action

ticketId

string

(Ticket Id)

Id of the ticket

True

attachmentId

string

(Id of the attachment)

Id of the attachment

True

 

Returns:

          Type:TicketAttachment

 

TicketAttachmentsByTicketId

Summary: Get ticket attachments by ticket Id

Description: Get ticket attachments by the ticket Id

 

Syntax:

FORCAMFORCEBridge.TicketAttachmentsByTicketId (string ticketId)

 

Parameters:

Name

Type

Summary

Required

Related Action

ticketId

string

(Ticket Id)

Id of the ticket

True

 

Returns:

          Type:TicketAttachmentList

 

TicketActivityById

Summary: Get ticket activity by Id

Description: Get ticket activity by the ticket and activity Id

 

Syntax:

FORCAMFORCEBridge.TicketActivityById (string ticketId, string activityId)

 

Parameters:

Name

Type

Summary

Required

Related Action

ticketId

string

(Ticket Id)

Id of the ticket

True

activityId

string

(Id of the Activity)

Id of the Activity

True

 

Returns:

          Type:TicketActivity

 

TicketActivityByTicketId

Summary: Get ticket activities by ticket Id

Description: Get ticket activities by the ticket Id

 

Syntax:

FORCAMFORCEBridge.TicketActivityByTicketId (string ticketId)

 

Parameters:

Name

Type

Summary

Required

Related Action

ticketId

string

(Ticket Id)

Id of the ticket

True

 

Returns:

          Type:TicketActivityList

 

TicketClasses

Summary: Get ticket classes

Description: Get ticket classes

 

Syntax:

FORCAMFORCEBridge.TicketClasses ([Optional]string limit, [Optional]string offset)

 

Parameters:

Name

Type

Summary

Required

Related Action

limit

string

(Limit)

Limit

False

offset

string

(Offset)

Offset

False

 

Returns:

          Type:TicketClassList

 

TicketClassByClassId

Summary: Get ticket class by Id

Description: Get ticket class by Id

 

Syntax:

FORCAMFORCEBridge.TicketClassByClassId (string ticketClassId)

 

Parameters:

Name

Type

Summary

Required

Related Action

ticketClassId

string

(TicketClassId)

Id of ticketClass

True

TicketClasses

 

Returns:

          Type:TicketClass

 

TicketActivityRemarkById

Summary: Get ticket activity remark by Id

Description: Get ticket activity remark by the remark Id

 

Syntax:

FORCAMFORCEBridge.TicketActivityRemarkById (string ticketId, string activityId, string remarkId)

 

Parameters:

Name

Type

Summary

Required

Related Action

ticketId

string

(Ticket Id)

Id of the ticket

True

activityId

string

(Id of the Activity)

Id of the Activity

True

remarkId

string

(Id of the Activity)

Id of the Activity

True

 

Returns:

          Type:TicketActivityRemark

 

TicketStates

Summary: Get ticket states

Description: Get ticket states

 

Syntax:

FORCAMFORCEBridge.TicketStates ([Optional]string limit, [Optional]string offset)

 

Parameters:

Name

Type

Summary

Required

Related Action

limit

string

(Limit)

Limit

False

offset

string

(Offset)

Offset

False

 

Returns:

          Type:TicketStateList

 

TicketActivityRemarkByActivityId

Summary: Get ticket activity  remarks by activity Id

Description: Get ticket activity remarks  by the activity Id

 

Syntax:

FORCAMFORCEBridge.TicketActivityRemarkByActivityId (string ticketId, string activityId)

 

Parameters:

Name

Type

Summary

Required

Related Action

ticketId

string

(Ticket Id)

Id of the ticket

True

activityId

string

(Id of the Activity)

Id of the Activity

True

 

Returns:

          Type:TicketActivityRemarkList

 

TicketStatesChange

Summary: Change state of ticket

Description: Change state of ticket

 

Syntax:

FORCAMFORCEBridge.TicketStatesChange (string ticketId, string newTicketState)

 

Parameters:

Name

Type

Summary

Required

Related Action

ticketId

string

(Ticket Id)

Id of ticket

True

newTicketState

string

(New ticket state)Values: [NEW, IN_PROGRESS, DONE, CONFIRMED, REOPENED]

New ticket state for ticket

True

 

Returns:

          Type:Ticket

 

TicketActivityAttachmentById

Summary: Get ticket activity attachment by Id

Description: Get ticket activity attachment by the ticket, activity and attachmentId

 

Syntax:

FORCAMFORCEBridge.TicketActivityAttachmentById (string ticketId, string activityId, string attachmentId)

 

Parameters:

Name

Type

Summary

Required

Related Action

ticketId

string

(Ticket Id)

Id of the ticket

True

activityId

string

(Id of the Activity)

Id of the activity

True

attachmentId

string

(Id of the attachment)

Id of the attachment

True

 

Returns:

          Type:TicketActivityAttachment

 

TicketStatesByStateId

Summary: Get ticket state by Id

Description: Get ticket state by Id

 

Syntax:

FORCAMFORCEBridge.TicketStatesByStateId (string ticketStateId)

 

Parameters:

Name

Type

Summary

Required

Related Action

ticketStateId

string

(Ticket state)Values: [NEW, IN_PROGRESS, DONE, CONFIRMED, REOPENED]

Ticket state

True

 

Returns:

          Type:TicketState

 

TicketActivityAttachmentsByActivityId

Summary: Get ticket activity attachments by Id

Description: Get ticket activity attachments by the ticket, activity and attachmentId

 

Syntax:

FORCAMFORCEBridge.TicketActivityAttachmentsByActivityId (string ticketId, string activityId)

 

Parameters:

Name

Type

Summary

Required

Related Action

ticketId

string

(Ticket Id)

Id of the ticket

True

activityId

string

(Id of the Activity)

Id of the activity

True

 

Returns:

          Type:TicketActivityAttachmentList

 

GetWorkplace

Summary: Get workplace

Description: Get workplace

 

Syntax:

FORCAMFORCEBridge.GetWorkplace (string workplaceId)

 

Parameters:

Name

Type

Summary

Required

Related Action

workplaceId

string

(WorkplaceId)

Id of workplace

True

getWorkplaces

 

Returns:

          Type:Workplace

 

getWorkplaces

Summary: Get workplace

Description: Get workplaces

 

Syntax:

FORCAMFORCEBridge.getWorkplaces ()

 

Returns:

          Type:WorkplaceFilter

 

WorkplaceStuffMember

Summary: Get current staff members of the workplace

Description: Get current staff members of the workplace

 

Syntax:

FORCAMFORCEBridge.WorkplaceStuffMember (string workplaceId)

 

Parameters:

Name

Type

Summary

Required

Related Action

workplaceId

string

(WorkplaceId)

Id of workplace

True

getWorkplaces

 

Returns:

          Type:WorkplaceStuffMemberList

 

getWorkplaceGroups

Summary: Get workplace groups

Description: Get workplaces groups

 

Syntax:

FORCAMFORCEBridge.getWorkplaceGroups ()

 

Returns:

          Type:WorkplaceGroupListFilter

 

Triggers:

Trigger TicketCreatedTrigger

Summary: When a new ticket has been created

Description: When a new ticket has been created

 

Syntax:

FORCAMFORCEBridge.TicketCreatedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(Id of object to filter)

Id of object to filter

False

 

Returns:

 

Trigger TicketUpdatedTrigger

Summary: When an existing ticket has been updated

Description: When an existing ticket has been updated

 

Syntax:

FORCAMFORCEBridge.TicketUpdatedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(Id of object to filter)

Id of object to filter

False

 

Returns:

 

Trigger TicketDeletedTrigger

Summary: When a ticket has been deleted

Description: When a ticket has been deleted

 

Syntax:

FORCAMFORCEBridge.TicketDeletedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(Id of object to filter)

Id of object to filter

False

 

Returns:

 

Trigger TicketStateChangedTrigger

Summary: When the state of a ticket has been changed

Description: When the state of a ticket has been changed

 

Syntax:

FORCAMFORCEBridge.TicketStateChangedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(Id of object to filter)

Id of object to filter

False

 

Returns:

 

Trigger TicketAttachmentCreatedTrigger

Summary: When a ticket attachment has been created

Description: When a ticket attachment has been created

 

Syntax:

FORCAMFORCEBridge.TicketAttachmentCreatedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(Id of object to filter)

Id of object to filter

False

 

Returns:

 

Trigger TicketAttachmentDeletedTrigger

Summary: When a ticket attachment has been deleted

Description: When a ticket attachment has been deleted

 

Syntax:

FORCAMFORCEBridge.TicketAttachmentDeletedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(Id of object to filter)

Id of object to filter

False

 

Returns:

 

Trigger TicketActivityCreatedTrigger

Summary: When a ticket activity has been created

Description: When a ticket activity has been created

 

Syntax:

FORCAMFORCEBridge.TicketActivityCreatedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(Id of object to filter)

Id of object to filter

False

 

Returns:

 

Trigger TicketActivityUpdatedTrigger

Summary: When a ticket activity has been updated

Description: When a ticket activity has been updated

 

Syntax:

FORCAMFORCEBridge.TicketActivityUpdatedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(Id of object to filter)

Id of object to filter

False

 

Returns:

 

Trigger TicketActivityDeletedTrigger

Summary: When a ticket activity has been deleted

Description: When a ticket activity has been deleted

 

Syntax:

FORCAMFORCEBridge.TicketActivityDeletedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(Id of object to filter)

Id of object to filter

False

 

Returns:

 

Trigger TicketActivityStateChangedTrigger

Summary: When a ticket activity state has been changed

Description: When a ticket activity state has been changed

 

Syntax:

FORCAMFORCEBridge.TicketActivityStateChangedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(Id of object to filter)

Id of object to filter

False

 

Returns:

 

Trigger TicketActivityRemarkCreatedTrigger

Summary: When a ticket activity remark has been created

Description: When a ticket activity remark has been created

 

Syntax:

FORCAMFORCEBridge.TicketActivityRemarkCreatedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(Id of object to filter)

Id of object to filter

False

 

Returns:

 

Trigger TicketActivityRemarkDeletedTrigger

Summary: When a ticket activity remark has been deleted

Description: When a ticket activity remark has been deleted

 

Syntax:

FORCAMFORCEBridge.TicketActivityRemarkDeletedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(Id of object to filter)

Id of object to filter

False

 

Returns:

 

Trigger TicketActivityAttachmentCreatedTrigger

Summary: When a ticket activity attachment has been created

Description: When a ticket activity attachment has been created

 

Syntax:

FORCAMFORCEBridge.TicketActivityAttachmentCreatedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(Id of object to filter)

Id of object to filter

False

 

Returns:

 

Trigger TicketActivityAttachmentDeletedTrigger

Summary: When a ticket activity attachment has been deleted

Description: When a ticket activity attachment has been deleted

 

Syntax:

FORCAMFORCEBridge.TicketActivityAttachmentDeletedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(Id of object to filter)

Id of object to filter

False

 

Returns:

 

Trigger WorkplaceCreatedTrigger

Summary: When a new workplace has been created

Description: When a new workplace has been created

 

Syntax:

FORCAMFORCEBridge.WorkplaceCreatedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(WorkplaceId)

Id of object to filter

False

getWorkplaces

 

Returns:

 

Trigger WorkplaceUpdatedTrigger

Summary: When a workplace has been updated

Description: When a workplace has been updated

 

Syntax:

FORCAMFORCEBridge.WorkplaceUpdatedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(WorkplaceId)

Id of object to filter

False

getWorkplaces

 

Returns:

 

Trigger WorkplaceOperatingStateChangedTrigger

Summary: When the operating state of a workplace has been changed

Description: When the operating state of a workplace has been changed

 

Syntax:

FORCAMFORCEBridge.WorkplaceOperatingStateChangedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(WorkplaceId)

Id of object to filter

False

getWorkplaces

 

Returns:

 

Trigger WorkplaceDeletedTrigger

Summary: When a workplace has been deleted

Description: When a workplace has been deleted

 

Syntax:

FORCAMFORCEBridge.WorkplaceDeletedTrigger (RegisterHookPayload body, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

filterId

string

(WorkplaceId)

Id of object to filter

False

getWorkplaces

 

Returns:

 

Trigger ProcessDataRuleViolatedEventTrigger

Summary: When a process data rule has been violated

Description: When a process data rule has been violated

 

Syntax:

FORCAMFORCEBridge.ProcessDataRuleViolatedEventTrigger (string eventName, RegisterHookPayload body)

 

Parameters:

Name

Type

Summary

Required

Related Action

eventName

string

(Name of the rule)

Name of the rule

True

body

RegisterHookPayload

 

 

True

 

Returns:

 

Trigger CustomizedTrigger

Summary: When a customized action occured

Description: When a customized action occured

 

Syntax:

FORCAMFORCEBridge.CustomizedTrigger (RegisterHookPayload body, string eventName)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

eventName

string

(Name of the event)

Name of the event

True

 

Returns:

 

Trigger CustomizedRawTrigger

Summary: When a customized action occured (raw)

Description: When a customized action occured (raw)

 

Syntax:

FORCAMFORCEBridge.CustomizedRawTrigger (RegisterHookPayload body, string eventName)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

eventName

string

(Name of the event)

Name of the event

True

 

Returns:

 

Trigger Webhook-trigger

Summary: Triggers when a PUSH event occurs

Description: Creates webhook

 

Syntax:

FORCAMFORCEBridge.Webhook-trigger (RegisterHookPayload body, string eventRegisterName, [Optional]string eventName, [Optional]string filterId)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

RegisterHookPayload

 

 

True

eventRegisterName

string

 

name of the registered event

True

eventName

string

(Name of the event)

Name of the event

False

filterId

string

(Id of object to filter)

Id of object to filter

False

 

Returns:

 


 

MasterDataOperatingState

Summary:

Description:

 

          Properties:

Name

Type

Summary

operatingStateId

string

 

 

description

string

 

 

shortDescription

string

 

 

code

string

 

 

color

string

 

 

recodable

boolean

 

 

splittable

boolean

 

 

annotatable

boolean

 

 

customerCode

string

 

 

workplaceStateId

string

 

 

operatingStateClassId

string

 

 


 

Material

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

number

string

 

 

description

string

 

 

type

string

 

 


 

MaterialList

Summary:

Description:

 

          Properties:

Name

Type

Summary

numberOfMaterials

number

 

 

materials

array of (Material)

 

 


 

MaterialsListFilter

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (MaterialList)

value

 


 

Operation

Summary:

Description:

 

          Properties:

Name

Type

Summary

operationErpKey

string

 

 

operationId

string

 

 

operationName

string

 

 

operationSequenceNumber

string

 

 

operationDescription

string

 

 

operationPhase

string

 

 

productionOrderId

string

 

 

productionOrderName

string

 

 

productionOrderSplit

string

 

 

productionOrderDescription

string

 

 

productionOrderMaterialNumber

string

 

 

productionOrderMaterialDescription

string

 

 

productionOrderMaterialType

string

 

 


 

OperationList

Summary:

Description:

 

          Properties:

Name

Type

Summary

numberOfOperations

number

 

 

operationList

array of (OperationWorkplace)

 

 


 

OperationWorkplace

Summary:

Description:

 

          Properties:

Name

Type

Summary

workplaceId

string

 

 

operationErpKey

string

 

 

workplaceNumber

string

 

 

workplaceDescription

string

 

 

productionLineNumber

string

 

 

productionLineDescription

string

 

 

workplaceType

string

 

 

operationId

string

 

 

operationName

string

 

 

operationSequenceNumber

string

 

 

operationDescription

string

 

 

operationPhase

string

 

 

productionOrderId

string

 

 

productionOrderName

string

 

 

productionOrderSplit

string

 

 

productionOrderDescription

string

 

 

productionOrderMaterialNumber

string

 

 

productionOrderMaterialDescription

string

 

 

productionOrderMaterialType

string

 

 


 

RegisterHookPayload

Summary:

Description:

 

          Properties:

Name

Type

Summary

callbackUrl

string

 

callbackUrl


 

SemanticHitListOperatingStateMaterial

Summary:

Description:

 

          Properties:

Name

Type

Summary

absoluteDurationPercentage

number

 

 

duration

number

 

 

durationPercentage

number

 

 

frequency

number

 

 

materialId

string

 

 

operationStateId

string

 

 


 

SemanticHitListOperatingStateMaterialList

Summary:

Description:

 

          Properties:

Name

Type

Summary

numberOfMaterialOperationStates

number

 

 

materialOperationStates

array of (SemanticHitListOperatingStateMaterial)

 

 


 

SemanticHitListOperatingStateWorkplace

Summary:

Description:

 

          Properties:

Name

Type

Summary

absoluteDurationPercentage

number

 

 

duration

number

 

 

durationPercentage

number

 

 

frequency

number

 

 

workplaceId

string

 

 

operatingStateId

string

 

 


 

SemanticHitListOperatingStateWorkplaceList

Summary:

Description:

 

          Properties:

Name

Type

Summary

numberOfWorkplaceOperatingStates

number

 

 

workplaceOperatingStates

array of (SemanticHitListOperatingStateWorkplace)

 

 


 

SemanticOverallEquipmentEfficiency

Summary:

Description:

 

          Properties:

Name

Type

Summary

availability

number

 

 

oee

number

 

 

performance

number

 

 

quality

number

 

 


 

SemanticOverallProcessEfficiency

Summary:

Description:

 

          Properties:

Name

Type

Summary

ope

number

 

 

performance

number

 

 

processAvailability

number

 

 

productionProcessRatio

number

 

 

quality

number

 

 

schedulingEfficiency

number

 

 

setupReduction

number

 

 


 

SemanticQualityDetailsMaterial

Summary:

Description:

 

          Properties:

Name

Type

Summary

qualityTypeId

string

 

 

qualityDetailId

string

 

 

materialId

string

 

 

quantity

number

 

 


 

SemanticQualityDetailsMaterialList

Summary:

Description:

 

          Properties:

Name

Type

Summary

numberOfMaterialQualityDetails

number

 

 

materialQualityDetails

array of (SemanticQualityDetailsMaterial)

 

 


 

SemanticQualityDetailsWorkplace

Summary:

Description:

 

          Properties:

Name

Type

Summary

qualityTypeId

string

 

 

qualityDetailsId

string

 

 

workplaceId

string

 

 

quantity

number

 

 


 

SemanticQualityDetailsWorkplaceList

Summary:

Description:

 

          Properties:

Name

Type

Summary

numberOfWorkplaceQualityDetails

number

 

 

workplaceQualityDetails

array of (SemanticQualityDetailsWorkplace)

 

 


 

SemanticTotalQuantity

Summary:

Description:

 

          Properties:

Name

Type

Summary

endDate

string(date-time)

 

 

materialId

string

 

 

reworkQuantity

number

 

 

scrapQuantity

number

 

 

startDate

string(date-time)

 

 

targetQuantity

number

 

 

totalQuantity

number

 

 

workplaceId

string

 

 

yieldQuantity

number

 

 


 

SemanticTotalQuantityList

Summary:

Description:

 

          Properties:

Name

Type

Summary

numberOfTotalQuantities

number

 

 

totalQuantities

array of (SemanticTotalQuantity)

 

 


 

Ticket

Summary:

Description:

 

          Properties:

Name

Type

Summary

ticketId

string

 

 

ticketNumber

string

 

 

title

string

 

 

description

string

 

 

rootCause

string

 

 

priority

string

 

 

creationDate

string(date-time)

 

 

editor

string

 

 

ticketStateId

string

 

Values: [NEW, IN_PROGRESS, DONE, CONFIRMED, REOPENED]

ticketClassId

string

 

 

operationId

string

 

 

materialId

string

 

 

materialNumber

string

 

 

materialDescription

string

 

 

materialType

string

 

 

workplaceId

string

 

 

workplaceNumber

string

 

 

workplaceDescription

string

 

 

workplaceErpContextId

string

 

 

shiftId

string

 

 


 

TicketActivity

Summary:

Description:

 

          Properties:

Name

Type

Summary

ticketActivityId

string

 

 

ticketActivityTitle

string

 

 

ticketActivityEditor

string

 

 

ticketActivityDescription

string

 

 

ticketActivityDueDate

string(date-time)

 

 

ticketActivityStateId

string

 

 


 

TicketActivityAttachment

Summary:

Description:

 

          Properties:

Name

Type

Summary

ticketActivityAttachmentId

string

 

 

ticketActivityAttachmentData

string(binary)

 

 

ticketActivityAttachmentName

string

 

 

ticketActivityAttachmentEditor

string

 

 

ticketActivityAttachmentDescription

string

 

 

ticketActivityAttachmentCreationDate

string(date-time)

 

 

ticketActivityAttachmentMimeType

string

 

 

ticketActivityAttachmentSize

number

 

 


 

TicketActivityAttachmentList

Summary:

Description:

 

          Properties:

Name

Type

Summary

numberOfTicketActivityAttachments

number

 

 

ticketActivityAttachments

array of (TicketActivityAttachment)

 

 


 

TicketActivityList

Summary:

Description:

 

          Properties:

Name

Type

Summary

numberOfTicketActivities

number

 

 

ticketActivities

array of (TicketActivity)

 

 


 

TicketActivityRemark

Summary:

Description:

 

          Properties:

Name

Type

Summary

ticketActivityRemarkId

string

 

 

ticketActivityRemark

string

 

 

ticketActivityRemarkEditor

string

 

 

ticketActivityRemarkCreationDate

string(date-time)

 

 


 

TicketActivityRemarkList

Summary:

Description:

 

          Properties:

Name

Type

Summary

numberOfTicketActivityRemarks

number

 

 

ticketActivityRemarks

array of (TicketActivityRemark)

 

 


 

TicketAttachment

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

attachment

string(binary)

 

 

editor

string

 

 

description

string

 

 

creationDate

string(date-time)

 

 

mimeType

string

 

 

size

number

 

 


 

TicketAttachmentList

Summary:

Description:

 

          Properties:

Name

Type

Summary

numberOfTicketAttachments

number

 

 

ticketAttachments

array of (TicketAttachment)

 

 


 

TicketClass

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

shortDescription

string

 

 

description

string

 

 

sequence

number

 

 

code

string

 

 


 

TicketClassList

Summary:

Description:

 

          Properties:

Name

Type

Summary

numberOfTicketClasses

number

 

 

ticketClasses

array of (TicketClass)

 

 


 

TicketCreateParameterNewTicket

Summary:

Description:

 

          Properties:

Name

Type

Summary

title

string

 

 

description

string

 

 

rootCause

string

 

 

priority

string

 

Values: [LOW, MEDIUM, HIGH, VERY_HIGH]

ticketStateId

string

 

Values: [NEW, IN_PROGRESS, DONE, CONFIRMED, REOPENED]

ticketClassId

string

 

 

operationId

string

 

 

materialNumber

string

 

 

workplaceId

string

WorkplaceId

 

shiftId

string

 

 


 

TicketList

Summary:

Description:

 

          Properties:

Name

Type

Summary

numberOfTickets

number

 

 

tickets

array of (Ticket)

 

 


 

TicketState

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

Values: [NEW, IN_PROGRESS, DONE, CONFIRMED, REOPENED]

name

string

 

 

color

string

 

 


 

TicketStateList

Summary:

Description:

 

          Properties:

Name

Type

Summary

numberOfTicketStates

number

 

 

ticketStates

array of (TicketState)

 

 


 

Workplace

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id of the workplace

Id of the workplace

erpKey

string

Erp key linked with the workplace

Erp key linked with the workplace

name

string

Name of the workplace

Name of the workplace

description

string

Description of the workplace

Description of the workplace

type

string

Type of the workplace

Type of the workplace

productionLineNumber

string

Production line number of a workplace

Production line number of a workplace

productionLineDescription

string

Production line description of a workplace

Production line description of a workplace

operatingStateId

string

Operation state id of a workplace

Operation state id of a workplace

operatingStateCode

string

Operation state code of a workplace

Operation state code of a workplace

operatingStateDescription

string

Operation state description of a workplace

Operation state description of a workplace

operatingStateShortDescription

string

Operation state short description of a workplace

Operation state short description of a workplace

operatingStateColor

string

Operation state color of a workplace

Operation state color of a workplace


 

WorkplaceFilter

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (WorkplaceList)

value

 


 

WorkplaceGroup

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

erpContextId

string

 

 

number

string

 

 

description

string

 

 

type

string

 

 


 

WorkplaceGroupList

Summary:

Description:

 

          Properties:

Name

Type

Summary

numberOfWorkplaceGroups

number

 

 

workplaceGroups

array of (WorkplaceGroup)

 

 


 

WorkplaceGroupListFilter

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (WorkplaceGroupList)

value

 


 

WorkplaceList

Summary:

Description:

 

          Properties:

Name

Type

Summary

numberOfWorkplaces

number

 

 

workplaces

array of (Workplace)

 

 


 

WorkplaceStuffMember

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

erpContextId

string

 

 

firstName

string

 

 

lastName

string

 

 

identificationNumber

string

 

 

staffNumber

string

 

 


 

WorkplaceStuffMemberList

Summary:

Description:

 

          Properties:

Name

Type

Summary

numberOfStaffMembers

number

 

 

staffMembers

array of (WorkplaceStuffMember)