[CDATA[*/ All users can view attachments they uploaded. This entity's purpose is to describe a Country as defined in the Autotask CRM module. I think I posted the beginning of that script in here that will get you connected via Powershell and how to create the ticket. Best Practice but optional: Set up Workplace-specific queue, ticket source, issues and sub-issues in Autotask. This entity enables you to decrease inventory counts associated with the InventoryProducts entity. This entity contains attachments for the Companies entity. To learn more, see our tips on writing great answers. Where developers & technologists share private knowledge with coworkers, Reach developers & technologists worldwide, Read the instructions and follow the path. It describes whether a Service 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. Site design / logo 2023 Stack Exchange Inc; user contributions licensed under CC BY-SA. Refer to Web Services APIsecurity settings. Thanks for your feedback. If you edit a note or time entry that is associated with existing attachments, they appear in a separate Attachments section. [CDATA[*/ This entity contains the attachments for the ExpenseReports entity. The DomainRegistrars entity contains WHOISdetails for Domain assets. You can configure API Only security levels to allow the impersonation of other resources on supported endpoints. On update, a TicketCategory cannot be updated to another TicketCategory that is inactive. 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. This entity allows you to track the progress of the opportunity and generate sales forecasts. Autotask Service Bundles group multiple Services for purchase. Be aware that some field data, such as picklist values and user-defined fields, may vary between Autotask implementations and cannot be provided in this document. To learn more, refer to our AutotaskRESTAPIcalls >Timestamp format article. The Add New Attachments section is always collapsed. Provide feedback for the Documentation team. The function of this entity is to describe the mapping of the Asset (Configuration Item) to the contract billing rule. IMPORTANT Fields that are not visible cannot be validated. This entity contains attachments for the Tickets entity. Namely the VS solutions are here. This entity describes an Autotask Ticket. The Note Type field defaults to Task Summary. After you create the API key, login to your Autotask instance, hover over the Autotask button in the top left corner then . IMPORTANT If the New/Edit Time Entry or New/Edit Note dialog is saved on the Edit Task or Edit Ticket page, both the details panel and main canvas will be updated. Asking for help, clarification, or responding to other answers. In addition, a stumbling block I noted was to double check the AssignedResourceID has the actual role assigned via AssignedResourceRoleID. Press question mark to learn the rest of the keyboard shortcuts. This resource describes key business details for the Autotask Company 0, the Autotask user's company account. [CDATA[*/ This check box appears on task notes, ticket notes and both task and ticket quick notes and quick replies. This entity's purpose is to describe a Quote in Autotask. Enter your API credentials and then click Connect. Need troubleshooting help? 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. Provide feedback for the Documentation team. /*]]>*/Want to tell us more? You cannot change a resource's ticket number prefix once created. Gettings 721 tickets based on a title filter: "Title eq hello!" The Action Type specifies the type of activity scheduled by the to-do or associated with the note and the actionType View controls where the Note or To-do appears in the user interface. resource and child collection access URLs, Resource and child collection access URLs, Finding resource and child access URLs of REST API entities, Allow impersonation of resources with this security level, ArticleConfigurationItemCategoryAssociations, WebhookExcludedResources (REST), ConfigurationItemBillingProductAssociations, Using Swagger UIto explore REST API requests, Need troubleshooting help? 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. This entity describes an Autotask Notification, as listed in the Notification History page. Head on over to our Community Forum! Each entity description includes the following information: Note that actions are governed by the permissions of the logged-in end user; for example, although a Company entity allows a create call, the logged-in end user may not have permission to create a Company entity. 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. Is there a proper earth ground point in this switch box? The template corresponding to the speed code will be highlighted automatically. They can click New Ticket on the Autotask interface sub-navigation menu to open the New Ticket window. This entity's purpose is to describe a resource assigned to a task but not as the primary resource. A company's category determines the layout of the entity's pages, which fields are visible, and which picklist options are available. 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. Every attempt gives me a 500 server error. I changed some values just in case they are sensitive. DocumentConfigurationItemCategoryAssociations. Reddit and its partners use cookies and similar technologies to provide you with a better experience. This entity contains the attachments for the TaskNotes entity. A place where magic is studied and practiced? 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. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; 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. We recommend that you create a new resource (Autotask user account) for the integration, so that it is separate from other user accounts. IssueType and SubIssueType are never required in the API. /*Admin > Features and Settings > Projects & Tasks >Deleted Ticket Activity Log. Autotask users manage Tickets through a number of modules including Service Desk, Home, CRM, and Contracts. The Autotask REST API presents selected Autotask resources as programming objects that allow the client to perform actions on them. 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. Thanks for your feedback. A billing item may or may not be included in an invoice and billed to the customer. You can assign it to any resource and associate it with a Contract, Ticket, or Opportunity. 2. When updating a field that has Rich Text, the APIwill return the text-only version of the field. This entity describes an Autotask Project. 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. A resource must have at least one role assignment. ChangeInfoFields are available regardless of whether they are Active or Inactive. Resource access URLs for all entities appear in the next section of this article. The Ticket entity can have no more than 300 UDFs. This entity enables you to increase inventory counts associated with the InventoryProducts entity. Also create Note/Attachment(s) on # incident(s). Each entity type object contains an array of properties that describe instances of the entity type. An error message indicates that Service Request tickets cannot be associated with a problem ticket. The function of this entity is to describe the Webhook error log where errors are kept by the application for 30 days. Want to learn about upcoming enhancements? Basic Incoming Email Processing is available to all Autotask customers at no additional cost, and includes: The Add Ticket Email Service (ATES) mailbox, which is already set up One additional active custom mailbox. A subreddit for users of Autotask Professional Services Automation tool. 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. This entity represents ticket and article tags in Autotask. 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. For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed. Thanks for your feedback. If you set the status of selected tickets to Complete, and one or more tickets have incomplete to-dos, a confirmation message will ask if you want to complete associated to-dos. When you enable the Organizational Structure feature in Autotask, this object describes the association between an organizational structure Branch and Line of Business. This entity's purpose is to describe a resource assigned to a ticket but not as the primary resource. window.open(uri); It describes Price List information associated with a WorkTypeModifier entity. They can click New Ticket on the Autotask interface sub-navigation menu to open the New Ticket window. This entity's role is to describe any sort of note created by an Autotask user and associated with a Company entity as opposed to a Ticket Note. Do new devs get fired if they can't solve a certain bug? This entity's purpose is to describe a billing role that is excluded from the contract to which the set applies. This entity represents time off requests submitted by Autotaskusers. Implementing the time entry portion wouldn't be terrible. For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed. NOTE Not all entities use UDFs. If Ticket.AccountID is updated then Ticket.AccountPhysicalLocation must have AccountID = Ticket.AccountID. This entity contains the categories that hold Knowledgebase articles in Autotask. You may also update UDFs for entity types that allow update and create. A setting on the General tab of the category will determine if a note title is required for task and ticket notes. Did any DOS compatibility layers exist for any UNIX-like systems before DOS started to become outmoded? This entity represents a document in Autotask. This includes the following fields: ChangeApprovalBoard, ChangeApprovalType, ChangeApprovalStatus, ChangeInfoField1, ChangeInfoField2, ChangeInfoField3, ChangeInfoField4, ChangeInfoField5. This entity describes an adjustment to the quantity of units of a Service Bundle that are added to a Recurring Service Contract. From the main navigation menu click Admin/Features & Settings. Either click the template or click. 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. The status field describes how close a ticket is to resolution, or how close a task is to completion. 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. Append to Resolution on # incident(s) (tickets only). This entity defines a user-defined field (UDF) in Autotask. This entity describes notes created by an Autotask user and associated with a Product entity. All fields are read-only. The date/time stamp indicates the date and time the status was last refreshed from the task or ticket. 4. The entity exists for billing use purposes. For example, when updating an entity, you may not be able to update all fields within the entity. To complete the attachment process, you must save the note or time entry. IMPORTANT By default, notes and time entry pages launched from a task or ticket in New, Edit, or View mode open in a modal dialog box. The note will only be added to the incidents of problem tickets, not incidents of Change Request tickets. This object associates a Product entity with a PurchaseOrder entity. Although the data will remain intact and will be reportable, it will not be viewable in the ticket in Autotask. 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. Is it possible to rotate a window 90 degrees if it has the same length and width? [CDATA[*/ TicketCategory default values will be applied unless another value is passed in. The API can complete a ticket that has one or more incomplete 'Important' Checklist items. This entity's purpose is to describe a skill or ability that you can associate with a Resource via the ResourceSkill entity. The Ticket entity will support the Ticket Category: The following fields are not editable when ticket category is RMA: AccountID, InstalledProductID, TicketType. If the ticket type is not = Change Request and a current ChangeApprovalType value exists on the entity, then the field is cleared. For more information about fields marked as picklists, review our Understanding picklists article. /*]]>*/Want to tell us more? LOB security is respected in the API. The Status defaults to the current status of the parent entity when the page or dialog box is opened. The check boxes are shortcuts to manually selecting or clearing role-based recipients on the Notification panel. This entity describes an Autotask Block Hour Factor, an option used with Block Hour type Contracts. Visit our SOAP API lifecycle FAQ article to learn more. This field is editable for tickets whose ticket category is 'RMA.' If the ticket type = Change Request, then ChangeApprovalType is set to the default value. RESTAPIsupportability and query thresholds, Using Swagger UIto explore REST API requests. The AllocationCodeID field must reference a Work Type allocation code. 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. Ticket User-Defined Field: When you select a User-Defined Field, the extension call will be triggered only for tickets that . IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. This entity describes DNSrecords associated with Assets in Autotask. This entity's purpose is to describe an asset category. How can I explain to my manager that a project he wishes to undertake cannot be performed by the team? This entity's purpose is to describe a record of approval for a ticket change request. 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 Autotask is a one solution ticketing system for managing your IT business that integrates with N-able N-central enabling you to map customers between both systems and share asset information for ticket creation, configure automatic ticket creation and bundle accounts in Autotask for billing. You cannot use the API to create items that contain Rich Text, but you can add Rich Text later via a supported method. ConfigurationItemWebhookExcludedResources. Three read only fields, MonitorID, MonitorTypeID, and RMMAlertID are currently available for use by the Autotask RMM integration only. On ticket grids, you can select the Add Note to Selected Tickets option from the bulk menu. You can individually configure the following entities to allow querying, adding, editing, and deleting (bold items only): For more information about impersonation security levels, refer to Allow impersonation of resources with this security level. Security: This check box is available even if users do not have permission to edit tickets. For more information, refer to Notification panel. This entity's purpose is to describe a line item associated with an Expense Report entity. In Autotask, you can create ticket categories that are identified as API-Only. LastActivityPersonType values indicating whether the initiator of the last activity was a resource or a contact. The fields that do appear show the following differences: A Keep Current option is available and is the default. It allows you to configure tiered or volume pricing for the billing product. This entity contains SSLSubject Alternative Name (SAN) records associated with the ConfigurationItemsentity in Autotask. 1. /**/Want to tell us more? This check box only appears for notes and time entries on problem tickets associated with one or more incidents. You get internal server error when it's not happy about something, but in the returned body it normally expands on the particular error. This entity describes an Autotask Role. Invoices include Billing Items that have been approved and posted and are being billed to a customer or presented for information purposes only. The RMA ticket category cannot be edited through the API. function SendLinkByMail(href) { This entity's purpose is to describe a payment amount applied to a Retainer type contract and sets the time period covered by the purchase. It allows you to create, query, and update expense line items through the API. This entity describes an Autotask Quote Template that defines the content and appearance of an Autotask Quote. This data will not change during update operations. To subscribe to this RSS feed, copy and paste this URL into your RSS reader. A table that lists all standard Autotask fields by Field Name and provides the following information for each field: Field Name, Data Type, Read-Only, Is Required, Reference Name (provided only if the field is a reference), Picklist, and Picklist Parent Column Name (only if the field is a picklist child). About note types. Calculated in hours only. This object describes Autotask Assets (previously known as Configuration Items), other than the primary Assets (Ticket.configurationItemID). It mirrors the fields found on the. The attachments will only be added to the incidents of problem tickets, not incidents of Change Request tickets. The impersonated resource must have permission to act as configured in the other sections on the Edit Security Level page. The function of this entity is to describe the relationship between an asset category and a specific UDF. This entity is only used by multi-currency databases. All text formatting and images will be lost. I am trying to create a ticket in autotask using the below python code: Tickets define service requests within the Autotask system. QueueID requirement - The ticket's category (Ticket.TicketCategory) will determine whether or not Ticket.QueueID is required, based on the category's 'Queue is Required' setting. The 'YYYYMMDD' value must be a date less than or equal to today's date. If there is no Contract Service or Bundle SLA, then check the Contract. To obtain extended information about entities and their field data, use the GET API call. The allowed actions are specific to the field. A SubscriptionPeriod stores the information for an individual billing period item associated with an Autotask Subscription. To make calls to the entities of the AutotaskRESTAPI, you will need to use their resource access URLs or child collection access URLs. This entity describes an Autotask Contract Rate. Within Autotask navigate to Homepage > Admin > Features & Settings; Tip - click the images to make them larger. A new inactive attribute value cannot be assigned. Refer to The Rich Text editor to learn more. This entity represents ticket tag groups in Autotask. } Button bar Header Task Status or Ticket Status General Quick Notification (Notify via "To") Quick Ticket Edits (tickets only) Add New Attachments Attachments The Notification panel Adding a note to selected tickets The current data is loaded when the section is first expanded. This entity describes an Autotask SubscriptionPeriod. How do I connect these two faces together? It will not appear on the New Ticket Note or New Ticket Time Entry form. Open the Kaseya Helpdesk. This entity contains checklist items related to documents in Autotask. This entity describes one or more Autotask Assets (previously known as Configuration Items) assigned to a Ticket beyond the primary asset(ticket.configurationItemID). function SendLinkByMail(href) { 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 . Want to talk about it? That InstalledProduct must also reference a Product that is EligibleForRma. This entity represents associations between, This entity represents articles associated with. /*]]>*/Want to tell us more? This entity describes an approved and posted billable item in Autotask. NOTE When opened from the Ticket Time Entry dialog box or page, you can select the Internal Only check box. If the ticket catgeory = 'RMA', the TicketType is set to 'Change Request', regardless of the value that is supplied. Access deactivation for version 1.5 began in Q1 2022 and will enter its concluding phases in October 2022. By clicking Post Your Answer, you agree to our terms of service, privacy policy and cookie policy. It describes whether a Role Hourly Rate 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.