Informizely customer feedback surveys
By using the Aculab site, you agree with our use of cookies.

Interrupting a REST application

This describes the web service to interrupt an instance of a REST application running on Aculab Cloud.

It references the following web service:
 This is a low level API. For information on higher level APIs see the Web Services Language Wrappers
  • Rest Interrupt

    This will interrupt one or more REST application instances that are running on Aculab Cloud. The current action will be stopped and any further actions in the current list will be skipped.

    Url:https://ws.aculabcloud.net/rest_interrupt
    Methods:GET, POST

    ParameterValueDescription
    application_instance_idsstringa list of application instance IDs of the REST applications to interrupt, delimited by the character /.
    redirect_pagestring (optional)the page to which to send the result of the interrupt.
    redirect_methodstring (optional)the method (GET, POST) to use when accessing redirect_page

    The Redirect Page Request:

    If redirect_page is defined it will receive a JSON object containing the result of the interrupt command. The JSON object will be the standard REST instance_info object which will include an action_result containing the result of the interrupt and, if available, the action that was interrupted. The redirect page can continue the application by returning a new action list to the application instance.

    Note that if a redirect_page is not specified, the REST application's final page will be called and the application will end.

    Returns:

    A JSON object containing one or more JSON objects keyed on application instance Id. Each result object contains a string specifying the result of that interrupt. If the interrupt succeeds the action that was interrupted may also be supplied.

    ParameterAvailabilityDescription
    resultAlwaysA string indicating the result of the interrupt.
    Either:
    interrupted - the application instance was interrupted successfully.
    no such application - an application with the given instance ID does not exist. It may have completed some time ago.
    application already completed - no action was interrupted because the application has recently completed.
    failed - the interrupted failed for any other reason.
    actionAlwaysA string indicating the action that was interrupted. May be empty depending on the result.

    Examples:

    https://ws.aculabcloud.net/rest_interrupt?application_instance_ids=06e122c3364cc74c.787379&redirect_page=my_interrupt_page&redirect_method=POST

    Response:

      {
        "06e122c3364cc74c.787379" : 
    	{
    		"result" : "interrupted",
    		"action" : "play"
    	}	
      }

    https://ws.aculabcloud.net/rest_interrupt?application_instance_ids=06e122c3364cc74c.787945/06e122c3364cc74c.788624&redirect_page=my_interrupt_page

    Response:

      {
        "06e122c3364cc74c.787945" : 
    	{
    		"result" : "interrupted",
    		"action" : "record"
    	},
        "06e122c3364cc74c.788624" : 
    	{
    		"result" : "application already completed",
    		"action" : ""
    	}	
      }