Cumulocity OEE

Default

createConfiguration

Add a new machine or line profile to this tenant.<br>Required permission: ROLE_OEECONFIGURATOR_ADMIN


/configurationmanager/2/configuration

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json,text/plain"\
-H "Content-Type: application/json"\
"https://oee-dev.eu-latest.cumulocity.com/service/oee-bundle/configurationmanager/2/configuration"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {

        DefaultApi apiInstance = new DefaultApi();
        MachineOEEConfiguration body = ; // MachineOEEConfiguration |
        try {
            MachineOEEConfiguration result = apiInstance.createConfiguration(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#createConfiguration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        MachineOEEConfiguration body = ; // MachineOEEConfiguration |
        try {
            MachineOEEConfiguration result = apiInstance.createConfiguration(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#createConfiguration");
            e.printStackTrace();
        }
    }
}
MachineOEEConfiguration *body = ; //  (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance createConfigurationWith:body
              completionHandler: ^(MachineOEEConfiguration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CumulocityOee = require('cumulocity_oee');

var api = new CumulocityOee.DefaultApi()
var opts = {
  'body':  // {{MachineOEEConfiguration}}
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createConfiguration(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createConfigurationExample
    {
        public void main()
        {

            var apiInstance = new DefaultApi();
            var body = new MachineOEEConfiguration(); // MachineOEEConfiguration |  (optional)

            try
            {
                MachineOEEConfiguration result = apiInstance.createConfiguration(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.createConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // MachineOEEConfiguration |

try {
    $result = $api_instance->createConfiguration($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::MachineOEEConfiguration->new(); # MachineOEEConfiguration |

eval {
    my $result = $api_instance->createConfiguration(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->createConfiguration: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
body =  # MachineOEEConfiguration |  (optional)

try:
    api_response = api_instance.create_configuration(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->createConfiguration: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - OK

Status: 401 - Authorization Error

Status: 403 - Insufficient Permission

Status: 500 - Internal server error


deleteConfiguration

Delete the profile with the given configurationId.<br>Required permission: ROLE_OEECONFIGURATOR_ADMIN


/configurationmanager/2/configuration/{configurationId}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json,text/plain"\
"https://oee-dev.eu-latest.cumulocity.com/service/oee-bundle/configurationmanager/2/configuration/{configurationId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {

        DefaultApi apiInstance = new DefaultApi();
        String configurationId = configurationId_example; // String |
        try {
            inline_response_200 result = apiInstance.deleteConfiguration(configurationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deleteConfiguration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String configurationId = configurationId_example; // String |
        try {
            inline_response_200 result = apiInstance.deleteConfiguration(configurationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deleteConfiguration");
            e.printStackTrace();
        }
    }
}
String *configurationId = configurationId_example; //

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance deleteConfigurationWith:configurationId
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CumulocityOee = require('cumulocity_oee');

var api = new CumulocityOee.DefaultApi()
var configurationId = configurationId_example; // {{String}}

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteConfiguration(configurationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteConfigurationExample
    {
        public void main()
        {

            var apiInstance = new DefaultApi();
            var configurationId = configurationId_example;  // String |

            try
            {
                inline_response_200 result = apiInstance.deleteConfiguration(configurationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deleteConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDefaultApi();
$configurationId = configurationId_example; // String |

try {
    $result = $api_instance->deleteConfiguration($configurationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $configurationId = configurationId_example; # String |

eval {
    my $result = $api_instance->deleteConfiguration(configurationId => $configurationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->deleteConfiguration: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
configurationId = configurationId_example # String |

try:
    api_response = api_instance.delete_configuration(configurationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->deleteConfiguration: %s\n" % e)

Parameters

Path parameters
Name Description
configurationId*
String
Required

Responses

Status: 200 - OK

Status: 401 - Authorization Error

Status: 403 - Insufficient Permission

Status: 500 - Internal server error


getAllConfigurations

Get all profiles defined in this tenant.<br>Required permission: ROLE_OEECONFIGURATOR_READ


/configurationmanager/2/configuration

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://oee-dev.eu-latest.cumulocity.com/service/oee-bundle/configurationmanager/2/configuration"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            array[MachineOEEConfiguration] result = apiInstance.getAllConfigurations();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getAllConfigurations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            array[MachineOEEConfiguration] result = apiInstance.getAllConfigurations();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getAllConfigurations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance getAllConfigurationsWithCompletionHandler:
              ^(array[MachineOEEConfiguration] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CumulocityOee = require('cumulocity_oee');
var defaultClient = CumulocityOee.ApiClient.instance;
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

var api = new CumulocityOee.DefaultApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllConfigurations(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllConfigurationsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                array[MachineOEEConfiguration] result = apiInstance.getAllConfigurations();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getAllConfigurations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();

try {
    $result = $api_instance->getAllConfigurations();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getAllConfigurations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: BasicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval {
    my $result = $api_instance->getAllConfigurations();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getAllConfigurations: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try:
    api_response = api_instance.get_all_configurations()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getAllConfigurations: %s\n" % e)

Parameters

Responses

Status: 200 - OK


getConfiguration

Get the profile with the given configurationId.<br>Required permission: ROLE_OEECONFIGURATOR_READ


/configurationmanager/2/configuration/{configurationId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json,text/plain"\
"https://oee-dev.eu-latest.cumulocity.com/service/oee-bundle/configurationmanager/2/configuration/{configurationId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String configurationId = configurationId_example; // String |
        try {
            MachineOEEConfiguration result = apiInstance.getConfiguration(configurationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getConfiguration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String configurationId = configurationId_example; // String |
        try {
            MachineOEEConfiguration result = apiInstance.getConfiguration(configurationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getConfiguration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *configurationId = configurationId_example; //

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance getConfigurationWith:configurationId
              completionHandler: ^(MachineOEEConfiguration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CumulocityOee = require('cumulocity_oee');
var defaultClient = CumulocityOee.ApiClient.instance;
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

var api = new CumulocityOee.DefaultApi()
var configurationId = configurationId_example; // {{String}}

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConfiguration(configurationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConfigurationExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var configurationId = configurationId_example;  // String |

            try
            {
                MachineOEEConfiguration result = apiInstance.getConfiguration(configurationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$configurationId = configurationId_example; // String |

try {
    $result = $api_instance->getConfiguration($configurationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: BasicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $configurationId = configurationId_example; # String |

eval {
    my $result = $api_instance->getConfiguration(configurationId => $configurationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getConfiguration: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
configurationId = configurationId_example # String |

try:
    api_response = api_instance.get_configuration(configurationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getConfiguration: %s\n" % e)

Parameters

Path parameters
Name Description
configurationId*
String
Required

Responses

Status: 200 - OK

Status: 401 - Authorization Error

Status: 403 - Insufficient Permission

Status: 500 - Internal server error


getDescriptors

This service will take the deviceId as input and return the all supported measurement descriptors filtered by the given category.<br>Required permission: ROLE_OEECONFIGURATOR_ADMIN


/oeeuiappbackend/supportedmessages/{deviceId}/{category}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://oee-dev.eu-latest.cumulocity.com/service/oee-bundle/oeeuiappbackend/supportedmessages/{deviceId}/{category}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String deviceId = deviceId_example; // String |
        String category = category_example; // String |
        try {
            map['String', MessageTypeDescriptor] result = apiInstance.getDescriptors(deviceId, category);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getDescriptors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String deviceId = deviceId_example; // String |
        String category = category_example; // String |
        try {
            map['String', MessageTypeDescriptor] result = apiInstance.getDescriptors(deviceId, category);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getDescriptors");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *deviceId = deviceId_example; //
String *category = category_example; //

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance getDescriptorsWith:deviceId
    category:category
              completionHandler: ^(map['String', MessageTypeDescriptor] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CumulocityOee = require('cumulocity_oee');
var defaultClient = CumulocityOee.ApiClient.instance;
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

var api = new CumulocityOee.DefaultApi()
var deviceId = deviceId_example; // {{String}}
var category = category_example; // {{String}}

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDescriptors(deviceId, category, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDescriptorsExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var deviceId = deviceId_example;  // String |
            var category = category_example;  // String |

            try
            {
                map['String', MessageTypeDescriptor] result = apiInstance.getDescriptors(deviceId, category);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getDescriptors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$deviceId = deviceId_example; // String |
$category = category_example; // String |

try {
    $result = $api_instance->getDescriptors($deviceId, $category);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getDescriptors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: BasicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $deviceId = deviceId_example; # String |
my $category = category_example; # String |

eval {
    my $result = $api_instance->getDescriptors(deviceId => $deviceId, category => $category);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getDescriptors: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
deviceId = deviceId_example # String |
category = category_example # String |

try:
    api_response = api_instance.get_descriptors(deviceId, category)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getDescriptors: %s\n" % e)

Parameters

Path parameters
Name Description
deviceId*
String
Required
category*
String
Required

Responses

Status: 200 - OK


getDevices

This service will take the deviceId as input and return the all supported measurement descriptors.<br>Required permission: ROLE_OEECONFIGURATOR_ADMIN


/oeeuiappbackend/supportedmeasurements/{deviceId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://oee-dev.eu-latest.cumulocity.com/service/oee-bundle/oeeuiappbackend/supportedmeasurements/{deviceId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String deviceId = deviceId_example; // String |
        try {
            MeasurementDescriptorList result = apiInstance.getDevices(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getDevices");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String deviceId = deviceId_example; // String |
        try {
            MeasurementDescriptorList result = apiInstance.getDevices(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getDevices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *deviceId = deviceId_example; //

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance getDevicesWith:deviceId
              completionHandler: ^(MeasurementDescriptorList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CumulocityOee = require('cumulocity_oee');
var defaultClient = CumulocityOee.ApiClient.instance;
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

var api = new CumulocityOee.DefaultApi()
var deviceId = deviceId_example; // {{String}}

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDevices(deviceId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDevicesExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var deviceId = deviceId_example;  // String |

            try
            {
                MeasurementDescriptorList result = apiInstance.getDevices(deviceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getDevices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$deviceId = deviceId_example; // String |

try {
    $result = $api_instance->getDevices($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getDevices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: BasicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $deviceId = deviceId_example; # String |

eval {
    my $result = $api_instance->getDevices(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getDevices: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
deviceId = deviceId_example # String |

try:
    api_response = api_instance.get_devices(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getDevices: %s\n" % e)

Parameters

Path parameters
Name Description
deviceId*
String
Required

Responses

Status: 200 - OK


getProductionPlanList

Retrieve the ProductionPlanList for the given location. Response might be empty if no Productionplan was supplied before via the putProductionPlanList method.<br>Required permission: ROLE_OEECONFIGURATOR_READ


/mes/productionplanlist/{deviceId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://oee-dev.eu-latest.cumulocity.com/service/oee-bundle/mes/productionplanlist/{deviceId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String deviceId = deviceId_example; // String |
        try {
            ProductionPlanList result = apiInstance.getProductionPlanList(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getProductionPlanList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String deviceId = deviceId_example; // String |
        try {
            ProductionPlanList result = apiInstance.getProductionPlanList(deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getProductionPlanList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *deviceId = deviceId_example; //

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance getProductionPlanListWith:deviceId
              completionHandler: ^(ProductionPlanList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CumulocityOee = require('cumulocity_oee');
var defaultClient = CumulocityOee.ApiClient.instance;
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

var api = new CumulocityOee.DefaultApi()
var deviceId = deviceId_example; // {{String}}

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProductionPlanList(deviceId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProductionPlanListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var deviceId = deviceId_example;  // String |

            try
            {
                ProductionPlanList result = apiInstance.getProductionPlanList(deviceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getProductionPlanList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$deviceId = deviceId_example; // String |

try {
    $result = $api_instance->getProductionPlanList($deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getProductionPlanList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: BasicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $deviceId = deviceId_example; # String |

eval {
    my $result = $api_instance->getProductionPlanList(deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getProductionPlanList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
deviceId = deviceId_example # String |

try:
    api_response = api_instance.get_production_plan_list(deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getProductionPlanList: %s\n" % e)

Parameters

Path parameters
Name Description
deviceId*
String
Required

Responses

Status: 200 - OK

{"tenantId":"t12345678","deviceId":9876543,"productionPlans":[{"idealCycleTime":2,"timeslot":{"slotStart":"2021-08-18T09:00:00Z","slotEnd":"2021-08-18T17:00:00Z"}},{"idealCycleTime":4,"timeslot":{"slotStart":"2021-08-18T18:00:00Z","slotEnd":"2021-08-18T20:00:00Z"}}]}

Status: 500 - Server error


getShiftplan

Retrieve the Shiftplan for the given location. Response might be empty if no Shiftplan was supplied before via the putShiftplan method.<br>Required permission: ROLE_OEECONFIGURATOR_READ


/mes/shiftplan/{locationId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://oee-dev.eu-latest.cumulocity.com/service/oee-bundle/mes/shiftplan/{locationId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        String locationId = locationId_example; // String |
        try {
            Shiftplan result = apiInstance.getShiftplan(locationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getShiftplan");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String locationId = locationId_example; // String |
        try {
            Shiftplan result = apiInstance.getShiftplan(locationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getShiftplan");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *locationId = locationId_example; //

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance getShiftplanWith:locationId
              completionHandler: ^(Shiftplan output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CumulocityOee = require('cumulocity_oee');
var defaultClient = CumulocityOee.ApiClient.instance;
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

var api = new CumulocityOee.DefaultApi()
var locationId = locationId_example; // {{String}}

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShiftplan(locationId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getShiftplanExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var locationId = locationId_example;  // String |

            try
            {
                Shiftplan result = apiInstance.getShiftplan(locationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getShiftplan: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$locationId = locationId_example; // String |

try {
    $result = $api_instance->getShiftplan($locationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getShiftplan: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: BasicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $locationId = locationId_example; # String |

eval {
    my $result = $api_instance->getShiftplan(locationId => $locationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getShiftplan: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
locationId = locationId_example # String |

try:
    api_response = api_instance.get_shiftplan(locationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getShiftplan: %s\n" % e)

Parameters

Path parameters
Name Description
locationId*
String
Required

Responses

Status: 200 - OK

{"tenantId":"t12345678","locationId":"MachineLocation","timeslots":[{"slotType":"PRODUCTION","slotStart":"2021-08-18T09:00:00Z","slotEnd":"2021-08-18T17:00:00Z"},{"slotType":"MAINTENANCE","slotStart":"2021-08-18T17:00:00Z","slotEnd":"2021-08-18T18:00:00Z"},{"slotType":"PRODUCTION","slotStart":"2021-08-18T18:00:00Z","slotEnd":"2021-08-18T22:00:00Z"}]}

Status: 500 - Server error


greeting

public health endpoint to check if the ConfigurationManager is up & running.<br>Required permission: [none]


/configurationmanager/2/health

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
"https://oee-dev.eu-latest.cumulocity.com/service/oee-bundle/configurationmanager/2/health"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        try {
            apiInstance.greeting();
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#greeting");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            apiInstance.greeting();
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#greeting");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance greetingWithCompletionHandler:
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CumulocityOee = require('cumulocity_oee');
var defaultClient = CumulocityOee.ApiClient.instance;
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

var api = new CumulocityOee.DefaultApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.greeting(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class greetingExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();

            try
            {
                apiInstance.greeting();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.greeting: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();

try {
    $api_instance->greeting();
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->greeting: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: BasicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval {
    $api_instance->greeting();
};
if ($@) {
    warn "Exception when calling DefaultApi->greeting: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try:
    api_instance.greeting()
except ApiException as e:
    print("Exception when calling DefaultApi->greeting: %s\n" % e)

Parameters

Responses

Status: 200 - OK


putProductionPlanList

Add or update the list of Productionplans for the device defined in the Productionplan. The tenantId is indirectly retrieved within the service via the credentials. Therefore no tenantId must be specified in the body. If a Productionplans exists for the given tenant and device, the new Productionplans will be merged internally and obsolete instances will be removed. The resulting Productionplans will then be sent to the Apama service.<br>Required permission: ROLE_OEECONFIGURATOR_ADMIN


/mes/productionplanlist

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: text/plain"\
-H "Content-Type: application/json"\
"https://oee-dev.eu-latest.cumulocity.com/service/oee-bundle/mes/productionplanlist"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        ProductionPlanList body = {
  "deviceId" : 9876543,
  "productionPlans" : [ {
    "idealCycleTime" : 2,
    "timeslot" : {
      "slotStart" : "2021-08-18T09:00:00Z",
      "slotEnd" : "2021-08-18T17:00:00Z"
    }
  }, {
    "idealCycleTime" : 4,
    "timeslot" : {
      "slotStart" : "2021-08-18T18:00:00Z",
      "slotEnd" : "2021-08-18T20:00:00Z"
    }
  } ]
}; // ProductionPlanList |
        try {
            'String' result = apiInstance.putProductionPlanList(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#putProductionPlanList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        ProductionPlanList body = {
  "deviceId" : 9876543,
  "productionPlans" : [ {
    "idealCycleTime" : 2,
    "timeslot" : {
      "slotStart" : "2021-08-18T09:00:00Z",
      "slotEnd" : "2021-08-18T17:00:00Z"
    }
  }, {
    "idealCycleTime" : 4,
    "timeslot" : {
      "slotStart" : "2021-08-18T18:00:00Z",
      "slotEnd" : "2021-08-18T20:00:00Z"
    }
  } ]
}; // ProductionPlanList |
        try {
            'String' result = apiInstance.putProductionPlanList(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#putProductionPlanList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
ProductionPlanList *body = {
  "deviceId" : 9876543,
  "productionPlans" : [ {
    "idealCycleTime" : 2,
    "timeslot" : {
      "slotStart" : "2021-08-18T09:00:00Z",
      "slotEnd" : "2021-08-18T17:00:00Z"
    }
  }, {
    "idealCycleTime" : 4,
    "timeslot" : {
      "slotStart" : "2021-08-18T18:00:00Z",
      "slotEnd" : "2021-08-18T20:00:00Z"
    }
  } ]
}; //  (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance putProductionPlanListWith:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CumulocityOee = require('cumulocity_oee');
var defaultClient = CumulocityOee.ApiClient.instance;
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

var api = new CumulocityOee.DefaultApi()
var opts = {
  'body': {
  "deviceId" : 9876543,
  "productionPlans" : [ {
    "idealCycleTime" : 2,
    "timeslot" : {
      "slotStart" : "2021-08-18T09:00:00Z",
      "slotEnd" : "2021-08-18T17:00:00Z"
    }
  }, {
    "idealCycleTime" : 4,
    "timeslot" : {
      "slotStart" : "2021-08-18T18:00:00Z",
      "slotEnd" : "2021-08-18T20:00:00Z"
    }
  } ]
} // {{ProductionPlanList}}
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putProductionPlanList(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class putProductionPlanListExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var body = new ProductionPlanList(); // ProductionPlanList |  (optional)

            try
            {
                'String' result = apiInstance.putProductionPlanList(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.putProductionPlanList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$body = {
  "deviceId" : 9876543,
  "productionPlans" : [ {
    "idealCycleTime" : 2,
    "timeslot" : {
      "slotStart" : "2021-08-18T09:00:00Z",
      "slotEnd" : "2021-08-18T17:00:00Z"
    }
  }, {
    "idealCycleTime" : 4,
    "timeslot" : {
      "slotStart" : "2021-08-18T18:00:00Z",
      "slotEnd" : "2021-08-18T20:00:00Z"
    }
  } ]
}; // ProductionPlanList |

try {
    $result = $api_instance->putProductionPlanList($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->putProductionPlanList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: BasicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::ProductionPlanList->new(); # ProductionPlanList |

eval {
    my $result = $api_instance->putProductionPlanList(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->putProductionPlanList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
body = {
  "deviceId" : 9876543,
  "productionPlans" : [ {
    "idealCycleTime" : 2,
    "timeslot" : {
      "slotStart" : "2021-08-18T09:00:00Z",
      "slotEnd" : "2021-08-18T17:00:00Z"
    }
  }, {
    "idealCycleTime" : 4,
    "timeslot" : {
      "slotStart" : "2021-08-18T18:00:00Z",
      "slotEnd" : "2021-08-18T20:00:00Z"
    }
  } ]
} # ProductionPlanList |  (optional)

try:
    api_response = api_instance.put_production_plan_list(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->putProductionPlanList: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - OK

Status: 500 - Internal server error


putShiftplan

Add or update the Shiftplan for the location defined in the Shiftplan. The tenantId is indirectly retrieved within the service via the credentials. Therefore no tenantId must be specified 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 will then be sent to the Apama service.<br>Required permission: ROLE_OEECONFIGURATOR_ADMIN


/mes/shiftplan

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: text/plain"\
-H "Content-Type: application/json"\
"https://oee-dev.eu-latest.cumulocity.com/service/oee-bundle/mes/shiftplan"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        DefaultApi apiInstance = new DefaultApi();
        Shiftplan body = {
  "locationId" : "MachineLocation",
  "timeslots" : [ {
    "slotType" : "PRODUCTION",
    "slotStart" : "2021-08-18T09:00:00Z",
    "slotEnd" : "2021-08-18T17:00:00Z"
  }, {
    "slotType" : "MAINTENANCE",
    "slotStart" : "2021-08-18T17:00:00Z",
    "slotEnd" : "2021-08-18T18:00:00Z"
  }, {
    "slotType" : "PRODUCTION",
    "slotStart" : "2021-08-18T18:00:00Z",
    "slotEnd" : "2021-08-18T22:00:00Z"
  } ]
}; // Shiftplan |
        try {
            'String' result = apiInstance.putShiftplan(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#putShiftplan");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Shiftplan body = {
  "locationId" : "MachineLocation",
  "timeslots" : [ {
    "slotType" : "PRODUCTION",
    "slotStart" : "2021-08-18T09:00:00Z",
    "slotEnd" : "2021-08-18T17:00:00Z"
  }, {
    "slotType" : "MAINTENANCE",
    "slotStart" : "2021-08-18T17:00:00Z",
    "slotEnd" : "2021-08-18T18:00:00Z"
  }, {
    "slotType" : "PRODUCTION",
    "slotStart" : "2021-08-18T18:00:00Z",
    "slotEnd" : "2021-08-18T22:00:00Z"
  } ]
}; // Shiftplan |
        try {
            'String' result = apiInstance.putShiftplan(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#putShiftplan");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: BasicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Shiftplan *body = {
  "locationId" : "MachineLocation",
  "timeslots" : [ {
    "slotType" : "PRODUCTION",
    "slotStart" : "2021-08-18T09:00:00Z",
    "slotEnd" : "2021-08-18T17:00:00Z"
  }, {
    "slotType" : "MAINTENANCE",
    "slotStart" : "2021-08-18T17:00:00Z",
    "slotEnd" : "2021-08-18T18:00:00Z"
  }, {
    "slotType" : "PRODUCTION",
    "slotStart" : "2021-08-18T18:00:00Z",
    "slotEnd" : "2021-08-18T22:00:00Z"
  } ]
}; //  (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance putShiftplanWith:body
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CumulocityOee = require('cumulocity_oee');
var defaultClient = CumulocityOee.ApiClient.instance;
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

var api = new CumulocityOee.DefaultApi()
var opts = {
  'body': {
  "locationId" : "MachineLocation",
  "timeslots" : [ {
    "slotType" : "PRODUCTION",
    "slotStart" : "2021-08-18T09:00:00Z",
    "slotEnd" : "2021-08-18T17:00:00Z"
  }, {
    "slotType" : "MAINTENANCE",
    "slotStart" : "2021-08-18T17:00:00Z",
    "slotEnd" : "2021-08-18T18:00:00Z"
  }, {
    "slotType" : "PRODUCTION",
    "slotStart" : "2021-08-18T18:00:00Z",
    "slotEnd" : "2021-08-18T22:00:00Z"
  } ]
} // {{Shiftplan}}
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putShiftplan(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class putShiftplanExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new DefaultApi();
            var body = new Shiftplan(); // Shiftplan |  (optional)

            try
            {
                'String' result = apiInstance.putShiftplan(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.putShiftplan: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiDefaultApi();
$body = {
  "locationId" : "MachineLocation",
  "timeslots" : [ {
    "slotType" : "PRODUCTION",
    "slotStart" : "2021-08-18T09:00:00Z",
    "slotEnd" : "2021-08-18T17:00:00Z"
  }, {
    "slotType" : "MAINTENANCE",
    "slotStart" : "2021-08-18T17:00:00Z",
    "slotEnd" : "2021-08-18T18:00:00Z"
  }, {
    "slotType" : "PRODUCTION",
    "slotStart" : "2021-08-18T18:00:00Z",
    "slotEnd" : "2021-08-18T22:00:00Z"
  } ]
}; // Shiftplan |

try {
    $result = $api_instance->putShiftplan($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->putShiftplan: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
# Configure HTTP basic authorization: BasicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::Shiftplan->new(); # Shiftplan |

eval {
    my $result = $api_instance->putShiftplan(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->putShiftplan: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
body = {
  "locationId" : "MachineLocation",
  "timeslots" : [ {
    "slotType" : "PRODUCTION",
    "slotStart" : "2021-08-18T09:00:00Z",
    "slotEnd" : "2021-08-18T17:00:00Z"
  }, {
    "slotType" : "MAINTENANCE",
    "slotStart" : "2021-08-18T17:00:00Z",
    "slotEnd" : "2021-08-18T18:00:00Z"
  }, {
    "slotType" : "PRODUCTION",
    "slotStart" : "2021-08-18T18:00:00Z",
    "slotEnd" : "2021-08-18T22:00:00Z"
  } ]
} # Shiftplan |  (optional)

try:
    api_response = api_instance.put_shiftplan(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->putShiftplan: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - OK

Status: 500 - Internal server error


updateConfiguration

Update the profile with the given configurationId.<br>Required permission: ROLE_OEECONFIGURATOR_ADMIN


/configurationmanager/2/configuration/{configurationId}

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json,text/plain"\
-H "Content-Type: application/json"\
"https://oee-dev.eu-latest.cumulocity.com/service/oee-bundle/configurationmanager/2/configuration/{configurationId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {

        DefaultApi apiInstance = new DefaultApi();
        String configurationId = configurationId_example; // String |
        MachineOEEConfiguration body = ; // MachineOEEConfiguration |
        try {
            MachineOEEConfiguration result = apiInstance.updateConfiguration(configurationId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateConfiguration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String configurationId = configurationId_example; // String |
        MachineOEEConfiguration body = ; // MachineOEEConfiguration |
        try {
            MachineOEEConfiguration result = apiInstance.updateConfiguration(configurationId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateConfiguration");
            e.printStackTrace();
        }
    }
}
String *configurationId = configurationId_example; //
MachineOEEConfiguration *body = ; //  (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance updateConfigurationWith:configurationId
    body:body
              completionHandler: ^(MachineOEEConfiguration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CumulocityOee = require('cumulocity_oee');

var api = new CumulocityOee.DefaultApi()
var configurationId = configurationId_example; // {{String}}
var opts = {
  'body':  // {{MachineOEEConfiguration}}
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateConfiguration(configurationId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateConfigurationExample
    {
        public void main()
        {

            var apiInstance = new DefaultApi();
            var configurationId = configurationId_example;  // String |
            var body = new MachineOEEConfiguration(); // MachineOEEConfiguration |  (optional)

            try
            {
                MachineOEEConfiguration result = apiInstance.updateConfiguration(configurationId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.updateConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDefaultApi();
$configurationId = configurationId_example; // String |
$body = ; // MachineOEEConfiguration |

try {
    $result = $api_instance->updateConfiguration($configurationId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $configurationId = configurationId_example; # String |
my $body = WWW::SwaggerClient::Object::MachineOEEConfiguration->new(); # MachineOEEConfiguration |

eval {
    my $result = $api_instance->updateConfiguration(configurationId => $configurationId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->updateConfiguration: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
configurationId = configurationId_example # String |
body =  # MachineOEEConfiguration |  (optional)

try:
    api_response = api_instance.update_configuration(configurationId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->updateConfiguration: %s\n" % e)

Parameters

Path parameters
Name Description
configurationId*
String
Required
Body parameters
Name Description
body

Responses

Status: 200 - OK

Status: 401 - Authorization Error

Status: 403 - Insufficient Permission

Status: 500 - Internal server error