Direct Inward Dialing: +1 408 916 9393
Free EditionThis API helps you raise a workflow request to move a contact 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 details about the container to which the contact has to be moved. | |
| Yes | Specify the title of the request under Subject. | |
| Yes | Specify the action as MOVE_CONTACT under RequestAction. | |
| Yes | Specify the name of the contacts to be moved. | |
| Optional | Specify the priority of the task. | |
| Optional | Provide a suitable description. | |
| Optional | Specify the details of the Container to which the contact has to be moved. | |
| 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":"MOVE_CONTACT", "Subject":"Move Contacts", "accounts":[{"name":"fuel_vendor"}], "Container":"OU=testOU,DC=admp,DC=local"}]
Response:
[{"Subject":"Move Contacts","requestId":7809,"statusMessage":"Successfully created the request.","status":"1"}]
