Using Web Services for Multiple Approvals using ReportsTo Data

Overview

Web service steps open up extensive possibilities for things that can occur on a ticket within TeamDynamix as part of a ticketing workflow. This article serves as an example of adding multiple approval layers based on the ReportsTo data.  For example, a request may be approved by the Requestor's Supervisor and the Supervisor's Supervisor. 

Learn more about setting up and using web service steps.

There are a few steps needed to set up the web service steps for the workflow:

  1. Get Requestor Data -  ReportsToUID from People Records
  2. Write the Supervisor to a custom "Approver1" attribute on the ticket
  3. Get Supervisor Data -  ReportsToUID from People Records
  4. Write the Supervisor's Supervisor to a custom "Approver2" attribute on the ticket
  5. Create Approval Workflow Steps - Use the Approver1 and Approver2 attributes as Approval Roles

Preparing Custom Attributes

  1. In TDAdmin, click Applications in the left navigation.
  2. Click the Name of the Ticketing application you want to add this workflow to.
  3. Click Attributes in the left nvigation.
  4. Select +New from the top navigation
    1. Attribute Name: Approver1
    2. Header Text: Approver1
    3. Attribute Type: Person
    4. Save
    5. Note the ID under the attribute name at the top of the pop-out window.  This will be needed later. 
  5. Repeat Step 4 to create an Approver2 attribute.

 

Step 1 - Get Requestor Data from People

Creating the Web Service Method - Get Requestor Data

This Web Service Method will retrieve information about the Requestor.

  1. In TDAdmin, click Applications in the left navigation.
  2. Click the Name of the Ticketing application you want to add this workflow step to.
  3. Click Workflow Web Services in the left navigation, then click Web Service Methods.
  4. Click the +New button.
  5. On the New Web Service page, enter a Name for the method. This name will show up in the workflow builder. (Suggested: Get Requestor Data)
  6. In the Web Service Provider field, enter the web service provider you've already defined.[where?]
  7. Click the Method button to the left of the URL field and select GET.
  8. In the URL field, enter https://[Your TeamDynamix URL]/TDWebApi/api/people/{{RequestorUID}}
  9. Click the Headers tab and define the following header:
    1. Key – Content-type
    2. Value – application/json 
  10. Click the Add button to add the header.
  11. Click the Parameters tab and define one of the following parameters: 
    1. RequestorUID – String – From Ticket – Requestor UID
  12. Click the Add button to add the parameter.
  13. Click Authentication and select and Auth method that has access to People records.
  14. Click the Save button.

The Body field is intentionally left blank, GET requests should have no body value. 

Storing the Get Requestor Data Results in the Workflow 

Add a workflow step to call the Get Ticket Details method (from above) and store the results in the workflow with a meaningful name, such as REQUESTORDATA. Whatever you name the result is how you will need to reference it in a the next web service method.

Step 2 - Write the Supervisor to Approver1

Creating the Web Service Method - Write the Supervisor to Approver1

This Web Service Method will update the ticket by setting Approver1 to the Requestor's "ReportsTo" Supervisor. 

  1. In TDAdmin, click Applications in the left navigation.
  2. Click the Name of the Ticketing application you want to add this workflow step to.
  3. Click Workflow Web Services in the left navigation, then click Web Service Methods.
  4. Click the +New button.
  5. On the New Web Service page, enter a Name for the method. This name will show up in the workflow builder. (Suggested: Write Supervisor to Approver1)
  6. In the Web Service Provider field, enter the web service provider you've already defined.[where?]
  7. Click the Method button to the left of the URL field and select PATCH.
  8. In the URL field, enter https://[Your TeamDynamix URL]/TDWebApi/api/{{AppID}}/tickets/{{TicketID}}
  9. Click the Headers tab and define the following header:
    1. Key – Content-type
    2. Value – application/json 
  10. Click the Add button to add the header.
  11. Click the Parameters tab and define one of the following parameters: 
    1. AppID – Integer – From Ticket – Application ID
    2. TicketID – Integer – From Ticket – ID 
    3. ReportsToUID - String - From Workflow - REQUESTORDATA.ReportsToUID
  12. Click the Add button to add the parameter.
  13. Click </> Body tab
    1. [ {"op": "replace", "path": "/attributes/XXXX", "value": "{{ReportsToUID}}"}]
    2. Replace XXXX with the custom attribute ID number from the "Approver1" attribute created at the beginning of this article.
  14. Click Authentication and select and Auth method that has access to People records.
  15. Click the Save button.

Step 3 - Get Supervisor Data from People

Creating the Web Service Method - Get Supervisor Data

This Web Service Method will retrieve information about the Requestor's Supervisor.

  1. In TDAdmin, click Applications in the left navigation.
  2. Click the Name of the Ticketing application you want to add this workflow step to.
  3. Click Workflow Web Services in the left navigation, then click Web Service Methods.
  4. Click the +New button.
  5. On the New Web Service page, enter a Name for the method. This name will show up in the workflow builder. (Suggested: Get Supervisor Data)
  6. In the Web Service Provider field, enter the web service provider you've already defined.[where?]
  7. Click the Method button to the left of the URL field and select GET.
  8. In the URL field, enter https://[Your TeamDynamix URL]/TDWebApi/api/people/{{SupervisorUID}}​​​​​​​
  9. Click the Headers tab and define the following header:
    1. Key – Content-type
    2. Value – application/json 
  10. Click the Add button to add the header.
  11. Click the Parameters tab and define one of the following parameters: 
    1. SupervisorUID – Integer – From Workflow – REQUESTORDATA.ReportsToUID (Note: "REQUESTORDATA" is the response body name defined in Step 2)
  12. Click the Add button to add the parameter.
  13. Click Authentication and select and Auth method that has access to People records.
  14. Click the Save button.

The Body field is intentionally left blank, GET requests should have no body value. 

Storing the Get Supervisor Data Results in the Workflow 

Add a workflow step to call the Get Ticket Details method (from above) and store the results in the workflow with a meaningful name, such as SUPERVISORDATA. Whatever you name the result is how you will need to reference it in a the next web service method.

Step 4 - Write the Supervisor's Supervisor to Approver2

Creating the Web Service Method - Write Supervisor's Supervisor to Approver2

This Web Service Method will update the ticket by setting Approver2 to the Requestor's Supervisor's "ReportsTo" Supervisor. 

  1. In TDAdmin, click Applications in the left navigation.
  2. Click the Name of the Ticketing application you want to add this workflow step to.
  3. Click Workflow Web Services in the left navigation, then click Web Service Methods.
  4. Click the +New button.
  5. On the New Web Service page, enter a Name for the method. This name will show up in the workflow builder. (Suggested: Write Supervisor's Supervisor to Approver2)
  6. In the Web Service Provider field, enter the web service provider you've already defined.[where?]
  7. Click the Method button to the left of the URL field and select PATCH.
  8. In the URL field, enter https://[Your TeamDynamix URL]/TDWebApi/api/{{AppID}}/tickets/{{TicketID}}
  9. Click the Headers tab and define the following header:
    1. Key – Content-type
    2. Value – application/json 
  10. Click the Add button to add the header.
  11. Click the Parameters tab and define one of the following parameters: 
    1. AppID – Integer – From Ticket – Application ID
    2. TicketID – Integer – From Ticket – ID 
    3. ReportsToUID - String - From Workflow - SUPERVISORDATA.ReportsToUID
  12. Click the Add button to add the parameter.
  13. Click </> Body tab
    1. [ {"op": "replace", "path": "/attributes/XXXX", "value": "{{ReportsToUID}}"}]
    2. Replace XXXX with the custom attribute ID number from the "Approver2" attribute created at the beginning of this article.
  14. Click Authentication and select and Auth method that has access to People records.
  15. Click the Save button.

Step 5 - Create Approval Workflow Steps

  1. Create Approval Workflow Step for Approver1
    1. Choose Approver1 as the Approver Role
  2. Create Approval Workflow Step for Approver2
    1. Choose Approver2 as the Approver Role
Print Article