Skip to main content
Represents a service ticket.

Constructors

NSTicketEntity()

Initializes a new instance of the NSTicketEntity class.

Methods

GetActivate()

When the ticket should be activated, if it is postponed.
Returns: CRMScript.Global.DateTime Example:

GetAlertLevel()

The alert level for the ticket. Matches the level value of the ticket_alert table.
Returns: CRMScript.Global.Integer Example:

GetAlertTimeout()

The datetime for when the ticket should jump to the next alert_level.
Returns: CRMScript.Global.DateTime Example:

GetAuthor()

A string representing the author of the ticket (same as author of first message).
Returns: CRMScript.Global.String Example:

GetBaseStatus()

Returns: CRMScript.Global.Integer - The status of the ticket. See <xref href=“CRMScript.NetServer.TicketBaseStatus” data-throw-if-not-resolved=“false”></xref> Example:

GetCategory()

The ticket category entity which this ticket is connected to
Returns: CRMScript.NetServer.NSTicketCategoryEntity Example:

GetClosedAt()

When the ticket was closed.
Returns: CRMScript.Global.DateTime Example:

GetConnectId()

If a ticket is connected to another ticket, this field is set to the ID of the ‘master’ ticket.
Returns: CRMScript.Global.Integer Example:

GetCreatedAt()

When the ticket was created.
Returns: CRMScript.Global.DateTime Example:

GetCreatedBy()

The associate who created this ticket
Returns: CRMScript.NetServer.NSAssociate Example:

GetCustomFields()

Gets the user-defined + extra fields on a TicketEntity as a map.
Returns: CRMScript.Native.Map Example:

GetDeadline()

Deadline for ticket.
Returns: CRMScript.Global.DateTime Example:

GetExtraFields()

Gets the extra fields on TicketEntity as a map.
Returns: CRMScript.Native.Map Example:

GetFirstReadByUser()

The datetime for when the ticket first was read by a user.
Returns: CRMScript.Global.DateTime Example:

GetFromAddress()

The from-address used when this ticket got created, e.g. by email
Returns: CRMScript.Global.String Example:

GetHasAttachment()

Bool indicating if this ticket has one or more attachments.
Returns: CRMScript.Global.Bool Example:

GetLastChanged()

The last time the ticket was modified.
Returns: CRMScript.Global.DateTime Example:

GetMessages()

Returns: CRMScript.NetServer.NSTicketMessage[] - TicketMessageId, CreatedAt, SLevel, and Important for all the messages connected to this ticket.
For message body, see the NSTicketMessageEntity or the NSTicketMessage archive.
Example:

GetNumMessages()

The total number of messages for this request.
Returns: CRMScript.Global.Integer Example:

GetNumReplies()

The number of replies (messages) to the customer for this request.
Returns: CRMScript.Global.Integer Example:

GetOrigin()

What is the origin of this ticket
Returns: CRMScript.Global.Integer - See <xref href=“CRMScript.NetServer.TicketOrigin” data-throw-if-not-resolved=“false”></xref>. Example:

GetOwnedBy()

The associate who owns this ticket
Returns: CRMScript.NetServer.NSAssociate Example:

GetPerson()

The primary person that this ticket is connected to
Returns: CRMScript.NetServer.NSPerson Example:

GetPriority()

The ticket priority entity which this ticket is connected to
Returns: CRMScript.NetServer.NSTicketPriorityEntity Example:

GetReadByCustomer()

The datetime for when the ticket was read by the customer.
Returns: CRMScript.Global.DateTime Example:

GetReadByOwner()

The datetime for when the ticket last was read by the owner.
Returns: CRMScript.Global.DateTime Example:

GetReadStatus()

Returns: CRMScript.Global.Integer - Whether the owner has read the ticket or not (red, yellow, green). See <xref href=“CRMScript.NetServer.TicketReadStatus” data-throw-if-not-resolved=“false”></xref>. Example:

GetRealTimeSpentExternally()

The total time (seconds) within 24x7 the ticket has been in a external waiting status (configurable), not including current state
Returns: CRMScript.Global.Integer Example:

GetRealTimeSpentInternally()

The total time (seconds) within 24x7 the ticket has been in an open status (configurable), not including current state
Returns: CRMScript.Global.Integer Example:

GetRealTimeSpentQueue()

The total time (seconds) within 24x7 hours the ticket has been in a queue status, not including current state
Returns: CRMScript.Global.Integer Example:

GetRealTimeToClose()

Same as time_to_close, but not calculated based on priority.
Returns: CRMScript.Global.Integer Example:

GetRealTimeToReply()

Same as time_to_reply, but not calculated based on priority.
Returns: CRMScript.Global.Integer Example:

GetRepliedAt()

The datetime for when the ticket was replied to. I.e. the first external message added to the ticket.
Returns: CRMScript.Global.DateTime Example:

GetSecondaryPersons()

The secondary persons this ticket is connected to
Returns: CRMScript.NetServer.NSPerson[] Example:

GetSlevel()

Returns: CRMScript.Global.Integer - The security level of the ticket. See <xref href=“CRMScript.NetServer.TicketSecurityLevel” data-throw-if-not-resolved=“false”></xref>. Example:

GetStatus()

The ticket status entity which this ticket is connected to
Returns: CRMScript.NetServer.NSTicketStatusEntity Example:

GetTags()

An array containing the tags assigned to this request.
Returns: CRMScript.NetServer.NSTag[] Example:

GetTicketId()

The primary key (auto-incremented)
Returns: CRMScript.Global.Integer Example:

GetTimeSpentExternally()

The total time (seconds) within the priority’s office hours the ticket has been in a external waiting status (configurable), not including current state
Returns: CRMScript.Global.Integer Example:

GetTimeSpentInternally()

The total time (seconds) within the priority’s office hours the ticket has been in an open status (configurable), not including current state
Returns: CRMScript.Global.Integer Example:

GetTimeSpentQueue()

The total time (seconds) within the priority’s office hours the ticket has been in a queue status, not including current state
Returns: CRMScript.Global.Integer Example:

GetTimeToClose()

The time (minutes) between when the ticket was created and when it was closed. Calculated based on priority’s timeframe.
Returns: CRMScript.Global.Integer Example:

GetTimeToReply()

The time (minutes) between when the ticket was created and when it was replied to. Calculated based on priority’s timeframe.
Returns: CRMScript.Global.Integer Example:

GetTitle()

The title of the ticket.
Returns: CRMScript.Global.String Example:

SetActivate(DateTime)

When the ticket should be activated, if it is postponed.
Returns: CRMScript.Global.Void Example:

SetAlertLevel(Integer)

The alert level for the ticket. Matches the level value of the ticket_alert table.
Returns: CRMScript.Global.Void Example:

SetAlertTimeout(DateTime)

The datetime for when the ticket should jump to the next alert level.
Returns: CRMScript.Global.Void Example:

SetAuthor(String)

A string representing the author of the ticket (same as author of first message).
Returns: CRMScript.Global.Void Example:

SetBaseStatus(Integer)

Returns: CRMScript.Global.Void Example:

SetCategory(NSTicketCategoryEntity)

Returns: CRMScript.Global.Void Example:

SetClosedAt(DateTime)

Returns: CRMScript.Global.Void Example:

SetConnectId(Integer)

If a ticket is connected to another ticket, this field is set to the ID of the ‘master’ ticket.
Returns: CRMScript.Global.Void Example:

SetCreatedAt(DateTime)

When the ticket was created.
Returns: CRMScript.Global.Void Example:

SetCreatedBy(NSAssociate)

Returns: CRMScript.Global.Void Example:

SetCustomFields(Map)

Sets the user-defined and extra fields on a TicketEntity with a map.
Returns: CRMScript.Global.Void Example:

SetDeadline(DateTime)

Returns: CRMScript.Global.Void Example:

SetExtraFields(Map)

Sets the extra field values on TicketEntity with a map.
Returns: CRMScript.Global.Void Example:

SetFirstReadByUser(DateTime)

Returns: CRMScript.Global.Void Example:

SetFromAddress(String)

The from-address used when this ticket got created, e.g. by email
Returns: CRMScript.Global.Void Example:

SetHasAttachment(Bool)

Bool indicating if this ticket has one or more attachments.
Returns: CRMScript.Global.Void Example:

SetLastChanged(DateTime)

Returns: CRMScript.Global.Void Example:

SetMessages(NSTicketMessage[])

Returns: CRMScript.Global.Void
For message body, see the NSTicketMessageEntity or the NSTicketMessage archive.
Example:

SetNumMessages(Integer)

The total number of messages for this request.
Returns: CRMScript.Global.Void Example:

SetNumReplies(Integer)

The number of replies (messages) to the customer for this request.
Returns: CRMScript.Global.Void Example:

SetOrigin(Integer)

Returns: CRMScript.Global.Void Example:

SetOwnedBy(NSAssociate)

Returns: CRMScript.Global.Void Example:

SetPerson(NSPerson)

The primary person that this ticket is connected to
Returns: CRMScript.Global.Void Example:

SetPriority(NSTicketPriorityEntity)

The ticket priority entity which this ticket is connected to
Returns: CRMScript.Global.Void Example:

SetReadByCustomer(DateTime)

Returns: CRMScript.Global.Void Example:

SetReadByOwner(DateTime)

Returns: CRMScript.Global.Void Example:

SetReadStatus(Integer)

Returns: CRMScript.Global.Void Example:

SetRealTimeSpentExternally(Integer)

The total time (seconds) within 24x7 the ticket has been in a external waiting status (configurable), not including current state
Returns: CRMScript.Global.Void Example:

SetRealTimeSpentInternally(Integer)

The total time (seconds) within 24x7 the ticket has been in an open status (configurable), not including current state
Returns: CRMScript.Global.Void Example:

SetRealTimeSpentQueue(Integer)

The total time (seconds) within 24x7 hours the ticket has been in a queue status, not including current state
Returns: CRMScript.Global.Void Example:

SetRealTimeToClose(Integer)

Same as time_to_close, but not calculated based on priority.
Returns: CRMScript.Global.Void Example:

SetRealTimeToReply(Integer)

Same as time_to_reply, but not calculated based on priority.
Returns: CRMScript.Global.Void Example:

SetRepliedAt(DateTime)

The datetime for when the ticket was replied to (when the first external message added to the ticket).
Returns: CRMScript.Global.Void Example:

SetSecondaryPersons(NSPerson[])

The secondary persons this ticket is connected to
Returns: CRMScript.Global.Void Example:

SetSlevel(Integer)

Returns: CRMScript.Global.Void Example:

SetStatus(NSTicketStatusEntity)

Returns: CRMScript.Global.Void Example:

SetTags(NSTag[])

An array containing the tags assigned to this request
Returns: CRMScript.Global.Void Example:

SetTicketId(Integer)

The primary key (auto-incremented)
Returns: CRMScript.Global.Void Example:

SetTimeSpentExternally(Integer)

The total time (seconds) within the priority’s office hours the ticket has been in a external waiting status (configurable), not including current state
Returns: CRMScript.Global.Void Example:

SetTimeSpentInternally(Integer)

The total time (seconds) within the priority’s office hours the ticket has been in an open status (configurable), not including current state
Returns: CRMScript.Global.Void Example:

SetTimeSpentQueue(Integer)

The total time (seconds) within the priority’s office hours the ticket has been in a queue status, not including current state
Returns: CRMScript.Global.Void Example:

SetTimeToClose(Integer)

The time (minutes) between when the ticket was created and when it was closed. Calculated based on priority’s timeframe.
Returns: CRMScript.Global.Void Example:

SetTimeToReply(Integer)

The time (minutes) between when the ticket was created and when it was replied to. Calculated based on priority’s timeframe.
Returns: CRMScript.Global.Void Example:

SetTitle(String)

The title of the ticket.
Returns: CRMScript.Global.Void Example: