Direct Inward Dialing: +1 408 916 9393
Free EditionThis API helps you raise a workflow request to configure automatic replies using your application.
Request URL (JSON) Format: http://<hostname>:<port>/RestAPI/CreateWorkFlowRequest
Request Parameters:
| Parameters | Mandatory | Description |
| AuthToken | Yes | Authentication token that is generated either from the Delegation tab (Delegation > Configuration > Technician Authtokens) or from the My account tab (My Account > Active Authtokens) in the top right corner of the product. |
| domainName | Yes | Domain in which this operation is to be performed. |
| inputData | Details about the workflow request to be raised. It must also contain the details about the user accounts for which the automatic replies have to be configured. | |
| Yes | Specify the title of the request under Subject. | |
| Yes | Specify the action as ENABLE_AUTO_REPLY under RequestAction. | |
| Yes | Specify the user accounts for which automatic replies have to be configured. | |
| Optional | Specify the priority of the task. | |
| Optional | Provide a suitable Description. | |
| Yes | Specify the value of IsSendAutoReply attribute as dontSend or send based on your requirements. | |
| Optional | Specify the values of InsideMessage, IsSendOutsideMsg and OutsideMessage based on the factor that the auto reply must be sent to recipients inside or outside the organizations. | |
| Yes | Specify whether the auto reply is time-based with the help of IsAutoReplyTimeBased attribute. | |
| Optional if the value of IsAutoReplyTimeBased is false. | Specify the duration for which the auto replies must be sent with the help of ReplyStartDate, ReplyEndDate, StartHr, StartMin, EndHr, EndMin attributes. | |
| PRODUCT_NAME | Yes | Product name/module name from which the request is being sent; will be needed for auditing. |
Response Parameters:
| Parameters | Description |
| Subject | Subject of the request |
| requestId | RequestId of the request raised. This is not displayed in the response, if the operation has failed. |
| status | Status of the operation, where 1 stands for Success and 0 stands for Failure. |
| statusMessage | The response message to be displayed in case of success or failure. |
Sample Input / Output
Request:
http://admanager:8080/RestAPI/CreateWorkFlowRequest?AuthToken=244f8f17-041d-4c85-9924-02f7351a6fbb&domainName=admp.local&PRODUCT_NAME=RESTAPI&inputData=[{"RequestAction":"ENABLE_AUTO_REPLY", "Subject":"Auto reply", "accounts":[{"sAMAccountName":"john"}], "IsSendAutoReply":"send", "InsideMessage":"InsideMessage", "IsSendOutsideMsg":"true", "OutsideMessage":"OutsideMessage", "IsAutoReplyTimeBased":"true", "ReplyStartDate":"2019-08-01", "ReplyEndDate":"2019-07-01", "StartHr":"0", "StartMin":"10", "EndHr":"23", "EndMin":"59"}]
Response:
[{"Subject":"Auto reply","requestId":6322,"statusMessage":"Successfully created the request.","status":"1"}]
