Getting Started With Workflow Web Services

Summary

The video is designed for technical resources to gain introductory knowledge to the TeamDynamix Workflow Web Services highlighted in the Advanced Ticketing Readiness Course. It is also configured during implementation or general configuration.  Content related in the video area available in the Related Articles section of this article's sidebar.

Duration: 19 minutes

Presented By: William Cochran, Senior Consultant, TeamDynamix

Contents

• Agenda (00:20)
• Overview of Workflow Web Services (01:00)
• How to Create a Service Account (01:58)
• How to create a Web Service Auth Account and Web Service Provider  (03:43)
• Overview of Web Service Methods and creation example (05:55)
• Applying a Workflow Web Service to a Workflow (16:04)
• Recap (17:25)

Tips and Tricks

Locating your API Catalog

The location of your API catalog will vary depending on if you have a vanity URL, or a standard-issue TeamDynamix URL.

Standard SaaS TeamDynamix URL:

• Production: https://ORGNAME.teamdynamix.com/TDWebAPI
• Sandbox: https://ORGNAME.teamdynamix.com/SBTDWebAPI

Vanity URL:

• Production: https://yourVanityURL/TDWebAPI
• Sandbox: https://yourVanityURL/SBTDWebAPI

Working with Parameters

In order to work with variables within your TeamDynamix workflow web service step, you need to declare them as parameters. Your TeamDynamix API catalog will indicate what aspects of the URL can be treated as variables by putting within a set of single { } curly braces. Within the API documentation, TeamDynamix only uses single curly braces in order to remain tool-agnostic, however, within TeamDynamix, a variable is declared by using a set of double {{ }} curly braces. Any parameters you declare in the parameters tab can then by referenced by including the parameter within a set of {{ }} anywhere within the workflow web service step.

E.g., you want to work with the endpoint from your API Catalog to patch a ticket within a workflow, https://YourDomain.teamdynamix.com/TDWebApi/api/{appid}/tickets/{id}

1. You can explicitly declare the ticketing appid within the API call (e.g., 100)
2. Change the URL from {id} to {{id}}
   • {id} is the documentation indicating that this can be a variable
   • {{id}} is how TeamDynamix recognizes that there is a variable and will check your declared parameters list to find the value of said variable
3. In the Parameters tab, set the following:
   1. Name as id (case-sensitive!)
   2. Data type as Integer (String will also work)
   3. Source is From Ticket
   4. Source Property is ID

The newly constructed URL is https://YourDomain.teamdynamix.com/TDWebApi/api/100/tickets/{{id}} which will assign the ID of the ticket to the variable id, and which will then perform the API call within Ticketing App, ID 100.

Constructing the API Body (Working with JSON)

When creating a Workflow Web Service Body for PATCH or POST, you may come across using these following pieces in your JSON:

• Angle Brackets: < >
• Parentheses: ( )
• Brackets: [ ]
• Braces: { }

For more information on working with JSON, reference the official JSON site.

Testing your Workflow Web Service Steps

There are two primary ways to test your newly constructed workflow web service step:

1. Using the Test Request button within the workflow web service, or
2. Assigning the workflow web service to a workflow step and sending a ticket through the workflow to trigger the step.