Skip to end of metadata
Go to start of metadata


This sample demonstrates how to view a document using OpenDocument URL using BI Platform RESTful Web Service APIs with .NET. BI Platform RESTful Web Services is used to obtain logon token which is used to to authenticate with OpenDocument.


  1. Going through Exploring BI4 Platform RESTful Web Services with REST browser plugins  will be crucial before developing the code in .NET. Getting the thorough knowledge of RESTful Web Services API on how to use it from browser plugins/tools is must.
  2. Basic knowledge of WebRequest and WebResponse classes of System.Net namespace.
  3. A BI4 system with at least Feature Pack 3 or greater patch level.

Sample Code

        string userName = "administrator";
        string password = "password";
        string auth = "secEnterprise";       
        string baseURL = "http://BI40SP5W08:6405/biprws/";
        string LogonURI = baseURL + "logon/long";
        string logonToken;
        string docURL = "http://BI40SP5W08:8080/BOE/OpenDocument/opendoc/openDocument.jsp?sIDType=CUID&iDocID=AW4AVT1AUhVAogA6P7OQv9c";

        //Making GET Request to  /logon/long to receive XML template.
        WebRequest myWebRequest = WebRequest.Create(LogonURI);
        myWebRequest.ContentType = "application/xml";
        myWebRequest.Method = "GET";

	//Returns the response to the request made
        WebResponse myWebResponse = myWebRequest.GetResponse();
	//Creating an instance of StreamReader to read the data stream from the resource
        StreamReader sr = new StreamReader(myWebResponse.GetResponseStream());
	//Reads all the characters from the current position to the end of the stream and store it as string
        string output = sr.ReadToEnd();
        //Initialize a new instance of the XmlDocument class
        XmlDocument doc = new XmlDocument();
	//Loads the document from the specified URI
        //Returns an XmlNodeList containing a list of all descendant elements 
        //that match the specified name i.e. attr
        XmlNodeList nodelist = doc.GetElementsByTagName("attr");
	//  Add the logon parameters to the attribute nodes of the document
        foreach (XmlNode node in nodelist)
            if (node.Attributes["name"].Value == "userName")
                node.InnerText = userName;

            if (node.Attributes["name"].Value == "password")
                node.InnerText = password;

            if (node.Attributes["name"].Value == "auth")
                node.InnerText = auth;
       //Making POST request to /logon/long to receive a logon token
       WebRequest myWebRequest1 = WebRequest.Create(LogonURI);
       myWebRequest1.ContentType = "application/xml";
       myWebRequest1.Method = "POST";

       byte[] reqBodyBytes = System.Text.Encoding.Default.GetBytes(doc.OuterXml); 

       Stream reqStream = myWebRequest1.GetRequestStream();
       reqStream.Write(reqBodyBytes, 0, reqBodyBytes.Length);
           WebResponse myWebResponse1 = myWebRequest1.GetResponse();
           StreamReader sr1 = new StreamReader(myWebResponse1.GetResponseStream());
           string output1 = sr1.ReadToEnd();

           XmlNodeList nodelist1 = doc.GetElementsByTagName("attr");
           if (nodelist1[0].Attributes["name"].Value== "logonToken")
	       //Finding the value of the logonToken
               logonToken = nodelist1[0].InnerText;
	       //Encoding the logonToken
               string encodedToken = Server.UrlEncode(logonToken);
	       //Appending the encoded token to the OpenDocument URL
               string finalUrl = docURL + "&X-SAP-LogonToken=" + encodedToken;

       catch (WebException err)
           //error while accessing the network through a pluggable protocol
           Response.Write("<b>" + err.Message + "</b>");
       catch (Exception err)
           //generic error
           Response.Write("<b>" + err.Message + "</b>");

Related Content