Versions
Versions this documentation is relevant for:
- 8.7.0+
List
The Team – List API call reads a full list of existing Teams from Eyelit MES-M with no filtering. Using the Team – List API call has no impact on the data within the given Eyelit MES-M application, it is read-only. Figure 1 shows the logic used within the Team – List API call.
Figure 1 - Logic within Team/List API Call
Data Pre-requisites
There is no data required in Eyelit MES-M to act as a pre-requisite to make the API call to list Teams, although to be able to create a user and subsequently use Eyelit MES-M, at least one Team is required. It is, therefore, not possible to receive an empty payload in response when calling this endpoint. Additionally, a default Team is provided automatically in an empty Eyelit MES-M environment.
Request
Table 2 shows the method and endpoint required to make the API call to list Work Centre Groups.
Table 2 - Outbound Message Detail for Team - List
Method | URL Structure | Endpoint |
GET | https://[environment].mestec.net | /api/Team/List |
As no parameters can be passed into this endpoint, the request requires no body. If a body is passed into the payload, it will be ignored and the full list of all Teams will be returned.
Sample Request
The body of the request should consist of only the call to the endpoint as specified above.
Response
When using the Team – List API call, 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.
No Teams exist:
Multiple Teams exist:
