--- title: "Completing Assignments Using API" slug: "complete-assignment-using-api" description: "This document demonstrates how to Call Internal Services via API Calls, to complete Assignments in Decisions. This is completed with the Assignment Service which allows the API to update, modify, or add information to an Assignment. " tags: ["processformassignmentresponse", "process assignment API", "completing assignments via API", "assignments", "API", "process form assignment response"] updated: 2025-06-18T16:32:16Z published: 2025-06-18T16:32:16Z --- > ## Documentation Index > Fetch the complete documentation index at: https://documentation.decisions.com/llms.txt > Use this file to discover all available pages before exploring further. # Completing Assignments Using API ## Overview Through the ability to [**Call Internal Services using API Calls**](https://documentation.decisions.com/v9/docs/calling-decisions-services-net), and specifically the **Assignment Service**, users can update, modify, or add information to an [**Assignment**](https://documentation.decisions.com/v9/docs/assigning-form-interactions-as-tasks) via API. The following article and example demonstrates how to use the **Process Form Assignment Response** **Service**as to create an **Assignment**, get the **Assignment****ID**, and gather **Integration****Details******to complete the Assignment via [Postman](https://www.postman.com/). --- ## Setup Assignment 1. From the **Flow****Designer**, connect an **Add****Task**step to the **Start**step, then configure the desired **Assign****To**, **Assignment****Name**, and **Assignment****Action****Name**values. Then select PICK OR CREATE FORM, and configure the [**Assigned****Form**](https://documentation.decisions.com/v9/docs/creating-a-task-from-a-flow). Assignment ConsiderationsThe example **Assignment**utilizes****an empty **Approval****Form**that uses a simple **Approve**or **Reject**button; note that this **Form**could be any other Form depending on the desired use case. It is best practice to dynamically provide values for the **Assignment****Name**and **Assignment****Action****Name**with **Merge****Plain****Text**mappings. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h22_46.png) 2. From the **Properties**tab of the **Add****Task**step, select [ASSIGNMENT SETUP > EDIT](https://documentation.decisions.com/v9/docs/assignment-settings). Then, locate **Additional Assignment Actions > Action Definitions**, and click ADD. 3. In the**Add Action Definitions** window, uncheck **Can Respond Via Email**and select **NotAllow**from the **Allow****Files**dropdown. Then, under **DATA > Outcome Name**, input "Approved" and click OK. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h24_45.png) 4. Back in the **Assignment Setup window**, define a **Rejected**Action by repeating the previous steps used to configure the **Approved**action, then click DONE. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h25_31.png) 5. Connect both outcomes of the **Add****Task**step to the **End**step. Then, **Save**and close the **Flow**. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h27_11.png) --- ## Integration Details 1. In the **Decisions****Studio**, navigate to **System > Administration > Features > All Services.**Then, locate and right-click **Assignment** and select [**View****Integration****Details**](https://documentation.decisions.com/v9/docs/view-integration-details). ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2025-06-18_12h29_46.png) 2. In the **Assignment**window, find and select **ProcessFormAssignmentResponse**from the **Method****Name**list. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2022-01-20_14h31_46.png) 3. In the **ProcessFormAssignmentResponse**window, set up the**Integration Details**by selecting the desired **Credentials******and****leaving the rest of the values default. 4. From the INFO tab, copy the **Using****POST**URL and **Parameter(s)**text.Storing InformationIf **Specify****Session****ID**or **Specify****User****Credentials**are in use, be sure to click STORE SESSION ID or STORE CREDENTIALS, to update the **Parameters**before copying over any of the INFO tab contents. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2022-01-20_14h54_52.png) --- ## Setup [Postman](https://www.postman.com/) 1. Open [**Postman**](https://www.postman.com/)****and add a new **POST****Request**. 2. Paste the URL in the URL box. 3. Format and paste the following code into the **Body**:Parameter VariationThe following code was sourced from the **ProcessFormAssignmentResponse**page, but the file portion was removed as this example does not allow files when setting up the **Assignment**. Additionally, the first couple of lines may vary depending on if **Specify****User****Credentials**, **Specify****Session****ID**, or a **Named****Session**was used.  ```json { "userid": "YOUR USER ID", "password": "YOUR PASSWORD", "assignmentId": "StringValue", "response": "StringValue", "comment": "StringValue", "outputtype": "Json" } or { "sessionid": "YOUR SESSION ID VALUE", "assignmentId": "StringValue", "response": "StringValue", "comment": "StringValue", "outputtype": "Json" } ``` ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2022-01-20_15h16_31.png) --- ## Debug 1. Navigate back to the **Decisions****Studio**and **Run**previously created **Assignment****Flow**; if prompted to complete the Assignment, click NO. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2024-06-26_11h34_50.png) 2. Navigate to the **Inbox**; from the **Action**menu of the received **Assignment**, select **Manage > Get Form Assignment ID.![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2024-06-26_11h35_45.png)** 3. From the ID window, select **Copy****Text**, then select DONE.![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2024-06-26_11h36_30.png) 4. Return to Postman, and replace the **StringValue**in the quotation marks for **assignmentId**with the copied **Assignment****ID**. 5. Replace the StringValue for response with "Approved", replace the StringValue for comment with "Done", then click **Send**.![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2022-01-20_15h28_10.png) 6. After receiving the **"ProcessFormAssignmentResponseResult": null Response**, navigate to and refresh the **Assignee's****Inbox**to confirm that the **Assignment**was completed via the API, and removed from the Inbox. ![](https://cdn.document360.io/6ef8bcc1-6489-4486-9ad1-83acff7e5df0/Images/Documentation/2024-06-26_11h38_13.png) --- For further information on Forms, visit the [Decisions Forum](https://community.decisions.com/categories/Forms).