Direct Inward Dialing: +1 408 916 9393
Free EditionThis API helps you raise a workflow request to hide users from Exchange address lists 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 must be performed. |
| inputData | Details about the workflow request to be raised. It must also contain the details about the mailbox that is to be disabled or deleted. | |
| Yes | Specify the title of the request under Subject. | |
| Yes | Specify the action as HIDE_EXCHANGE_ADDR_LIST under RequestAction. | |
| Yes | Specify the user accounts that are to be hidden from the Exchange address lists. | |
| Optional | Specify the priority of the task. | |
| Optional | Provide a suitable Description. | |
| Yes | Specify the value of HideFromAddrList field as 0/1 | |
| 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":"HIDE_EXCHANGE_ADDR_LIST", "Subject":"Hide from Exchange address lists", "accounts":[{"sAMAccountName":"john"}], "HideFromAddrList":"0"}]
Response:
[{"Subject":"Hide from Exchange address lists","requestId":6311,"statusMessage":"Successfully created the request.","status":"1"}]
