Execute remote workflow

This endpoint is for remote workflow execution via an INUBIT IS connector.

Request

URL: /ibis/rest/isconnector

Method: POST

Authorization: required

POST /ibis/rest/isconnector HTTP/1.1
Accept: application/xml
Host: localhost:8080

Request Parameters

Name Description Required Allowed values

workflowName

Name of the workflow

yes

Any string

moduleName

Name of the IS connector module

yes

Any string

type

Type of request

yes

workflowExecute

inputMessageSize

Number of input messages

yes

1

inputMessages

Serialized input message using XStream

yes

Any string

variables

Workflow variables in XML format

yes

Any string

Example for Request Parameter:

inputMessages:
Input messages need to be created from the list of attachment (org.apache.cxf.jaxrs.ext.multipart.Attachment) and this needs to be serialized with XStream (com.thoughtworks.xstream.XStream).Below code is an example for input message.

<?xml version='1.0' encoding='UTF-8'?>
<linked-list>
    <org.apache.cxf.jaxrs.ext.multipart.Attachment>
        <handler>
            <!-- This XML structure is built by the XStream library; this content is not always fixed. -->
            <dataSource class="org.apache.cxf.jaxrs.ext.multipart.InputStreamDataSource">
                <is class="java.io.ByteArrayInputStream">
                    <buf>dGVzdA==</buf>
                    <pos>0</pos>
                    <mark>0</mark>
                    <count>4</count>
                </is>
                <contentType>application/octet-stream</contentType>
            </dataSource>
            <transferFlavors/>
        </handler>
        <headers class="org.apache.cxf.jaxrs.impl.MetadataMap">
            <caseInsensitive>true</caseInsensitive>
            <readOnly>false</readOnly>
            <m class="linked-hash-map">
                <entry>
                    <string>Content-Disposition</string>
                    <list>
                        <string>attachment</string>
                    </list>
                </entry>
                <entry>
                    <string>Content-ID</string>
                    <list>
                        <string>responseMessage</string>
                    </list>
                </entry>
                <entry>
                    <string>Content-Type</string>
                    <list>
                        <string>application/octet-stream</string>
                    </list>
                </entry>
            </m>
        </headers>
    </org.apache.cxf.jaxrs.ext.multipart.Attachment>
</linked-list>

Variables:
Workflow variable property in XML format as below.

<?xml version='1.0' encoding='UTF-8'?>
<Properties version="4.1">
    <Property name="ISFileSize">571</Property>
    <Property name="ISCurrentTime" type="Long">1719378732082</Property>
    <Property name="ISWorkflowName">DemoISConnector</Property>
    <Property name="ISModuleName">ISMedium</Property>
    <Property name="ISModuleId">7</Property>
    <Property name="ISProcessId">80001</Property>
    <Property name="ISServerName">server name</Property>
    <Property name="ISNodeName">172.17.0.1</Property>
    <Property name="ISGlobalProcessId">80001</Property>
</Properties>

Response

HTTP/1.1 200 OK
Content-Tye: multipart/form-data
Content-Length: 908

<?xml version='1.0' encoding='UTF-8'?>
<linked-list>
    <org.apache.cxf.jaxrs.ext.multipart.Attachment>
        <handler>
            <!-- This XML structure is built by the XStream library; this content is not always fixed. -->
            <dataSource class="org.apache.cxf.jaxrs.ext.multipart.InputStreamDataSource">
                <is class="java.io.ByteArrayInputStream">
                    <buf>dGVzdA==</buf>
                    <pos>0</pos>
                    <mark>0</mark>
                    <count>4</count>
                </is>
                <contentType>application/octet-stream</contentType>
            </dataSource>
            <transferFlavors/>
        </handler>
        <headers class="org.apache.cxf.jaxrs.impl.MetadataMap">
            <caseInsensitive>true</caseInsensitive>
            <readOnly>false</readOnly>
            <m class="linked-hash-map">
                <entry>
                    <string>Content-Disposition</string>
                    <list>
                        <string>attachment</string>
                    </list>
                </entry>
                <entry>
                    <string>Content-ID</string>
                    <list>
                        <string>responseMessage</string>
                    </list>
                </entry>
                <entry>
                    <string>Content-Type</string>
                    <list>
                        <string>application/octet-stream</string>
                    </list>
                </entry>
            </m>
        </headers>
    </org.apache.cxf.jaxrs.ext.multipart.Attachment>
</linked-list>

Errors

Authorization Failed (401)

Authorization with the given username and password failed. Please revisit both values and provide valid credentials.

<?xml version="1.0" encoding="UTF-8"?>
<ApiError>
    <statusCode>401</statusCode>
    <message>Unauthorized access</message>
    <path>/rest/endpoint</path>
    <timestamp>2025-06-07T14:21:11.781</timestamp>
</ApiError>
Resource Not Found (404)

The 404 (Not Found) status code indicates that the requested endpoint or resource is unavailable or does not exist on the server.

Server Error (500)

Execution on the INUBIT server failed. Have a look into the response message, otherwise access to the INUBIT log is required to retrieve further information.

<?xml version="1.0" encoding="UTF-8"?>
<ApiError>
    <statusCode>500</statusCode>
    <message>Internal Server Error</message>
    <path>/rest/endpoint</path>
    <timestamp>2025-08-06T12:55:31.862</timestamp>
</ApiError>
Service Unavailable (503)

In maintenance mode the INUBIT server endpoint will not respond to incoming requests but return this error response. Once the maintenance mode is switched off the endpoint will respond normally.

<?xml version="1.0" encoding="UTF-8"?>
<ApiError>
    <statusCode>503</statusCode>
    <message>Service Unavailable</message>
    <path>/rest/endpoint</path>
    <timestamp>2025-08-06T12:58:06.688</timestamp>
</ApiError>
Press Esc to exit full screen
Modal image placeholder
Press Esc to exit full screen