IRIS Supply Chain Analytics API

Default

closeIssue

close an issue

/closeissue/{issueId}

Usage and SDK Samples

curl -X POST "http://localhost/api/scbi/v1/closeissue/{issueId}"

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 issueId = issueId_example; // String | Issue ID
        CloseMessage body = ; // CloseMessage | 
        try {
            apiInstance.closeIssue(issueId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#closeIssue");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String issueId = issueId_example; // String | Issue ID
        CloseMessage body = ; // CloseMessage | 
        try {
            apiInstance.closeIssue(issueId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#closeIssue");
            e.printStackTrace();
        }
    }
}

String *issueId = issueId_example; // Issue ID
CloseMessage *body = ; // 

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

[apiInstance closeIssueWith:issueId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IrisSupplyChainAnalyticsApi = require('iris_supply_chain_analytics_api');

var api = new IrisSupplyChainAnalyticsApi.DefaultApi()

var issueId = issueId_example; // {String} Issue ID

var body = ; // {CloseMessage} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.closeIssue(issueId, body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class closeIssueExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var issueId = issueId_example;  // String | Issue ID
            var body = new CloseMessage(); // CloseMessage | 

            try
            {
                apiInstance.closeIssue(issueId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.closeIssue: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DefaultApi();
$issueId = issueId_example; // String | Issue ID
$body = ; // CloseMessage | 

try {
    $api_instance->closeIssue($issueId, $body);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->closeIssue: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $issueId = issueId_example; # String | Issue ID
my $body = WWW::SwaggerClient::Object::CloseMessage->new(); # CloseMessage | 

eval { 
    $api_instance->closeIssue(issueId => $issueId, body => $body);
};
if ($@) {
    warn "Exception when calling DefaultApi->closeIssue: $@\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()
issueId = issueId_example # String | Issue ID
body =  # CloseMessage | 

try: 
    api_instance.close_issue(issueId, body)
except ApiException as e:
    print("Exception when calling DefaultApi->closeIssue: %s\n" % e)

Parameters

Path parameters

Name	Description
issueId*	String Issue ID Required

Body parameters

Name	Description
body *

Responses

Status: 200 - Success

Status: 500 - Server error

completeWorkflow

Update the workflow with user input, and close the issue accordingly

/completeissueworkflow/{issueId}

Usage and SDK Samples

curl -X POST "http://localhost/api/scbi/v1/completeissueworkflow/{issueId}"

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 issueId = issueId_example; // String | KPI name
        WorkflowMessage body = ; // WorkflowMessage | 
        try {
            apiInstance.completeWorkflow(issueId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#completeWorkflow");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String issueId = issueId_example; // String | KPI name
        WorkflowMessage body = ; // WorkflowMessage | 
        try {
            apiInstance.completeWorkflow(issueId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#completeWorkflow");
            e.printStackTrace();
        }
    }
}

String *issueId = issueId_example; // KPI name
WorkflowMessage *body = ; // 

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

[apiInstance completeWorkflowWith:issueId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IrisSupplyChainAnalyticsApi = require('iris_supply_chain_analytics_api');

var api = new IrisSupplyChainAnalyticsApi.DefaultApi()

var issueId = issueId_example; // {String} KPI name

var body = ; // {WorkflowMessage} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.completeWorkflow(issueId, body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class completeWorkflowExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var issueId = issueId_example;  // String | KPI name
            var body = new WorkflowMessage(); // WorkflowMessage | 

            try
            {
                apiInstance.completeWorkflow(issueId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.completeWorkflow: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DefaultApi();
$issueId = issueId_example; // String | KPI name
$body = ; // WorkflowMessage | 

try {
    $api_instance->completeWorkflow($issueId, $body);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->completeWorkflow: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $issueId = issueId_example; # String | KPI name
my $body = WWW::SwaggerClient::Object::WorkflowMessage->new(); # WorkflowMessage | 

eval { 
    $api_instance->completeWorkflow(issueId => $issueId, body => $body);
};
if ($@) {
    warn "Exception when calling DefaultApi->completeWorkflow: $@\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()
issueId = issueId_example # String | KPI name
body =  # WorkflowMessage | 

try: 
    api_instance.complete_workflow(issueId, body)
except ApiException as e:
    print("Exception when calling DefaultApi->completeWorkflow: %s\n" % e)

Parameters

Path parameters

Name	Description
issueId*	String KPI name Required

Body parameters

Name	Description
body *

Responses

Status: 200 - Success

Status: 500 - Server error

createKpiDefinition

Create a new KPI definition

/kpi/definitions

Usage and SDK Samples

curl -X POST "http://localhost/api/scbi/v1/kpi/definitions"

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();
        KpiDefinition body = ; // KpiDefinition | 
        try {
            apiInstance.createKpiDefinition(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#createKpiDefinition");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

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

KpiDefinition *body = ; // 

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

[apiInstance createKpiDefinitionWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IrisSupplyChainAnalyticsApi = require('iris_supply_chain_analytics_api');

var api = new IrisSupplyChainAnalyticsApi.DefaultApi()

var body = ; // {KpiDefinition} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createKpiDefinition(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createKpiDefinitionExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var body = new KpiDefinition(); // KpiDefinition | 

            try
            {
                apiInstance.createKpiDefinition(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.createKpiDefinition: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DefaultApi();
$body = ; // KpiDefinition | 

try {
    $api_instance->createKpiDefinition($body);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createKpiDefinition: ', $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::KpiDefinition->new(); # KpiDefinition | 

eval { 
    $api_instance->createKpiDefinition(body => $body);
};
if ($@) {
    warn "Exception when calling DefaultApi->createKpiDefinition: $@\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 =  # KpiDefinition | 

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

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - Success

Status: 400 - Invalid message body

Status: 500 - Server error

deleteKpiDefinition

Delete a KPI definition

/kpi/definitions/{kpiName}

Usage and SDK Samples

curl -X DELETE "http://localhost/api/scbi/v1/kpi/definitions/{kpiName}"

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 kpiName = kpiName_example; // String | KPI name
        try {
            apiInstance.deleteKpiDefinition(kpiName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deleteKpiDefinition");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String kpiName = kpiName_example; // String | KPI name
        try {
            apiInstance.deleteKpiDefinition(kpiName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deleteKpiDefinition");
            e.printStackTrace();
        }
    }
}

String *kpiName = kpiName_example; // KPI name

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

[apiInstance deleteKpiDefinitionWith:kpiName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IrisSupplyChainAnalyticsApi = require('iris_supply_chain_analytics_api');

var api = new IrisSupplyChainAnalyticsApi.DefaultApi()

var kpiName = kpiName_example; // {String} KPI name


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteKpiDefinition(kpiName, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteKpiDefinitionExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var kpiName = kpiName_example;  // String | KPI name

            try
            {
                apiInstance.deleteKpiDefinition(kpiName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.deleteKpiDefinition: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DefaultApi();
$kpiName = kpiName_example; // String | KPI name

try {
    $api_instance->deleteKpiDefinition($kpiName);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteKpiDefinition: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $kpiName = kpiName_example; # String | KPI name

eval { 
    $api_instance->deleteKpiDefinition(kpiName => $kpiName);
};
if ($@) {
    warn "Exception when calling DefaultApi->deleteKpiDefinition: $@\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()
kpiName = kpiName_example # String | KPI name

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

Parameters

Path parameters

Name	Description
kpiName*	String KPI name Required

Responses

Status: 200 - Success

Status: 404 - KPI not found

getKpiDefinition

Returns KPI definition of the specified KPI

/kpi/definitions/{kpiName}

Usage and SDK Samples

curl -X GET "http://localhost/api/scbi/v1/kpi/definitions/{kpiName}"

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 kpiName = kpiName_example; // String | KPI name
        try {
            array[KpiDefinition] result = apiInstance.getKpiDefinition(kpiName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getKpiDefinition");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String kpiName = kpiName_example; // String | KPI name
        try {
            array[KpiDefinition] result = apiInstance.getKpiDefinition(kpiName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getKpiDefinition");
            e.printStackTrace();
        }
    }
}

String *kpiName = kpiName_example; // KPI name

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

[apiInstance getKpiDefinitionWith:kpiName
              completionHandler: ^(array[KpiDefinition] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IrisSupplyChainAnalyticsApi = require('iris_supply_chain_analytics_api');

var api = new IrisSupplyChainAnalyticsApi.DefaultApi()

var kpiName = kpiName_example; // {String} KPI name


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getKpiDefinition(kpiName, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getKpiDefinitionExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var kpiName = kpiName_example;  // String | KPI name

            try
            {
                array[KpiDefinition] result = apiInstance.getKpiDefinition(kpiName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getKpiDefinition: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DefaultApi();
$kpiName = kpiName_example; // String | KPI name

try {
    $result = $api_instance->getKpiDefinition($kpiName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getKpiDefinition: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $kpiName = kpiName_example; # String | KPI name

eval { 
    my $result = $api_instance->getKpiDefinition(kpiName => $kpiName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->getKpiDefinition: $@\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()
kpiName = kpiName_example # String | KPI name

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

Parameters

Path parameters

Name	Description
kpiName*	String KPI name Required

Responses

Status: 200 - KPI definition

Schema

getKpiDefinitions

Get all KPI definitions defined in the system

/kpi/definitions

Usage and SDK Samples

curl -X GET "http://localhost/api/scbi/v1/kpi/definitions"

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();
        try {
            apiInstance.getKpiDefinitions();
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getKpiDefinitions");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            apiInstance.getKpiDefinitions();
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getKpiDefinitions");
            e.printStackTrace();
        }
    }
}


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

[apiInstance getKpiDefinitionsWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IrisSupplyChainAnalyticsApi = require('iris_supply_chain_analytics_api');

var api = new IrisSupplyChainAnalyticsApi.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getKpiDefinitions(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getKpiDefinitionsExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();

            try
            {
                apiInstance.getKpiDefinitions();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getKpiDefinitions: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $api_instance->getKpiDefinitions();
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getKpiDefinitions: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

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

eval { 
    $api_instance->getKpiDefinitions();
};
if ($@) {
    warn "Exception when calling DefaultApi->getKpiDefinitions: $@\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()

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

Parameters

Responses

Status: 200 - Success

Status: 500 - Server error

getKpiListing

Returns source listing of a KPI

/kpi/listings/{kpiName}

Usage and SDK Samples

curl -X GET "http://localhost/api/scbi/v1/kpi/listings/{kpiName}"

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 kpiName = kpiName_example; // String | KPI name
        try {
            apiInstance.getKpiListing(kpiName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getKpiListing");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String kpiName = kpiName_example; // String | KPI name
        try {
            apiInstance.getKpiListing(kpiName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getKpiListing");
            e.printStackTrace();
        }
    }
}

String *kpiName = kpiName_example; // KPI name

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

[apiInstance getKpiListingWith:kpiName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IrisSupplyChainAnalyticsApi = require('iris_supply_chain_analytics_api');

var api = new IrisSupplyChainAnalyticsApi.DefaultApi()

var kpiName = kpiName_example; // {String} KPI name


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getKpiListing(kpiName, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getKpiListingExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var kpiName = kpiName_example;  // String | KPI name

            try
            {
                apiInstance.getKpiListing(kpiName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getKpiListing: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DefaultApi();
$kpiName = kpiName_example; // String | KPI name

try {
    $api_instance->getKpiListing($kpiName);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getKpiListing: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $kpiName = kpiName_example; # String | KPI name

eval { 
    $api_instance->getKpiListing(kpiName => $kpiName);
};
if ($@) {
    warn "Exception when calling DefaultApi->getKpiListing: $@\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()
kpiName = kpiName_example # String | KPI name

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

Parameters

Path parameters

Name	Description
kpiName*	String KPI name Required

Responses

Status: 200 - Success

Status: 500 - Server error

getKpiValue

Returns KPI value of the specified KPI

/kpi/values/{kpiName}

Usage and SDK Samples

curl -X GET "http://localhost/api/scbi/v1/kpi/values/{kpiName}"

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 kpiName = kpiName_example; // String | KPI name
        try {
            apiInstance.getKpiValue(kpiName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getKpiValue");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String kpiName = kpiName_example; // String | KPI name
        try {
            apiInstance.getKpiValue(kpiName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getKpiValue");
            e.printStackTrace();
        }
    }
}

String *kpiName = kpiName_example; // KPI name

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

[apiInstance getKpiValueWith:kpiName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IrisSupplyChainAnalyticsApi = require('iris_supply_chain_analytics_api');

var api = new IrisSupplyChainAnalyticsApi.DefaultApi()

var kpiName = kpiName_example; // {String} KPI name


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getKpiValue(kpiName, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getKpiValueExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var kpiName = kpiName_example;  // String | KPI name

            try
            {
                apiInstance.getKpiValue(kpiName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getKpiValue: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DefaultApi();
$kpiName = kpiName_example; // String | KPI name

try {
    $api_instance->getKpiValue($kpiName);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getKpiValue: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $kpiName = kpiName_example; # String | KPI name

eval { 
    $api_instance->getKpiValue(kpiName => $kpiName);
};
if ($@) {
    warn "Exception when calling DefaultApi->getKpiValue: $@\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()
kpiName = kpiName_example # String | KPI name

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

Parameters

Path parameters

Name	Description
kpiName*	String KPI name Required

Responses

Status: 200 - Success

Status: 500 - Server error

runIssueAnalysis

Run analysis for a given issue

/runissueanalysis/{issueId}

Usage and SDK Samples

curl -X POST "http://localhost/api/scbi/v1/runissueanalysis/{issueId}"

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 issueId = issueId_example; // String | Issue uid
        RunMessage body = ; // RunMessage | 
        try {
            apiInstance.runIssueAnalysis(issueId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#runIssueAnalysis");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String issueId = issueId_example; // String | Issue uid
        RunMessage body = ; // RunMessage | 
        try {
            apiInstance.runIssueAnalysis(issueId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#runIssueAnalysis");
            e.printStackTrace();
        }
    }
}

String *issueId = issueId_example; // Issue uid
RunMessage *body = ; //  (optional)

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

[apiInstance runIssueAnalysisWith:issueId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IrisSupplyChainAnalyticsApi = require('iris_supply_chain_analytics_api');

var api = new IrisSupplyChainAnalyticsApi.DefaultApi()

var issueId = issueId_example; // {String} Issue uid

var opts = { 
  'body':  // {RunMessage} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.runIssueAnalysis(issueId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class runIssueAnalysisExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var issueId = issueId_example;  // String | Issue uid
            var body = new RunMessage(); // RunMessage |  (optional) 

            try
            {
                apiInstance.runIssueAnalysis(issueId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.runIssueAnalysis: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DefaultApi();
$issueId = issueId_example; // String | Issue uid
$body = ; // RunMessage | 

try {
    $api_instance->runIssueAnalysis($issueId, $body);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->runIssueAnalysis: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $issueId = issueId_example; # String | Issue uid
my $body = WWW::SwaggerClient::Object::RunMessage->new(); # RunMessage | 

eval { 
    $api_instance->runIssueAnalysis(issueId => $issueId, body => $body);
};
if ($@) {
    warn "Exception when calling DefaultApi->runIssueAnalysis: $@\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()
issueId = issueId_example # String | Issue uid
body =  # RunMessage |  (optional)

try: 
    api_instance.run_issue_analysis(issueId, body=body)
except ApiException as e:
    print("Exception when calling DefaultApi->runIssueAnalysis: %s\n" % e)

Parameters

Path parameters

Name	Description
issueId*	String Issue uid Required

Body parameters

Name	Description
body

Responses

Status: 200 - Success

Status: 500 - Server error

updateKpiDefinition

Update a KPI definition

/kpi/definitions/{kpiName}

Usage and SDK Samples

curl -X PUT "http://localhost/api/scbi/v1/kpi/definitions/{kpiName}"

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 kpiName = kpiName_example; // String | Name of the KPI
        KpiDefinition body = ; // KpiDefinition | New KPI definition
        try {
            array[KpiDefinition] result = apiInstance.updateKpiDefinition(kpiName, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateKpiDefinition");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String kpiName = kpiName_example; // String | Name of the KPI
        KpiDefinition body = ; // KpiDefinition | New KPI definition
        try {
            array[KpiDefinition] result = apiInstance.updateKpiDefinition(kpiName, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateKpiDefinition");
            e.printStackTrace();
        }
    }
}

String *kpiName = kpiName_example; // Name of the KPI
KpiDefinition *body = ; // New KPI definition

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

[apiInstance updateKpiDefinitionWith:kpiName
    body:body
              completionHandler: ^(array[KpiDefinition] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IrisSupplyChainAnalyticsApi = require('iris_supply_chain_analytics_api');

var api = new IrisSupplyChainAnalyticsApi.DefaultApi()

var kpiName = kpiName_example; // {String} Name of the KPI

var body = ; // {KpiDefinition} New KPI definition


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateKpiDefinition(kpiName, body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateKpiDefinitionExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var kpiName = kpiName_example;  // String | Name of the KPI
            var body = new KpiDefinition(); // KpiDefinition | New KPI definition

            try
            {
                array[KpiDefinition] result = apiInstance.updateKpiDefinition(kpiName, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.updateKpiDefinition: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DefaultApi();
$kpiName = kpiName_example; // String | Name of the KPI
$body = ; // KpiDefinition | New KPI definition

try {
    $result = $api_instance->updateKpiDefinition($kpiName, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateKpiDefinition: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $kpiName = kpiName_example; # String | Name of the KPI
my $body = WWW::SwaggerClient::Object::KpiDefinition->new(); # KpiDefinition | New KPI definition

eval { 
    my $result = $api_instance->updateKpiDefinition(kpiName => $kpiName, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->updateKpiDefinition: $@\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()
kpiName = kpiName_example # String | Name of the KPI
body =  # KpiDefinition | New KPI definition

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

Parameters

Path parameters

Name	Description
kpiName*	String Name of the KPI Required

Body parameters

Name	Description
body *

Responses

Status: 200 - KPI definition details

Schema

Status: 400 - Invalid message body

Status: 404 - KPI not found

Status: 500 - Server error

updateKpiIssues

Update issues for a given KPI

/kpiissues

Usage and SDK Samples

curl -X POST "http://localhost/api/scbi/v1/kpiissues"

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();
        KpiIssueMessage body = ; // KpiIssueMessage | 
        try {
            apiInstance.updateKpiIssues(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateKpiIssues");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

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

KpiIssueMessage *body = ; // 

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

[apiInstance updateKpiIssuesWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IrisSupplyChainAnalyticsApi = require('iris_supply_chain_analytics_api');

var api = new IrisSupplyChainAnalyticsApi.DefaultApi()

var body = ; // {KpiIssueMessage} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateKpiIssues(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateKpiIssuesExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var body = new KpiIssueMessage(); // KpiIssueMessage | 

            try
            {
                apiInstance.updateKpiIssues(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.updateKpiIssues: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DefaultApi();
$body = ; // KpiIssueMessage | 

try {
    $api_instance->updateKpiIssues($body);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateKpiIssues: ', $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::KpiIssueMessage->new(); # KpiIssueMessage | 

eval { 
    $api_instance->updateKpiIssues(body => $body);
};
if ($@) {
    warn "Exception when calling DefaultApi->updateKpiIssues: $@\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 =  # KpiIssueMessage | 

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

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - Success

Status: 500 - Server error

Suggestions, contact, support and error reporting;

Information URL: https://helloreverb.com

Contact Info: hello@helloreverb.com

http://apache.org/licenses/LICENSE-2.0.html

IRIS Supply Chain Analytics API

API and SDK Documentation

Default

closeIssue

Usage and SDK Samples

Parameters

Responses

Status: 200 - Success

Status: 500 - Server error

completeWorkflow

Usage and SDK Samples

Parameters

Responses

Status: 200 - Success

Status: 500 - Server error

createKpiDefinition

Usage and SDK Samples

Parameters

Responses

Status: 200 - Success

Status: 400 - Invalid message body

Status: 500 - Server error

deleteKpiDefinition

Usage and SDK Samples

Parameters

Responses

Status: 200 - Success

Status: 404 - KPI not found

getKpiDefinition

Usage and SDK Samples

Parameters

Responses

Status: 200 - KPI definition

getKpiDefinitions

Usage and SDK Samples

Parameters

Responses

Status: 200 - Success

Status: 500 - Server error

getKpiListing

Usage and SDK Samples

Parameters

Responses

Status: 200 - Success

Status: 500 - Server error

getKpiValue

Usage and SDK Samples

Parameters

Responses

Status: 200 - Success

Status: 500 - Server error

runIssueAnalysis

Usage and SDK Samples

Parameters

Responses

Status: 200 - Success

Status: 500 - Server error

updateKpiDefinition

Usage and SDK Samples

Parameters

Responses

Status: 200 - KPI definition details

Status: 400 - Invalid message body

Status: 404 - KPI not found

Status: 500 - Server error

updateKpiIssues

Usage and SDK Samples

Parameters

Responses

Status: 200 - Success

Status: 500 - Server error