Ticket cannot be created with an inactive TicketCategory. This entity's purpose is to describe a Contact associated with a ContactGroup. 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. IssueType and SubIssueType are never required in the API. This data will not change during update operations. NAVIGATION Visit the Ideas forum! This entity describes a transaction where a specified quantity of an InventoryProducts or an InventoryStockedItems entity is transferred from the items current InventoryLocation to a different InventoryLocation. The allowed actions are specific to the object. This entity's purpose is to describe a note associated with an Autotask Contract. Tickets where Type = Service Request cannot be associated with a ProblemTicket ID. Notes can be searched and viewed from one place using the Global Notes Search, accessed from > Home >Search > Global Notes Search or > Reports > Other >General. It allows you to compensate for the Block Hour fixed rate by applying a multiplier to specific role rates. This is by far the best wrapper for the SOAP API. Gettings 721 tickets based on a title filter: "Title eq hello!" This resource describes key business details for the Autotask Company 0, the Autotask user's company account. By accepting all cookies, you agree to our use of cookies to deliver and maintain our services and site, improve the quality of Reddit, personalize Reddit content and advertising, and measure the effectiveness of advertising. Want to talk about it? Autotask Resources are employees, contractors, or consultants with access to a company's Autotask system. If a ticket already has checklist items, the checklist library is appended to the end of the list of checklist items. https://www.autotask.com/, Press J to jump to the feed. From the Autotask Home page toolbar, select Help. Wherever it is available, it tracks essential information about the record. 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. Making statements based on opinion; back them up with references or personal experience. A new inactive ContactID value cannot be assigned on create() or update(). This entity describes an Autotask Appointment,a scheduled calendar time that is not a service call. This entity is only used by multi-currency databases. A WorkTypeModifier entity modifies a given Work Type BillingCode. This entity describes an Autotask Subscription. This entity contains the attachments for the TicketNotes entity. Click on Service Desk/Ticket Categories. Currently, the API provides the following actions: GET, PUT, PATCH, POST, and DELETE. This resource describes contract billing rules that generate charges which allow you to bill your customer by the end user or by the asset. function SendLinkByMail(href) { The Ticket entity can have no more than 300 UDFs. To open the page, use the path (s) in the Security and navigation section above. This entity represents ticket tag groups in Autotask. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; This is an event a Zap performs. DocumentConfigurationItemCategoryAssociations. This entity describes an Autotask Time Entry. Want to learn about upcoming enhancements? The returned body will be super useful going forward if you can get it though! The Autotask REST API presents selected Autotask resources as programming objects that allow the client to perform actions on them. A Department is an association the application can use to manage resources, especially when assigning project tasks. . ChangeApprovalStatus can only be set to Requested or Assigned. Some fields on Entities require an id to a parent Entity. Thanks for your feedback. When a SubIssueType value is provided, the associated IssueType value must also be provided. 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. 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. Refer to Time Entry/Note Quick Edit Fields. [CDATA[*/ Associates a Skill with a Resource to provide information about the skills or abilities of the resource. For more information, refer to Notification panel. It determines a customer's total taxes on billing items. For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed. Assets are products that are associated with a Company entity. This entity describes results and information for a survey generated by Autotask. If the ticket category is associated to an SLA, then use that ID. The status code getting printed here is 401! Roles are associated with a department, have a standard billing rate, and are assigned to resources for billing purposes. This entity contains ticket associations for documents in Autotask. When you enable the Organizational Structure feature in Autotask, this object describes an organizational structure Line of Business. Notes published to All Autotask Users are visible to customers. Every attempt gives me a 500 server error. This entity describes the Resource Role and Department association. [CDATA[*/ 5. This entity describes an Autotask To-Do, a scheduled item associated with a Company that appears on the user's Autotask calendar. For additional information, refer to. A resource must have at least one role assignment. Can airtags be tracked from an iMac desktop, with no iPhone? Find centralized, trusted content and collaborate around the technologies you use most. Adding or changing a value for a recipient via the Quick Ticket Edits section will cause the names next to that check box to be added or changed accordingly. Complete the New Attachment dialog box. This entity describes an Autotask Ticket. 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. They are also not exposed in the API or LiveReports. The integration uses the Autotask Web Services API for automatic ticket creation in Autotask. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; An error message indicates that Service Request tickets cannot be associated with a problem ticket. This entity represents associations between asset categories and documents in Autotask. This entity describes an Autotask Role. Have an idea for a new feature? You cannot use the API to create items that contain Rich Text, but you can add Rich Text later via a supported method. This entity's purpose is to describe a resource assigned to a ticket but not as the primary resource. Most of the values were taken from an existing ticket. This entity describes a cost associated with an Autotask Ticket. Open the Datto Help Center. Thanks for your feedback. All active note types of the category Task are available, plus the current selection even if it is inactive. 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. Head on over to our Community Forum! This entity contains attachments for the Companies entity. 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. By clicking Post Your Answer, you agree to our terms of service, privacy policy and cookie policy. If the ticket type is not = Change Request and a current ChangeApprovalType value exists on the entity, then the field is cleared. SubIssueType is associated with an Issue and the available SubIssueType picklist items are specific to the associated IssueType. This entity describes an Autotask Department. Update/Create Maximum Entities: The Web Service API calls can update or create a maximum of 200 objects with one call. The Add New Attachments section is always collapsed. This field is not filterable for tickets in the API. Site design / logo 2023 Stack Exchange Inc; user contributions licensed under CC BY-SA. This entity's purpose is to describe a Quote in Autotask. NOTE Although the Autotask interface now allows multiple resources on a ticket, the current versions of the Web Services API do not support this feature. This will populate the LOB field with that selection when creating any entities where LOB can be applied. This entity describes an Autotask Opportunity. Quote Items define a line item added to an Autotask Quote. I am trying to create a ticket in autotask using the below python code: Head on over to our Community Forum! Refer to Note Titles. Have an idea for a new feature? If the ticket type = Change Request, then ChangeApprovalType is set to the default value. /**/Want to tell us more? It shows the Task Number or Ticket Number, Task Title or Ticket Title, and Company fields, plus the quick copy icons. This entity's purpose is to describe a billing role that is excluded from the contract to which the set applies. This entity's purpose is to describe a day specified as a Holiday (usually counted as paid time off) and included in an Autotask Internal location Holiday Set. permission is required. 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. If setting equals 'RequiredWhenPrimaryResourceIdBlank', then the API will produce an error when both the QueueID and ResourceID fields are empty. What is a word for the arcane equivalent of a monastery? Don't assume anything incl. Refer to the About entity fields section of this article for more information. 3. } 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. /*]]>*/Want to tell us more? This entity's purpose is to describe a record of approval for a ticket change request. Entity details You can also retrieve this information with the Web Services API call The getEntityInfo () SOAP API call. The entity provides an efficient way to access the details, via the API, to assist with the customer's Autotask implementation. 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. [CDATA[*/ It describes whether a Product on the Price List uses the internal currency or an external currency, and if it is external, lets you set the price in that currency. Entity details You can also retrieve this information with the Web Services API call The getEntityInfo () SOAP API call. This entity describes an Autotask Quote Item. For detailed information, refer to The task or ticket stopwatch. Write. This entity describes list items added to a check list on an Autotask ticket or task. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; All text formatting and images will be lost. IMPORTANT Although you can query all resources, some objects contain fields that you cannot query. Open the Kaseya Helpdesk. The client can access and act on the entity's field parameters: supplying, updating, or deleting the field data. A Resource + Role combination assigned to a ticket must be associated with at least one Service Desk Queue. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; The API does not respect the TicketCategory's 'required' and 'available list item' settings, with the exception of the 'Queue is Required' setting. This entity contains the attachments for the ContractNotes entity. Need troubleshooting help? The function of this entity is to describe the associations between Change Request tickets and both Incidents and Problems. RESTAPIsupportability and query thresholds, Using Swagger UIto explore REST API requests. Thanks for your feedback. 2. If the API receives an invalid prefix, it will automatically generate one and assign it to the resource. To open the page, use the path(s) in the Security and navigation section above. IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. Either click the template or click. When it is expanded on the New Note or New Time Entry form, the New Attachment dialog box will open automatically. This entity's purpose is to describe a transaction where a specified quantity of one Inventory Item entity transfers from the items currently assigned Inventory location to another Inventory location. Provide feedback for the Documentation team, To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call. Saves and closes the note or time entry and opens the Forward/Modify Ticket(s) page. This entity describes an Autotask project task assigned to a service call. Contracts specify a billing arrangement with a Company. This entity's purpose is to describe a billing Work Type (Allocation Code) that is excluded from the contract to which the set applies. , This field is editable for tickets whose ticket category is 'RMA.'. This entity contains the records for the Deleted Task Activity journal located in the Autotaskapplication at, This entity contains the records for the Deleted Ticket log located in the Autotaskapplication at. This entity's purpose is to describe a Resource - Role - Queue relationship. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; You cannot change a resource's ticket number prefix once created. Do new devs get fired if they can't solve a certain bug? This entity takes on the UDFs that hold the site setup information for the Company represented by companyID. Visit our SOAP API lifecycle FAQ article to learn more. I think I posted the beginning of that script in here that will get you connected via Powershell and how to create the ticket. A Contact is an individual associated with a Company. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; window.open(uri); If the Can edit Status of Complete tickets (does not apply to Autotask Web Services/API) permission is cleared for your security level, you can update the status of incomplete incidents. For more information on granular ticket security, refer to the Online Help topic: Update() is allowed on a Ticket with an inactive attribute value if that value is not being changed. You can only associate it with a Quote entity. Everything else looks correct! In Picklist, an inactive TicketCategory displays in italic text. window.open(uri); The function of this entity is to describe the number of units of a specific service bundle with an association to a Recurring Service contract for a specific date range. This entity contains the attachments for the ExpenseReports entity. Autotask users manage Asset notes on Assets. Please open the solution (the C# one) in Visual Studio and work with the sample code there. This entity describes notes created by an Autotask user and associated with a Task entity. This entity describes an Autotask SubscriptionPeriod. Set up the Autotask trigger, and make magic happen automatically in Microsoft Excel. NOTE The Autotask REST API stores and returns all entity time data in Coordinated Universal Time (UTC). Want to learn about upcoming enhancements? This entity contains the categories that hold Knowledgebase articles in Autotask. Selecting a Note Type populates the Publish To field of the note, but this default can be overridden. Billing milestones define tangible work or measured progress that must be completed before billing can take place. To complete the attachment process, you must save the note or time entry. The instructions in this topic help you create an Autotask API user account, configure configuration items and monitors, and configure ticket management in Autotask for your Firebox integration. /*]]>*/Want to tell us more? This entity describes visual identifiers that you can use to categorize and search for Companies. This entity contains attachments for the Projects entity. This entity's purpose is to describe a deliverable item that represents a pre-defined unit of work performed for a set price and billed at regular intervals; for example, a 'Disk Backup' performed for one computer. ConfigurationItemSslSubjectAlternativeName. It also tracks the resource and date &time each step was completed. Available in the UI only when the installed module is enabled. Field is cleared when ticket comes out of Waiting Customer status and is recalculated every time ticket goes back into Waiting Customer status. } If an association is removed from a resource and that pairing is set as the default, that default is not removed. 4. A billing item may or may not be included in an invoice and billed to the customer. 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. This entity contains attachments for the Opportunities entity. This entity represents company (account)categories 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. How to handle a hobby that makes income in US. Saves the note or time entry and opens a new dialog box. The Ticket entity will support the Ticket Category: The following fields are not editable when ticket category is RMA: AccountID, InstalledProductID, TicketType. Autotask Service Bundles group multiple Services for purchase. This entity contains the attachments for the Resources entity. This entity's purpose is to describe a Service entity assigned to a ServiceBundle entity. Autotask administrators create UDFs in the Administration Settings of the Autotask system. Create Ticket Note. This field is required unless the supplied ticket category or the user's default ticket category has both the Due Date and Due Time configured. This selection opens a page that contains a subset of the fields documented above. I have taken the Resource location "15" from the below page on autotask because while creating the api user I have selected the location as "Headquarters". This entity describes the pricing and costing tiers for a specific billing product on the Product table. An opportunity is a forecasted piece of business; an identifiable prospect that needs a product or service and offers a potential sale, project, or contract. Create Ticket using API Hello, i've been trying to create a ticket in Autotask using the API but the documentation (as everyone has already mentioned) is virtually useless. Creates a ticket note. Visit the Ideas forum! Want to talk about it? The AllocationCodeID field must reference a Work Type allocation code. How can I explain to my manager that a project he wishes to undertake cannot be performed by the team? If an unsupported entity receives a request to update a field that contains Rich Text, the API will update the text-only version of the field and overwrite the data in the Rich Text field with plain text. When a ticket category is applied and it changes the value of ChangeApprovalType, the field will be updated even if the ticket type does not = ChangeApproval. Refer to Forwarding and modifying tickets. You can also retrieve this information with the Web Services API call The getEntityInfo() SOAPAPIcall. Provide feedback for the Documentation team. Create a new record or update an existing record in your app. This entity describes an Autotask resource assigned to a ticket that is assigned to a service call. This entity is only used by multi-currency databases. via the API and attached to the OnPlus Service Desk queue. Notes published . This object describes Expense Reports created in Autotask; its purpose is for the submission of expense line items for approval and reimbursement. It also controls if this section is automatically expanded when the time entry or note is opened for creating or editing. Create a Ticket in Autotask using Powershell 27 Aug 2015. This entity contains the attachments for the. You cannot use the API to create items that contain Rich Text, but you can add Rich Text later via a supported method. The entity exists for billing use purposes. The entity header identifies the parent entity the note or time entry is associated with. This entity's purpose is to describe a list item associated with a UserDefinedFieldDefinition entity that has dataType = List. This entity describes an approved and posted billable item in Autotask. There were some field name changes between the Soap and REST API, can you try all the same but replace the accountId field with companyId? The name of the user who is filling the role is added to the role name. Here is the code I tried (after authenticating). For example, although the client can create certain resources, not all resources accept a create call. If you attempt to query these fields, you will receive an error message. UPDATE: I have published an updated version of this article based on our new PowerShell module for Autotask. NOTE If the InstalledProduct value is not being updated, and for some reason it is already associated with an Account that is different from the Ticket Account, the update() will not fail. /*