Introduction to the Issue Management API

This page introduces the APIs for issue management in InterSystems Supply Chain Orchestrator™.

Creating and Retrieving Issues

To create and retrieve issues, use the data APIOpens in a new tab:

Creating an issue: POST {{IRIS-SERVER}}/api/{NAMESPACE}/scdata/v1/issues

With the issue value in JSON format added to the body of the request.
Get issues: GET {{IRIS-SERVER}}/api/{NAMESPACE}/scdata/v1/issues

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

The same API provides options for updating and deleting issues.

To analyze and manage issues, use the analytics APIOpens in a new tab, which provides the following options:

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/runissueanalysis/[ISSUE-ID]

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

{ "processName": "YourProcessName" }
Update the issue with the user choice from workflow: POST {{IRIS-SERVER}}/api/{NAMESPACE}/scbi/v1/completeissueworkflow/[ISSUE-ID]

This updates the issue with the user’s choice from workflow and then closes the issue. In this case, specify the option selected by the user by including the following JSON body data:

{ "comment": "Some comment", "selectedOption": "Option name" }
Close the issue: POST {{IRIS-SERVER}}/api/{NAMESPACE}/scbi/v1/closeissue/[ISSUE-ID]