PUBLIC SAP BusinessObjects Business Intelligence platform Document Version: 4.2 SP6 – 2018-07-18 Business Intelligence Platform RESTful Web Service Developer Guide Content 1 Document History..............................................................8 2 Getting Started............................................................... 11 3 Setting up the development environment........................................... 12 3.1 Supported programming languages..................................................12 3.2 Using Ajax and JavaScript with RESTful web services across domains..........................13 4 Using the SDK................................................................15 4.1 Retrieving the base URL for RESTful web service requests..................................15 Retrieving the base URL through the CMC...........................................15 Retrieving the base URL programmatically.......................................... 15 4.2 Making RESTful web service requests................................................ 16 Creating the request header.....................................................21 Creating the request body......................................................22 Interpreting the response header.................................................22 Interpreting a response body in XML format.........................................25 Interpreting a response body in the JSON format......................................29 Comparison of XML and JSON attributes...........................................35 Working with multilingual data...................................................38 4.3 Authentication................................................................ 38 To get a logon token from a user name and password...................................39 To get a logon token from a serialized session or session token............................ 41 To get a logon token using an Active Directory Single Sign-On (AD SSO) account...............43 To get a logon token using trusted authentication..................................... 44 Converting a logon token from XML-encoded text.....................................46 To add a logon token to a request header............................................47 Using HTTP basic authentication.................................................48 To log off the BI platform.......................................................49 Using authenticated sessions obtained from other SDKs................................50 SAML Configuration for REST end point............................................52 4.4 Using logon tokens with OpenDocument URLs..........................................56 4.5 Navigating the BI platform repository................................................ 58 To view the top level of the BI platform repository......................................59 To retrieve an object by ID......................................................60 To retrieve an object by CUID....................................................61 To access child objects........................................................ 61 To use pagination with results................................................... 63 Business Intelligence Platform RESTful Web Service Developer Guide 2 PUBLIC Content To filter results by type........................................................ 64 To access objects with relationships...............................................65 4.6 Scheduling...................................................................68 To discover the scheduling URLs for an object........................................69 To schedule a resource........................................................70 4.7 Configuring RESTful Web Services for Tomcat Server..................................... 72 4.8 Configuring RESTful Web Services for WebSphere Server.................................. 72 5 Administration and installation tasks.............................................. 74 5.1 To install RESTful web services on Windows............................................74 5.2 To install RESTful web services on Unix............................................... 75 5.3 To configure web.xml to enable WinAD SSO............................................75 5.4 To configure Methods and Headers command line parameters...............................77 5.5 To configure the base URL for RESTful web services......................................78 5.6 To enable the error message stack...................................................79 5.7 To set the default number of entries displayed on each page................................ 79 5.8 To set the timeout value of a logon token..............................................80 5.9 To configure session pool settings...................................................80 5.10 To enable HTTP basic authentication.................................................81 5.11 To configure cross-origin resource sharing (CORS) .......................................82 5.12 To enable and configure trusted authentication......................................... 82 5.13 Securing Microsoft Silverlight access to the WACS server..................................83 6 Configuring Recipient Delivery Rules...............................................85 7 API Reference................................................................86 7.1 About API Reference and Prerequisites...............................................86 7.2 Fetching Information About the Build.................................................88 7.3 Fetching the Timezone Information..................................................89 7.4 Authentication................................................................ 89 /v1/logon/long..............................................................89 /v1/logon/token.............................................................92 /v1/logon/adsso.............................................................95 /v1//logon/trusted...........................................................97 /v1//logon/trustedx509...................................................... 100 /v1/logoff.................................................................101 7.5 Managing Scheduling...........................................................102 Getting Template for Scheduling.................................................103 Creating Schedule now....................................................... 105 Creating Schedule Once.......................................................107 Creating Hourly Schedule......................................................110 Creating Daily Schedule.......................................................112 Business Intelligence Platform RESTful Web Service Developer Guide Content PUBLIC 3 Creating Weekly Schedule..................................................... 115 Creating Monthly Schedule.....................................................118 Creating Schedule for Nth Day of Month...........................................120 Creating Schedule for First Monday of the Month.....................................123 Creating Schedule for Calendar .................................................126 Creating Schedule for Xth Day of Nth Week of a Month .................................128 Creating Schedule for Last Day of the Month........................................ 131 Getting Instances for a Report.................................................. 134 Getting Instance Details of a Report.............................................. 135 Getting Schedule List for a Report................................................138 Getting Instances Details of a Schedule............................................139 Sorting and Filtering..........................................................141 Getting Details of a Schedule...................................................142 Finding Available Server Groups for Scheduling......................................144 Fetching Available Calendars and Calendar Dates.....................................145 7.6 Managing Users...............................................................146 Creating New User...........................................................147 Getting User Details......................................................... 150 Modifying User Details........................................................151 Specifying Locale and Time-zone information for current user............................153 Listing Available Locales and Timezones...........................................155 Changing Password of Current User.............................................. 157 Changing password of ABAP User................................................158 7.7 Deleting Users................................................................160 7.8 Listing Users................................................................. 161 7.9 Managing User Groups..........................................................165 Listing User Group.......................................................... 166 Creating New User Group......................................................170 Getting User Group Details.....................................................172 Listing All Users in an User Group................................................173 Adding Users to a User Group...................................................177 Removing Users from a User Group...............................................178 Listing User Groups in a User Group.............................................