Cumulocity IoT OEE

Cumulocity IoT OEE allows you to easily integrate the OEE data of your machine park with your or other business systems. You can update the OEE App with shift and production plans.

API Versions: 10.10.0.3

API Types: REST

Authentication and Authorization: Basic

Prerequisites:

  • Cumulocity OEE login and password information.

  • Required permission for reading is ROLE_OEECONFIGURATOR_READ.

  • Required permission for creating, editing, or deleting is ROLE_OEECONFIGURATOR_ADMIN.

The connector authenticates via an application in the Cumulocity tenant. During initial setup of the connection, this application is created automatically.

Actions

  • getShiftplan: Retrieves the Shiftplan for the given locationId. The response is empty if no Shiftplan is provided before by using the createShiftplan method.

  • createShiftplan: Creates the Shiftplan for the locationId. The tenantId is indirectly retrieved within the service using the credentials. Do not specify a tenantId in the body. If a Shiftplan exists for the given tenant and location, the new Shiftplan will be merged internally, and obsolete Timeslots will be removed. The resulting Shiftplan is sent to the Apama service. Required permission: ROLE_OEECONFIGURATOR_ADMIN.

  • deleteShiftplan: Deletes the Shiftplan for the given locationId. The response is empty if no Shiftplan is provided before by using the createShiftplan method. Required permission: ROLE_OEECONFIGURATOR_ADMIN.

  • getProductionplanlist: Retrieves the Productionplanlist for the given deviceId. The response is empty if no Productionplan is provided before by using the createProductionplanlist method.

  • createProductionplanlist: Creates a list of Productionplanlist for the deviceId defined in the Productionplan. The tenantId is indirectly retrieved within the service using the credentials. Do not specify a tenantId in the body. If a Productionplan exists for the given tenant and device, the new Productionplan will be merged internally, and obsolete Timeslots will be removed. The resulting Productionplan is sent to the Apama service. Required permission: ROLE_OEECONFIGURATOR_ADMIN.

  • deleteProductionplanlist: Deletes the Productionplanlist for the given deviceId. The response is empty if no Productionplan is provided before by using the createProductionplanlist method. Required permission: ROLE_OEECONFIGURATOR_ADMIN.

  • getAllConfigurations: Retrieves all the configurations defined in the tenant.

  • createConfiguration: Adds a new machine or line configuration to the tenant. Required permission: ROLE_OEECONFIGURATOR_ADMIN.

  • getConfiguration: Retrieves the configuration with the given configurationId.

  • updateConfiguration: Updates the configuration with the given configurationId. Required permission: ROLE_OEECONFIGURATOR_ADMIN.

  • deleteConfiguration: Deletes the configuration with the given configurationId. Required permission: ROLE_OEECONFIGURATOR_ADMIN.

  • getSupportedMeasurementsByCategory: Retrieves all the supported message descriptors for the given deviceId and chosen category.

  • getSupportedMeasurements: Retrieves all the supported measurements for the given deviceId.