1. APIs
  2. TeamDynamix.Api.Tickets.Ticket

Contents

Summary

A ticket.

Properties

Name Editable? Required? Type Nullable? Summary
ID Int32 The ID of the ticket.
ParentID This field is editable through the web API. Int32 The ID of the parent associated with the ticket.
ParentTitle String The title of the parent associated with the ticket.
ParentClass TeamDynamix.Api.Tickets.TicketClass The classification of the parent associated with the ticket.
TypeID This field is editable through the web API. This field is required. Int32 The ID of the ticket type associated with the ticket.
TypeName String The name of the ticket type associated with the ticket.
TypeCategoryID Int32 The ID of the category associated with the ticket's type.
TypeCategoryName String The name of the category associated with the ticket's type.
Classification TeamDynamix.Api.Tickets.TicketClass The classification associated with the ticket.
ClassificationName String The application-defined name of the classification associated with the ticket.
FormID This field is editable through the web API. Int32 The ID of the form associated with the ticket.
FormName String The name of the form associated with the ticket.
Title This field is editable through the web API. This field is required. String The title of the ticket.
Description This field is editable through the web API. String This field is nullable. The description of the ticket.
IsRichHtml This field is editable through the web API. Boolean Indicates if the ticket description is rich-text or plain-text.
Uri String The URI to retrieve the full details of the ticket via the web API.
AccountID This field is editable through the web API. This field is required. Int32 The ID of the account/department associated with the ticket.
AccountName String The name of the account/department associated with the ticket.
SourceID This field is editable through the web API. Int32 The ID of the ticket source associated with the ticket.
SourceName String The name of the ticket source associated with the ticket.
StatusID This field is editable through the web API. This field is required. Int32 The ID of the ticket status associated with the ticket.
StatusName String The name of the ticket status associated with the ticket.
StatusClass TeamDynamix.Api.Statuses.StatusClass The class of the ticket status associated with the ticket.
ImpactID This field is editable through the web API. Int32 The ID of the impact associated with the ticket.
ImpactName String The name of the impact associated with the ticket.
UrgencyID This field is editable through the web API. Int32 The ID of the urgency associated with the ticket.
UrgencyName String The name of the urgency associated with the ticket.
PriorityID This field is editable through the web API. This field is required. Int32 The ID of the priority associated with the ticket.
PriorityName String The name of the priority associated with the ticket.
PriorityOrder Double The order of the priority associated with the ticket.
SlaID Int32 The ID of the Service Level Agreement (SLA) associated with the ticket.
SlaName String The name of the Service Level Agreement (SLA) associated with the ticket.
IsSlaViolated Boolean Whether the Service Level Agreement (SLA) associated with the ticket has been violated.
IsSlaRespondByViolated Boolean This field is nullable. Whether the Service Level Agreement (SLA) associated with the ticket has its "Respond By" component violated.
IsSlaResolveByViolated Boolean This field is nullable. Whether the Service Level Agreement (SLA) associated with the ticket has its "Resolve By" component violated.
RespondByDate DateTime This field is nullable. The "Respond By" deadline of the Service Level Agreement (SLA) associated with the ticket.
ResolveByDate DateTime This field is nullable. The "Resolve By" deadline of the Service Level Agreement (SLA) associated with the ticket.
SlaBeginDate DateTime This field is nullable. The date the Service Level Agreement (SLA) associated with the ticket was started.
IsOnHold Boolean The on hold status of the ticket.
PlacedOnHoldDate DateTime This field is nullable. The date the ticket was placed on hold.
GoesOffHoldDate This field is editable through the web API. DateTime This field is nullable. The date the ticket goes off hold.
CreatedDate DateTime The created date of the ticket.
CreatedUid Guid The UID of the user who created the ticket.
CreatedFullName String The full name of the user who created the ticket.
CreatedEmail String The email address of the user who created the ticket.
ModifiedDate DateTime The last modified date of the ticket.
ModifiedUid Guid The UID of the user who last modified the ticket.
ModifiedFullName String The full name of the user who last modified the ticket.
RequestorName String The full name of the requestor associated with the ticket.
RequestorFirstName String The first name of the requestor associated with the ticket.
RequestorLastName String The last name of the requestor associated with the ticket.
RequestorEmail String The email address of the requestor associated with the ticket.
RequestorPhone String The phone number of the requestor associated with the ticket.
RequestorUid This field is editable through the web API. This field is required. Guid This field is nullable. The UID of the requestor associated with the ticket.
ActualMinutes Int32 The time, in minutes, entered against the ticket or associated tasks/activities.
EstimatedMinutes This field is editable through the web API. Int32 The estimated minutes of the ticket.
DaysOld Int32 The age of the ticket, in days.
StartDate This field is editable through the web API. DateTime This field is nullable. The start date of the ticket.
EndDate This field is editable through the web API. DateTime This field is nullable. The end date of the ticket.
ResponsibleUid This field is editable through the web API. Guid This field is nullable. The UID of the responsible user associated with the ticket.
ResponsibleFullName String The full name of the responsible user associated with the ticket.
ResponsibleEmail String The email address of the responsible user associated with the ticket.
ResponsibleGroupID This field is editable through the web API. Int32 The ID of the responsible group associated with the ticket.
ResponsibleGroupName String The name of the responsible group associated with the ticket.
RespondedDate DateTime The date the ticket was responded to.
RespondedUid Guid This field is nullable. The UID of the user who responded to the ticket.
RespondedFullName String The full name of the user who responded to the ticket.
CompletedDate DateTime The completed/closed date of the ticket.
CompletedUid Guid This field is nullable. The UID of the user who completed/closed the ticket.
CompletedFullName String The full name of the user who completed/closed the ticket.
ReviewerUid Guid This field is nullable. The UID of the reviewing user associated with the ticket.
ReviewerFullName String The full name of the reviewing user associated with the ticket.
ReviewerEmail String The email address of the reviewing user associated with the ticket.
ReviewingGroupID Int32 The ID of the reviewing group associated with the ticket.
ReviewingGroupName String The name of the reviewing group associated with the ticket.
TimeBudget This field is editable through the web API. Double The time budget of the ticket.
ExpensesBudget This field is editable through the web API. Double The expense budget of the ticket.
TimeBudgetUsed Double The used time budget of the ticket.
ExpensesBudgetUsed Double The used expense budget of the ticket.
IsConvertedToTask Boolean Whether the ticket has been converted to a project task.
ConvertedToTaskDate DateTime The date the ticket was converted to a project task.
ConvertedToTaskUid Guid This field is nullable. The UID of the user who converted the ticket to a project task.
ConvertedToTaskFullName String The full name of the user who converted the ticket to a project task.
TaskProjectID Int32 The ID of the associated project when the ticket has been converted to a project task.
TaskProjectName String The name of the associated project when the ticket has been converted to a project task.
TaskPlanID Int32 The ID of the associated project plan when the ticket has been converted to a project task.
TaskPlanName String The name of the associated project plan when the ticket has been converted to a project task.
TaskID Int32 The ID of the associated project task when the ticket has been converted to a project task.
TaskTitle String The title of the associated project task when the ticket has been converted to a project task.
TaskStartDate DateTime The start date of the associated project task when the ticket has been converted to a project task.
TaskEndDate DateTime The end date of the associated project task when the ticket has been converted to a project task.
TaskPercentComplete Int32 The percent complete of the associated project task when the ticket has been converted to a project task.
LocationID This field is editable through the web API. Int32 The ID of the location associated with the ticket.
LocationName String The name of the location associated with the ticket.
LocationRoomID This field is editable through the web API. Int32 The ID of the location room associated with the ticket.
LocationRoomName String The name of the location room associated with the ticket.
RefCode String The reference code of the ticket.
ServiceID This field is editable through the web API. Int32 The ID of the service associated with the ticket.
ServiceName String The name of the service associated with the ticket.
ServiceOfferingID This field is editable through the web API. Int32 The ID of the service offering associated with the ticket.
ServiceOfferingName String The name of the service offering associated with the ticket.
ServiceCategoryID Int32 The ID of the category associated with the ticket's service.
ServiceCategoryName String The name of the category associated with the ticket's service.
ArticleID This field is editable through the web API. Int32 The ID of the Knowledge Base article associated with the ticket.
ArticleSubject String The subject of the Knowledge Base article associated with the ticket.
ArticleStatus TeamDynamix.Api.KnowledgeBase.ArticleStatus The ID of the Knowledge Base article associated with the ticket.
ArticleCategoryPathNames String A delimited string of the category hierarchy associated with the ticket's Knowledge Base article.
ArticleAppID Int32 The ID of the client portal application associated with the ticket's Knowledge Base article.
ArticleShortcutID This field is editable through the web API. Int32 This field is nullable. The ID of the shortcut that is used when viewing the ticket's Knowledge Base article. This is set when the ticket is associated with a cross client portal article shortcut.
AppID Int32 The ID of the ticketing application associated with the ticket.
Attributes This field is editable through the web API. TeamDynamix.Api.CustomAttributes.CustomAttribute[] This field is nullable. The custom attributes associated with the ticket.
Attachments TeamDynamix.Api.Attachments.Attachment[] This field is nullable. The attachments associated with the ticket.
Tasks TeamDynamix.Api.Tickets.TicketTask[] This field is nullable. The ticket tasks associated with the ticket.
Notify TeamDynamix.Api.ResourceItem[] This field is nullable. The list of people who can be notified for the ticket.
WorkflowID Int32 The ID of the workflow associated with the ticket.
WorkflowConfigurationID Int32 The ID of the configuration workflow associated with the ticket.
WorkflowName String This field is nullable. The name of the workflow associated with the ticket.