Get form help or validate form data

Use this endpoint to retrieve help information for form fields. You can also use it to perform server-side validation of form data.

Request

To get help information or validate form data, send a POST request to the endpoint below. The query parameters control the behavior of the endpoint.

URL: /task/help

Method: POST

Authorization: required

POST /ibis/rest/task/help?ajaxType=validation&ajaxMode=Submission&workflowName=@@@ISAjaxCall@@@&params=webform@@@ServerSideValWAC/form_webappvalidateserversidetg(2)_serversidevalidationwebapp@@@210004.xml@@@validation@@@ajaxSubmission@@@null@@@en HTTP/1.1
Accept: text/html
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`	Specifies the technical name of the workflow as visible in the Queue Manager.	yes	A valid URL-encoded string.
`params`	Provides context for the server-side operation, including form name and language.	yes	A structured, alphanumeric string.

workflowName

Specifies the technical name of the workflow as visible in the Queue Manager.

yes

A valid URL-encoded string.

params

Provides context for the server-side operation, including form name and language.

yes

A structured, alphanumeric string.

Request Body

The body of the request contains the form data to be validated.

submitId=&hiddenSubmitIS=_nothing&TextField_114030349=&%23sb_value=Next

Response

The response contains the validation result or the help text information.

HTTP/1.1 200 OK
Content-Type: application/xml

<result>
    <header>
        <heading>3 errors at form validation.</heading>
        <headingUnsigned>{errorCount} error{s} at form validation.</headingUnsigned>
        <language>en</language>
    </header>
    <html>Field 1 is mandatory<errornodes id="1"><errornode>Field1WAC</errornode></errornodes>
    </html>
    <html>Field 2 is mandatory<errornodes id="2"><errornode>Field2WAC</errornode></errornodes>
    </html>
    <html>Field 3 is mandatory<errornodes id="3"><errornode>Field3WAC</errornode></errornodes>
    </html>
</result>

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.

{
    "statusCode": 401,
    "message": "Unauthorized access",
    "path": "/rest/<endpoint>",
    "timestamp": "2025-06-07T14:21:11.781"
}

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.

{
  "statusCode": 500,
  "message": "Internal Server Error",
  "path": "/rest/<endpoint>",
  "timestamp": "2025-08-06T12:55:31.862"
}

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.

{
  "statusCode": 503,
  "message": "Service Unavailable",
  "path": "/rest/<endpoint>",
  "timestamp": "2025-08-06T12:58:06.688"
}