Skip to main content

Introduction to the Issue Management API

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

Creating and Getting Issues

The analysis API includes options for working with issues:

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.

Managing Issues

To analyze and manage issues, use the analytics APIOpens in a new tab

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"
}

Alternatively, you can specify a template to use. In this case, use a JSON body of the following form:

{
    "processName": "YourProcessName",
    "templateName" : "TemplateTest1",
    "contexts" : [
      { "parameterName" : "ProductId",
        "value" : "PROD001"
      },
      { "parameterName" : "Q1",
        "value" : "100",
        "stage" : "Preprocessor"
      },
      { "parameterName" : "Q2",
        "value" : "200"
      }
    ]
}

In this case, the business process is responsible for specify the severity, urgency, root cause, and impacts of the issue, based upon the data in the source records, but the business process cannot include interoperability workflow components. The system first runs the business process and then uses the scenario analysis module to perform an analysis using the given template and context information.

Additional endpoints enable you to update the workflow with user input, and close the issue.

See Also

FeedbackOpens in a new tab