Versions
Versions this documentation is relevant for:
- 8.7.0+
Assign
The Work Centre Group – AssignWorkCentres API call attempts to assign a Work Centre to a Work Centre Group.
Figure 1 shows the logic used within the Work Centre/Work Centre Group – Assign API call.
Figure 1 - Logic within Work Centre Group - AssignWorkCentres API Call
Prerequisites
When assigning a Work Centre to a Work Centre Group, both the Work Centre and Work Centre Group must exist in Eyelit MES-M.
Request
Table 1 shows the method and endpoint required to make the API call to list Work Centre Groups.
Table 1 - Outbound Message Detail for Work Centre Group - AssignWorkCentres
Method | URL Structure | Endpoint |
PUT | https://[environment].mestec.net | /api/WorkCentreGroup/AssignWorkCentres |
The body of the payload should follow the format below.
See Table 2 for information on which fields are optional, the appropriate data types and the mappings to fields in Eyelit MES-M.
Table 2 - Parameter Information for Work Centre Group - AssignWorkCentres
Parameter Name | Data Mapping | Data Type | Mandatory | Case Sensitive | Match Type |
id | WorkCentregroup.id | NUMBER | Yes | No | Exact |
WorkCentres | WorkCentre.name | JSON Array - String | Yes | No | Exact |
Note: For any fields where the match type is ‘Like’, a percent symbol should be used as a wildcard character to indicate a number of characters within the given string.
Sample Request
See below for sample use cases with examples of the JSON payload format required.
Assign by ID
Response
When using the Work Centre Group – AssignWorkCentres API call, if a Work Centre has been assigned from a Work Centre Group, a JSON payload will be returned containing data in the following structure
Sample Response
See below for sample use cases with examples of the JSON payload format returned.
UnassignWorkCentres
The Work Centre Group – UnassignWorkCentres API call attempts to unassign a Work Centre from a Work Centre Group.
Figure 2 shows the logic used within the Work Centre Group – UnassignWorkcentres API call.
Figure 2 - Logic within Work Centre Group - UnassignWorkCentres API Call
Prerequisites
When unassigning a Work Centre from a Work Centre Group, both the Work Centre and Work Centre Group must exist in Eyelit MES-M, Additionally, the Work Centre must be assigned to the Work Centre Group.
Request
Table 3 shows the method and endpoint required to make the API call to unasssign a Work Centre from a Work Centre Group.
Table 3 - Outbound Message Detail for Workcentregroup/UnassignWorkCentres
Method | URL Structure | Endpoint |
PUT | https://[environment].mestec.net | /api/WorkCentreGroup/UnassignWorkCentres |
The body of the payload should follow the format below.
See Table 4 for information on which fields are optional, the appropriate data types and the mappings to fields in Eyelit MES-M.
Table 4 - Parameter Information for Work Centre Group - UnAssignWorkCenres
Parameter Name | Data Mapping | Data Type | Mandatory | Case Sensitive | Match Type |
id | WorkCentregroup.id | NUMBER | Yes | No | Exact |
WorkCentres | WorkCentre.name | JSON Array - String | Yes | No | Exact |
Note: For any fields where the match type is ‘Like’, a percent symbol should be used as a wildcard character to indicate a number of characters within the given string.
Sample Request
See below for sample use cases with examples of the JSON payload format required.
Unassign by ID
Response
When using the Work Centre Group – UnassignWorkCentres API call, if a Work Centre has been unassigned from a Work Centre Group, a JSON payload will be returned containing data in the following structure:
Sample Response
See below for sample use cases with examples of the JSON payload format returned.
