Helper - Run tool.

API Url

Use it to execute tools

POST

http://localhost:16010/ProMarkREST/web/Helper/execution/{helper}

Permissions: user

Request headers

Field	Type	Description
Accept-Language`optional`	String	=en-GB Language use for localization.
X-Client`optional`	String	=Client type. Allowed values:`"Portal""Mobile""Admin"`
X-Role`optional`	Number	ProMark role (1: Employee, 2: User). Allowed values:`{12}`
X-WebPart-Id`optional`	Number	Unique web-part identifier.

Parameter

Field	Type	Description
data	Object	Object containg data to be uploaded.
tools	Object[]	A list of tools to be executed
type	Integer	The type of the tool

Request example:

{
  "request": {
      "data": 
          {
              "deleteAutoTransferredHolidays": {
              "holidayType": "AUR2",
              "holidayYear": 2023,
              "update": true}
             
          }
      

  }
}

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
tools	Object[]	A list of tools execute
executionInfo	String	Information send back about the execution of the tool
executionStatus	Integer	Information send back about the status of the execution. 0 = Successful / 99 = Unsuccessful
type	Integer	The type of the tool
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Response example:

HTTP/1.1 200 OK
  {
    "response": {
        "data": {
             "executionInfo": "Finding/Removing auto transferred holiday transactions: 2024/05/24 13:55:50\n\nProcessing completed at 2024/05/24 13:55:50\nNothing changed",
             "executionStatus": 0
        }
    }
}

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.