TDX API Required Fields

Environment

API TEST Directory/TDxTicketInfo - TeamDynamix Sandbox
API Prod Directory - TeamDynamix Production

Issue

There are new required field values that need to be passed in the request body when integrating via the API TEST Directory to create new tickets in TeamDynamix. The directory includes a field and data type validation.

Resolution

The request body of the API call for the following endpoint to create a TeamDynamix ticket requires a value for all of the fields listed below.

Code that points to Prod can be updated now with the required field changes, and will continue to create tickets in TeamDynamix Prod as expected.  Future communication will be sent to API Directory subscribers with further information and the Prod release date.

API endpoint url:

POST https://gw.api.it.umich.edu/um/it/{appId}/tickets

Required fields:

TypeID(Int32)
ServiceID(Int32)
Title(String)
StatusID(Int32)   
SourceID(Int32) - Use value=8 for all Systems 
RequestorEmail(String)
ResponsibleGroupID(Int32)

Sample payload:

curl --location --request POST 'https://gw.api.it.umich.edu/um/it/31/tickets?EnableNotifyReviewer=false&NotifyRequestor=true&NotifyResponsible=true' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer tokenXXX' \
--data-raw '{"RequestorEmail": "phoang@umich.edu",
"TypeID": 28,
"ServiceID": 67,
"Title": "test preview",
"ResponsibleGroupID": 118,
"PriorityID": 19,
"Classification": "46",
"Description": "test preview api directory",
"SourceID":8,
"StatusID":78}'

Additional Information

See UM's TeamDynamix API Documentation for more information.

Print Article

Details

Article ID: 5706
Created
Tue 6/8/21 1:54 PM
Modified
Tue 5/2/23 4:15 PM