Introduction to the Issue Management API

This page introduces the API for issue managementOpens in a new tab in InterSystems Supply Chain Orchestrator™.

Note:

You may find it easier to analyze supply chain issues by using the newer scenario analysis module instead.

Introduction to the Issue Management API

The analysis API includes options for working with issues:

Creating an issue

POST {{IRIS-SERVER}}/api/{NAMESPACE}/scbi/v1/issues

With the issue value in JSON format added to the body of the request.

Get issues

GET {{IRIS-SERVER}}/api/{NAMESPACE}/scbi/v1/issues

Additional query parameters based on any issue attributes can be added in the form of HTTP parameters, such as `status=open`.

Update issues for a KPI

POST {{IRIS-SERVER}}/api/{NAMESPACE}/scbi/v1/kpiissues

Forces an issue update for the given KPI. This applies to KPIs that are issue-enabled. In this case, specify KPI information in the JSON body data, for example:

{
    "kpi": "SalesOrderLateShipVsCommitted"
}

Force a new analysis for an issue

POST {{IRIS-SERVER}}/api/{NAMESPACE}/scbi/v1/analyzeissue/[ISSUE-ID]

This option applies if a process is associated with an issue. In this case, specify the process to use by including the following JSON body data:

{
    "processName": "YourProcessName"
}