WebFOCUS RESTful Web Services Developer's Guide


Copyright © 2018 Information Builders

This documentation describes how to develop and use WebFOCUS RESTful Web Services. It is intended for experienced developers who will use this capability to expose WebFOCUS functionality as callable services from a Microsoft Visual Studio .NET or J2EE development platform. Developers should have knowledge of RESTful web service technology and object oriented programming.

How This Manual Is Organized

This manual includes the following chapters:




Introducing WebFOCUS RESTful Web Services

Provides an introduction to REST and RESTful web services in the context of WebFOCUS.


WebFOCUS Managed Reporting RESTful Web Service Requests

Describes the format and structure of WebFOCUS authentication and Managed Reporting RESTful web service requests.


WebFOCUS Reporting Server RESTful Web Service Requests

Describes the format and structure of WebFOCUS Reporting Server RESTful web service requests.


WebFOCUS Security Administration RESTful Web Service Requests

Describes the format and structure of WebFOCUS security administration web service requests.


ReportCaster RESTful Web Service Requests

Describes the format and structure of ReportCaster RESTful web service requests.


Using the RESTful Web Services Test Page

Describes how to use the Test page to test and debug the functionality of RESTful web services.


Alternative Method of Calling WebFOCUS RESTful Web Service Requests

Describes an alternative method of calling WebFOCUS RESTful web service requests.


Visual Basic .NET, Java, HTML and jQuery Code Examples

Provides Visual Basic .NET, Java, HTML and jQuery code examples on how to create WebFOCUS RESTful web service requests.

Documentation Conventions

The following table describes the documentation conventions that are used in this manual.





this typeface

Denotes syntax that you must enter exactly as shown.

this typeface

Represents a placeholder (or variable), a cross-reference, or an important term.


Indicates a default setting.

Key + Key

Indicates keys that you must press simultaneously.

{ }

Indicates two or three choices. Type one of them, not the braces.

[ ]

Indicates a group of optional parameters. None is required, but you may select one of them. Type only the parameter in the brackets, not the brackets.


Separates mutually exclusive choices in syntax. Type one of them, not the symbol.


Indicates that you can enter a parameter multiple times. Type only the parameter, not the ellipsis (...).




Indicates that there are (or could be) intervening or additional commands.

Related Publications

Visit our Technical Content Library at http://documentation.informationbuilders.com. You can also contact the Publications Order Department at (800) 969-4636.

Customer Support

Do you have any questions about this product?

Join the Focal Point community. Focal Point is our online developer center and more than a message board. It is an interactive network of more than 3,000 developers from almost every profession and industry, collaborating on solutions and sharing tips and techniques. Access Focal Point at http://forums.informationbuilders.com/eve/forums.

You can also access support services electronically, 24 hours a day, with InfoResponse Online. InfoResponse Online is accessible through our website, http://www.informationbuilders.com. It connects you to the tracking system and known-problem database at the Information Builders support center. Registered users can open, update, and view the status of cases in the tracking system and read descriptions of reported software issues. New users can register immediately for this service. The technical support section of www.informationbuilders.com also provides usage techniques, diagnostic tips, and answers to frequently asked questions.

Call Information Builders Customer Support Services (CSS) at (800) 736-6130 or (212) 736-6130. Customer Support Consultants are available Monday through Friday between 8:00 a.m. and 8:00 p.m. EST to address all your questions. Information Builders consultants can also give you general guidance regarding product capabilities. Please be ready to provide your six-digit site code number (xxxx.xx) when you call.

To learn about the full range of available support services, ask your Information Builders representative about InfoResponse Online, or call (800) 969-INFO.

Information You Should Have

To help our consultants answer your questions effectively, be prepared to provide the following information when you call:

User Feedback

In an effort to produce effective documentation, the Technical Content Management staff welcomes your opinions regarding this document. You can contact us through our website, http://documentation.informationbuilders.com/connections.asp.

Thank you, in advance, for your comments.

Information Builders Consulting and Training

Interested in training? Information Builders Education Department offers a wide variety of training courses for this and other Information Builders products.

For information on course descriptions, locations, and dates, or to register for classes, visit our website (http://education.informationbuilders.com) or call (800) 969-INFO to speak to an Education Representative.