Completing Assignments using API

Overview

Decisions offers the ability to Call Internal Services using API Calls. One of these services is the Assignment Service, which allows an API call to update, modify, or add information to an Assignment. This feature allows for a third-party system to call into Decisions to create an Assignment for a user. The user will need to complete the Assignment if the "failure condition" in the other system automatically recovers.  The service, Process Form Assignment Response, featured in this article allows this to happen.

Example

This example will set up a basic Assignment, get the Assignment ID, and use the ProcessFormAssignmentResponse Operation to gather the Integration Details and complete the Assignment using Postman.

Setup Assignment

1. Starting in the Flow Designer, place an Add Task step onto the workspace. This example Task (Form) will be left blank; however, it may contain any customizable Form components needed for various use cases.
2. With the task highlighted, locate the Assign To field in the Properties panel.  
3. Add an Assignee, or person the task will go to, by typing in the designated field. This example will use "admin@decisions.com." 
4. Give the Assignment an Assignment Name and an Assignment Action Name. Although it is best practice to have a dynamic Assignment Name, this example will use a Constant name. 

   

5. In the Properties panel, click the Edit button next to Assignment Setup. 
6. In the Assignment Setup dialog, scroll to the Additional Assignment Action section and select Add New.

   

7. In the Add Action Definitions dialog, uncheck Can Respond Via Email. 
8. In the Allow Files drop down, choose NotAllow. 
9. Under Data > Outcome Name, type "Approved."
10.  Select OK to save.
    
11. Upon return to the Assignment Setup dialog, define a Denied action in the same manner as the previously configured Approved action. 
12. When finished select Done.
    
13. In the Flow Designer, save and close the Flow.

    

Integration Details

1. In the Decisions Studio, navigate to System > Administration > Features > All Services. 
2. Select Assignment > Viewing Integration Details .

   

3. In the Assignment Operations window, find and select ProcessFormAssignmentResponse.

   

4. In the ProcessFormAssignmentResponse Operations window, set up the integration details and select Show. The URL and Body will need to be pasted into Postman to test.

   

Setup Postman

1. In Postman, add a new POST request and paste the URL in the URL box. 
2. Paste the following code into the body. 

{
  "userid": "admin@decisions.com",
  "password": "admin",
  "assignmentId": "StringValue",
  "response": "StringValue",
  "comment": "StringValue",
  "outputtype": "Json"
}

Debug

1. Run the Assignment Flow from the Designer Folder.
2. Select No when prompted to complete the Assignment. 
3. Navigate to the Inbox Folder in the Folder tree. 
4. Select the Assignment waiting to be completed, choose Manage > Get Form Assignment ID. 
5. In the ID dialog, copy the Form Assignment ID then select Done.
6. Navigate to Postman, next to "AssignmentId": replace "StringValue" with the Assignment ID that was just copied. 
7. Replace the StringValue of "Response" with Approved and then replace the StringValue of "Comment" with Done.
8. Select Send to process the response. The Response panel will show the body of the response as "ProcessFormAssignmentReponseResult": null. 
9. Back in the Decisions Studio, refresh the screen and notice the Assignment is no longer in the Inbox Folder as it was completed using API.