Skip to main content

Introduction to the Issue Management API

InterSystems Supply Chain Orchestrator™ provides an analytics APIOpens in a new tab which includes API endpoints for issue management.

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"
}
FeedbackOpens in a new tab