If Ticket.AccountID is updated then Ticket.AccountPhysicalLocation must have AccountID = Ticket.AccountID. The ConfigurationItemRelatedItems entity enables you to view, add, and remove related child or parent CIs in Autotask. [CDATA[*/ Resources receive assignment to one or more roles through their department and queue associations. Although the data will remain intact and will be reportable, it will not be viewable in the ticket in Autotask. This entity is only used by multi-currency databases. } Every resource is associated with a location. If the time entry dialog box is open for a long time, the Quick Edit fields can be changed by another user or a workflow rule. Once you have connected Powershell to Autotask (see my previous post for a howto), you can query, create and update everything that the API allows.In this post I will show you how to create a new ticket, but the method is the . It allows you to compensate for the Block Hour fixed rate by applying a multiplier to specific role rates. The nature of simulating nature: A Q&A with IBM Quantum researcher Dr. Jamie We've added a "Necessary cookies only" option to the cookie consent popup. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; This entity defines a user-defined field (UDF) in Autotask. NOTE Not all entities use UDFs. This entity contains ticket associations for documents in Autotask. You get internal server error when it's not happy about something, but in the returned body it normally expands on the particular error. /*]]>*/Want to tell us more? This entity's purpose is to describe a modifier for a given Work Type BillingCode. This entity represents ticket tag groups in Autotask. The attachments will only be added to the incidents of problem tickets, not incidents of Change Request tickets. Visit the Ideas forum! Any changes to the Status or Quick Edit fields made on the time entry or note will also be applied to their corresponding ticket fields. Thanks for your feedback. ConfigurationItemSslSubjectAlternativeName. Head on over to our Community Forum! The id field belongs to each entity and acts as the unique identifier. For example, when creating a Ticket Note you must supply the id for the Ticket that the note will be associated with. If the Contract is associated to an SLA, then use that ID. This entity describes the Resource and Role through the Queue association. Site design / logo 2023 Stack Exchange Inc; user contributions licensed under CC BY-SA. If you edit a note or time entry that is associated with existing attachments, they appear in a separate Attachments section. The date/time stamp indicates the date and time the status was last refreshed from the task or ticket. Autotask now allows Role to be inactivated. This entity's purpose is to describe a Work Type billing (or allocation) code that has been excluded from a Contract. To learn more, refer to The Rich Text editor. [CDATA[*/ If no value is provided for Ticket.Source when a ticket is created via the API, the default Source value is returned on update. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; You can use notes to track information, update the status of the associated contract, and communicate with resources and customers. This entity's purpose is to describe a transaction where a specified quantity of a Purchase Order Item is 'received,' that is, debited from the Quantity value of the associated Purchase Order Item and added to the Quantity On Hand value of the Inventory Item. Refer to WebhookUdfFields (RESTAPI). For information about dialog boxes and how they differ from browser pages, refer to Minimizing Dialog Boxes. Contact Groups are an association of contacts, from one or more companies, that allow PSA users to send bulk email and create notes and/or to-dos simultaneously for all included contacts. Refer to Time Entry/Note Quick Edit Fields. Enter your API credentials and then click Connect. Want to learn about upcoming enhancements? Thanks for your feedback. The change request approval process is part of the Autotask Change Management feature set. The function of this entity is to describe the values for custom Additional Invoice Fields that users can add to Autotask for use with Autotask Invoice Templates. This entity's purpose is to describe a Country as defined in the Autotask CRM module. For example, 'T20200615.0674.'. Refer to Forwarding and modifying tickets. The Status defaults to the current status of the parent entity when the page or dialog box is opened. This entity's purpose is to describe a multi-level approval record for an Autotask time entry. Please open the solution (the C# one) in Visual Studio and work with the sample code there. A cost is a billing item for products or materials. This object describes Expense Reports created in Autotask; its purpose is for the submission of expense line items for approval and reimbursement. We recommend that you create a new resource (Autotask user account) for the integration, so that it is separate from other user accounts. After you create the API key, login to your Autotask instance, hover over the Autotask button in the top left corner then . This entity contains the attachments for the TaskNotes entity. Wherever it is available, it tracks essential information about the record. IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. The id value is set by the system and cannot be changed by the user; for example, if you attempt to specify a value for the id field when using the POSTAPI call, the create will fail. If cleared (default setting), all Autotask resources, Outsourcing partners, and customers with access to the item in the Client Portal can view the note. NOTE The Autotask REST API stores and returns all entity time data in Coordinated Universal Time (UTC). All other statuses, Not Assigned, Partially Approved, Approved, or Rejected can only be set by the system. It describes Price List information associated with a WorkTypeModifier entity. If no asset or contract SLA, then check the Ticket Category. Checklists are an optional feature on the ticket page that display numbered items to be completed in order to finish work on a ticket. They are also not exposed in the API or LiveReports. NAVIGATION Incidents on Change Request tickets will not be updated. ProblemTicketID cannot = TicketID of a ticket that is already associated with a ProblemTicketID; that is, an incident ticket already associated with a problem ticket cannot become a problem ticket. This entity describes an Autotask Contact. Tickets where Type = Service Request cannot be associated with a ProblemTicket ID. This entity describes an approved and posted billable item in Autotask. This object describes a payment amount applied to the purchase of (or pre-payment for) one or more Service Desk Tickets through a Per Ticket Contract. They are saved as replies to the note or time entry they are added to. Change request tickets are part of the Autotask Change Management feature set. This entity's purpose is to describe a resource assigned to a task but not as the primary resource. This data will not change during update operations. If selected, only internal Autotask resources will be able to view the note, and the, you opened the Time Entry or Note page from the Edit Ticket page, you don't have permission to edit tickets. About note types. The function of this entity is to describe the Resource - Service Desk Role association and takes some functionality from the ResourceRoleQueue entity, since Resource - Queue associations no longer require a Role association. This object describes general information for a survey generated by Autotask. Saves the note or time entry and closes the dialog box. This entity represents aliases for ticket and article tags in Autotask. This entity describes an Autotask Payment Term. This allows the field to be cleared for tickets that are not Change Request type tickets. This entity describes an Autotask To-Do, a scheduled item associated with a Company that appears on the user's Autotask calendar. When it is expanded on the New Note or New Time Entry form, the New Attachment dialog box will open automatically. A ticket can have additional assets even if there is no primary asset. Refer to Adding and managing attachments. This entity allows all items in a checklist library to be added to a ticket. This entity describes detailed information about on-hand. Visit the Ideas forum! window.open(uri); /* Service Desk >Search >Tickets >click Search > open a ticket >Quick Add bar > select Note (Alt+2), NAVIGATION > Projects >Projects > search for a project >click on the Project Name > Schedule > task context menu > General > View Details > Quick Add bar > select Note (Alt+2). If no TicketCategory is passed in, the API will use the logged in resource's default category; if the resource does not have a default category, the API will use the Company's system default ticket category. Each of the entities inherits from the Autotask base class Entity. Thanks for contributing an answer to Stack Overflow! This entity represents checklist libraries related to documents in Autotask. The API currently exposes the following entities. If it is selected, the note is created with the Internal & Co-managed publish type. The AllocationCodeID field must reference a Work Type allocation code. Saves the note or time entry and opens a new dialog box. To verify and configure these settings perform the following steps. Field is cleared when ticket comes out of Waiting Customer status and is recalculated every time ticket goes back into Waiting Customer status. Did any DOS compatibility layers exist for any UNIX-like systems before DOS started to become outmoded? This entity describes an Autotask project task assigned to a service call. This entity's purpose is to describe a Quote in Autotask. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; This entity manages the tags associated with tickets in Autotask. The Status field is required on all tickets and project tasks, regardless of category. The function of this entity is to describe the link between co-managed accounts and the resources with a co-managed security level who have access to them. Ticket.AccountID cannot be changed if the ticket has an associated and posted TimeEntry, TicketCost, or Expense. window.open(uri); The configurationItemType associates one or more user-defined fields with assets of the same type. Service calls are instances of time, with specified start and stop times, that are scheduled to perform work for a Company. If the Contract Service or Bundle is associated to an SLA, then use that ID. This entity describes a ticket category applied to tickets in Autotask to specify features and fields that appear on the ticket detail. Getting an API User setup, along with the keys, will set us up to establish a link between CloudRadial and Autotask so that they can share information back and forth. Visit our SOAPAPIlifecycle FAQ article to learn more. If a status or quick edit field supplied by the dialog fields conflicts with an unsaved change on the Edit Ticket page, the dialogs value will be used.Information on the Insights panel will not be updated until that task or ticket is saved. ConfigurationItemWebhookExcludedResources. Find centralized, trusted content and collaborate around the technologies you use most. Billing milestones define tangible work or measured progress that must be completed before billing can take place. To attach the new attachment to the notification email, select Include Attachments in Email on the notification panel. This entity describes an Autotask Company. This entity's purpose is to describe a ticket category, applied to tickets in Autotask to specify features and fields that appear on the ticket detail. LOB security is respected in the API. Which actions can be performed on the entity. Security: This check box is available even if users do not have permission to edit tickets. This entity is only used by multi-currency databases. For more information about attachments, including call syntax, thresholds and limits, and a full list of attachment entities, refer to Working with attachments in the RESTAPI. Refer to WebhookFields (REST API). This field is not filterable for tickets in the API. This article provides a general technical overview and index of the resources (entities)that you can access via the AutotaskRESTAPI. The Note Type field defaults to Task Summary. To use a speed code, enter it in the field. This entity enables you to increase inventory counts associated with the InventoryProducts entity. Tickets with no TicketType specified are set automatically to Service Request. This entity's purpose is to describe a location defined in Company Setup in the Autotask Admin module. This entity describes an Autotask Task. The ArticlePlainTextContent entity contains the plain text version of body content held by a Knowledgebase article. , This field is editable for tickets whose ticket category is 'RMA.'. It outlines the steps that must be performed to complete the ticket or task. This entity is only used by multi-currency databases. The Autotask REST API presents selected Autotask resources as programming objects that allow the client to perform actions on them. Create Quote. This entity describes an individual business unit that has an association with a company in Autotask. Open the Kaseya Helpdesk. This check box appears on task notes, ticket notes and both task and ticket quick notes and quick replies. How do I align things in the following tabular environment? window.open(uri); If recipients are added or removed from the To: field on the Notification panel, the matching role-based check boxes will become selected or cleared. NOTE If the APIuser does not have the Contracts impersonation option enabled, it will be unable to specify custom values for the AttachedByContactIDand the CreatedByContactIDfields. Refer to The Rich Text editor to learn more. The function of this entity is to describe the mapping of the contact to the contract billing rule. and not visible to the API user when inspecting the Extension Callout on edit and when creating a new Extension Callout. This entity describes an Attachment in Autotask. If your company uses Datto RMM, and you have integrated it with Autotask, you can configure monitors to create tickets in Autotask. This entity describes an Autotask SubscriptionPeriod. Some Read-Only fields must be supplied for a create, so while they are initially required, once the entity has been created, you cannot change them. If TicketType = Problem and incidents are associated with the ticket, TicketType cannot be changed to Incident or Service Request until the incidents are disassociated from the ticket. This entity contains the attachments for the ExpenseReports entity. 3. This entity describes an Autotask Inventory location, that is, a physical or virtual place where your company stores or assigns inventory items. 5. If QueueID does not meet the requirement specified by the associated ticket category's 'Queue is Required' setting, as listed below, an error will occur. Provide feedback for the Documentation team. IMPORTANT When this feature is released, we will change the Publish settings of ticket and task notes and attachments to Internal &Co-managed for all tickets and tasks where the Co-managed Visibility is set to Visible. The function of this entity is to describe the number of units of a specific service with an association to a Recurring Service contract for a specific date range. Attachments are external documents that are associated with an Autotask Account, Task, Ticket, Task or Ticket Note, Time Entry, Asset, Asset Note, Project, or Opportunity entity. function SendLinkByMail(href) { UDF changes are included in the criteria for updating LastTrackedModificationDate. Resources receive assignment to one or more roles through their department and queue associations. This entity represents associations between, This entity represents articles associated with. You can only associate it with a Quote entity. If you want your integration users' names to show on the entity, follow these steps: This example adds an impersonated user to a request's headers. This entity describes notes created by an Autotask user and associated with a Product entity. Does ZnSO4 + H2 at high pressure reverses to Zn + H2SO4? If the Quick Ticket Edits section remains collapsed, you can save the note or time entry without completing required fields. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; It is only available through the REST API. To obtain extended information about entities and their field data, use the GET API call.