The TerminateModelChainAsync Endpoint

Definition

The TerminateModelChainAsync endpoint is used to terminate a currently running calculation that was initiated with a POST request to the ModelChainAsync endpoint.

You may have erroneously started the calculation, or realised the parameters weren't correct so need to cancel it, or it may be taking much longer than you expect. You can do this with the TerminateModelChainAsync endpoint.

• API endpoint: https://solarfarmer.dnv.com/api/TerminateModelChainAsync
• It is a HTTP POST request
• Inputs:
  • instanceId: (string) - the instance ID returned from the POST request to the ModelChainAsync endpoint that you wish to terminate
  • reason - (string) - reason for terminating the calculation (optional)
• Outputs:
  • No direct content is returned from this call, just one of the following HTTP status codes:
    • 202 = Accepted (successfully found the calculation and terminated it)
    • 400 = BadRequest (something not right with how it is being called or authorized)
    • 404 = NotFound (couldn't find a calculation with the instance ID that was provided)
    • 410 = Gone (found the calculation but it has finished or was already terminated)
  • (see https://en.wikipedia.org/wiki/List_of_HTTP_status_codes)

See the TerminateModelChainAsync Endpoint Tutorial to learn how to use this endpoint.