Ticket

Ticket

new Ticket(client, properties)

Ticket class
Parameters:
Name Type Description
client TDAPI The TDAPI client the user belongs to
properties Object The properties to be initialized on the Ticket object (See: Properties)
Properties:
Name Type Description
ID Number The ID of the ticket.
ParentID Number The ID of the parent ticket.
ParentTitle String The title of the parent ticket.
ParentClass Number The classification of the parent ticket.
TypeID Number The ticket type ID.
TypeName String The ticket type name.
TypeCategoryID Number The type category ID.
TypeCategoryName String The type category name.
Classification Number The ticket classification.
Title String The ticket title.
Description String The ticket description.
Uri String The Uri to retrieve the individual ticket.
AccountID Number The account/department ID.
AccountName String The account/department name.
SourceID Number The source ID.
SourceName String The source name.
StatusID Number The status ID.
StatusName String The status name.
StatusClass Number The status class.
ImpactID Number The impact ID.
ImpactName String The impact name.
UrgencyID Number The urgency ID.
UrgencyName String The urgency name.
PriorityID Number The priority ID.
PriorityName String The priority name.
PriorityOrder Number The priority ordering.
SlaID Number The SLA ID.
SlaName String The SLA name.
IsSlaViolated Boolean A value indicating whether the ticket's SLA has been violated.
IsSlaRespondByViolated Boolean | null A value indicating whether the "Respond By" component of the ticket's SLA has been violated, or null if this has been not loaded.
IsSlaResolveByViolated Boolean | null A value indicating whether the "Resolve By" component of the ticket's SLA has been violated, or null if this has been not loaded.
RespondByDate Date | null The "respond by" SLA deadline for the ticket.
ResolveByDate Date | null The "resolve by" SLA deadline for the ticket.
SlaBeginDate Date | null The date the ticket started its current SLA.
IsOnHold Boolean A value indicating whether the ticket is on hold.
PlacedOnHoldDate Date | null The date the ticket was placed on hold.
GoesOffHoldDate Date | null The date the ticket will go off hold.
CreatedDate Date The created date.
CreatedUid Guid The UID of the creator.
CreatedFullName String The full name of the creator.
CreatedEmail String The email address of the creator.
ModifiedDate Date The last modified date.
ModifiedUid Guid The UID of the last person to modify the ticket.
ModifiedFullName String The full name of the last person to modify the ticket.
RequestorName String The full name of the requestor.
RequestorFirstName String The first name of the requestor.
RequestorLastName String The last name of the requestor.
RequestorEmail String The email address of the requestor.
RequestorPhone String The phone number of the requestor.
RequestorUid Guid | null The UID of the requestor.
ActualMinutes Number The time, in minutes, entered against the ticket or associated tasks/activities.
EstimatedMinutes Number The estimated minutes.
DaysOld Number The age of the ticket, in days.
StartDate Date | null The start date.
EndDate Date | null The end date.
ResponsibleUid Guid | null The UID of the responsible person.
ResponsibleFullName String The full name of the responsible person.
ResponsibleEmail String The email address of the responsible person.
ResponsibleGroupID Number The ID of the responsible group.
ResponsibleGroupName String The name of the responsible group.
RespondedDate Date The date the ticket was responded to.
RespondedUid Guid | null The UID of the person who responded to the ticket.
RespondedFullName String The full name of the person who responded to the ticket.
CompletedDate Date The completed/closed date.
CompletedUid Guid | null The UID of the person who closed the ticket.
CompletedFullName String The full name of the person who closed the ticket.
ReviewerUid Guid | null The UID of the reviewing person.
ReviewerFullName String The full name of the reviewing person.
ReviewerEmail String The email address of the reviewing person.
ReviewingGroupID Number The ID of the reviewing group.
ReviewingGroupName String The name of the reviewing group.
TimeBudget Number The time budget.
ExpensesBudget Number The expenses budget.
TimeBudgetUsed Number The time budget used.
ExpensesBudgetUsed Number The expenses budget used.
IsConvertedToTask Boolean A value indicating whether the ticket has been converted to a project task.
ConvertedToTaskDate Date The date the ticket was converted to a project task.
ConvertedToTaskUid Guid | null The UID of the person who converted the ticket to a project task.
ConvertedToTaskFullName String The full name of the person who converted the ticket to a project task.
TaskProjectID Number The project ID of the associated project task.
TaskProjectName String The project name of the associated project task.
TaskPlanID Number The plan ID of the associated project task.
TaskPlanName String The plan name of the associated project task.
TaskID Number The ID of the associated project task.
TaskTitle String The title of the associated project task.
TaskStartDate Date The start date of the associated project task.
TaskEndDate Date The end date of the associated project task.
TaskPercentComplete Number The percent complete of the associated project task.
OpportunityID Number The ID of the associated CRM opportunity.
OpporunityName String The name of the associated CRM opportunity.
LocationID Number The location ID.
LocationName String The location name.
LocationRoomID Number The room ID for the ticket's location.
LocationRoomName String The room name for the ticket's location.
RefCode String The reference code.
ServiceID Number The ID of the associated service.
ServiceName String The name of the associated service.
ServiceCategoryID Number The ID of the associated service's category.
ServiceCategoryName String The name of the associated service's category.
ArticleID Number The ID of the associated knowledge base article.
ArticleSubject String The subject of the associated knowledge base article.
ArticleStatus Number The status of the associated knowledge base article.
ArticleCategoryPathNames String A delimited string describing the category hierarchy of the associated knowledge base article.
AppID Number The ID of the application to which this ticket belongs.
Attributes Array.<CustomAttribute> The custom ticket attributes.
Attachments Array.<Attachment> The ticket attachments.
Tasks Array.<TicketTask> The ticket tasks.
Notify Array.<ResourceItem> The list of people who can be notified for a ticket.
Source:

Methods

addAsset(assetId) → {Promise.<Object>}

Adds an asset to the Ticket
Parameters:
Name Type Description
assetId any
Source:
Returns:
message
Type
Promise.<Object>

addContact(contactUid) → {Promise.<Object>}

Adds a contact to the Ticket
Parameters:
Name Type Description
contactUid Guid
Source:
Returns:
message
Type
Promise.<Object>

edit(notifyNewResponsibleopt) → {Promise.<Ticket>}

Edits the ticket
Parameters:
Name Type Attributes Default Description
notifyNewResponsible Boolean <optional>
 false
Source:
Returns:
ticket
Type
Promise.<Ticket>

getContacts() → {Promise.<Array.<User>>}

Gets the Ticket contacts
Source:
Returns:
contacts
Type
Promise.<Array.<User>>

getFeedEntries() → {Promise.<Array.<TicketFeedEntry>>}

Gets the feed entries for the Ticket
Source:
Returns:
feedEntries - The ticket's feed entries
Type
Promise.<Array.<TicketFeedEntry>>

patch(notifyNewResponsible, patch) → {Promise.<Ticket>}

Edits the ticket via HTTP PATCH (Edits only specified fields)
Parameters:
Name Type Description
notifyNewResponsible Boolean
patch any
Source:
Returns:
ticket
Type
Promise.<Ticket>

removeAsset(assetId) → {Promise.<Object>}

Removes an asset from the Ticket
Parameters:
Name Type Description
assetId any
Source:
Returns:
message
Type
Promise.<Object>

removeContact(contactUid) → {Promise.<Object>}

Removes a contact from the Ticket
Parameters:
Name Type Description
contactUid Guid
Source:
Returns:
message
Type
Promise.<Object>

update(ticketFeedEntry) → {Promise.<ItemUpdate>}

Updates the Ticket
Parameters:
Name Type Description
ticketFeedEntry TicketFeedEntry The new feed entry to add
Source:
Returns:
itemUpdate
Type
Promise.<ItemUpdate>