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 object describes Expense Reports created in Autotask; its purpose is for the submission of expense line items for approval and reimbursement. This entity describes an Autotask Role. It describes whether a Product on the Price List uses the internal currency or an external currency for a Product Tier, and if it is external, lets you set the price in that currency. The function of this entity is to describe the resources associated with a Company Team. To open the page, use the path (s) in the Security and navigation section above. Connect and share knowledge within a single location that is structured and easy to search. You can only create it; you cannot query or update it. /*]]>*/Want to tell us more? This entity describes an Autotask Project. 2. These accounts are free of charge, but they do not provide access to the Autotask UI. LOB security is respected in the API. This entity's purpose is to describe a Contact associated with a ContactGroup. You can configure API Only security levels to allow the impersonation of other resources on supported endpoints. 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. Edit: oh and for the REST API, the ID field isn't needed, just so you are aware. To use a speed code, enter it in the field. Have an idea for a new feature? Adding or editing a note To open the page, use the path (s) in the Security and navigation section above. To subscribe to this RSS feed, copy and paste this URL into your RSS reader. It allows you to configure tiered or volume pricing for the billing product. An error message indicates that Service Request tickets cannot be associated with a problem ticket. Refer to Forwarding and modifying tickets. Field is cleared when ticket comes out of Waiting Customer status and is recalculated every time ticket goes back into Waiting Customer status. On ticket grids, you can select the Add Note to Selected Tickets option from the bulk menu. This entity manages the tags associated with tickets in Autotask. Create Workflow Rules to Set Ticket Severity Level In Autotask, you can set the ticket severity level by creating workflow rules using information provided in the Ticket Title or Description fields. If Ticket.AccountID is updated then Ticket.AccountPhysicalLocation must have AccountID = Ticket.AccountID. If the asset is associated to an SLA, then use that ID. If the ticket type is not = Change Request and a current ChangeApprovalType value exists on the entity, then the field is cleared. This entity describes an Autotask Department. The function of this entity is to describe the tax rate charged to a customer for specific goods or services purchased in a specified tax region. 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. Thanks for your feedback. If setting equals 'Always', the API will always require the QueueID value. Visit our SOAP API lifecycle FAQ article to learn more. Best Practice but optional: Set up Workplace-specific queue, ticket source, issues and sub-issues in Autotask. This article provides a general technical overview and index of the resources (entities)that you can access via the AutotaskRESTAPI. /*]]>*/Want to tell us more? The Web Services API stores and returns all time data in Coordinated Universal Time (UTC). This entity's purpose is to describe a Country as defined in the Autotask CRM module. This entity contains the attachments for the ProjectNotes entity. The RMA ticket category cannot be edited through the API. This entity represents a document in Autotask. window.open(uri); If the ticket catgeory = 'RMA', the TicketType is set to 'Change Request', regardless of the value that is supplied. Gettings 721 tickets based on a title filter: "Title eq hello!" To attach the new attachment to the notification email, select Include Attachments in Email on the notification panel. Head on over to our Community Forum! This entity is only used by multi-currency databases. This section will be expanded if the note or time entry has at least one attachment. Selecting a Note Type populates the Publish To field of the note, but this default can be overridden. window.open(uri); For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed. This entity represents time off requests submitted by Autotaskusers. If you have not clicked the Get current Status link, it will be the date and time you opened the page. 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. The value you select will be set as the status of the parent entity when the dialog box or page is saved. This entity represents documents associated with Knowledgebase articles in Autotask. They are also not exposed in the API or LiveReports. This check box is enabled when the Internal check box is selected. Visit the Ideas forum! If a ticket already has checklist items, the checklist library is appended to the end of the list of checklist items. This entity describes an Autotask Company. Within Autotask navigate to Homepage > Admin > Features & Settings; Tip - click the images to make them larger. For child collection access URLs and specific entity names, refer to the individual articles linked in the List of Entities section of this article. The ConfigurationItemRelatedItems entity enables you to view, add, and remove related child or parent CIs in Autotask. Saves the note or time entry and closes the dialog box. Implementing the time entry portion wouldn't be terrible. All text formatting and images will be lost. 3. Enter your API credentials and then click Connect. Also create Note/Attachment on # incident(s) (tickets only). 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 . Some fields on Entities require an id to a parent Entity. It is only available through the REST API. Access to version 1.6 will deactivate in Q4 2024. It describes whether a ServiceBundle 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. The API user security level has access to contact impersonation for tickets. This entity's purpose is to describe a Resource - Role - Queue relationship. This entity describes an Autotask Inventory location, that is, a physical or virtual place where your company stores or assigns inventory items. Web Services is, however, aware of and will check existing multiple resources on a ticket and will not allow any resource to be assigned as primary resource if that resource is already a secondary resource. In Autotask, you can create ticket categories that are identified as API-Only. To learn more, refer to The Rich Text editor. Changing the task the time entry is associated with, Creating Knowledgebase articles from tickets, Can view time entry internal notes, internal notes, and internal attachments (on Ticket Detail and CRM Detail screens), Can view time entry internal notes, internal notes, and internal attachments (on Task Detail screens), Need troubleshooting help? The API currently exposes the following entities. Some users wanted a benchmark of the new API. Changes made to the Contract by using the ContractServiceAdjustment entity affect only the quantity of units. 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's purpose is to describe a geographic area where billing items have the same tax rate. This entity records existing associations between tags and Knowledgebase articles in Autotask. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; When you enable the Organizational Structure feature in Autotask, this object describes an Autotask Resource association with an organizational structure pairing of OrganizationalLevel1 and OrganizationalLevel2 (OrganizationalLevelAssociation entity). The API does not respect the TicketCategory's 'required' and 'available list item' settings, with the exception of the 'Queue is Required' setting. A shipping type defines a carrier for a product shipment. This entity allows you to track the progress of the opportunity and generate sales forecasts. I think I posted the beginning of that script in here that will get you connected via Powershell and how to create the ticket. This entity contains the attachments for the ConfigurationItems entity. LastActivityPersonType values indicating whether the initiator of the last activity was a resource or a contact. What is a word for the arcane equivalent of a monastery? This entity describes the pricing and costing tiers for a specific billing product on the Product table. The API-only user's security level must allow impersonation on the entity type. Please see the general Autotask PSA Web Services On-line help at: https://ww2.autotask.net/help/DeveloperHelp/Content/AdminSetup/2ExtensionsIntegrations/APIs/SOAP/SOAPHome.htm About Examples using the Autotask API Readme MIT license 25 stars 11 watching 13 forks Releases No releases published Packages No packages published Contributors 3 Languages Form templates follow the limitations of the currently applied category and the user's security settings. You can create additional mailboxes, but you won't be able to activate them. We then put time entries in through Autotask. This entity represents company (account)categories in Autotask. When a SubIssueType value is provided, the associated IssueType value must also be provided. Here is the code I tried (after authenticating). It does not describe transactions where an Inventory Item is associated with a Company as an Asset. The allowed actions are specific to the object. You cannot use the API to create items that contain Rich Text, but you can add Rich Text later via a supported method. A resource must have at least one role assignment. A new inactive attribute value cannot be assigned. This entity describes an Autotask Payment Term. /*]]>*/Want to tell us more? /**/Want to tell us more? The fields that do appear show the following differences: A Keep Current option is available and is the default. This field is editable for tickets whose ticket category is 'RMA.' 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. 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. The note will only be added to the incidents of problem tickets, not incidents of Change Request tickets. If no asset or contract SLA, then check the Ticket Category. This entity describes an Autotask Company Contact that has access permissions for the Client Access Portal. This entity describes an Autotask Contract. Want to talk about it? This entity contains ticket associations for documents in Autotask. Where developers & technologists share private knowledge with coworkers, Reach developers & technologists worldwide, Read the instructions and follow the path. AllocationCodeID is required on create() and update() if your company has enabled the Autotask system setting that requires a Work Type on a Ticket. To obtain extended information about entities and their field data, use the GET API call. If it is selected, you can update the status of all incidents. This entity's purpose is to describe a Resource - Role relationship. . 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. This entity describes one or more account contacts assigned to a Ticket, other than the Ticket Contact (Ticket.contactID). A cost is a billing item for products or materials. This entity describes results and information for a survey generated by Autotask. The time zone and holiday set of the associated location are applied to the resource's time entries and schedules. If the ticket is created from a Datto RMM alert and the Autotask ticket category has a Due Date and Time configured, then we will clear the DueDateTime field on the alert supplied by Datto RMM, and apply the default from the Autotask ticket category. While this is not possible in the UI, in the API, you can create tickets with a ticket category of 'API.'. The date/time stamp indicates the date and time the status was last refreshed from the task or ticket. This entity describes an Autotask To-Do, a scheduled item associated with a Company that appears on the user's Autotask calendar. Want to learn about upcoming enhancements? Press question mark to learn the rest of the keyboard shortcuts. This entity's purpose is to describe a cost associated with an Autotask contract. The allowed actions are specific to the object. If cleared (default setting), all Autotask resources, Outsourcing partners, and customers with access to the item in the Client Portal can view the note. The client can access and act on the entity's field parameters: supplying, updating, or deleting the field data. Autotask Resources are employees, contractors, or consultants with access to a company's Autotask system. Resource access URLs for all entities appear in the next section of this article. I am using CyberDrain PowerShell module but I am clearly missing something. 4. A cost is a billing item for products or materials. https://www.autotask.com/, Press J to jump to the feed. For more information or technical support about how to configure settings on the Autotask website, see the Autotask documentation. Head on over to our Community Forum! If the ticket category has only the due date or only the due time configured, then the API Ticket.DueDateTime will be required, and not supplying a value will return an error message. This entity describes an individual business unit that has an association with a company in Autotask. Autotask Service Bundles group multiple Services for purchase. For more information about fields marked as picklists, review our Understanding picklists article. For more information, refer to. The attachments will only be added to the incidents of problem tickets, not incidents of Change Request tickets. If selected, the text entered into the Summary Notes or Description field will be added to the end of the Resolution field of the ticket. For the Autotask REST API, the Read-Only and Required field attributes have the following meanings: It is possible for a field to be both Read-Only and Required. The allowed actions are specific to the field. According to their documentation it requires the URI https://webservices4.autotask.net/atservicesrest/v1.0/Tickets and then the body contains the JSON formatted data: But this doesn't seem to work either and Datto are taking forever to respond to support tickets these days. For more information, refer to Notification panel. For information about dialog boxes and how they differ from browser pages, refer to Minimizing Dialog Boxes. NOTE If the Ticket Note or Ticket Time Entry page is opened from the Edit Ticket page, Forward/Modify is disabled. This entity contains attachments for the Companies entity. There is no warning. This entity contains the attachments for the TimeEntries entity. Refer to. You cannot change a resource's ticket number prefix once created. This check box appears on task notes, ticket notes and both task and ticket quick notes and quick replies. This resource describes contract billing rules that generate charges which allow you to bill your customer by the end user or by the asset. Update Status on {#} incident(s) (tickets only). For more information about fields marked as picklists, review our Understanding picklists article. This entity's purpose is to describe a predecessor/successor arrangement between two project schedule items. This entity describes an Autotask Contract Rate. This entity describes an Autotask SubscriptionPeriod. The API will set the impersonated users name and impersonatorCreatorResourceID value as the content creator during create operations. 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. Autotask users manage Tickets through a number of modules including Service Desk, Home, CRM, and Contracts. You can also retrieve this information with the Web Services API call The getEntityInfo() SOAPAPIcall. It describes whether an Allocation Code of type Material Code 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. Log into Autotask and navigate to the menu on the left and click on Admin Create a Ticket in Autotask using Powershell 27 Aug 2015. The Autotask REST API Getting started REST API security and authentication REST API revision history Working in the API Introduction to the Autotask REST API Introduction to REST API calls Autotask REST API resources Good to know. This entity describes an Autotask Inventory module Purchase Order. This object describes list items added to a check list on an Autotask ticket. This entity describes the refund or credit charge that generates when the RMA is set as Authorized on a ticket with the RMA ticket category. Refer to Creating Knowledgebase articles from tickets. The function of this entity is to describe the relationship between an asset category and a specific UDF. NOTE This field is visible only if Co-managed Help Desk is enabled on the Activation page, and only shown to resources who are not co-managed. This entity describes an Autotask Appointment,a scheduled calendar time that is not a service call. This entity describes the Resource and Role through the Queue association. /*