XML API Reference Guide October 8, 2022 Copyright © 2013, 2022, Oracle and/or its affiliates. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error- free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract. The terms governing the U.S. Government's use of Oracle cloud services are defined by the applicable contract for such services. No other rights are granted to the U.S. Government. This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle. If this document is in public or private pre-General Availability status: This documentation is in pre-General Availability status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation. If this document is in private pre-General Availability status: The information contained in this document is for informational sharing purposes only and should be considered in your capacity as a customer advisory board member or pursuant to your pre-General Availability trial agreement only. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, timing, and pricing of any features or functionality described in this document may change and remains at the sole discretion of Oracle. This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your access to and use of this confidential material is subject to the terms and conditions of your Oracle Master Agreement, Oracle License and Services Agreement, Oracle PartnerNetwork Agreement, Oracle distribution agreement, or other license agreement which has been executed by you and Oracle and with which you agree to comply. This document and information contained herein may not be disclosed, copied, reproduced, or distributed to anyone outside Oracle without prior written consent of Oracle. This document is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates. Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http:// www.oracle.com/pls/topic/lookup?ctx=acc&id=trsif you are hearing impaired. Sample Code Oracle may provide sample code in SuiteAnswers, the Help Center, User Guides, or elsewhere through help links. All such sample code is provided "as is” and “as available”, for use only with an authorized NetSuite Service account, and is made available as a SuiteCloud Technology subject to the SuiteCloud Terms of Service at www.netsuite.com/tos, where the term “Service” shall mean the OpenAir Service. Oracle may modify or remove sample code at any time without notice. No Excessive Use of the Service As the Service is a multi-tenant service offering on shared databases, Customer may not use the Service in excess of limits or thresholds that Oracle considers commercially reasonable for the Service. If Oracle reasonably concludes that a Customer’s use is excessive and/or will cause immediate or ongoing performance issues for one or more of Oracle’s other customers, Oracle may slow down or throttle Customer’s excess use until such time that Customer’s use stays within reasonable limits. If Customer’s particular usage pattern requires a higher limit or threshold, then the Customer should procure a subscription to the Service that accommodates a higher limit and/or threshold that more effectively aligns with the Customer’s actual usage pattern. Table of Contents Introduction to OpenAir XML API ............................................................................................... 1 Technology ......................................................................................................................... 1 Target Audience .................................................................................................................. 1 Overview ............................................................................................................................ 1 Definitions .......................................................................................................................... 2 Presentation of XML ............................................................................................................ 2 Authorization and Command Overview ................................................................................... 3 Naming Conventions for Objects and Commands ..................................................................... 3 Error Handling .................................................................................................................... 4 Connecting to the API .............................................................................................................. 5 Namespaces ....................................................................................................................... 5 Connecting to the API .......................................................................................................... 5 Limits ................................................................................................................................ 6 Internationalization and Character Sets .................................................................................. 8 OAuth 2.0 Authorization ........................................................................................................... 9 Managing API Integration Applications in OpenAir .................................................................... 9 OAuth 2.0 for Integration Applications Developers .................................................................. 17 Authorizing Applications to Access OpenAir on Your Behalf ...................................................... 27 Auditing and Managing OAuth 2.0 Authorizations ................................................................... 29 XML Commands .................................................................................................................... 32 Time ................................................................................................................................ 32 Read ................................................................................................................................ 32 Read, all ........................................................................................................................... 35 Read, equal to .................................................................................................................. 36 Read, not equal to ............................................................................................................. 39 Read, custom equal to ....................................................................................................... 39 Read, user ........................................................................................................................ 40 Read, project .................................................................................................................... 40 Read, not exported ............................................................................................................ 41 Report ............................................................................................................................. 41 Add ................................................................................................................................. 42 Delete (id) ........................................................................................................................ 43 Modify (id) ........................................................................................................................ 44 Modify (Logo) .................................................................................................................... 46 Modify, custom equal to ..................................................................................................... 46 Submit ............................................................................................................................. 47 CreateAccount .................................................................................................................. 47 CreateUser ....................................................................................................................... 47 Auth ................................................................................................................................ 49 RemoteAuth ...................................................................................................................... 49 MakeURL .......................................................................................................................... 50 Whoami ........................................................................................................................... 52 Version ............................................................................................................................ 53 Approve ........................................................................................................................... 53 Reject .............................................................................................................................. 53 Unapprove ....................................................................................................................... 54 ModifyOnCondition ............................................................................................................ 54 Custom Fields ....................................................................................................................... 55 Requesting Custom Fields for a Datatype .............................................................................. 55 Reading Custom Field Values Inline with Native Fields ............................................................. 55 Reading Custom Field Values in a Separate Request ............................................................... 55 Adding or Modifying Records with Inline Custom Field Values ................................................... 56 Modifying Records to Set Custom Field Values ....................................................................... 56 Setting Allocation Grid Custom Field Values ........................................................................... 56 XML Datatypes ...................................................................................................................... 58 Actualcost ......................................................................................................................... 62 AccountingPeriod .............................................................................................................. 63 Address ........................................................................................................................... 63 Agreement ....................................................................................................................... 64 Agreement_to_project ........................................................................................................ 64 Approval .......................................................................................................................... 64 ApprovalLine ..................................................................................................................... 65 Approvalprocess ................................................................................................................ 66 Attachment ....................................................................................................................... 66 Attribute ........................................................................................................................... 66 AttributeDescription ........................................................................................................... 67 Attributeset ...................................................................................................................... 67 BillingSplit ........................................................................................................................ 67 Booking ........................................................................................................................... 68 BookingByDay ................................................................................................................... 68 BookingType ..................................................................................................................... 69 Booking_request ................................................................................................................ 69 Budget ............................................................................................................................. 70 BudgetAllocation ............................................................................................................... 70 Category .......................................................................................................................... 71 Category_1 ....................................................................................................................... 71 Category_2 ....................................................................................................................... 72 Category_3 ....................................................................................................................... 72 Category_4 ....................................................................................................................... 73 Category_5 ....................................................................................................................... 73 Ccrate .............................................................................................................................. 73 Company .......................................................................................................................... 74 Contact ............................................................................................................................ 74 Costcategory ..................................................................................................................... 75 Costcenter ........................................................................................................................ 76 Costtype ........................................................................................................................... 76 Currency .......................................................................................................................... 76 Currencyrate ..................................................................................................................... 77 CustField .......................................................................................................................... 77 Customer ......................................................................................................................... 78 CustomerLocation .............................................................................................................. 80 Customerpo ...................................................................................................................... 80 Customerpo_to_project ....................................................................................................... 81 CustomerProspect ............................................................................................................. 81 Date ................................................................................................................................ 82 Deal ................................................................................................................................ 83 Dealcontact ...................................................................................................................... 83 Dealschedule .................................................................................................................... 83 Department ...................................................................................................................... 84 Entitytag .......................................................................................................................... 84 Envelope .......................................................................................................................... 85 Error ................................................................................................................................ 85 Estimate ........................................................................................................................... 86 Estimateadjustment ........................................................................................................... 86 Estimateexpense ............................................................................................................... 86 Estimatelabor .................................................................................................................... 87 Estimatemarkup ................................................................................................................ 87 Estimatephase ................................................................................................................... 88 Event ............................................................................................................................... 88 ExpensePolicy ................................................................................................................... 88 ExpensePolicyItem ............................................................................................................. 89 Filter ................................................................................................................................ 89 Filterset ............................................................................................................................ 89 Flag ................................................................................................................................. 90 ForexInput ........................................................................................................................ 90 FormPermissionField .......................................................................................................... 90 Fulfillment ........................................................................................................................ 91 Hierarchy ......................................................................................................................... 91 HierarchyNode .................................................................................................................. 92 History ............................................................................................................................. 92 ImportExport .................................................................................................................... 92 Invoice ............................................................................................................................. 93 InvoiceLayout .................................................................................................................... 94 Issue ............................................................................................................................... 94 IssueCategory ................................................................................................................... 95 IssueSeverity ..................................................................................................................... 95 IssueSource ...................................................................................................................... 95 IssueStage ........................................................................................................................ 96 IssueStatus ....................................................................................................................... 96 Item ................................................................................................................................ 96 ItemToUserLocation ........................................................................................................... 97 Jobcode ............................................................................................................................ 97 JobCodeUsed .................................................................................................................... 98 Leave_accrual_rule ............................................................................................................. 98 Leave_accrual_rule_to_user .................................................................................................. 99 Leave_accrual_transaction ................................................................................................... 99 LoadedCost ...................................................................................................................... 99 Login ............................................................................................................................. 100 Module .......................................................................................................................... 100 Notes ............................................................................................................................. 100 Newsfeed ....................................................................................................................... 101 NewsfeedMessage ........................................................................................................... 101 Payment ......................................................................................................................... 101 Paymentterms ................................................................................................................. 102 Paymenttype ................................................................................................................... 102 Payrolltype ...................................................................................................................... 103 PendingBooking .............................................................................................................. 103 Preference ...................................................................................................................... 104 Product .......................................................................................................................... 104 Project ........................................................................................................................... 105 Projectassign ................................................................................................................... 108 ProjectAssignmentProfile ................................................................................................... 108 Projectbillingrule .............................................................................................................. 109 Projectbillingtransaction .................................................................................................... 112 ProjectBudgetGroup ......................................................................................................... 113 ProjectBudgetRule ........................................................................................................... 114 ProjectBudgetTransaction ................................................................................................. 115 Projectgroup ................................................................................................................... 116 Projectlocation ................................................................................................................. 116 Projectstage .................................................................................................................... 116 Projecttask ...................................................................................................................... 117 ProjecttaskEstimate .......................................................................................................... 119 Projecttask_type ............................................................................................................... 120 Projecttaskassign ............................................................................................................. 120 Proposal ......................................................................................................................... 121 Proposalblock .................................................................................................................. 122 Proxy ............................................................................................................................. 122 Purchase_item ................................................................................................................. 123 Purchaseorder ................................................................................................................. 124 Purchaser ....................................................................................................................... 125 Purchaserequest .............................................................................................................. 125 Ratecard ......................................................................................................................... 126 RateCardItem .................................................................................................................. 126 Reimbursement ............................................................................................................... 127 Repeat ........................................................................................................................... 127 Report ............................................................................................................................ 127 Request_item .................................................................................................................. 128 ResourceAttachment ........................................................................................................ 129 Resourceprofile ............................................................................................................... 129 Resourceprofile_type ........................................................................................................ 129 ResourceRequest ............................................................................................................. 130 ResourceRequestQueue .................................................................................................... 130 Resourcesearch ............................................................................................................... 131 RevenueContainer ............................................................................................................ 132 RevenueProjection ........................................................................................................... 133 Revenue_recognition_rule .................................................................................................. 135 Revenue_recognition_rule_amount ...................................................................................... 136 Revenue_recognition_transaction ........................................................................................ 137 RevenueStage ................................................................................................................. 138 Role ............................................................................................................................... 138 Schedulebyday ................................................................................................................ 138 Scheduleexception ........................................................................................................... 139 Schedulerequest .............................................................................................................. 139 Schedulerequest_item ....................................................................................................... 140 Slip ................................................................................................................................ 140 SlipProjection .................................................................................................................. 142 Slipstage ........................................................................................................................ 143 TagGroup ....................................................................................................................... 143 TagGroupAttribute ........................................................................................................... 143 TargetUtilization .............................................................................................................. 144 Task ............................................................................................................................... 144 TaskTimecard .................................................................................................................. 146 TaxLocation .................................................................................................................... 147 TaxRate .......................................................................................................................... 147 Term .............................................................................................................................. 148 Ticket ............................................................................................................................. 148 Timecard ........................................................................................................................ 149 Timesheet ....................................................................................................................... 150 Timetype ........................................................................................................................ 151 Todo .............................................................................................................................. 151 Uprate ........................................................................................................................... 152 User .............................................................................................................................. 152 UserLocation ................................................................................................................... 158 UserWorkschedule ........................................................................................................... 159 Vendor ........................................................................................................................... 159 Viewfilter ........................................................................................................................ 160 Viewfilterrule ................................................................................................................... 160 WorkscheduleWorkhour .................................................................................................... 161 Workspace ...................................................................................................................... 161 Workspacelink ................................................................................................................. 161 Workspaceuser ................................................................................................................ 162 Setting Application Switches Via the API .................................................................................. 163 Customizing the Application .................................................................................................. 164 Other Features .................................................................................................................... 167 Filters ............................................................................................................................. 167 Hints .............................................................................................................................. 168 IDs ................................................................................................................................ 168 Remaining Limit ............................................................................................................... 168 Code Examples .................................................................................................................... 170 Basic Example ................................................................................................................. 170 Intermediate Example ...................................................................................................... 171 Advanced Example ........................................................................................................... 172 Appendix A Error Code Listing ............................................................................................... 174 Error Responses .............................................................................................................. 174 Error Codes .................................................................................................................... 175 Appendix B Simple client (in perl) ........................................................................................... 188 Appendix C OpenAir Data Dictionary ....................................................................................... 190 Customer Table ............................................................................................................... 190 Appendix D Best Practices .................................................................................................... 196 Build the API Integration .................................................................................................. 196 Optimize the API Integration ............................................................................................. 197 Maintain the API Integration .............................................................................................. 198 Troubleshooting .................................................................................................................. 200 New Features ...................................................................................................................... 201 Interim Features .............................................................................................................. 201 Features for October 8, 2022 ............................................................................................. 201 Features for April 9, 2022 ................................................................................................. 201 Features for October 9, 2021 ............................................................................................. 201 Features for April 10, 2021 ................................................................................................ 202 Features for October 10, 2020 ........................................................................................... 202 Features for April 18, 2020 ................................................................................................ 202 Features for October 12, 2019 ........................................................................................... 203 Features for April 13, 2019 ................................................................................................ 203 Features for October 13, 2018 ........................................................................................... 203 Features for April 14, 2018 ................................................................................................ 204 Features for October 14, 2017 ........................................................................................... 204 Features for April 15, 2017 ................................................................................................ 204 Features for October 15, 2016 ........................................................................................... 205 Features for April 16, 2016 ................................................................................................ 206 Features for October 17, 2015 ........................................................................................... 206 Features for April 18, 2015 ................................................................................................ 206 Features for October 18, 2014 ........................................................................................... 206 Features for May 17, 2014 ................................................................................................ 207 Features for February 15, 2014 .......................................................................................... 207 Features for November 16, 2013 ........................................................................................ 207 Features for August 17, 2013 ............................................................................................ 208 Features for May 18, 2013 ................................................................................................ 208 Features for March 16, 2013 ............................................................................................. 209 Features for January 19, 2013 ............................................................................................ 209 Features for November 17, 2012 ........................................................................................ 209 Features for July 14, 2012 ................................................................................................. 209 Features for May 12, 2012 ................................................................................................ 210 Features for March 17, 2012 ............................................................................................. 210 Features for January 21, 2012 ............................................................................................ 211 Features for November 19, 2011 ........................................................................................ 211 Features for September 17, 2011 ....................................................................................... 211 Features for May 14, 2011 ................................................................................................ 212 Features for March 19, 2011 ............................................................................................. 213 Features for January 22, 2011 ............................................................................................ 213 Features for November 20, 2010 ........................................................................................ 214 Features for September 18, 2010 ....................................................................................... 214 Features for July 17, 2010 ................................................................................................. 215 Features for May 15, 2010 ................................................................................................ 215 Features for March 20, 2010 ............................................................................................. 216 Features for January 23, 2010 ............................................................................................ 216 Features for November 21, 2009 ........................................................................................ 217 Introduction to OpenAir XML API 1 Introduction to OpenAir XML API OpenAir provides OpenAir XML API as a layer for the exchange of OpenAir data between the main site and peripheral programs. These programs include partnered Web sites, OpenAir in-house applications that do not need direct database access, and third party applications indirectly supported through OpenAir. Before you begin using this service, we recommend that you review Appendix D Best Practices. The application programming interface (API) is data-centric, but it is not a direct line into the OpenAir database. While it provides access to much of the information on OpenAir, it is a layer of indirection from the actual database structure. OpenAir's database structure may change, but applications that use the API will not need to change. Technology OpenAir XML API is based on industry standard components: HTTPS (Secure Hypertext Transfer Protocol) and XML (Extensible Markup Language). Standard Name Web Site Reference RFC2660 The Secure HyperText Transfer Protocol http://rfc.net/rfc2660.html Extensible Markup Language (XML) 1.0 (Fourth Edition) http://www.w3.org/TR/xml/ Much of the work in implementing an API-aware client can be done using off-the-shelf parts. HTTPS is used for the transport layer, providing an easy avenue to encrypt transactions. XML is used both for the command syntax (asking for information) and for the actual data content (packaging the requested information). The HTTPS request is presented in a PUT or POST request, and the response is the resulting document. XML is essentially a subset of SGML (Standard Generalized Markup Language) and, unlike HTML, has the advantage of being able to handle user-defined tags. XML has a context-dependent, nested structure. XML tags provide a context for the data contained within each of them. This allows you to send meaningful information easily and quickly over the World Wide Web. XML is particularly suited to the transfer of data to and from databases. For the information to be useful, it must be properly identified. Since the OpenAir services are database-driven, it is important that the information you collect from your users is compatible with the fields in the database. We provide you with the list of XML commands and datatypes that are meaningful to an OpenAir database. Through the use of commands and datatypes provided by the API and by limiting the values that can be stored in each datatype, your data will always be consistent with, and able to be stored within, an OpenAir database. Target Audience This document is intended for developers of applications that will connect to the OpenAir Web site. Overview ■ Namespaces and Connecting to the API — addresses how to access namespaces and shows you how to connect to the OpenAir API. ■ XML Commands — lists XML commands for each possible method. Provides associated code, results returned, and additional information and examples. XML API Reference Guide