XML API Reference Guide - OpenAir

1 XML API Reference GuideOctober 9, 2021 Copyright 2013, 2021, oracle and/or its software and related documentation are provided under a license agreement containing restrictionson use and disclosure and are protected by intellectual property laws. Except as expressly permittedin 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 anymeans. Reverse engineering, disassembly, or decompilation of this software, unless required by law forinteroperability, is information contained herein is subject to change without notice and is not warranted to be error-free.

2 If you find any errors, please report them to us in this is software or related documentation that is delivered to the Government or anyone licensing iton behalf of the Government, then the following notice is GOVERNMENT END USERS: oracle programs (including any operating system, integrated software,any programs embedded, installed or activated on delivered hardware, and modifications of suchprograms) and oracle computer documentation or other oracle data delivered to or accessed Government end users are "commercial computer software" or "commercial computer softwaredocumentation" pursuant to the applicable Federal Acquisition Regulation and agency-specificsupplemental regulations. As such, the use, reproduction, duplication, release, display, disclosure,modification, preparation of derivative works, and/or adaptation of i) oracle programs (including anyoperating system, integrated software, any programs embedded, installed or activated on deliveredhardware, and modifications of such programs), ii) oracle computer documentation and/or iii) otherOracle data, is subject to the rights and limitations specified in the license contained in the applicablecontract.

3 The terms governing the Government's use of oracle cloud services are defined by theapplicable contract for such services. No other rights are granted to the software or hardware is developed for general use in a variety of information managementapplications. It is not developed or intended for use in any inherently dangerous applications, includingapplications that may create a risk of personal injury. If you use this software or hardware in dangerousapplications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and othermeasures to ensure its safe use. oracle Corporation and its affiliates disclaim any liability for any damagescaused by use of this software or hardware in dangerous and Java are registered trademarks of oracle and/or its affiliates.

4 Other names may be trademarksof their respective and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarksare 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 aregistered trademark of The Open 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 andexpressly disclaim all warranties of any kind with respect to third-party content, products, and servicesunless otherwise set forth in an applicable agreement between you and oracle .

5 oracle Corporation andits affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or useof third-party content, products, or services, except as set forth in an applicable agreement between youand 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 preliminaryuse only. It may not be specific to the hardware on which you are using the software. oracle Corporationand its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect tothis documentation and will not be responsible for any loss, costs, or damages incurred due to the use ofthis this document is in private pre-General Availability status:The information contained in this document is for informational sharing purposes only and should beconsidered in your capacity as a customer advisory board member or pursuant to your pre-GeneralAvailability trial agreement only.

6 It is not a commitment to deliver any material, code, or functionality, andshould not be relied upon in making purchasing decisions. The development, release, timing, and pricingof any features or functionality described in this document may change and remains at the sole discretionof document in any form, software or printed matter, contains proprietary information that is theexclusive property of oracle . Your access to and use of this confidential material is subject to the termsand conditions of your oracle Master Agreement, oracle License and Services Agreement, OraclePartnerNetwork Agreement, oracle distribution agreement, or other license agreement which hasbeen executed by you and oracle and with which you agree to comply.

7 This document and informationcontained herein may not be disclosed, copied, reproduced, or distributed to anyone outside Oraclewithout prior written consent of oracle . This document is not part of your license agreement nor can it beincorporated into any contractual agreement with oracle or its subsidiaries or AccessibilityFor information about oracle 's commitment to accessibility, visit the oracle Accessibility Program websiteat to oracle SupportOracle customers that have purchased support have access to electronic support through My OracleSupport. For information, visit or visit you are hearing CodeOracle may provide sample code in SuiteAnswers, the Help Center, User Guides, or elsewhere throughhelp links.

8 All such sample code is provided "as is and as available , for use only with an authorizedNetSuite Service account, and is made available as a SuiteCloud Technology subject to the SuiteCloudTerms of Service at , where the term Service shall mean the OpenAir may modify or remove sample code at any time without Excessive Use of the ServiceAs the Service is a multi-tenant service offering on shared databases, Customer may not use the Servicein excess of limits or thresholds that oracle considers commercially reasonable for the Service. If Oraclereasonably concludes that a Customer s use is excessive and/or will cause immediate or ongoingperformance issues for one or more of oracle s other customers, oracle may slow down or throttleCustomer s excess use until such time that Customer s use stays within reasonable limits.

9 If Customer sparticular usage pattern requires a higher limit or threshold, then the Customer should procure asubscription to the Service that accommodates a higher limit and/or threshold that more effectively alignswith the Customer s actual usage of ContentsIntroduction 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 Authorization .. 9 Managing API Integration Applications in OpenAir .

10 9 OAuth for Integration Applications Developers .. 17 Authorizing Applications to Access OpenAir on Your Behalf .. 27 Auditing and Managing OAuth 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.