Invoking Oracle Business Intelligence Web Services Over HTTPS

1-4 Oracle Fusion Middleware Integrators Guide for Oracle Business Intelligence Enterprise Edition into the appropriate keystore of the Web services client that is calling these Web services. Oracle recommends that in a production environment you use a certificate signed by a well-know certificate authority. Use the following procedure to confirm the location of the root certificate of the Managed Servers that the Web services client needs to trust. To confirm the location of the root certificate: 1. Open the Weblogic console in a browser. By default, the location of the Weblogic console is: http:host:7001console. 2. From the Oracle WebLogic Server Administration Console, select the SSL tab and go to the Identity area. By default, the Certificate location is from the Demo Identity Keystore. If this is the case, navigate to the Keystores tab and review the location of the Demo Identity Keystore. Note that the Demo Identity Keystore’s default location is: middleware_homewlserver_10.3_serverlibDemoIdentity.jks 3. Use the Oracle Keytool utility to view and export the root certificate. 2 Description of Structures in Oracle BI EE Web Services 2-1 2 Description of Structures in Oracle BI EE Web Services This chapter describes the structures used by Oracle BI EE Web Services. This chapter contains the following sections: ■ Section 2.1, AccessControlToken Structure ■ Section 2.2, Account Structure ■ Section 2.3, ACL Structure ■ Section 2.4, ArrayofGUIDS Structure ■ Section 2.5, AuthResult Structure ■ Section 2.6, CatalogItemsFilter Structure ■ Section 2.7, CatalogObject Structure ■ Section 2.8, ErrorInfo Structure ■ Section 2.9, GetSubItemsParams Structure ■ Section 2.10, ImportError Structure ■ Section 2.11, ItemInfo Structure ■ Section 2.12, NameValuePair Structure ■ Section 2.13, PathMap Structure ■ Section 2.14, Privilege Structure ■ Section 2.15, QueryResults Structure ■ Section 2.16, ReportHTMLOptions Structure ■ Section 2.17, ReportParams Structure ■ Section 2.18, ReportRef Structure ■ Section 2.19, SAColumn Structure ■ Section 2.20, SASubjectArea Structure Note: This document uses JavaScript-like syntax to describes structures. The exact syntax and implementation depends on the SOAP code generation tool and the target language used by your application development environment. 2-2 Oracle Fusion Middleware Integrators Guide for Oracle Business Intelligence Enterprise Edition ■ Section 2.21, SATable Structure ■ Section 2.22, SAWLocale Structure ■ Section 2.23, SAWSessionParameters Structure ■ Section 2.24, SegmentationOptions Structure ■ Section 2.25, SessionEnvironment Structure ■ Section 2.26, StartPageParams Structure ■ Section 2.27, TreeNodePath Structure ■ Section 2.28, UpdateACLParams Structure ■ Section 2.29, UpdateCatalogItemACLParams Structure ■ Section 2.30, Variable Structure ■ Section 2.31, XMLQueryExecutionOptions Structure

2.1 AccessControlToken Structure

Use this structure to describe permissions granted to a specific account in the access control list. This structure is used in the SecurityService Service . Table 2–1 lists the fields in this structure.

2.2 Account Structure

Use this structure to hold user names or group names. It has a flag to indicate whether the name is a user or a group. This structure is used in the SecurityService Service . Table 2–2 lists the fields in this structure. Table 2–1 AccessControlToken Structure Fields Fields Description Account account Specifies a reference to the Account structure. int permissionMask Specifies a combination of the following flags: 1 = Permission to read item content 2 = Permission to traverse directory 4 = Permission to change item content 8 = Permission to delete an item 16 = Permission to assign permissions to other accounts 32 = Permission to take ownership of the item 2048 = Permission to run an Oracle BI Publisher report live 4096 = Permission to schedule an Oracle BI Publisher report 8192 = Permission to view output from an Oracle BI Publisher report Table 2–2 Account Structure Fields Fields Description String accountName Specifies an account name or group name. Description of Structures in Oracle BI EE Web Services 2-3

2.3 ACL Structure

Use this structure to hold the access control list ACL. This structure is used in the SecurityService Service . Table 2–3 list the fields in this structure.

2.4 ArrayofGUIDS Structure

Use this structure to specify a list of GUIDs representing a saved result set. This structure is used in the SecurityService Service . Table 2–4 lists the field in this structure.

2.5 AuthResult Structure

Use this structure to specify authorization details during an authentication. This structure is used in the SecurityService Service in the impersonateex Method and logonex Method . Table 2–5 lists the fields in this structure. int accountType Specifies whether the account is a user or a group or both 0 = user, 1 = catalog group, 2 = app role, 3 = all. Note the following information for advanced use of this field. If accountType is greater than or equal to 4, the system treats the Name or GUID as a pattern. Namely, accountType may be 4 for fetching users, 5 for fetching cat groups, 6 for fetching app roles, 7 all pattern. Using this field in this way can be expensive, slow, and result in the system returning many records. When receiving an Account, both Name and GUID are set. The accountType will be 0 for user, 1 for catalog group, 4 for application role. String GUID Specifies the unique ID which identifies the account. Table 2–3 ACL Structure Fields Fields Description AccessControlToken[] accessControlTokens Specifies the full list of permissions. String dummy For internal purposes. Table 2–4 ArrayofGUIDS Structure Fields Fields Description String[] guid Specifies a list of GUIDs representing the saved result set. Table 2–5 AuthResult Structure Fields Fields Description String sessionID Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. Table 2–2 Cont. Account Structure Fields Fields Description