Get For Rm Ui
Get a ticket entity, adapted to the specific needs of the Request Management UI.
WARNING: This endpoint is not guaranteed to be stable/compatible between versions NsApiSlow threshold: 2000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
TicketId
GetForRmUi: Get a ticket entity, adapted to the specific needs of the Request Management UI. WARNING: This endpoint is not guaranteed to be stable/compatible between versions
Response
OK
The ticket entity is used for representing a service ticket Carrier object for TicketEntity. Services for the TicketEntity Carrier is available from the Ticket Agent.
The primary key (auto-incremented)
The title of the ticket.
When the ticket was created.
The last time the ticket was modified.
The datetime for when the ticket last was read by the owner.
The datetime for when the ticket was read by the customer.
The datetime for when the ticket first was read by the current owner.
The datetime for when the ticket first was read by a user.
When the ticket should be activated, if it is postponed.
When the ticket was closed.
The datetime for when the ticket was replied to. I.e. the first external message added to the ticket.
The datetime for when the ticket should jump to the next alert_level.
Deadline for ticket.
Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
A string representing the author of the ticket (same as author of first message).
Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
This entity describes the meta data for a ticket category, and provides special operations on it. Carrier object for TicketCategoryEntity. Services for the TicketCategoryEntity Carrier is available from the List Agent.
The securitylevel of the ticket.
Unknown, Internal, External Entity for a ticket priority. This entity describes the meta data for a ticket priority, and provides special operations on it. Carrier object for TicketPriorityEntity. Services for the TicketPriorityEntity Carrier is available from the List Agent.
The status of the ticket. I.e. active/closed/postponed/deleted Use MDO List name "ticketstatus" to get list items.
Unknown, Active, Closed, Postponed, Deleted, Merged, Spam, PostponedSpecific, Postponed1Hour, Postponed2Hours, Postponed3Hours, Postponed4Hours, PostponedDay, PostponedWeek, PostponedMonth Entity for a ticket status. This entity describes the meta data for a ticket status, and provides special operations on it. Carrier object for TicketStatusEntity. Services for the TicketStatusEntity Carrier is available from the List Agent.
What is the origin of this ticket
Unknown, Email, SMS, Fax, Phone, Facebook, Twitter, Internal, CustomerCentre, EMarketing, AutoGenerated, Chat, Form, API, Flow Carrier object for Person. Services for the Person Carrier is available from the Person Agent.
The secondary persons this ticket is connected to Use MDO List name "person_new" to get list items.
The alert level for the ticket. Matches the level value of the ticket_alert table.
If a ticket is connected to another ticket, this field is set to the id of the 'master' ticket.
Whether the owner has read the ticket or not (red, yellow, green).
Unknown, Green, Yellow, Red The time (minutes) between when the ticket was created and when it was replied to. Calculated based on priority's timeframe.
Same as time_to_reply, but not calculated based on priority.
The time (minutes) between when the ticket was created and when it was closed. Calculated based on priority's timeframe.
Same as time_to_close, but not calculated based on priority.
The total time (seconds) within the priority's office hours the ticket has been in an open status (configurable), not including current state
The total time (seconds) within the priority's office hours the ticket has been in a external waiting status (configurable), not including current state
The total time (seconds) within the priority's office hours the ticket has been in a queue status, not including current state
The total time (seconds) within 24x7 the ticket has been in an open status (configurable), not including current state
The total time (seconds) within 24x7 the ticket has been in a external waiting status (configurable), not including current state
The total time (seconds) within 24x7 hours the ticket has been in a queue status, not including current state
The total time (minutes). Aggregated time spent from ticket's messages. Read-only for external use.
Boolean indicating if this ticket has one or more attachments.
The number of replies (messages) to the customer for this request.
The total number of messages for this request.
The from-address used when this ticket got created, e.g. by email
TicketMessageId,CreatedAt,SLevel and Important for all the messages connected to this ticket. For message body see the TicketMessageEntity or the TicketMessage archive.
An array containing the tags assigned to this request
The language of the first external message
The sentiment index of the last external message
The sentiment confidence of the last external message
Suggestion for categorization, based on the text of the message (AI)
Suggested category from AI
Will contain the category id selected by the user, when having the choice of using the suggested category or manually selecting a category
Icon representing ticket's state
Carrier object for Sale. Services for the Sale Carrier is available from the Sale Agent.
Carrier object for Project. Services for the Project Carrier is available from the Project Agent.
Class representing form submission related to ticket. Carrier object for TicketFormSubmission.
Ticket Type - light read-only version of TicketTypeEntity. Carrier object for TicketType. Services for the TicketType Carrier is available from the List Agent.
Active status monitor identity for related contact. This is a read-only property and is ignored on Save
Deprecated: Use {SuperOffice.CRM.Services.TicketEntity.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.
Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual {SuperOffice.CRM.Services.TicketEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.
Related topics
Get Live Ui ConfigThe SharePoint migration UIRequirements for user UI and designPublish And Sync Ui EventsPublish And Retrieve Ui EventsGet Template Stream