Start an ad-hoc process

Use this resource to start an ad-hoc process. This triggers a new instance of a technical workflow at the module specified by the ad-hoc process starter ID. This module is usually a Task Generator or is followed by a Task Generator.

Request

To start the process, send a POST request to the endpoint defined below.

URL: /task/adhoc/{user}/{id}

Method: POST

Authorization: required

POST /ibis/rest/task/adhoc/testuser/74933f6c-72c6-44c5-9e90-91070f98c7dd HTTP/1.1
Accept: application/xml
Host: localhost:8080

The request body is empty.

Path Parameters

The following table lists the path parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`user`	Enter the username.	yes	Any existing username
`id`	Enter the ID of an ad-hoc process starter that the user can access.	yes	Any valid ad-hoc process starter ID

user

Enter the username.

yes

Any existing username

id

Enter the ID of an ad-hoc process starter that the user can access.

yes

Any valid ad-hoc process starter ID

Query Parameters

The following table lists the query parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`lang`	Enter the language code.	no (default: `de`)	`de` or `en`
`client`	Enter the tenant name.	no	e.g. `Virtimo_AG`

lang

Enter the language code.

no (default: de)

de or en

client

Enter the tenant name.

e.g. Virtimo_AG

Response

If the request is successful, the server returns one of the following responses.

HTTP/1.1 201 Created
Content-Type: application/plain

10f66801-77e7-4dfa-8f40-0f5039d4552a

201 Created: A new task was created. The response body contains the ID of the new task. The new task receives the attributes popup=true and user=<username>.
204 No Content: The process was started successfully, but no follow-on task was created.

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.