This entity defines a user-defined field (UDF) in Autotask. Provide feedback for the Documentation team. Only the incidents of problem tickets will have their status updated. If the ticket category is associated to an SLA, then use that ID. You use it to override your company's standard role rate for labor tracked against the contract. Roles are associated with a department, have a standard billing rate, and are assigned to resources for billing purposes. This entity's purpose is to describe a line item associated with an Expense Report entity. /*]]>*/Want to tell us more? When updating a field that has Rich Text, the APIwill return the text-only version of the field. Changes made to the Contract by using the ContractServiceAdjustment entity affect only the quantity of units. The API can complete a ticket that has one or more incomplete 'Important' Checklist items. All text formatting and images will be lost. Attempting to edit this field on a ticket with a different ticket category will result in the supplied value being ignored. The following table describes the standard Autotask field objects for this entity. } IMPORTANT Except in the case of certain entities, when the APIreceives a request to update a field that contains Rich Text, the APIwill update the text-only version of the field and overwrite the data in the Rich Text field with plain text. window.open(uri); Access to version 1.6 will deactivate in Q4 2024. 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). This entity describes one or more Autotask Assets (previously known as Configuration Items) assigned to a Ticket beyond the primary asset(ticket.configurationItemID). /**/Want to tell us more? The allowed actions are specific to the field. When you enable the Organizational Structure feature in Autotask, this object describes an organizational structure Line of Business. When an inventory product is manually created, stocked items are also created. Cost items can be billable or non-billable. Update Status on {#} incident(s) (tickets only). The ticket category controls which fields appear here and in what order. If the setting Enable [Entity] Stopwatch is cleared for the entity category, the stopwatch will not appear. This entity takes on the UDFs that hold the site setup information for the Company represented by companyID. After you create the API key, login to your Autotask instance, hover over the Autotask button in the top left corner then . By clicking Post Your Answer, you agree to our terms of service, privacy policy and cookie policy. Calculated in hours only. To obtain complete field information specific to your Autotask implementation, use theGETAPIcalls described in the resource and child collection access URLs section of this document. 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? 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. /**/Want to tell us more? This entity describes an Autotask Department. In Autotask, you can create ticket categories that are identified as API-Only. Change request tickets are part of the Autotask Change Management feature set. function SendLinkByMail(href) { 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. Thanks for your feedback. 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 . With the granular ticket security features implemented in the 2016.1 release, the API Ticket entity will respect the View, Add, and Edit permissions assigned to the logged in end user, EXCEPT the API will not respect the 'Mine + Accounts' setting. If the user sends content back to an unsupported entity, the Rich Text and all images it contains will be lost. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; Open the Kaseya Helpdesk. This object describes Expense Reports created in Autotask; its purpose is for the submission of expense line items for approval and reimbursement. This entity's purpose is to describe a grouped set of Holiday entities assigned to an Autotask Internal location and used in tracking internal time off. The function of this entity is to describe the mapping of the Asset (Configuration Item) to the contract billing rule. The current data is loaded when the section is first expanded. Each of the entities inherits from the Autotask base class Entity. Phases allow users to break projects into sub-groups of project tasks. Enable the Allow Ticket Creation Without Configuration Items option only if you do not track all monitored computers as Autotask Configuration Items. This object describes general information for a survey generated by Autotask. An API user is a special type of account required for communication with the Autotask API. Every attempt gives me a 500 server error. The note will only be added to the incidents of problem tickets, not incidents of Change Request tickets. Open the Kaseya Helpdesk. This entity contains ticket associations for documents in Autotask. This entity's purpose is to describe a resource assigned to a task but not as the primary resource. Service calls are instances of time, with specified start and stop times, that are scheduled to perform work for a Company. This entity contains the records for the Deleted Ticket Activity journal located in the Autotaskapplication at >Admin > Features and Settings > Projects & Tasks >Deleted Ticket Activity Log. I use the Powershell API to create tickets based on an Excel spreadsheet. This field is not filterable for tickets in the API. This entity's purpose is to describe a Resource - Role - Department relationship. This entity represents associations between assets and documents in Autotask. The InventoryProducts entity is the container where you define inventory location, minimum and maximum stocking levels, and can see the summary of the product (Available, Reserved, etc.). This entity is only used by multi-currency databases. Refer to. 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. If you send the content back, the Rich Text and all images that it contains will be lost. To obtain extended information about entities and their field data, use the GET API call. On the incidents, the Internal Notes are created as a reply to the Summary Notes. We recommend that you create a new resource (Autotask user account) for the integration, so that it is separate from other user accounts. This entity describes an Autotask Ticket. Does ZnSO4 + H2 at high pressure reverses to Zn + H2SO4? Head on over to our Community Forum! } This entity contains attachments for the Opportunities entity. This entity's purpose is to describe a Service entity assigned to a ServiceBundle entity. Press question mark to learn the rest of the keyboard shortcuts. [CDATA[*/ function SendLinkByMail(href) { Ticket.AccountID cannot be changed if the ticket has an associated and posted TimeEntry, TicketCost, or Expense. window.open(uri); Such ticket categories are hidden everywhere you select a ticket category when you create or edit a ticket; they are only used when tickets are created via the API. You can configure API Only security levels to allow the impersonation of other resources on supported endpoints. } The status field describes how close a ticket is to resolution, or how close a task is to completion. It has code to get popular entities like accounts, tickets, contacts etc. Entity details You can also retrieve this information with the Web Services API call The getEntityInfo () SOAP API call. window.open(uri); NOTE The Autotask REST API stores and returns all entity time data in Coordinated Universal Time (UTC). 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. Currently, the API provides the following actions: GET, PUT, PATCH, POST, and DELETE. The time zone and holiday set of the associated location are applied to the resource's time entries and schedules. When you enable the Organizational Structure feature in Autotask, this object describes the association between an organizational structure Branch and Line of Business. It represents any organization with which you do business. I changed some values just in case they are sensitive. Any existing Change Request tickets can be edited. This includes the following fields: ChangeApprovalBoard, ChangeApprovalType, ChangeApprovalStatus, ChangeInfoField1, ChangeInfoField2, ChangeInfoField3, ChangeInfoField4, ChangeInfoField5. The function of this entity is to describe the relationship between an asset category and a specific UDF. Any unsaved changes in those areas will be kept. To verify and configure these settings perform the following steps. TicketCategory default values will be applied unless another value is passed in. A new inactive ContactID value cannot be assigned on create() or update(). Set up the Autotask trigger, and make magic happen automatically in Microsoft Excel. 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. This entity describes an Autotask Opportunity. 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. This entity describes an Autotask Appointment,a scheduled calendar time that is not a service call. Thanks for your feedback. Is there a proper earth ground point in this switch box? If setting equals 'Always', the API will always require the QueueID value. var uri = 'https://docs.google.com/forms/d/e/1FAIpQLSdw1y-_z7_O1tSWNFkiDliribqAz5IrqAiJJ6u2KsbEvICTqw/viewform?usp=pp_url&entry.876121135=' + document.location.href; ConfigurationItemSslSubjectAlternativeName. 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. It outlines the steps that must be performed to complete the ticket or task. 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. Where does this (supposedly) Gibson quote come from? 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. This field is editable for tickets whose ticket category is 'RMA.' [CDATA[*/ This entity enables you to decrease inventory counts associated with the InventoryProducts entity. Edit: oh and for the REST API, the ID field isn't needed, just so you are aware. /*
Schoolteachers Friendly Society Child Trust Fund Login, Articles A