Validate remote workflow and module

Use this resource to validate the workflow that contains the IS Connector module.

A source IS Connector can only connect to the IS Connector in a target workflow. If that connector is missing on the target side, the request will fail. Therefore, use this validation check to handle such situations.

Request

To validate the workflow and module, send a GET request to the endpoint defined below.

URL: /ibis/rest/isconnector

Method: GET

Authorization: required

GET /ibis/rest/isconnector?workflowName=MyWorkflow&moduleName=MyISConnector&type=validateWorkflow HTTP/1.1
Accept: */*
Host: localhost:8080

Query Parameters

The following table lists the query parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`workflowName`	Enter the name of the workflow.	yes	Any string
`moduleName`	Enter the name of the IS Connector module.	yes	Any string
`type`	Enter the type of request.	yes	`validateWorkflow`

workflowName

Enter the name of the workflow.

yes

Any string

moduleName

Enter the name of the IS Connector module.

yes

Any string

type

Enter the type of request.

yes

validateWorkflow

Response

The response returns the validation result.

HTTP/1.1 200 OK
Content-Type: text/plain

Workflow test successful: Workflow testworkflow and module testmodule were found.

Errors

This request might return one of the following error codes:

Authorization Failed (401): Authorization with the given username and password failed. Please revisit both values and provide valid credentials.

<html>

    <head>
        <title>Status page</title>
    </head>

    <body style="font-family: sans-serif;">
        <p style="font-size: 1.2em;font-weight: bold;margin: 1em 0px;">Unauthorized</p>
        <p>The request requires user authentication</p>
        <p>You can get technical details <a
                href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">here</a>.<br>
            Please continue your visit at our <a href="/">home page</a>.
        </p>
    </body>
</html>

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.
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.