Visit our SOAPAPIlifecycle FAQ article to learn more. Changes made to the Contract by using the ContractServiceBundleAdjustment entity affect only the quantity of Contract Service units. > 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). Tickets with no TicketType specified are set automatically to Service Request. A cost is a billing item for products or materials. Any entities or attachments that the account creates will be attributed to "APIUser." The id field belongs to each entity and acts as the unique identifier. window.open(uri); 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). To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call. [CDATA[*/ For additional information, refer to. This entity's purpose is to describe a Resource - Role - Department relationship. 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". Read-Only:Read-Only fields cannot be changed by, Required: Required fields must be present when you attempt a. This entity's purpose is to describe a list item associated with a UserDefinedFieldDefinition entity that has dataType = List. This entity describes an Autotask Project. Visit the Ideas forum! Resolution: After playing with some items and looking through the module code and Postman, everything needs to be treated as a string: Thanks to u/nutter91 for the assistance with submitting a record ID of 0 for new records and reminding me to simplify things. You can create additional mailboxes, but you won't be able to activate them. It does not describe transactions where an Inventory Item is associated with a Company as an Asset. This entity contains notes for Knowledgebase articles in Autotask. [CDATA[*/ In Autotask, you can create ticket categories that are identified as API-Only. permission is required. This entity contains attachments for the Projects entity. 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. We're using Power Apps to capture information and then Flow passes it to Autotask, i can pull information using GET but unable to create anything. This entity describes an Autotask Block Hour Factor, an option used with Block Hour type Contracts. To learn more, refer to our AutotaskRESTAPIcalls >Timestamp format article. function SendLinkByMail(href) { A resource can be associated with multiple LOBs; entities cannot. 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. If selected, the note's Description or the time entry's Summary Notes, Internal Notes, and any new attachments are added to the ticket's incidents, as well. This entity describes an adjustment to the quantity of units of a Service Bundle that are added to a Recurring Service Contract. A new inactive attribute value cannot be assigned. This entity describes an Autotask Contract. From the Autotask Home page toolbar, select Help. This entity contains the attachments for the CompanyNotes entity. This entity's purpose is to describe a modifier for a given Work Type BillingCode. When you use the APIto update this field, the RESTAPIwill return the text-only version of its content. If TicketType = Service Request and the ticket also specifies a ProblemTicketID, the ticket type is updated to Service Request. This entity contains the attachments for the ConfigurationItems entity. This entity describes the Resource Role and Department association. This entity represents company (account)categories in Autotask. 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. Configure your support email address. The function of this entity is to describe the resources associated with a Company Team. Cost items can be billable or non-billable. For example, although the client can create certain resources, not all resources accept a create call. All text formatting and images will be lost. The Entities list provides a link to additional information about the entity and its standard Autotask fields. 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. This entity contains attachments for the Tickets entity. https://www.autotask.com/, Press J to jump to the feed. Need troubleshooting help? They are also not exposed in the API or LiveReports. The API-only user's security level must allow impersonation on the entity type. The Administrative Email Address for Action-Required Notifications should be an email address that does not create tickets in your Autotask. Which actions can be performed on the entity. When querying, a small number of entities contain fields that you cannot query. NAVIGATION Set up a mailbox in Autotask. This entity contains the attachments for the ExpenseReports entity. This object describes Expense Reports created in Autotask; its purpose is for the submission of expense line items for approval and reimbursement. This entity represents associations between asset categories and documents in Autotask. Ticket User-Defined Field: When you select a User-Defined Field, the extension call will be triggered only for tickets that . Thanks for your feedback. In Autotask, sales orders are associated to Opportunities. What is a word for the arcane equivalent of a monastery? This entity contains notes for documents in Autotask. This entity takes on the UDFs that hold the site setup information for the Company represented by companyID. Access to version 1.6 will deactivate in Q4 2024. Thanks for your feedback. [CDATA[*/ The ConfigurationItemRelatedItems entity enables you to view, add, and remove related child or parent CIs in Autotask. Visit our SOAPAPIlifecycle FAQ article to learn more. 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. This entity is only used by multi-currency databases. 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. This entity describes an Autotask Resource. } This entity describes one or more Autotask Assets (previously known as Configuration Items) assigned to a Ticket beyond the primary asset(ticket.configurationItemID). 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. /*]]>*/Want to tell us more? If you select Yes, all incomplete to-dos for the ticket to be set to complete when the note is saved. If the ticket has at least one incomplete to-do, and the value in this field is changed to, Time entries only: If the status is changed to, If you have not changed the status, clicking this link will update the, If the note was created by a Client Portal user, only the value, If the note was created by a Taskfire user, only the value. function SendLinkByMail(href) { The REST API permits you to retrieve values for all entity UDFs via the query method. On ticket grids, you can select the Add Note to Selected Tickets option from the bulk menu. This is an event a Zap performs. The application records an error when the maximum number of retries (5) have occurred for an event, but the payload could not be delivered. If a ticket is created with the 'RMA' ticket category via the API and no value is supplied for this field, the ticket category default value for the field will be used. /*]]>*/Want to tell us more? Refer to Forwarding and modifying tickets. Yep tried that - on the example given by Autotask it included "Id": "0" on the first line - but it doesn't make any difference. What could be the reason? 3. The function of this entity is to describe the associations between Change Request tickets and both Incidents and Problems. The ChangeManagement module must be enabled to create a new ticket with TicketType = Change Request. This entity contains attachments for Knowledgebase articles in Autotask. I know I have correctly authenticated and set the BaseURI because I can get company information for customers. If the setting Enable [Entity] Stopwatch is cleared for the entity category, the stopwatch will not appear. This entity contains the attachments for the TaskNotes entity. Each of the entities inherits from the Autotask base class Entity. Quote Items define a line item added to an Autotask Quote. This selection opens a page that contains a subset of the fields documented above. Other fields related to change request will accept values when Change Management is not enabled, but that data will not be available through the UI. Want to talk about it? The Ticket entity will support the Ticket Category: The following fields are not editable when ticket category is RMA: AccountID, InstalledProductID, TicketType. ServiceLevelAgreementPausedNextEventHours. The following table describes the standard Autotask field objects for this entity. Create an account to follow your favorite communities and start taking part in conversations. This entity represents checklist libraries related to documents in Autotask. On create(), if InstalledProductID is populated, the InstalledProduct.AccountID must = Ticket.AccountID. Phases allow users to break projects into sub-groups of project tasks. But does anyone know what should be used to create a ticket? ConfigurationItemSslSubjectAlternativeName. An inventory product represents a set of stocked items that share a product and a location. This entity describes detailed information about on-hand. Staging Ground Beta 1 Recap, and Reviewers needed for Beta 2, Representational state transfer (REST) and Simple Object Access Protocol (SOAP), Use of PUT vs PATCH methods in REST API real life scenarios, Calculating probabilities from d6 dice pool (Degenesis rules for botches and triggers). This entity manages the tags associated with tickets in Autotask. } The note will only be added to the incidents of problem tickets, not incidents of Change Request tickets. The API does not respect the TicketCategory's 'required' and 'available list item' settings, with the exception of the 'Queue is Required' setting. You cannot change a resource's ticket number prefix once created. This entity represents ticket tag groups in Autotask. This entity's purpose is to describe a Resource - Role - Queue relationship. Also create Note/Attachment(s) on # incident(s). Billable cost items appear in Approve and Post. This entity's purpose is to describe an asset category. 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. A new inactive ContactID value cannot be assigned on create() or update(). The allowed actions are specific to the object. For child collection access URLs and specific entity names, refer to the individual articles linked in the List of Entities section of this article. This entity enables you to increase inventory counts associated with the InventoryProducts entity. Additionally, only those statuses that are available to all selected tickets categories are available for selection. About note types. 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. The properties represent data fields. Tickets and project tasks share the same list of statuses. 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 It must have an association with an Autotask Opportunity entity, and it allows users to specify and track multiple products, services, labor items, etc., that further define the Opportunity. You can update an existing Ticket that has a Resource + Role combination that uses an inactive role. IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. IMPORTANT Although you can query all resources, some objects contain fields that you cannot query. A payment term specifies conditions and requirements for payment due on an Autotask invoice; for example, Net 30 days. This entity represents the daily availability, hours goal, and travel for a resource. 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. This entity contains attachments for the Tasks entity. If setting equals 'RequiredWhenPrimaryResourceIdBlank', then the API will produce an error when both the QueueID and ResourceID fields are empty. The purchase approval option is available through Autotask procurement. Step 1: Creating an API User and Getting API Keys from Autotask (REST API) Why are we doing this? Refer to Web Services APIsecurity settings. import requests. Can Query is not included because non-queryable fields are listed under a separate heading. 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 function of this entity is to describe the Ticket History, which tracks changes to the fields of the ticket entity, as well as the fields of any Service Level Agreement associated with the ticket. Expand RESOURCES/USERS (HR) and click Resources/Users; Tip - click the images to make them larger. Want to learn about upcoming enhancements? Notes published . ChangeApprovalStatus can only be set to Requested or Assigned. CreatorType specifies whether the CreatorResourceID refers to a Resource or a Contact. 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 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. Refer to Running a global notes search. 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. To obtain extended information about entities and their field data, use the GET API call.