SAP Crystal Reports RESTful Web Services Developer Guide

PUBLIC

SAP BusinessObjects Business Intelligence platform

Document Version: 4.3 – 2020-06-12

SAP Crystal Reports RESTful Web Services

Developer Guide

THE BEST RUN

Content

1 Document History........................................................... 4

2 Start here..................................................................5

2.1 Introduction to SAP Crystal Reports RESTful web services................................5

3 RESTful web services fundamentals..............................................6

3.1 Making RESTful web service requests...............................................6

Creating the request header.................................................. 11

Creating the request body....................................................12

Interpreting the response header...............................................12

Interpreting a response body in XML format.......................................15

Interpreting a response body in the JSON format................................... 19

Comparison of XML and JSON attributes.........................................25

Working with multilingual data................................................ 28

3.2 Retrieving the base URL for RESTful web service requests............................... 29

Retrieving the base URL through the CMC........................................29

Retrieving the base URL programmatically........................................29

3.3 Authentication..............................................................30

To get a logon token from a user name and password.................................31

To get a logon token from a serialized session or session token..........................33

To get a logon token using an Active Directory Single Sign-On (AD SSO) account.............35

To get a logon token using trusted authentication...................................37

Converting a logon token from XML-encoded text...................................39

To add a logon token to a request header.........................................39

Using HTTP basic authentication.............................................. 40

To log o the BI platform.................................................... 42

Using authenticated sessions obtained from other SDKs..............................43

SAML Conguration for REST Endpoint..........................................45

3.4 Retrieving the report ID........................................................48

To retrieve the report ID programatically......................................... 48

4 Using the SAP Crystal Reports RESTful web services API.............................51

4.1 Common URIs.............................................................. 51

4.2 Report URI.................................................................52

4.3 Report Metadata............................................................ 53

4.4 Report instances............................................................ 60

To create a transient report instance from an existing report............................61

4.5 Exporting..................................................................63

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Content

Character separated value (CSV) parameters......................................65

Microsoft Excel parameters.................................................. 66

Microsoft Excel Data-Only parameters...........................................68

Rich Text Format (RTF) parameters.............................................70

Tab separated text (TTX) parameters........................................... 70

XML parameters.......................................................... 71

4.6 Interactive parameters.........................................................71

4.7 OData Protocol..............................................................73

Accessing the OData service document..........................................74

Grand totals............................................................. 74

Groups.................................................................76

Metadata...............................................................80

Rows...................................................................81

SAP Crystal Reports RESTful Web Services Developer Guide

Content

PUBLIC 3

1 Document History

The following table provides an overview of the most important document changes.

Version

Date Changes

SAP BusinessObjects

Business Intelligence plat

form 4.3

June, 2020 Initial release

4 PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Document History

2 Start here

This online help is designed to help you develop your own Web or desktop applications with the SAP Crystal

Reports RESTful web services. It includes examples and programming references that you can use to

implement the SAP Crystal Reports RESTful web services.

2.1 Introduction to SAP Crystal Reports RESTful web

services

SAP Crystal Reports RESTful web services allow SAP Crystal Reports for Enterprise report data managed in a

SAP BusinessObjects Business Intelligence Platform repository to be consumed and embedded in mobile

devices and web-enabled technology. You can fetch report content in XML or JSON format, and manipulate a

report using the RESTful API and OData services. RESTful web services allow you to create applications using

the development language of your choice.

SAP Crystal Reports RESTful web services allow you to:

● Export a report to a number of dierent le types

● Retrieve report metadata.

● Get rows of data and calculations.

● Push a row of data to the report.

● Get and set report parameters.

● Retrieve data in XML or JSON format.

 Note

You can only work with reports created with SAP Crystal Reports for Enterprise when using the RESTful

web services.

SAP Crystal Reports RESTful Web Services Developer Guide

Start here

PUBLIC 5

3 RESTful web services fundamentals

In this section, you explore the fundamentals of the RESTful web services API. These fundamentals overlap

with functionality provided by the SAP Business Intelligence platform RESTful web services API.

For more information see the Business Intelligence Platform RESTful Web Services Developer Guide

3.1 Making RESTful web service requests

To access the Business Intelligence platform RESTful web service SDK, you send HTTP requests to the URL

that hosts the RESTful web services. The RESTful web service processes the request and returns a response

that contains the requested information. You can access RESTful web services with any programming language

or tool that supports HTTP requests. RESTful web services follow HTTP standards and the AtomPub

specication, but also include custom attributes.

Requests consist of two main components, the request header and the request body. The request header

denes the format of the request body, the accepted response format, and other custom settings such as the

preferred language and the logon token. The request body may be left blank, or it may contain additional

information needed to complete the request. For example, an authentication request passes the user name

and password as formatted XML in the request body.

To make a RESTful web service request, you need the following:

● URL - The URL that hosts the RESTful web service.

● Method - The type of HTTP method to use for sending the request, for example GET, PUT, POST, or

DELETE.

● Request header - The attributes that describe the request.

● Request body - Additional information that is used to process the request.

Once the request has been processed, you will receive a response. Responses contain the requested

information, and include supporting information that you need to complete your next step. For example,

responses may contain XML templates that can be used to populate the request body of subsequent requests,

or they may contain links to related RESTful URLs, including parent folders, child folders, pages of additional

information, and related links. By following the information provided by a RESTful response, you can navigate

the requested data and obtain the templates you need in order to complete subsequent requests.

The Business Intelligence platform RESTful web service responses may be formatted as XML or JSON

depending on the capabilities of the BI platform client application.

RESTful web service responses contain two main components:

● Response header - A list of attributes that describes the response format, and includes an HTTP response

code.

● Response body - The requested information, and additional information that enables you to complete

subsequent requests.

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

The examples in this document dene the URL, method, request header attributes, and request body content

that is required for each RESTful request. You can access the RESTful web services using any programming

language or tool that supports HTTP requests.

Example: A RESTful POST request using the /logon/long API and response

using the XML format

This example shows a RESTful request that logs on to the BI platform repository.

Request

URL: http://localhost:6405/biprws/logon/long

Method: POST

Request header attributes:

Attribute Value

Content-Type application/xml

Accept application/xml

Request body:

<attr name="userName" type="string">username</attr>

<attr name="password" type="string">password</attr>

<attr name="auth" type="string"

possibilities="secEnterprise,secLDAP,secWinAD">secEnterprise</attr>

</attrs>

Response

Response header:

Attribute Value

Status code 200 OK

Server Apache-Coyote/1.1

X-SAP-LogonToken "COMMANDCOM-LCM:

6400@{3&2=5542,U3&p=40680.8979564815,Y7&4F=12,U

3&63=secEnterprise,

0P&66=60,03&68=secEnterprise:Administrator,

0P&qe=100,U3&vz=TZnoIE2yQyeLCkAlnHtaaYUHon5.p0y

TkSaUiLC8SSM,UP}"

Date Tue, 17 May 2011 21:33:03 GMT

Content-Type application/xml

Content-Length 586

Response body:

<author><name>@COMMANDCOM-LCM:6400</name></author>

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 7

<id>tag:sap.com,2010:bip-rs/logon/long</id>

<title type="text">Logon Result</title>

<attr name="logonToken" type="string">COMMANDCOM-LCM:6400@{3&

2=5542,U3&am....YUHon5.p0yTkSaUiLC8SSM,UP}</attr>

</attrs>

</content>

</entry>

Example: A RESTful GET and POST request using the /logon/long API and

response using the JSON format

This example shows a RESTful request that uses a GET request to retrieves a JSON formatted request body to

use to enter the name and password and authentication type, then using a POST request to retrieve a logon

token from the BI platform repository.

Request

URL: http://localhost:6405/biprws/logon/long

Method: GET

Request header attributes:

Attribute Value

Accept application/json

The request body that is returned in JSON format after a GET request appears as follows:

{"userName":"","password":"","auth":"secEnterprise"}

Request body that has an name label, for example BOEuser and password, for example BOEPassword999

included before sending it as a POST request as showed in the following code snippet:

{"userName":"BOEuser","password":"BOEPassword999","auth":"secEnterprise"}

 Note

The auth default value is secEnterprise. The authentication types that may be used include are as

follows:

● secEnterprise - Enterprise authentication

● secLDAP - Lightweight Directory Access Protocol authentication

● secWinAD - Windows Active Directory authentication

● secSAPR3 - SAP authentication

Response header after a POST request:

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

Attribute Value

Status code 200 OK

Server Apache-Coyote/1.1

X-SAP-LogonToken :"COMMANDCOM-LCM:

6400@{3&2=5571,U3&p=40897.0049317824,Y7&4F=12,U3

&63=secEnterprise,

0P&66=60,03&68=secEnterprise:BOEuser,

0P&qe=100,U3&vz=odiw9uLc1kVlJf9lggLFEWPAX3qsFWB

T1LkdE2DTGhY,UP}"

Date Tue, 17 December 2011 21:33:03 GMT

Content-Type application/json

Content-Length 204

Response body in JSON format:

{"logonToken":"COMMANDCOM-LCM:

6400@{3&2=5571,U3&p=40897.0049317824,Y7&4F=12,U3&63=secEnterprise,

0P&66=60,03&68=secEnterprise:Administrator,0P&qe=100,U3&vz=odiw9uLc1kVlJf

9lggLFEWPAX3qsFWBT1LkdE2DTGhY,UP}"}

Example: A RESTful infostore JSON-formatted request

This example shows a RESTful request that uses a GET request and the /infostore API with a logon token to

request information from BI platform repository that is returned in JSON format.

Request

URL: http://commandcom-lcm:6405/biprws/infostore

Method: GET

Request header attributes:

Attribute Value

Accept application/json

X-SAP-LogonToken COMMANDCOM-LCM:

6400@{3&2=5542,U3&p=40680.897...UiLC8SS

Request body: (blank)

Response

Response header:

Attribute

Value

Status code 200 OK

Server Apache-Coyote/1.1

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 9

Attribute Value

X-SAP-LogonToken COMMANDCOM-LCM:

6400@{3&2=5542,U3&p=40680.897...UiLC8SSM,UP}

Date Tue, 17 December 2011 21:33:03 GMT

Content-Type application/json

Content-Length 6919

Response body formatted as JSON. For clarity in the following code snippet, the back slash for escaped

characters such as ( / ) and ( " ) have been removed.

{

"__metadata":

{"uri":"http://localhost:9998/biprws/infostore/Root%20Folder/children?

page=1&pageSize=3"},

"first":

{"__deferred":

{"uri":"http://localhost:9998/biprws/infostore/Root%20Folder/children?

page=1&pageSize=3"}

"next":

{"__deferred":

{"uri":"http://localhost:9998/biprws/infostore/Root%20Folder/children?

page=2&pageSize=3"}

"last":

{"__deferred":

{"uri":"http://localhost:9998/biprws/infostore/Root%20Folder/children?

page=3&pageSize=3"}

"entries":

[

{"__metadata":

{"uri":"http://localhost:9998/biprws/infostore/4005"},

"id":4005,

"cuid":"FnKsrkkctAcA8BAAALB7kkQAADAFzVMX",

"name":"Data Federation",

"type":"Folder"

{"__metadata":

{"uri":"http://localhost:9998/biprws/infostore/3931"},

"id":3931,

"cuid":"Ac1aKZlzj5VJmMQi5LDa53s",

"name":"LCM",

"type":"Folder"

{"__metadata":

{"uri":"http://localhost:9998/biprws/infostore/5056"},

"id":5056,

"cuid":"Acu9FvxWBZ9Htt0_08a25b4",

"description":"",

"name":"Monitoring Report Sample",

"type":"Folder"

}

]

}

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

Related Information

Retrieving the base URL for RESTful web service requests [page 29]

3.1.1 Creating the request header

The request header of an HTTP request contains a set of attributes that describe the request. The RESTful web

services SDK recognizes a set of standard HTTP attributes as well as custom attributes.

The following table describes request headers that are recognized by the RESTful web service:

Attribute Description

The accepted content types. Species the content in the

request body. Use this value to specify the format.

Examples of acceptable values:

●

application/xml

● application/atom+xml

● application/json

Accept-Charset

The accepted character sets.

Accept-Encoding

The accepted character encodings.

Accept-Language

The preferred language used to retrieve system and error

messages. This corresponds to the Procuct Locale (PL) of

the BI Platform.

Content-Length

The number of characters in the request body.

Content-Type

The type of content in the request body.

Examples of acceptable values:

●

application/xml

● application/atom+xml

● application/atom+xml;type=feed

Host

The internet host and port number of the RESTful web

service.

X-SAP-LogonToken

The value of the logon token recieved from the

authentication process.

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 11

Attribute Description

 Note

The logon token must be surrounded in quotation

marks when added to the request header. For example:

X-SAP-LogonToken:

"COMMANDCOM-LCM:

6400@{3&2=5328,U3&p=40676

8926203819,Y7&4F=12,U3&63=secEnterp

rise

0P&66=60,03&68=secEnterprise:Admini

strator

,0P&qe=100,U3&vz=IVD21LbMCB0eRiI4at

z9sNL18Ux5anRBdYB9fFv5NrY,UP}"

X-SAP-PVL

The preferred language used to retrieve BI platform

content. This corresponds to the Preferred Viewing

Language (PVL)

Related Information

Authentication [page 30]

3.1.2 Creating the request body

The request body contains the information that RESTful web services needs to complete the request. For

example, the request body of an authentication request contains the logon information, including user name

and password. This provides the authentication URL with the information it needs to accept or reject the logon

request.

You set an attribute in the request header to dene the format of the request body. Set the Content-Type

attribute in the message header to specify the format.

3.1.3 Interpreting the response header

The response header contains attributes that describe whether the request was successful, and describe the

contents of the response body. Most of the response header attributes belong to the HTTP standard. However,

the X-SAP-LogonToken header attribute is a custom attribute used only by the BI platform.

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

Status code

The status code contains a standard HTTP status code that describes whether the request was successful.

HTTP Response Code Error Description

400 Bad request The requested resource exists, but the

request contains errors.

401 Failed to logon or invalid session Logon failed. Check that the username,

password, and servername are correct.

403 Access denied You do not have permission to operate

on the requested resource. The current

session may have expired. Log on to

obtain a new session.

404 Service is not available The requested service is not provided

by the RESTful web services SDK.

405 Invalid request method A request was made using a method

that was not supported by the

resource. For example, using a PUT

request on a read-only resource.

406 Not acceptable The requested resource cannot

generate the content type specied by

the Accept attribute of the request

header.

408 BI platform server timeout The server timed out waiting for the

request.

415 Unsupported media type The request contains a media type that

the server or resource does not

support.

500 RESTful web service internal error An unclassied error occurred. See the

response body for more information.

503 RESTful web service plugin not found RESTful web services are not available.

Verify that RESTful web services are

congured correctly.

Server

The server that was used to process the request.

Date

The date and time of the response.

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 13

Content-Type

The format of the response body. For example, most web service responses use the value application/xml

to show that the response body is formatted as XML.

Content-Length

The length of the response body.

Transfer-Encoding

The type of encoding that has been used to transport the message.

Content-Location

An alternative link that can be used to nd the resource.

X-SAP-LogonToken

A token that can be used with subsequent requests to prove that you have been authenticated to access the BI

platform. Authentication requests return the X-SAP-LogonToken custom attribute in the response header.

Include the logon token in the request header of subsequent requests, and enclose it in quotation marks.

 Note

A copy of the X-SAP-LogonToken value is returned in the response body of authentication responses.

However, the response body is formatted as XML and converts the logon token to an XML-encoded version.

This copy of the logon token must be converted back to its original format before it can be used.

Related Information

Converting a logon token from XML-encoded text [page 39]

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

3.1.4 Interpreting a response body in XML format

The Business Intelligence platform RESTful web service SDK provides responses in XML format, according to

the Atom specication, available at http://www.w3.org. This section describes how XML tags apply to RESTful

web services. The following screen illustrates how the BI launchpad returns XML data in response to a typical /

infostore request.

<feed>

The <feed> element denes a list of <entry> elements. JSON uses curly brackets { and } to enclose a

response.

...

</feed>

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 15

<entry>

A single item. The <entry> tag may include the xmlns attribute.

...

</entry>

The owner of the resource that was accessed. The <author> element includes a <name> element that denes

the name of the owner of the resource. The following element shows that the owner of the resource is System

Account

<author><name>System Account</name></author>

<id>

A unique identier of the resource.

<id>tag:sap.com,2010:bip-rs/AdoctK9h1sBHp3I6uG0Sh7M</id>

<title>

The name of the resource. This example shows that the name of the resource is Application Folder.

<title type="text">Application Folder</title>

The date and time the resource was last updated.

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

<link>

The link element denes links to URLs that can be used with other RESTful web service requests. These may

include parent or child folders, or other information that is relevant to the request. By following these links, you

can navigate through the BI platform repository.

The href attribute of the link tag denes the hyperlink, and the rel attribute describes the type of link. The

following list describes possible values of the

rel attribute:

self

A link back to this URL.

first

A link to the rst page of results.

A link to the next page of results.

A link to the previous page of results.

last

A link to the last page of results.

alternate

Another link to the same resource.

A link to the parent of the current resource.

A link to a related resource.

http://www.sap.com/rws/bip#children

A link to the children of the current resource.

http://www.sap.com/rws/bip#opendocument

A link that can be used to view the resource with

OpenDocument.

http://www.sap.com/rws/bip#schedule

A link that can be used to schedule a resource.

For example, the following link element describes a link to the next page of results:

page=3&pageSize=3" rel="next"></link>

Responses that provide links to documents also provide an OpenDocument URL that can be used to view

documents using OpenDocument.

sIDType=CUID&iDocID=Aa0U0jQbtKxCn.D3JDLOaHs" rel="http://www.sap.com/rws/

bip#opendocument" title="OpenDocument">

For more information about OpenDocument, see Viewing Documents Using OpenDocument.

 Note

You can use logon tokens obtained from this SDK to authenticate with OpenDocument.

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 17

The payload of the RESTful response. The <content> element contains an <attrs> element, which itself

contains a set of <attr> elements.

<attrs>

</attrs>

</content>

<attrs>

A list of properties of the content. The <attrs> element contains a set of <attr> elements.

<attrs>

</attrs>

<attr>

A property of the content.

Each <attr> element denes a property of the content. The <attr> tag uses two attributes, name, which

describes the name of the property, and type, which describes the type of the property. The following example

shows that the id property of the content is the value 43 (an integer), and the name property of the content is

Application Folder (a string).

<attr name="name" type="string">Application Folder</attr>

This table describes the possible values for the name and type attributes of the <attr> tag.

Name Type Description

name string

The name of the resource.

id int32

The ID of the resource.

cuid string

A unique identier of the resource.

type string

The type of resource, for example

Folder or InfoView.

description string

A description of the resource.

logonToken string

A logon token.

18 PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

<error>

Error codes.

Each <error_code> and <message> element refers to a RESTful Web Services error code reference in teh

format RWS 000xx and includes a brief description. For more details, see the BusinessObjects XI Error

Messages Explained guide.

3.1.5 Interpreting a response body in the JSON format

The Business Intelligence platform RESTful web service SDK provides responses in JSON format with the

request header accept : application/json. This section describes how JSON tags apply to RESTful web

services.

{ ... }

A JSON object is enclosed by curly brackets { and }, which is similar to the XML <feed> element.

{

"__metadata": {

"uri": "http://commandcom-lcm:6405/biprws/infostore/4/children?

page=1&pageSize=50"

"first": {

"__deferred": {

"uri": "http://commandcom-lcm:6405/biprws/infostore/4/children?

page=1&pageSize=50"

}

"last": {

"__deferred": {

"uri": "http://commandcom-lcm:6405/biprws/infostore/4/children?

page=1&pageSize=50"

}

"entries":

[

{

"__metadata": {

"uri": "commandcom-lcm:6405/biprws/infostore/Alert

%20Notifications"

"id": 64,

"cuid": "ARZB.BFCQk9PqaqDpcFwo1w",

"name": "Alert Notifications",

"type": "Folder",

"uri":"alslsls"

}

]

}

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 19

"entries":

Entries are JSON objects within an array. The format is "entries" : [{contentsOfEntryItem#1},

{contentsOfEntryItem#2}]. The following example is a result of an ../infostore RESTful Web Service

API request. The "entries": part of the response shows two children named "Alert Notifications" and

"Users".

"entries":

[

{

"__metadata": {

"uri": "commandcom-lcm:6405/biprws/infostore/Alert

%20Notifications"

"id": 64,

"cuid": "ARZB.BFCQk9PqaqDpcFwo1w",

"name": "Alert Notifications",

"type": "Folder",

"uri":"alslsls"

{

"__metadata": {

"uri": "http://commandcom-lcm:6405/biprws/infostore/Users"

"id": 19,

"cuid": "AXhmigik4CBKra9ZYzR2ezE",

"description": "",

"name": "Users",

"type": "Folder"

}

]

__metadata: { uri:

The __metadata: { uri: element equates to the XML <link> element. This denes links to URLs that can be

used with other RESTful web service requests. These may include parent or child folders, or other information

that is relevant to the request. By following these links, you can navigate through the BI platform repository.

The href attribute of the link tag denes the hyperlink, and the rel attribute describes the type of link. The

following list describes possible values of the rel attribute. Note that the XML tags alternate and related

have no JSON equivalent.

Attribute

Format Example Description

self __metadata: { uri: "__metadata":

{"uri":"http://

localhost:6405/

biprws/infostore/4/

children?

page=1&pageSize=5"}

A link back to this URL.

20 PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

Attribute Format Example Description

first first:

{ __deferred:

{ uri:

"first":

{"__deferred":

{"uri":"http://

localhost:6405/

biprws/infostore/4/

children?

page=1&pageSize=5"}

A link to the rst page of

results.

next next: { __deferred:

{ uri:

"next":

{"__deferred":

{"uri":"http://

localhost:6405/

biprws/infostore/4/

children?

page=2&pageSize=5"}

A link to the next page of

results.

previous previous:

{ __deferred:

{ uri:

"previous":

{"__deferred":

{"uri":"http://

localhost:6405/

biprws/infostore/4/

children?

page=6&pageSize=5"}

A link to the previous page of

results.

last last: { __deferred:

{ uri:

"last":

{"__deferred":

{"uri":"http://

localhost:6405/

biprws/infostore/4/

children?

page=7&pageSize=5"}

A link to the last page of

results.

up up: { __deferred:

{ uri:

"up":{"__deferred":

{"uri":"http://

localhost:6405/

biprws/infostore"}

A link to the parent of the

current resource.

children children:

{ __deferred:

{ uri:

"Children":

{"__deferred":

{"uri":"http://

localhost:6405/

biprws/infostore/

User%20Folders/

children"}

A link to the children of the

current resource.

openDocument opendocument

{ __deferred:

{ uri:

"openDocument":

{"__deferred":

{"uri":"http://

commandcom-lcm:

8080/BOE/

OpenDocument/

opendoc/

openDocument.jsp?

A link that can be used to

view the resource with

OpenDocument.

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 21

Attribute Format Example Description

sIDType=CUID&iDocID

=AQtkbbSqN4NOj3ydf.

Sw1lY"}

schedule schedule

{ __deferred:

{ uri:

"Scheduling forms":

{"__deferred":

{"uri":"http://

localhost:6405/

biprws/infostore/

4930/

scheduleForms"}

Use Post and include the

schedule:

"__metadata":

{"uri":"http://

localhost:6405/

biprws/infostore/

4930/scheduleForms/

hourly"}

A link that can be used to

schedule a resource. Use Get

to retrieve the template, use

Post to send the request.

For example, the following link element describes a link to the last page of results:

"last": {

"__deferred": {

"uri": "http://commandcom-lcm:6405/biprws/infostore/4/children?

page=1&pageSize=50"

}

Responses that include document types, such as Web Intelligence and Crystal Reports, also provide an

openDocument URL that can then be emailed or attached to a button control on a report.

In the following example, the ../infostore API is used to retrieve the listing of a Web Intelligence

openDocument-formatted links.

http://commandcom-lcm:6405/biprws/infostore/4930

{

"up":{

"__deferred":{

"uri":"http://10.162.204.68:6405/biprws/infostore/4904"

}

"Scheduling forms":{

"__deferred":{

"uri":"http://10.162.204.68:6405/biprws/infostore/4907/scheduleForms"

}

"id":4907,

"cuid":"AQtkbbSqN4NOj3ydf.Sw1lY",

"openDocument":{

"__deferred":{

"uri":"http://commandcom-lcm:8080/BOE/OpenDocument/opendoc/

openDocument.jsp?

sIDType=CUID&iDocID=AQtkbbSqN4NOj3ydf.Sw1lY"

}

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

"description":"",

"name":"Formatting Sample",

"type":"Webi"

}

For more information about OpenDocument, see Viewing Documents Using OpenDocument.

 Note

You can use the ../logon/long API to obtain a logon token string that can be added to an openDocument

URL so recipients do not have to provide their logon credentials.

Entry properties

Several properties make up the content of each entry item. The following example shows that the id property

of the content is the value 64 (an integer), and the name property of the content is Alert Notifications (a

string).

{

"__metadata": {"uri": "commandcom-lcm:6405/biprws/infostore/Alert

%20Notifications"},

"id": 64,

"cuid": "ARZB.BFCQk9PqaqDpcFwo1w",

"name": "Alert Notifications",

"type": "Folder",

"uri":"alslsls"

This table describes the available name and type properties for a JSON entry.

Name Type Example Description

name string "name": "Alert

Notifications"

The name of the resource.

id int32 "id": 64

The ID number of the

resource.

cuid string "cuid":

"ARZB.BFCQk9PqaqDpc

Fwo1w"

A unique identier of the

resource.

type string "type": "Folder"

The type of resource, for

example Folder or InfoView.

description string "description":

"Contains the ..."

A description of the

resource.

logonToken string "type":

"COMMANDCOM-LCM:

6400@{3&...Sv3b6vUJ

Ze9...}"

A logon token.

uri string "uri": "http://

localhost:6405/

URI value.

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 23

Name Type Example Description

biprws/infostore/

Custom%20Roles"

openDocument string "openDocument":

{"__deferred":

{"uri":"http://

commandcom-lcm:

8080/BOE/

OpenDocument/

opendoc/

openDocument.jsp?

sIDType=CUID&iDocID

=AQtkbbSqN4NOj3ydf.

Sw1lY"}

An openDocument

formatted URI value.

error_code

Each error_code and message element refers to a BI platform error or a RESTful Web Services error (RWS

prex) and includes a brief description. For more information, see the SAP BusinessObjects XI Error Messages

Explained guide.

{

"error_code":"FWM 01003",

"message":"Server COMMANDC-OM-LCM:6400 not found or server may be down (FWM

01003)"

}

JSON escape characters

RESTful Web Services returns ASCII characters that are considered special by JSON by prefacing them with a

back slash ( \ ). The JSON specication for which characters must be escaped can be found at http://

www.ietf.org/rfc/rfc4627.txt The following table lists several common ASCII++ characters that

RESTful Web Service JSON requests will return prefaced with backslashes:

RWS - JSON Unicode UTF-8 Description

U+0008 Backspace

U+000C Form feed

U+000A New line

U+000D Carriage return

U+0009 Tab

U+000B Vertical tab

24 PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

RWS - JSON Unicode UTF-8 Description

U+0027 Single quote

U+0022 Double quote

U+005C Back slash or reverse solidus

U+005D Forward slash or solidus

U+xxxx four-hex-digits

3.1.6 Comparison of XML and JSON attributes

RESTful Web Services requests that use XML always return some data to comply with the Atom specication.

The following XML tags that do not have equivalents in the JSON data format, and it helps to be aware of them:

● <author>

● <id>

● <title>

● <updated>

● <link rel=alternate>

● <link rel=related>

● <content>

● <attrs>

Supported XML tags and JSON objects

The following table lists the XML tags and their equivalent JSON objects and entries supported by the BI

platform RESTful Web Services implementation.

Supported XML tags and JSON objects

XML

JSON

DescriptionXML Tag Sample Type Value Type

<feed> { JSON object In a JSON result, the re

sponse is represented as a

JSON Object. The XML

<feed> tag equates to JSON's

outermost curly brackets { }.

<entry>

entries : [{contentsOfEntryItem#1},

{contentsOfEntryItem#2}]

A request for a list of children,

a collection of entries is re

turned, each one a JSON ob

ject. The collection of JSON

objects is represented as an

array in the "entries" name

and value pair.

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 25

XML JSON

DescriptionXML Tag Sample Type Value Type

<author> No JSON equivalent These elements are not ex

posed in JSON.

<id>

<title>

tion.

rel=rst rst: { __deferred: { uri:: A link to the rst page of re

sults.

rel=next next: { __deferred: { uri:: A link to the next page of re

sults.

rel=previous previous: { __deferred: { uri:: A link to the previous page of

results .

rel=last last: { __deferred: { uri:: A link to the last page of re

sults .

rel=alternate No JSON equivalent. An alternate link to your cur

rent location.

rel=up up: { __deferred: { uri:: A link to the parent of the cur

rent resource.

rel=related No JSON equivalent. A link to a related resource.

rel=http://www.sap.com/ rws/bip#chil

dren

children: { __deferred: { uri:: A link to the children of the

current resource.

rel=http://www.sap.com/ rws/

bip#opendocument

opendocument: { __deferred: { uri:: A link that can be used to

open a document such as a

report or Adobe Acrobat PDF

le.

rel=http://www.sap.com/ rws/

bip#schedule

schedule: { __deferred: { uri:: A link that can be used to

schedule a resource.

<content> No JSON equivalent. For XML only, this is a con

tainer for the

<attrs> ele

ment. <content> is re

quired for the Atom feed

specication, but not for

JSON.

<attrs>

The XML element that con

tains one or more

<attr> el

ements. In JSON, the attrib

utes are presented as name

and value pairs immediately

within the JSON object repre

senting the resource, rather

than grouped as with the XML

<attrs> tag.

26 PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

XML JSON

DescriptionXML Tag Sample Type Value Type

<attr> name=name string name: JSON string The name of the resource.

name=id int32 id: JSON number The numerical identication

number of the resource.

name=cuid string cuid: JSON string The 23 character alphanu

meric cluster unique identi

er.

name=type string type: JSON string The type of resource, for ex

ample Folder or InfoView.

name=description string descrip

tion:

JSON string The description of the re

source.

name=logonToken string logonTo

ken:

JSON string The logon token string.

Example: A comparison of XML and JSON format from an /infostore request

The following code snippet shows the hierarchy of RESTful Web Service elements with a typical /infostore GET

request. On the left, is the XML listing. On the right, is the JSON listing of the same request. The corresponding

lines of information are arranged for easier side-by-side comparison. To reduce the length of the code snippet,

only the rst object called "Alert Notications" is shown. Note that this screenshot does not contain all

available tags listed in the preceeding table.

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 27

3.1.7 Working with multilingual data

In multilingual environments, you can request the content and system messages to be returned in your

preferred language. There are two request header attributes used to dene the preferred language for content

and system messages: Accept-Language and X-SAP-PVL.

When the BI platform software is installed, the user interface and system error messages are displayed in the

Product Locale (PL). The available PL languages include the language packs that are installed with the BI

platform software.

The system messages, including error messages, are returned in the language specied by the PL. You can

request to use a specic language for system messages by setting the Accept-Language request header

attribute. For example, to retrieve system messages in Japanese, set the Accept-Language request header

attribute to ja-JP.

 Note

If the requested PL is not available, the system messages are returned in the PL that was used when the BI

platform software was installed.

The content in the BI platform may be stored in multiple languages. For example, the BI platform could store a

report that has been translated into French, Japanese, and German. Use the X-SAP-PVL request header

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

attribute to specify the preferred language of the content to be returned. If the content is not available in the

requested language, it is returned in the closest available language. For example, to request content that is

available in French, set the X-SAP-PVL request header attribute to fr-FR.

For more information about HTML language codes, see the HTML 4.01 specication at http://www.w3.org.

3.2 Retrieving the base URL for RESTful web service

requests

To use the Business Intelligence platform RESTful web service SDK, you must know the protocol, server name,

port number, and path of the service that listens to RESTful web service requests. Collectively, these form the

base URL. Whenever you make a request to RESTful web services, the beginning of the request starts with the

base URL and is followed by the specic details of the request.

Basic installations of the BI platform that are installed on a single server use the default base URL, http://

<servername>:6405/biprws/.

In complex deployment scenarios, there can be multiple instances of the Web Application Container Server

(WACS), which hosts the RESTful web service. In this case, RESTful web services may be hosted at a dierent

location. The BI platform administrator denes the location base URL that is used to access RESTful web

services, and you can discover the base URL programmatically or through the Central Management Console

(CMC).

 Note

Only with the default Tomcat full build installation, the Tomcat port gets updated in the respective default

base URL, and in other scenarios, this remains same as shown above.

3.2.1 Retrieving the base URL through the CMC

You can nd the base URL for RESTful web service requests by logging on to the Central Management Console

(CMC) user interface and navigating to the RESTful web services setting.

1. Log on to the CMC.

2. Click Applications.

3. Right-click RESTful Web Service and click Properties.

The RESTful Web Service properties window appears.

4. Retrieve the base URL from the Access URL text box.

3.2.2 Retrieving the base URL programmatically

You can programmatically discover the base URL for RESTful web services by using one of the other BI

platform SDKs, for example the BI Platform Java SDK. To programmatically nd the base URL for RESTful web

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 29

services, you must rst query the BI platform to retrieve the SI_ACCESS_URL property of the RESTful web

service object. You can query for the RESTful web service object by its CUID, or by its kind. You can nd the

CUID and kind by accessing the Java constants,

com.businessobjects.sdk.plugin.desktop.restwebservice.IRestWebService.CUID and

com.businessobjects.sdk.plugin.desktop.restwebservice.IRestWebService.KIND.

 Note

The CUID value for RESTful web services is AZpJlb9HDtxPjLHwEmF8xD8 and the kind value is

RestWebService.

"SELECT SI_ACCESS_URL FROM CI_APPOBJECTS WHERE SI_CUID='" + IRestWebService.CUID

+ "'"

"SELECT SI_ACCESS_URL FROM CI_APPOBJECTS WHERE SI_KIND=’" + IRestWebService.KIND

+ "’"

Finding the base URL by using the BI platform Java SDK version 4.1

You can use the getURL method of the IRestWebService interface to retrieve the RESTful web services base

URL.

IInfoObjects objects= infostore.query("SELECT SI_ACCESS_URL FROM CI_APPOBJECTS

WHERE SI_CUID='" + IRestWebService.CUID + "'");

IInfoObject object = (IInfoObject)objects.get(0);

IRestWebService restAppObject = (IRestWebService) object;

String baseUrl = restAppObject.getURL();

For more information on the BI platform Java SDK, see the SAP BusinessObjects Business Intelligence Platform

Java SDK Developer Guide.

3.3 Authentication

To access the BI platform through the Business Intelligence platform RESTful web service SDK, you need a

logon token. You get one by making a request to a logon URL. The token proves you have been authenticated as

a valid user, and it can be included with subsequent RESTful web services requests without exposing sensitive

information such as your password.

You can use any one of the following information types to obtain authentication and a resulting logon token:

● BI platform logon credentials. This method supports WinAD, LDAP, SAP and Enterprise authentication. For

more information about authentication, see the SAP BusinessObjects Business Intelligence Platform

Administrator Guide.

● A session token from another session. If you have access to a session that has already been authenticated,

you can use the session token to obtain a logon token.

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

 Note

The session token obtained from another SDK is not the same as the logon token, and cannot be used

directly with RESTful web service requests.

● A serialized session. If you have access to a session that has already been authenticated, you can use it to

obtain a logon token.

If your authentication request was successful, the response header includes a logon token. This logon token is

dened by X-SAP-LogonToken.

 Note

The response body contains a copy of the logon token. However, this copy of the logon token is embedded

in XML and has converted (encoded) illegal XML characters, such as &, < and > to an XML-friendly format.

You must convert the XML encoded characters back to their original format before you can use this copy of

the logon token. Alternatively, you can use the copy of the logon token that is provided in the response

header, which has not been formatted for XML.

Each time you make a request to RESTful web services, you must add the X-SAP-LogonToken attribute to the

request header, and set its value to be the logon token you received from being authenticated. Enclose the

logon token in quotation marks, because it may contain characters that are not otherwise allowed in the

request header.

The following table contains an example of a logon token:

Attribute Sample Value

X-SAP-LogonToken "COMMANDCOM-LCM:

6400@{3&2=5604,U3&p=40623.9446463889,Y7&

4F=12,U3&63=secEnterprise,

0P&68=secEnterprise:Administrator,

0P&qe=100,U3&vz=g5KUV8cAA.d_ARmSDnBy6T7j

JVNyFCTso4s0q3dI.4k,UP}"

Related Information

Converting a logon token from XML-encoded text [page 39]

3.3.1 To get a logon token from a user name and password

Before you can log on to the BI platform, you must have retrieved the base URL for RESTful web service

requests.

To log on to the BI platform and obtain a logon token, make a request to http://<baseURL>/logon/long

using the POST method, providing your user name, password, and type of authentication in the request body.

You can use the following types of authentication to log on to the BI platform:

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 31

● WinAD

● LDAP

● SAP

● Enterprise

To discover how to format the body of the logon request, make a request to the same URL, http://

<baseURL>/logon/long, using the GET method. This response contains an XML template that can be used

to format the request body of the logon request. The XML template includes a list of the supported

authentication types.

1. Create a new HTTP request.

2. Add the Accept attribute to the request header, and set its value to application/xml.

3. Use the GET method to send the request to the http://<baseURL>/logon/long URL.

Replace <baseURL> with the base URL for RESTful web services.

GET http://localhost:6405/biprws/logon/long

The response body contains a template.

<attr name="auth" type="string"

possibilities="secEnterprise,secLDAP,secWinAD,secSAPR3">secEnterprise</attr>

</attrs>

4. Create a new HTTP request.

5. Add the Accept attribute to the request header, and set its value to application/xml.

6. Add the Content-Type attribute to the request header, and set its value to application/xml.

7. Fill out the XML template with the user name, password, and authentication type, and add it to the request

body of the new request.

<attr name="userName" type="string">myUserName</attr>

<attr name="password" type="string">myPassword</attr>

<attr name="auth" type="string"

possibilities="secEnterprise,secLDAP,secWinAD,secSAPR3">secEnterprise</attr>

</attrs>

8. Use the POST method to send the request to the same URL, http://<baseURL>/logon/long.

Replace <baseURL> with the base URL for RESTful web services.

POST http://localhost:6405/biprws/logon/long

The response header returns the logon token as the X-SAP-LogonToken attribute.

X-SAP-LogonToken:"COMMANDCOM-LCM:

6400@{3&2=5595,U3&p=40674.9596541551,Y7&4F=12,U3&63=secEnterprise,

0P&66=60,03&68=secEnterprise:Administrator,

0P&qe=100,U3&vz=SFY6agrLPxpfQBK1ZKYCwoBZKCbfsQm7VgWZFiH.RhM,UP"

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

The logon token is contained between the quotation marks. In the example above, the logon token is as

follows:

COMMANDCOM-LCM:

6400@{3&2=5595,U3&p=40674.9596541551,Y7&4F=12,U3&63=secEnterprise,

0P&66=60,03&68=secEnterprise:Administrator,

0P&qe=100,U3&vz=SFY6agrLPxpfQBK1ZKYCwoBZKCbfsQm7VgWZFiH.RhM,UP

The response body contains a copy of the logon token in the <attr> element. If the logon token contains

characters that are illegal in XML, they are replaced with their XML-encoded value. For example the &

character is replaced with &. To use a logon token taken from the response body, you must convert

the XML-encoded logon token back to its original format.

The following example shows how the XML-encoded logon token appears in the response body:

<author><name>@COMMANDCOM-LCM:6400</name></author>

<id>tag:sap.com,2010:bip-rs/logon/long</id>

<title type="text">Logon Result</title>

<attr name="logonToken" type="string">COMMANDCOM-LCM:6400@{3&

2=5595,U3&p=40674.9596541551,Y7&4F=12,U3&63=secEnterprise,0P&

66=60,03&68=secEnterprise:Administrator,

0P&qe=100,U3&vz=SFY6agrLPxpfQBK1ZKYCwoBZKCbfsQm7VgWZFiH.RhM,UP}</attr>

</attrs>

</content>

</entry>

Related Information

Retrieving the base URL for RESTful web service requests [page 29]

Converting a logon token from XML-encoded text [page 39]

3.3.2 To get a logon token from a serialized session or

session token

To log on with this method, you must be able to use another BI platform SDK to access an existing

authenticated session, for example, use the BI platform Java SDK. You must also know the base URL for

RESTful web service requests.

You can get a logon token for RESTful web services from a valid session token or a serialized session. Make a

request to the http://<baseURL>/logon/token URL using the POST method, and provide an XML-encoded

version of the serialized session or session token in the request body. Replace

<baseURL> with the base URL

for RESTful web services.

To discover how to format the request body, make a request to the same URL, http://<baseURL>/logon/

token using the GET method. The response from this request contains an XML template that can be used with

the request body of the logon request.

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 33

By using a serialized session to obtain a logon token, you do not increase the number of concurrent user

licenses used by the BI platform. However, using a session token will increase the concurrent user license count

by one.

1. Create a new HTTP request.

2. Use the GET method to send the request to the http://<baseURL>/logon/token URL.

Replace <baseURL> with the base URL for RESTful web services.

GET http://localhost:6405/biprws/logon/token

The response contains an XML template.

<attr name="tokenType" type="string" possibilities="token,

serializedSession">token</attr>

</attrs>

3. Create a new HTTP request.

4. Add the Content-Type attribute to the request header, and set its value to application/xml.

5. Fill out the XML template and add it to the request body.

Set the value of the <attr name ="tokenType" type="string"> element to be token if you are

using a session token, and set it to serializedSession if you are using a serialized session. Set the value

of the <attr name="logonToken" type="string"> element to an XML-encoded version of the

serialized session or session token value.

<attr name="tokenType" type="string" possibilities="token,

serializedSession">serializedSession</attr>

<attr name="logonToken" type="string">3&ua=AWmaEx4Z.NVPpAEthuTGAjc,

8P&ub=AfRWaT5_131NlLLf5bRMLKY,8P&S5,88&

5U=5320JaqlNvF1mr4m8u5UQFadItj5319JWKkfBwlKLBfrgXC8Npg1jC,8P&

63=secEnterprise,8P&2r=COMMANDCOM-LCM:6400,8P&3k=@COMMANDCOM-LCM:

6400,8P&1=Administrator account,8P&W={},?z&

4E=5319JWKkfBwlKLBfrgXC8Npg1jC,8P&Tn={3&.1={3&

2=726,03&O=FavoritesFolder,0P},2z&.2={3&

2=727,03&O=PersonalCategory,0P},2z&.3={3&2=728,03&O=Inbox,0P},

2z&U=3,03},?z&4F=12,8P&Tm=36500,83&uy=-1043,8L&

35=Administrator,8P&ux=AeiCInd_R6lBrV98duvX1dc,8P&pa,8P</attr>

</attrs>

 Note

This example shows a serialized session. The serialized session or session token value must be XML-

encoded to remove illegal XML characters. For example, replace the & character with &.

6. Use the POST method to send the request to the same URL, http://<baseURL>/logon/token. Replace

<baseURL> with the base URL for RESTful web services.

POST http://localhost:6405/biprws/logon/token

The response header returns the logon token as the X-SAP-LogonToken attribute.

X-SAP-LogonToken:"COMMANDCOM-LCM:

6400@{3&2=5595,U3&p=40674.9596541551,Y7&4F=12,U3&63=secEnterprise,

0P&66=60,03&68=secEnterprise:Administrator,

0P&qe=100,U3&vz=SFY6agrLPxpfQBK1ZKYCwoBZKCbfsQm7VgWZFiH.RhM,UP"

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

The logon token is contained between the quotation marks.

 Note

The response body contains a copy of the logon token in the <attr> element. If the logon token

contains characters that are illegal in XML, they are replaced with their XML-encoded value. For

example, the & character is replaced with &. To use a logon token taken from the response body,

you must convert the XML-encoded logon token back to its original format.

The following example shows how the XML-encoded logon token appears in the response body:

<author><name>@COMMANDCOM-LCM:6400</name></author>

<id>tag:sap.com,2010:bip-rs/logon/token</id>

<title type="text">Logon Result</title>

<attr name="logonToken" type="string">COMMANDCOM-LCM:6400@{3&

2=5319,U3&p=40722.7462034491,Y7&4F=12,U3&63=secEnterprise,

0P&66=60,03&68=secEnterprise:Administrator,

0P&qe=100,U3&vz=KeDu7064jWSptBT_m5BkBJ5Q_NaxyvE_WStqXmigYrg,UP}</

attr>

</attrs>

</content>

</entry>

Related Information

Retrieving the base URL for RESTful web service requests [page 29]

Using authenticated sessions obtained from other SDKs [page 43]

Converting a logon token from XML-encoded text [page 39]

3.3.3 To get a logon token using an Active Directory Single

Sign-On (AD SSO) account

To use the Active Directory Single Sign-On feature of RESTful Web Services, clients must have a Windows

Active Directory (WinAD) account and be logged into the computer that will be using the /logon/adsso API.

Clients must also have logon accounts on the BI platform that match the WinAD accounts. The following

diagram illustrates the conguration and authentication relationship between the BI platform server, the client

computer, and the Windows Active Directory server.

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 35

Once the WinAD SSO feature is enabled as described in Administration and installation tasks >

To configure web.xml to enable WinAD SSO, clients can use their WinAD credentials to log on to their

computer. Those credentials will be used to authenticate them for access to the BI platform server

automatically.

Use the following steps to obtain a logon token through AD SSO.

1. Create a new HTTP request.

2. Use the GET method to send the request to http://<baseURL>/logon/adsso.

Replace <baseURL> with the base URL for RESTful web services.

For example:

GET http://localhost:6405/biprws/logon/adsso

The response header returns the logon token as the X-SAP-LogonToken attribute. An example XML

response appears as follows:

<?xml version="1.0" ?>

<name>

@BOESRVR.ADDOM.COM

</name>

</author>

<id>

tag:sap.com,2010:bip-rs/logon/adsso

</id>

Logon Result

</title>

2011-11-11T11:11:11.340Z

</updated>

BOESRVR.ADDOM.COM:6400@{3&2=4584,U3&p=40868.9276775116,Y7&4F=4331,U3

&63=secWinAD,0P&66=60,03&68=secWinAD:CN%3DADUser1%2CCN%3DUsers%2CDC%3D

ADDOM%2CDC%3DCOM,0P&qe=100,U3&vz=

kOox8TDqAiFsfs8T3GefI3sWXIyKymc9qvytAjihC7w,UP}

</attr>

</attrs>

</content>

</entry>

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

3. Use the resulting X-SAP-LogonToken within an HTTP request header to make further RESTful Web

Service requests (for example http://<baseURL>/infostore.) You can also HTTP-encode the logon

token and append it to an OpenDocument URL with the

&token=<logonToken> parameter.

Related Information

Retrieving the base URL for RESTful web service requests [page 29]

Converting a logon token from XML-encoded text [page 39]

3.3.4 To get a logon token using trusted authentication

To use the trusted authentication feature of RESTful Web Services, the features must be activated as described

in Administration and Installation tasks > To enable and congure trusted authentication.

Trusted authentication is used to speed up access to protected resources once users have already been

authenticated elsewhere; for example, after users have logged in with a Windows account.

The methods of logon token retrieval, using trusted authentication, are as follows:

● HTTP header requests using a customizable header for the user name.

● URL queries.

● Cookie authentication.

To use one of the three trusted authentication logon retrieval methods, open CMC and go to WACS > Trusted

Authentication Conguration, in the Retrieving Method menu, change the option to match the method you will

be using. For all trusted authentication methods, there is an option to change the Name Parameter, which is

found in Servers > Core Services > WACS. Note that all URLs and values supplied are case sensitive.

 Note

Trusted Authentication should not be enabled without HTTPS due to security reasons. If you have enabled

Trusted Authentication without https, it is considered as breach of security as the URL is exposed to

unauthorized users. To avoid security breach, the user's information can be validated with a valid

certicate. For more information, refer to 1388240 .

Retrieving Method RESTful API used Usage instructions

HTTP_HEADER

/logon/trusted

1. Create an HTTP request using the

GET method.

2. Use the /logon/trusted API,

for example, http://

localhost:6405/biprws/

logon/trusted

Create a request header with the

default label X-SAP-TRUSTED-

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 37

Retrieving Method RESTful API used Usage instructions

USER, and add a trusted user

name, for example bob.

The resulting logon token is

displayed in the response header.

QUERY_STRING

/logon/trusted?

1. In a web browser URL, use the /

logon/trusted API, and add

the user name parameter and the

user name, for example, http://

localhost:6405/biprws/

logon/trusted?

MyUser=bob

. For example:

○ Replace MyUser with a

customized user name

parameter that is set in CMC

under

Servers > Core Services

> WACS > Trusted

Authentication Conguration

○ Replace bob with a that of a

trusted user that is set in

CMC under Users and Groups

> User List.

The resulting logon token is

displayed in the browser body

window.

/logon/trusted

1. Create a cookie, and add the

following information:

○ The domain. For example,

localhost

○ The name label, for example

the default value of X-SAP-

TRUSTED-USER

, with the

value for the logon name, for

example, bob.

○ The path, for example /

(forward slash).

Enter the URL, for example,

http://localhost:6405/

biprws/logon/trusted and

press the Enter key to see the

resulting logon token displayed in

the browser window.

Related Information

Retrieving the base URL for RESTful web service requests [page 29]

Converting a logon token from XML-encoded text [page 39]

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

3.3.5 Converting a logon token from XML-encoded text

Logon tokens are returned in both the response header and the response body of authentication responses.

The response body is formatted as XML, which reserves certain characters for its own use. If the logon token

contains these characters, they are replaced with character sequences that are allowed to be embedded in

XML but will not work in a logon token. Before you can use an XML-encoded logon token, it must be converted

back to its original format.

 Note

You only need to perform this step if you retrieve the logon token from the response body. The logon token

that is contained in the response header is not XML-encoded.

To convert an XML-encoded logon token to its original format, replace each XML-encoded character sequence

with the character it represents. For example, replace the & character encoding with the & character.

The following table shows the examples of the most common XML encoding of illegal XML characters.

XML encoding Character

' '

" "

& &

< <

> >

For more information about representing characters in XML, refer to the specication for extensible markup

language at http://www.w3.org.

Example

This example shows a XML-encoded logon token.

COMMANDCOM-LCM:6400@{3&2=5675,U3&p=40653.0083064583,Y7&4F=12,U3&

63=secEnterprise,0P&66=60,03&68=secEnterprise:Administrator,

0P&qe=100,U3&vz=y3EqvsvoehahHhbmPrpaPjKVMU8raN3zEpnt2YjqDe4,UP}

The example shows the logon token after it has been converted to its original format.

COMMANDCOM-LCM:6400@{3&2=5675,U3&p=40653.0083064583,Y7&4F=12,U3&63=secEnterprise,

0P&66=60,03&68=secEnterprise:Administrator,

0P&qe=100,U3&vz=y3EqvsvoehahHhbmPrpaPjKVMU8raN3zEpnt2YjqDe4,UP}

3.3.6 To add a logon token to a request header

Once you have obtained a logon token, you can use it to authenticate RESTful requests that access the BI

platform.

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 39

 Note

If you obtained the logon token from the request body, you must convert it from its XML-encoded format

back to its original format. Alternatively, you can obtain the original logon token directly from the response

header.

For example, this text represents a logon token that is embedded in the XML of a response body.

COMMANDCOM-LCM:6400@{3&2=5675,U3&p=40653.0083064583,Y7&4F=12,U3&

63=secEnterprise,0P&66=60,03&68=secEnterprise:Administrator,

0P&qe=100,U3&vz=y3EqvsvoehahHhbmPrpaPjKVMU8raN3zEpnt2YjqDe4,UP}

This text represents a logon token obtained for a response header, or a token obtained from a response body

that has been converted back to its original format.

COMMANDCOM-LCM:6400@{3&2=5675,U3&p=40653.0083064583,Y7&4F=12,U3&63=secEnterprise,

0P&66=60,03&68=secEnterprise:Administrator,

0P&qe=100,U3&vz=y3EqvsvoehahHhbmPrpaPjKVMU8raN3zEpnt2YjqDe4,UP}

1. Create a new RESTful web service request or modify an existing request.

2. Add an attribute to the request header.

3. Set the name of the attribute to X-SAP-LogonToken.

4. Set the value of the attribute to the logon token value, and enclose the value in quotation marks.

Name Value

X-SAP-LogonToken "COMMANDCOM-LCM:

6400@{3&2=5604,U3&p=40623.9456463889,Y7

&4F=12,U3&63=secEnterprise,

0P&68=secEnterprise:Administrator,

0P&qe=100,U3&vz=g5KUU8cAA.d_ARmSDnBy6T7

jJVNyFCTso4s0q3dI.4k,UP}

Related Information

Converting a logon token from XML-encoded text [page 39]

3.3.7 Using HTTP basic authentication

Use HTTP basic authentication to log on to the BI platform without including a logon token in the HTTP header

of the RESTful web service request. Instead, you provide your user name, password, and an authentication

type.

 Note

User names and passwords are not transmitted securely using HTTP basic authentication, unless they are

used in conjunction with HTTPS.

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

HTTP basic authentication must be enabled by an administrator. The administrator may also dene a default

authentication type that is used if you do not specify an authentication type.

Authentication types

You can use the following authentication types with HTTP basic authentication:

● secEnterprise - Enterprise authentication

● secLDAP - LDAP authentication

● secWinAD - Windows AD authentication

● secSAPR3 - SAP authentication

Making requests using HTTP authentication consumes a license. If session caching is not used, a license is

consumed for the duration of the request and is released once the request is completed. If session caching is

used, the license associated with the cached session is used.

 Note

The user name, password, and authentication type must be base64-encoded as dened by RFC 2716. User

names that contain the : character cannot be used with HTTP basic authentication.

Using HTTP basic authentication in a web browser

To log on with a web browser using the default authentication type, provide your user name and password at

the prompt.

To log on using a particular authentication type, use <authenticationType>\<username> in the user name

eld, and provide your password in the password prompt. Replace <authenticationType> with the type of

authentication, and <username> with your user name. For example, to log on using SAP authentication with

the user name myUserName, enter secSAPR3\myUserName in the user name eld, and enter your password in

the password eld.

 Note

Sessions do not persist across multiple browser requests. Each service request you make through the basic

authentication needs a username and password encoded in base64 format in the request header.

Using HTTP basic authentication programmatically

To use HTTP basic authentication programmatically, add the Authorization attribute to the request header,

and set its value to be the base64-encoded value of the authorization string.

Use the following authorization string to use the default authentication type:

Basic <username>:<password>

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 41

Use the following authorization string to use a specic authentication type:

Basic <authtype>\<username>:<password>

3.3.8 To log o the BI platform

Before you can log o the BI platform, you must know the base URL for RESTful web service requests. You also

must have the logon token for the session that you want to invalidate.

Logon tokens expire automatically if they are not used for a set time. By default, logon tokens expire after one

hour of inactivity, but this value can be congured by an administrator. To log o of your session before it

expires automatically, make a POST request to the http://<baseURL>/logoff URL. Replace <baseURL>

with the base URL for RESTful web services.

By logging o the BI platform, you invalidate the logon token and release any license that is associated with the

session.

1. Create a new HTTP request.

2. Add the Accept attribute to the request header, and set its value to application/xml.

3. Add the X-SAP-LogonToken attribute to the request header, and set its value to the logon token value,

enclosed in quotation marks.

Name Value

X-SAP-LogonToken "COMMANDCOM-LCM:

6400@{3&2=5604,U3&p=40623.9456463889,Y7

&4F=12,U3&63=secEnterprise,

0P&68=secEnterprise:Administrator,

0P&qe=100,U3&vz=g5KUU8cAA.d_ARmSDnBy6T7

jJVNyFCTso4s0q3dI.4k,UP}

4. Use the POST method to send the request to the http://<baseURL>/logoff URL.

Replace <baseURL> with the base URL for RESTful web services.

POST http://<baseURL>/logoff

If the logo attempt was successful, the response header contains the HTTP status code 200.

Related Information

Retrieving the base URL for RESTful web service requests [page 29]

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

3.3.9 Using authenticated sessions obtained from other

SDKs

You can use another BI platform SDK to obtain a serialized session or session token from an existing

authenticated session. You can then obtain a logon token for the Business Intelligence platform RESTful web

service SDK by providing the serialized session or session token in a request to the /logon/token URL.

You can use serialized sessions or session tokens obtained from the following SDKs, version XI 3.0 and later:

● SAP BusinessObjects Business Intelligence platform Java SDK

● SAP BusinessObjects Business Intelligence platform .NET SDK

● SAP BusinessObjects Business Intelligence platform Web Services SDK

3.3.9.1 Getting session information with the BI platform

Java SDK

You can use the BI platform Java SDK to obtain a serialized session or session token from an existing session

that has already been authenticated. Provide the serialized session or session token in the body of a request to

the /logon/token URL to obtain a logon token for the Business Intelligence platform RESTful web service

SDK.

To get a serialized session, use the getSerializedSession method of the IEnterpriseSession class.

ISessionMgr sessionMgr = CrystalEnterprise.getSessionMgr();

IEnterpriseSession enterpriseSession = sessionMgr.logon("username", "password",

"cmsname", "secEnterprise");

String serializedSession = enterpriseSession.getSerializedSession();

To get a session token, use the getDefaultToken or the createLogonToken method of the

ILogonTokenMgr class.

ISessionMgr sessionMgr = CrystalEnterprise.getSessionMgr();

IEnterpriseSession enterpriseSession = sessionMgr.logon("username", "password",

"cmsname", "secEnterprise");

String sessionToken = enterpriseSession.getLogonTokenMgr().getDefaultToken();

For more information about using the BI platform Java SDK, see the SAP BusinessObjects Business Intelligence

Platform Java SDK Developer Guide.

3.3.9.2 Getting session information with the BI

platform .NET SDK

You can use the BI platform .NET SDK to obtain a serialized session or session token from an existing session

that has already been authenticated. Provide the serialized session or session token in the body of a request to

the /logon/token URL to obtain a logon token for the Business Intelligence platform RESTful web service

SDK.

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 43

To get a serialized session, use the SerializedSession property of the EnterpriseSession class.

SessionMgr sessionMgr = new SessionMgr();

EnterpriseSession session = sessionMgr.Logon("username", "password", "cms",

"secEnterprise");

string serializedSession = session.SerializedSession;

To get a session token, use the SerializedSesion property or the CreateLogonTokenEx method of the

LogonTokenMgr class.

SessionMgr sessionMgr = new SessionMgr();

EnterpriseSession session = sessionMgr.Logon("username", "password", "cms",

"secEnterprise");

string logonTokenMgr = session.LogonTokenMgr.DefaultToken;

3.3.9.3 Getting session information with the BI platform

Web Services SDK

You can use the BI platform Web Services SDK to obtain a serialized session or session token from an existing

session that has already been authenticated. Provide the serialized session or session token in the body of a

request to the /logon/token URL to obtain a logon token for Business Intelligence platform RESTful web

service SDK.

To get a serialized session, use the getSerializedSession method of the SessionInfo class.

URL boConURL = new URL("http://boserver:port/dswsbobje/services/Session");

Connection connection = new Connection(boConURL);

Session session = new Session(connection);

EnterpriseCredential credential = EnterpriseCredential.Factory.newInstance();

credential.setLogin("username");

credential.setPassword("password");

credential.setDomain("domain");

credential.setAuthType("secEnterprise");

SessionInfo sessionInfo = session.login(credential);

String serializedSession = sessionInfo.getSerializedSession();

To get a session token, use the getDefaultToken method of the SessionInfo class.

URL boConURL = new URL("http://boserver:port/dswsbobje/services/Session");

Connection connection = new Connection(boConURL);

Session session = new Session(connection);

EnterpriseCredential credential = EnterpriseCredential.Factory.newInstance();

credential.setLogin("username");

credential.setPassword("password");

credential.setDomain("domain");

credential.setAuthType("secEnterprise");

SessionInfo sessionInfo = session.login(credential);

String sessionToken = sessionInfo.getDefaultToken();

For more information about using the BI platform Web Services Consumer Java SDK, see the SAP

BusinessObjects Business Intelligence Platform Web Services Consumer Java SDK Developer Guide.

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

3.3.10 SAML Conguration for REST Endpoint

Any client that mimics the behavior of a web browser for SAML Authentication can invoke SAML REST API. In

SAML API, SAML logon (http://host:<port>/biprws/v1/logon/saml), takes no query parameters. It reads the

user principal from the HTTP request object and enables trusted authentication for that user principal, and

returns the serialized token.

 Note

You can congure SAML 2.0 only on Tomcat, WebSphere v9.x, and JBoss EAP v7.1 application server for a

REST endpoint.

To congure SAML for REST end point, follow the procedure below:

As a prerequisite, you should remove the BI platform from the application server.

1. To congure Trusted Authentication for the application server with Web session as the option in REST,

modify the properties le at <INSTALLDIR>\SAP BusinessObjects Enterprise XI 4.0\warfiles

\webapps\biprws\WEB-INF\config\custom\biprws.properties.

2. Add the property saml.enabled=true in biprws.properties le to enable SAML authentication.

3. Create the IDP user in the BI Platform or import through SDK script, or export using the CSV option in the

CMC. If you are using SAP Cloud Platform Identity Provider, export all the users and then import them to

the BI platform. Refer How to import users in bulk from Central Management Console .

4. To update the IDP metadata in the Service Provider, download the IDP metadata from the respective IDP

service providers. Copy the metadata le to <INSTALLDIR>\SAP BusinessObjects Enterprise XI

4.0\warfiles\webapps\biprws\WEB-INF and rename it to idp-meta-downloaded.xml . For more

details on downloading the IDP metadata, refer Tenant SAML 2.0 Conguration

5. Restart the application server.

If BOE is deployed on any non -Windows machine, the path seperators in lepath to the IDP metadata

under FilesystemMetadataProvider should be changed in securityContext.xml at <INSTALLDIR>

\SAP BusinessObjects Enterprise XI 4.0\warfiles\webapps\biprws\WEB-INF.

 Sample Code

<value type="java.io.File">/WEB-INF/idp-meta-downloaded.xml</value> has to

be changed to <value type="java.io.File">\WEB-INF\idp-meta-downloaded.xml</

value> for non-Windows

<bean

class="org.springframework.security.saml.metadata.ExtendedMetadataDelegate"

<constructor-arg>

<bean

class="org.opensaml.saml2.metadata.provider.FilesystemMetadataProvider">

<constructor-arg>

<!-- <value type="java.io.File">file:///C:/idp-meta-downloaded.xml</value>

-->

<!-- <value type="java.io.File">/WEB-INF/idp-meta-downloaded.xml</value> --

>

<value type="java.io.File">\WEB-INF\idp-meta-downloaded.xml</value> <!--

For non-Windows -->

</constructor-arg>

</bean>

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 45

Here, SAP Cloud Platform is used as the IDP. The downloaded IDP metadata le is as shown in the

screenshot.

 Note

○ This is a one-time activity.

○ Only one IDP is supported at a time for authentication.

6. (Optional) Generate keystore for enabling SAML 2.0.

This step is applicable only if you want to use your own keystore le.

SAML exchanges involve usage of cryptography for signing and encryption of data. A sample self-signed

keystore sampletestKeystore.jks is packaged with the product and is valid till January 01, 2023.

sampletestKeystore.jks has an alias nameTestkey and password Password1. You can now generate

a self-signed keystore le using the JAVA utility keytool. Follow the steps below to generate a keystore le:

1. Navigate to <INSTALLDIR>\SAP BusinessObjects Enterprise XI 4.0\win64_x64\sapjvm

\bin

2. Run the command: keytool -genkeypair -alias aliasname -keyalg RSA -keypass

password -keystore samplekeystore.jks -validity numberofdays -keysize

sizeofKey.

Command Description

-alias Enter the alias name of the certicate

-keypass Enter the certicate’s password

-keystore Name of the keystore le

-validity Validity of the certicate

numberofdays Number of days for which the self-signed certicate is

valid.

keyalg Species the algorithm to be used to generate the se

cret key.

keysize Species the size of the key to be generated.

The following questions are prompted after executing the command:

○ Enter keystore password: *****

○ Re-enter new password: *****

○ What is your rst and last name? : <MY_FIRST_AND_LAST_NAME>

○ What is the name of your organizational unit? : <MY_ORGANIZATIONAL_UNIT>

○ What is the name of your organization? : <MY_ORGANIZATION>

○ What is the name of your city and locality? : <MY_CITY>

○ What is the name of your State and Province? : <MY_STATE>

○ What is the two-letter country code for this unit? : <COUNTRY_CODE>

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

3. Stop the application server.

The keystore le is generated at <INSTALLDIR>\SAP BusinessObjects Enterprise XI

4.0\win64_x64\sapjvm\bin.

4. Move the keystore le to <INSTALLDIR>\SAP BusinessObjects Enterprise XI

4.0\warfiles\webapps\biprws\WEB-INF.

5. Edit the securityContext.xml le located at <INSTALLDIR>\SAP BusinessObjects

Enterprise XI 4.0\warfiles\webapps\biprws\WEB-INF with the new alias name, password,

and keystore le name. Refer to the XML code below:

 Sample Code

<bean id="keyManager"

class="org.springframework.security.saml.key.JKSKeyManager">

<constructor-arg value="/WEB-INF/sampleKeystore.jks"/>

<constructor-arg type="java.lang.String" value="Password1"/>

<constructor-arg>

<map>

</map>

</constructor-arg>

<constructor-arg type="java.lang.String" value="Testkey"/>

</bean>

Refer the table below for understanding the arguments:

XML Tag Description

<constructor-arg value="/WEB-INF/

sampleKeystore.jks"/>

Locates the keystore le.

<constructor-arg

type="java.lang.String"

value="Password1"/>

Password for the keystore le.

<entry key="aliasname"

value="password"/>

Alias password.

<constructor-arg

type="java.lang.String"

value="Testkey"/>

Alias of the default certicate

6. Restart the application server.

 Note

○ SP metadata must be generated every time the keystore le is changed.

○ If you get the below error message while generating a certicate, then you have to include two

parameters (which is highlighted in bold) in the keytool command as mentioned below:

keytool -genkeypair -alias aliasname -keyalg RSA -keypass password -

keystore samplekeystore.jks -validity numberofdays -keysize 2048.

7. Generate and upload the service provider metadata.

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 47

a. Go to: http://host:app_server_port/biprws/saml/metadata. This automatically downloads an XML le.

b. Upload the XML to the identity provider.

 Note

○ A pre-generated service Provider (SP) metadata le is shipped by default. You can edit and upload

the same metadata le. In <INSTALLDIR>\SAP BusinessObjects XI 4.0\webapps\biprws

\WEB-INF spring_saml_metadata.xml, replace the XML tags <replace_withip> with the IP

address or hostname of the machine depending on your network, and <replace_withport> with

the application server port number.

○ As an example for SAP Cloud Platform as IDP, refer the steps below:

1. After SAML application is created in SAP Cloud Platform, upload the SP metadata.

2. Create a new application under Applications.

3. Upload the SP metadata.

8. Create the WAR le using the wdeploy tool.

a. Navigate to the path <INSTALLDIR>\SAP BusinessObjects Enterprise XI 4.0\wdeploy.

b. Use the appropriate deploy command to create the war le for application-specic versions.

○ For Windows: wdeploy.bat <App_Server_Name><Version_Name> -DAPP=BOE predeploy

○ For UNIX: wdeploy.sh <App_Server_Name><Version_Name> -DAPP=BOE predeploy

 Note

You should replace <App_Server><Version_Name> with the type of application server and its version.

For example, you can use tomcat8 for Tomcat application server v8.x. Similarly, you can use jboss7 for

JBoss application server v7.x and websphere9 for WebSphere application server v9.x.

9. Once the WAR le is created, copy the WAR le and deploy it in your application server.

3.4 Retrieving the report ID

You need the report ID to access a Crystal report using the RESTful web services. You can discover the report ID

programmatically or through the Central Management Console (CMC). When you right-click a report in the

CMC, the report ID is be listed with the report properties.

For more information on navigating the BI platform repository, see the Business Intelligence Platform RESTful

Web Services Developer Guide.

3.4.1 To retrieve the report ID programatically

You must have a valid logon token, and you must know where the report is stored in the BI platform repository.

Navigate through the repository using the RESTful web services to get the report ID.

1. Create a new HTTP request.

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

2. Add the X-SAP-LogonToken attribute to the request header and set its value to be a valid logon token.

3. Use the GET method to send the request to the http://<baseURI>/infostore/Root%20Folder/

children

URL

The method returns a summary of content located in the root directory of the BI platform repository.

Folder ID's are returned in the request response. In this example response the ID of the Report Samples

folder is 5375.

<id>tag:sap.com,2010:bip-rs/ASHnC0S_Pw5LhKFbZ.iA_j4/children</id>

<title type="text">Children of Root Folder</title>

...

<entry>

<title type="text">Report Samples</title>

<id>tag:sap.com,2010:bip-rs/AfwlNA25oGlFr8gN2TxHddA</id>

<name>Administrator</name>

<uri>http://localhost:6405/biprws/infostore/12</uri>

</author>

link>

<attr name="cuid" type="string">AfwlNA25oGlFr8gN2TxHddA</attr>

<attr name="description" type="string">Contains sample reports.</attr>

<attr name="type" type="string">Folder</attr></attrs></content>

</entry>

...

</feed>

4. Create a new HTTP request.

5. Add the X-SAP-LogonToken attribute to the request header and set its value to be a valid logon token.

6. Use the GET method to send the request to the http://<baseURI>/infostore/<folderID>/

children/ URL.

 Note

Replace <folderID> with the folder ID.

The method returns a summary of the folder content and corresponding object ID's. Reports are listed by

name, and the report ID is provided with the content summary. In this example response the ID of the

Drilldown report is 5567.

<id>tag:sap.com,2010:bip-rs/AYLus319xBdAh0yC3SCxU6I/children</id>

<title type="text">Children of Feature Samples</title>

...

<entry>

<title type="text">Drilldown</title>

<id>tag:sap.com,2010:bip-rs/AbHK3o8Bnz1MpOXtKWa_1V8</id>

<name>Administrator</name>

<uri>http://localhost:6405/biprws/infostore/12</uri>

</author>

link>

<attr name="cuid" type="string">AbHK3o8Bnz1MpOXtKWa_1V8</attr>

<attr name="type" type="string">CrystalReport</attr>

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

PUBLIC 49

</attrs>

</content>

</entry>

...

</feed>

Repeat steps 4 through 6 to navigate through nested folders.

Related Information

Report URI [page 52]

50 PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

RESTful web services fundamentals

4 Using the SAP Crystal Reports RESTful

web services API

The RESTful web services API is strictly a tool for manipulating data in existing reports. It cannot create new

SAP Crystal reports.

SAP Crystal Reports RESTful web services comply with RESTful methodology. You can use GET to retrieve

reports and POST to modify transient report instances. Retrieved results are user readable and do not contain

extra markup.

RESTful web service requests are stateless. A typical report job created by the server has an inactive lifetime of

an hour before being recycled. If you request a report that has been recently requested from the server, the

existing report job may be shared.

 Note

The PUT, UPDATE, DELETE, MERGE, HEAD, and OPTIONS methods are not supported.

4.1 Common URIs

Frequently used URI's:

● http://<baseURI>

● http://<baseURI>/infostore/<reportID>/rpt

● http://<baseURI>/infostore/<reportID>/rpt/export?mime_type=application/pdf

● http://<baseURI>/infostore/<reportID>/rpt/data.svc

● http://<baseURI>/infostore/<reportID>/rpt/data.svc/Rows

● http://<baseURI>/infostore/<reportID>/rpt/data.svc/Rows(<INDEX>)

● http://<baseURI>/infostore/<reportID>/rpt/data.svc/Rows(<INDEX>)/<PROPERTY>

● http://<baseURI>/infostore/<reportID>/rpt/data.svc/Rows(<INDEX>)/<PROPERTY>/$<VALUE>

● http://<baseURI>/infostore/<reportID>/rpt/data.svc/Rows?$skip=<VALUE>

● http://<baseURI>/infostore/<reportID>/rpt/data.svc/Rows?$skiptoken=<VALUE>

● http://<baseURI>/infostore/<reportID>/rpt/data.svc/Rows?$inlinecount=allpages

● http://<baseURI>/infostore/<reportID>/rpt/data.svc/Rows/$count

● http://<baseURI>/infostore/<reportID>/rpt/data.svc/Rows?<PARAMETER>=<VALUE>

● http://<baseURI>/infostore/<reportID>/rpt/GrandTotals

● http://<baseURI>/infostore/<reportID>/rpt/instance

Related Information

Retrieving the base URL for RESTful web service requests [page 29]

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

PUBLIC 51

Retrieving the report ID [page 48]

4.2 Report URI

Allows the retrieval and interpretation of report information.

 Note

The default representation format is XML.

URI Operations Supported format Is AtomPub

<baseURI>/

infostore/

<reportID>/rpt

GET

XML, JSON No

Example: GET http://<baseURI>/infostore/<reportID>/rpt/

Make a GET request to retrieve report summary information.

Request:

● Method: GET

● URL: http://<baseURI>/infostore/<reportID>/rpt

● Request header attributes: X-SAP-LogonToken

● Request body: none

Response:

● An entry is returned that contains report summary information.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<report_summary_info xmlns="http://schemas.sap.com/crystalreports/

report_summary_info">

<report_name>DateAndTime.rpt</report_name>

<report_title></report_title>

<file_format_version>

<major_version>12</major_version>

<minor_version>0</minor_version>

</file_format_version>

<last_data_refresh_date>2010-12-17T11:59:51.000</last_data_refresh_date>

<export_uri>http://localhost:6405/biprws/infostore/6231/rpt/export</

export_uri>

<service_uri>http://localhost:6405/biprws/infostore/6231/rpt/data.svc</

service_uri>

<edit_uri>http://localhost:6405/biprws/infostore/6231/rpt/instance</

edit_uri>

</report_summary_info>

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

4.3 Report Metadata

Using this API, you can retrieve metadata structure from the crystal report.

 Note

The default representation format is XML.

URI Operations Supported format Is AtomPub

<baseURI>/

infostore/

<reportID>/rpt/

structure

GET

XML, JSON No

Example: GET http://<baseURI>/infostore/<reportID>/rpt/structure

Make a GET request to retrieve the report summary information.

Request:

● Method: GET

● URI: http://<baseURI>/infostore/<reportID>/rpt/structure

● Request header attributes: X-SAP-LogonToken

● Request body: none

Response:

● The response contains report summary as shown below:

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>

<ns17:reportstructure>

<datasourcename>10.160.197.218_Latest - Oracle12c_JDBC_Connection_10</

datasourcename>

<cuid>AUy28zmbGthPtalH6n3Gshg</cuid>

<database>Oracle 12</database>

</connection>

<table>

<name>CUSTOMER</name>

<tablekind>SQL_Table</tablekind>

<kind>SQL_Field</kind>

<datatype>decimal</datatype>

<qualifiedname>CUSTOMER.CUST_ID</qualifiedname>

</dbfield>

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

PUBLIC 53

<name>FIRST_NAME</name>

<kind>SQL_Field</kind>

<datatype>string</datatype>

<technicalname>FIRST_NAME</technicalname>

<qualifiedname>CUSTOMER.FIRST_NAME</qualifiedname>

</dbfield>

<kind>SQL_Field</kind>

<datatype>string</datatype>

<qualifiedname>CUSTOMER.LAST_NAME</qualifiedname>

</dbfield>

<kind>SQL_Field</kind>

<datatype>decimal</datatype>

<qualifiedname>CUSTOMER.AGE</qualifiedname>

</dbfield>

<name>PHONE_NUMBER</name>

<kind>SQL_Field</kind>

<datatype>string</datatype>

<technicalname>PHONE_NUMBER</technicalname>

<qualifiedname>CUSTOMER.PHONE_NUMBER</qualifiedname>

</dbfield>

<name>ADDRESS</name>

<kind>SQL_Field</kind>

<datatype>string</datatype>

<technicalname>ADDRESS</technicalname>

<qualifiedname>CUSTOMER.ADDRESS</qualifiedname>

</dbfield>

<kind>SQL_Field</kind>

<datatype>decimal</datatype>

<qualifiedname>CUSTOMER.CITY_ID</qualifiedname>

</dbfield>

<name>SALES_ID</name>

<kind>SQL_Field</kind>

<datatype>decimal</datatype>

<technicalname>SALES_ID</technicalname>

<qualifiedname>CUSTOMER.SALES_ID</qualifiedname>

</dbfield>

<name>SPONSOR_ID</name>

<kind>SQL_Field</kind>

<datatype>decimal</datatype>

<technicalname>SPONSOR_ID</technicalname>

<qualifiedname>CUSTOMER.SPONSOR_ID</qualifiedname>

</dbfield>

</dbfields>

</table>

<table>

<name>REGION</name>

<tablekind>SQL_Table</tablekind>

<name>REGION_ID</name>

<kind>SQL_Field</kind>

<datatype>decimal</datatype>

<technicalname>REGION_ID</technicalname>

<qualifiedname>REGION.REGION_ID</qualifiedname>

</dbfield>

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

<name>REGION</name>

<kind>SQL_Field</kind>

<datatype>string</datatype>

<technicalname>REGION</technicalname>

<qualifiedname>REGION.REGION</qualifiedname>

</dbfield>

<name>COUNTRY_ID</name>

<kind>SQL_Field</kind>

<datatype>decimal</datatype>

<technicalname>COUNTRY_ID</technicalname>

<qualifiedname>REGION.COUNTRY_ID</qualifiedname>

</dbfield>

</dbfields>

</table>

<table>

<name>COUNTRY</name>

<tablekind>SQL_Table</tablekind>

<name>COUNTRY_ID</name>

<kind>SQL_Field</kind>

<datatype>decimal</datatype>

<technicalname>COUNTRY_ID</technicalname>

<qualifiedname>COUNTRY.COUNTRY_ID</qualifiedname>

</dbfield>

<name>COUNTRY</name>

<kind>SQL_Field</kind>

<datatype>string</datatype>

<technicalname>COUNTRY</technicalname>

<qualifiedname>COUNTRY.COUNTRY</qualifiedname>

</dbfield>

</dbfields>

</table>

<table>

<tablekind>SQL_Table</tablekind>

<kind>SQL_Field</kind>

<datatype>decimal</datatype>

</dbfield>

<kind>SQL_Field</kind>

<datatype>string</datatype>

</dbfield>

<name>REGION_ID</name>

<kind>SQL_Field</kind>

<datatype>decimal</datatype>

<technicalname>REGION_ID</technicalname>

<qualifiedname>CITY.REGION_ID</qualifiedname>

</dbfield>

</dbfields>

</table>

</tables>

</datasource>

<joins>

<join>

<sourcetable>REGION</sourcetable>

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

PUBLIC 55

<kind>Inner</kind>

<targettable>COUNTRY</targettable>

<name>COUNTRY_ID</name>

<kind>DatabaseField</kind>

<datatype>decimal</datatype>

</fromfield>

<fieldlinkOperator>Equal</fieldlinkOperator>

<name>COUNTRY_ID</name>

<kind>DatabaseField</kind>

<datatype>decimal</datatype>

</tofield>

</fieldlink>

</fieldlinks>

</join>

<join>

<sourcetable>REGION</sourcetable>

<kind>Inner</kind>

<name>REGION_ID</name>

<kind>DatabaseField</kind>

<datatype>decimal</datatype>

</fromfield>

<fieldlinkOperator>Equal</fieldlinkOperator>

<name>REGION_ID</name>

<kind>DatabaseField</kind>

<datatype>decimal</datatype>

</tofield>

</fieldlink>

</fieldlinks>

</join>

<join>

<kind>Inner</kind>

<targettable>CUSTOMER</targettable>

<kind>DatabaseField</kind>

<datatype>decimal</datatype>

</fromfield>

<fieldlinkOperator>Equal</fieldlinkOperator>

<kind>DatabaseField</kind>

<datatype>decimal</datatype>

</tofield>

</fieldlink>

</fieldlinks>

</join>

</joins>

</datasources>

<usedfield fieldtype="DatabaseField" uniqueid="{CUSTOMER.CITY_ID}"

name="CITY_ID" />

<usedfield fieldtype="DatabaseField" uniqueid="{COUNTRY.COUNTRY}"

name="COUNTRY" />

<usedfield fieldtype="DatabaseField" uniqueid="{CUSTOMER.FIRST_NAME}"

name="FIRST_NAME" />

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

<usedfield fieldtype="DatabaseField" uniqueid="{CUSTOMER.LAST_NAME}"

name="LAST_NAME" />

<usedfield fieldtype="DatabaseField" uniqueid="{REGION.REGION}"

name="REGION" />

</usedfields>

<subreportstructureuri>http://10.160.199.155:6405/biprws/infostore/6518/rpt/

First+SubReport/structure</subreportstructureuri>

<subreportstructureuri>http://10.160.199.155:6405/biprws/infostore/6518/rpt/

Second%26%21%40%23%24%25%5E%26*%28%29SubReport/structure</

subreportstructureuri>

</subreports>

</ns17:reportstructure>

Tag Name Description

<ns17:reportstructure>

This contains the report structure. The following are its sub

tags:

● <datasources>

● <usedfields>

● <groupconditions>

● <parameters>

● <summary>

● <runningtotals>

● <subreports>

Contains list of data sources that are used by the report.

This contains <datasource> as a sub tag.

This contains information on a particular data source that is

consumed by the report. This tag contains the following sub

tags:

● <datasourcename>: This is the name of the data

source.

● <connection>: This contains data source connec

tion details.

● <tables>: This contains table details.

 Note

Each <datasource> tag refers to one connectivity.

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

PUBLIC 57

Tag Name Description

This contains data source connection details.

This contains the following sub tags:

● <cuid>: This is the unique connection ID

● <kind>: This is the type of connection like the follow

ing:

○ SQL-Relation connection

○ DSL-Other connections

● <database>: This contains following type of data

bases:

○ PQUERY-Analysis View

○ BICS-BICS connection

○ DSL-Universe

○ HANA-HANA OLAP connection

○ <DATABASE>- Connected database server name

along with version is displayed

● <datasourcelanguagelevel>: Language level of

data source

<joins>

This contains single or multiple join information.

This contains <join> as a sub tag.

<join>

This contains join information between the tables.

● <sourcetable>: This contains source table name.

● <kind>: This contains the type of join.

● <targettable>: This contains target table name.

● <fieldlinks>: This contains eld link information.

This contains eld link information. This contains only one

<fieldlink> as a sub tag.

This contains following sub tags:

● <fromfield> : This contains source table's eld in

formation.

● <fieldlinkOperator>: This contains operator

name like, Equal, NotEqual or LessThan etc

● <tofield> : This contains destination table's eld

information.

This contains source table's eld information.This contains

the following sub tags:

● <name>: This is the eld name.

● <kind>: This is the eld type.

58 PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

Tag Name Description

This contains destination table's eld information.

● <name>: This is the destination table's eld name.

● <kind>: This is the destination table's eld type.

<tables> This contains tables' information. This contains table

as a sub tag.

<table>

This contains table specic information and contains the fol

lowing sub tags:

● <name>: Table name

● <tablekind>: Table types, like:

○ SQL_Table: Relation connections

○ Universe_Table: Other connections

● <dbfields>: Database eld information

This contains database eld information. This contains

<dbfield> as asub tag.

This tag contains the following sub tags:

● <name>: Database eld name

● <kind>: Database eld type, like:

○ Dimention

○ Measure

○ ValueBasedHierarchy

● <datatype>: Database eld's data type

● <technicalname>: Database eld technical name

● <qualifiedname>: Database eld qualied name

This contains information about elds used in report.

This tag contains the following sub tag (single or multiple):

<usedfield>: Field used

This tag either contains <parameter> or

<parametergroup> tag.

● <parameter>: Parameter information

● <parametergroup>: Parameter group information

This contains <parameter> as sub tag.

This tag contains the following sub tags:

● <currentvalues>: Parameter's current values

● <initialvalues> : Parameter's initial values

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

PUBLIC 59

Tag Name Description

This contains database eld used in the group.

This tag contains <groupcondition> as sub tag.

This contains summary elds that are used in the reports.

This tag contains <summaryfield> as sub tag.

This contains running totals that are used in the report.

This tag contains <runningtotal> as sub tag.

This contains formulas that are used in the report.

This tag contains <formula> as sub tag.

This is the formula that is used in the report.

This tag contains <formulatext> as sub tag.

This contains sub reports' URI. Using this you can access

sub report's structure.

This tag contains <subreportstructureuri>as sub

tag.

4.4 Report instances

A report instance is a temporary copy of a report stored in the BI platform repository. The GET method returns

only report instances.

When you use the GET method to request an instance of a report that contains saved data, the RESTful web

service will show results that reect data saved the last time the report was refreshed in the repository. This is

indicated by the last_refresh_date property in the request response body. When you use the GET method

to request an instance of a report that does not contain saved data, you can view report metadata and

summary information, but requests that access report data will fail.

You can POST report data only to a transient report instance. Therefore, the report contained in the repository

will not be modied by the RESTful web service. The data returned by the instance will reect data refreshed at

the time the latest POST to the instance was performed.

 Note

When you POST eld names to a transient report instance, eld names are limited to 480 characters.

To view the data in a report without saved data, you must create a transient instance.

By default, a transient instance expires after an hour of inactivity. If the server is overloaded, an instance may

be recycled to make room for a new job before one hour has elapsed.

To create a transient instance you use a GET method to the /instance URI. This returns a form that must be

lled out and submitted using the POST method. The form contains entries containing connection information,

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

and any parameters used by the report. The form also contains a SuppressData entry that is set to false by

default.

● If SuppressData is set to false, rowset data will be retrieved from the report's data source and included

in the transient report instance.

● If SuppressData is set to true, the transient report instance will not include any data. This is useful in

scenarios where the report's data will be supplied programmatically using the POST to rows method in the

data service.

 Note

This option is only available for reports created without connections to universes.

The POST method creates the transient instance, and the response includes the instance ID link to the new

transient instance.

To use the transient instance, add the instance ID to the URI. For example:

http://<baseURI>/infostore/<reportID>/rpt/<instanceID>/data.svc/Rows

 Note

Replace <instanceID> with the ID of the instance you have created.

URI Operations Supported format Is AtomPub

<baseURI>/

infostore/

<reportID>/rpt/

instance

GET, POST

XML yes

 Note

If you create a report instance that requires a date or time parameter, you must use the Edm.Datetime

convention. For example, datetime'2010-02-26T17:08:53'. See the interactive parameters section for

more information.

Related Information

Rows [page 81]

Interactive parameters [page 71]

4.4.1 To create a transient report instance from an existing

report

1. Create a new HTTP request.

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

PUBLIC 61

2. Use the GET method to send the request to this URL: http://<baseURI>/infostore/

<reportID>/rpt/instance URL.

Example request:

○ Method: GET

○ URL: http://<baseURI>/infostore/<reportID>/rpt/instance

○ Request header attributes: X-SAP-LogonToken

○ Request body: none

Example response:

○ The response contains a form.

<title type="text">Crystal Reports New Instance</title>

<entry>

<title type="text">SuppressData</title>

<attrs>

<attr name="value" type="boolean">false</attr>

</attrs>

</content>

</entry>

<entry>

<title type="text">ConnectionInfo</title>

<id>reportse--</id>

<attrs>

<attr name="ServerName" type="string">reportse</attr>

</attrs>

</content>

</entry>

</feed>

3. Create another HTTP request.

4. Fill the form and use a POST method to send the request to the http://<baseURI>/infostore/

<reportID>/rpt/instance URL.

Example request:

○ Method: POST

○ URL: http://<baseURI>/infostore/<reportID>/rpt/instance

○ Request header attributes: X-SAP-LogonToken, Content-Type

○ Request body: Fill out the form retrieved by the GET request.

<title type="text">Crystal Reports New Instance</title>

<entry>

<title type="text">SuppressData</title>

<attrs>

<attr name="value" type="boolean">false</attr>

</attrs>

</content>

</entry>

<entry>

<title type="text">ConnectionInfo</title>

<id>reportse--</id>

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

<attrs>

<attr name="ServerName" type="string">reportse</attr>

<attr name="DatabaseName" type="string">HOSTID</attr>

<attr name="password" type="string">PASSWORD</attr>

</attrs>

</content>

</entry>

</feed>

 Note

Replace <HOSTID> with the database name, <USER> with the user name, and <PASSWORD> with the

password. Parameter elds may also appear in the form if the report includes parameter prompts.

Example response:

○ Response Header:

HTTP/1.1 201 Created

Content-Type: application/xml

Location: http://localhost:6405/biprws/1667/rpt/eNotTsEKgzAU

_5r2rBXnduhhqAdhA9GNnUt5KzLbynvdxL.fc_ySkISQ3HRex.

ntg1AtLkm2OpO9hiAHXVbVSXZ6FEVjo_ecwDiTgOIzrQaBnck7xkjWMC3GAQF

_AFkIVSq1TkG9jqh_Yofmuo3dmeMaN0pmHmCJmKjHaIFoCm789w8PXs0Ledmv3HX2BT49NO8

Date: Fri, 27 May 2011 21:52:19 GMT

Content-Length: 513

○ Response body:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<report_name>DateAndTime.rpt</report_name>

<resource>http://localhost:6405/biprws/infostore/1667/rpt/eNotTsEKgzAU

_5r2rBXnduhhqAdhA9GNnUt5KzLbynvdxL.fc_ySkISQ3HRex.

ntg1AtLkm2OpO9hiAHXVbVSXZ6FEVjo_ecwDiTgOIzrQaBnck7xkjWMC3GAQF

_AFkIVSq1TkG9jqh_Yofmuo3dmeMaN0pmHmCJmKjHaIFoCm789w8PXs0Ledmv3HX2BT49NO8</

resource>

<id>eNotTsEKgzAU_5r2rBXnduhhqAdhA9GNnUt5KzLbynvdxL.

fc_ySkISQ3HRex.ntg1AtLkm2OpO9hiAHXVbVSXZ6FEVjo

_ecwDiTgOIzrQaBnck7xkjWMC3GAQF_AFkIVSq1TkG9jqh

_Yofmuo3dmeMaN0pmHmCJmKjHaIFoCm789w8PXs0Ledmv3HX2BT49NO8</id>

</reportInstance>

The response body contains the URI to a new instance, and the unique ID associated with the instance. The

new instance ID is also accessible in the response header.

4.5 Exporting

Exports a report to the specied MIME type.

URI

Operations Supported format Is AtomPub

<baseURI>/

infostore/

<reportID/rpt/

GET

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

PUBLIC 63

URI Operations Supported format Is AtomPub

export?

mime_type=<MIMETYPE

 Note

Replace <MIMETYPE> with the type of le that you want to export to.

MIME types Description

text/csv

Character Separated Values (CSV )

application/vnd.ms-excel

Microsoft Excel (97-2003)

application/vnd.ms-excel&isDataOnly=true

Microsoft Excel Data-Only (97-2003)

application/vnd.openxmlformats-

officedocument.spreadsheetml.sheet

Microsoft Excel Workbook Data-Only

application/msword

Microsoft Word

application/msword&isEditable=true

Microsoft Word Editable

application/PDF

PDF

application/rtf

Rich Text Format (RTF )

text/ttx

Tab Separated Text (TTX)

text/plain

Text

application/xml

XML

 Note

The request can be customized with optional parameters.

Optional parameters Type Description

startPageNumber=<VALUE>

integer

<VALUE> species the rst page to

export.

endPageNumber=<VALUE>

integer

<VALUE> species the rst page to

export.

isCreateBookmarksFromGroup

Tree=<value>

boolean

<VALUE> denes whether bookmarks

need to be present while exporting to

PDF

 Note

All pages are exported if start and end page numbers are not specied.

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

Example: GET http://<baseURI>/infostore/<reportID>/rpt/export?

mime_type=application/PDF

Make a GET request to export a report to PDF.

Request:

● Method: GET

● URL: http://<baseURI>/infostore/<reportID>/rpt/export?mime_type=application/PDF

● Request header attributes: X-SAP-LogonToken

● Request body: none

Response:

● Response header:

Status Code: 200 OK

Server: Apache-Coyote/1.1

Date: Mon 30, May 2011 22:23:22 GMT

Content-Type: application/PDF

Transfer-Encoding: chunked

● Response body: contains the PDF encoding of the report

4.5.1 Character separated value (CSV) parameters

The following parameters can be used to format a report exported in character separated value (CSV) format.

Optional parameter Type Description

?delimiter=<VALUE>

string

<VALUE> will be used as the delimiter

in the report.

?separator=<VALUE>

string

<VALUE> is used as the character

separator in the report.

reportSectionsOption=<VALU

integer, string

<VALUE>sets the report section

option using the following values:

● 0 = Export

● 1 = ExportIsolated

● 2 = doNotExport

 Note

You can use either the integer or

the string to set the base area type.

For example:

reportSectionsOption="E

xport"

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

PUBLIC 65

Optional parameter Type Description

 Note

Other values will result in an

exception being thrown.

groupSectionsOption=<VALUE

integer, string

<VALUE> sets the group sections

option using the following values:

● 0 = Export

● 1 = ExportIsolated

● 2 = doNotExport

 Note

You can use either the integer or

the string to set the base area type.

For example:

groupSectionsOption="Ex

port"

 Note

Other values will result in an

exception being thrown.

4.5.2 Microsoft Excel parameters

The following optional parameters can be used to format a report exported to Microsoft Excel.

Optional parameter Type Description

?constantWidth=<VALUE>

integer

<VALUE> sets the constant width of

the report.

 Note

constantWidth and

baseAreaType are mutually

exclusive. If both exist in a query,

constant width will take

precedence.

?baseAreaType=<VALUE>

integer, string

<VALUE> sets the base area type,

using one of the following values:

66 PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

Optional parameter Type Description

● 1 = ReportHeader

● 2 = PageHeader

● 3 = GroupHeader

● 4 = Detail

● 5 = GroupFooter

● 7 = Page Footer

● 8 = ReportFooter

● 255 = WholeReport

 Note

You can use either the integer or

the string to set the base area type.

For example: ?

baseAreaType="ReportHea

der"

 Note

Other values will result in an

exception being thrown.

 Note

constantWidth and

baseAreaType are mutually

exclusive. If both exist in a query,

constant width will take

precedence.

exportPageHeaderFooter=<VA

LUE>

integer

<VALUE> sets the page header and

footer using one of the following values.

● 0 = None

● 1 = Once

● 2 = Each Page

 Note

Other values will result in an

exception being thrown.

isPageBreakCreated=<VALUE>

boolean If VALUE is “true”, page breaks are

inserted at the end of each report page

when exported to MS-Excel. The

following values are valid:

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

PUBLIC 67

Optional parameter Type Description

● true

● false

 Note

The value is false by default.

4.5.3 Microsoft Excel Data-Only parameters

The following parameters can be used to format or return information on a report exported to Microsoft Excel

Data-Only.

Optional parameter Type Description

?constantWidth=VALUE

integer

VALUE sets the width of the report.

 Note

constantWidth

and

baseAreaType are mutually

exclusive. If both exist in a query,

constant width will take

precedence.

?baseAreaType=VALUE

integer, string

VALUE sets the base area type using

one of the following values:

● 1 = ReportHeader

● 2 = PageHeader

● 3 = GroupHeader

● 4 = Detail

● 5 = GroupFooter

● 7 = Page Footer

● 8 = ReportFooter

● 255 = WholeReport

 Note

You can use either the integer or

the string to set the base area type.

For example:

baseAreaType="ReportHea

der"

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

Optional parameter Type Description

 Note

Other values will result in an

exception being thrown.

 Note

constantWidth and

baseAreaType are mutually

exclusive. If both exist in a query,

constant width will take

precedence.

exportPageHeaderFooter=VAL

integer

VALUE exports the page header and

footer using one of the following values:

● 0 = None

● 1 = Once

● 2 = Each Page

 Note

Other values will result in an

exception being thrown.

?isFormatUsed

boolean

Returns TRUE if this format is used,

FALSE otherwise.

?isWorksheetFuncUsed

boolean

Returns TRUE if worksheet functions

are used, FALSE otherwise.

?isColAlignmentMaintained

boolean

Returns TRUE if column alignment is

maintained, FALSE otherwise.

isRelativeObjPositionMaint

ained

boolean

Returns TRUE if relative object position

is maintained, FALSE otherwise.

?isPageHeaderExported

boolean

Returns TRUE if the page header is

exported, FALSE otherwise.

?isPageHeaderSimplified

boolean

Returns TRUE if page header is

simplied, FALSE otherwise.

?isShowGroupOutlines

boolean

Returns TRUE if group outlines are

shown, FALSE otherwise.

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

PUBLIC 69

4.5.4 Rich Text Format (RTF) parameters

The following parameter can be used to return information on a report exported in rich text format (RTF).

Optional parameter Type Description

isPageBreakAfterEachReport

Page

boolean

Returns TRUE if there is a page break

after each report page, FALSE

otherwise.

4.5.5 Tab separated text (TTX) parameters

The following parameters can be used to format or return information on a report exported in tab separated

text (TTX) format.

Optional parameter Type Description

?charactersPerInch=<VALUE>

integer

<VALUE> sets the number of

characters per inch.

?baseAreaType=<VALUE>

integer, string

<VALUE> sets the export charset

types using one of the following values:

● 0 = UTF-8

● 1 = UTF-16LE

● 2 = UTF-16BE

 Note

Other values will result in an

exception being thrown.

?insertFormFeedCharacter

boolean

Returns <TRUE> if a custom separator

is used between feeds, <FALSE>

otherwise.

minimumLinesPerPage=<VALUE

integer

<VALUE> is an integer that sets the

minimum number of lines per page.

pageAreaExportType=<VALUE>

integer

<VALUE> sets the page area export

type using one of the following values:

● 0 = AsInReport

● 1 = OncePerReport

● 2 = DoNotExport

70 PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

Optional parameter Type Description

 Note

Other values will result in an

exception being thrown.

doubleQuoteStringFields=<V

ALUE>

boolean

<TRUE> surrounds all string values by

double quotes(“”), and exports multi-

line text objects in a single line. The

default

<VALUE> is <FALSE>.

4.5.6 XML parameters

The following parameters can be used to return information on a report exported in RTF format.

Optional parameter Type Description

?apply/XSLTIndex=1

Applies a XSL transformation to the

exported XML using a zero-based

index.

?apply/XSLTName=<VALUE>

string

Applies a XSL transformation to the

exported XML using the XSLT's name.

<VALUE> is a string that contains the

name of the XSLT.

4.6 Interactive parameters

If a report contains interactive parameters, they can be modied to lter the data that is returned from an

export, row, grand totals, or group request. To modify interactive parameter values for these requests, add the

parameters to the request URL using ?<PARAMETERNAME>=<VALUES> .

 Note

Replace <PARAMETERNAME> with the name of the parameter, and replace <VALUES> with the value the

parameter is set to.

Interactive parameter values can be modied when you create a new instance of a report. To set parameter

values you must GET the report instance creation form, set the parameter values in the form that is returned,

and POST the form to create a new instance that uses the parameter values you have specied.

The following values are supported by parameters:

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

PUBLIC 71

Supported values Example

Null

MyParameter=null

Edm.Boolean

MyParameter=true

Edm.DateTime

MyTimestamp=datetime'2000-12-12T12:34:56

.403'

Edm.Double

MyCost=7.89

Edm.String

MyCountry='Canada'

Edm.Time

MyTime=time'PT17H'

Date

MyDate=datetime'2010-02-26T17:08:53'

 Note

Date values have no corresponding OData primitive

type. They are represented using Edm.Datetime. The

time portion must be valid, but will not aect the date

being represented.

Range parameter values are specied using an open square bracket. Values are separated by commas. To

exclude the lower or upper bound, you can indicate this using a parentheis.

Range Example

Bounded

MyLunchBreak=[time'PT12H',time'PT13H']

No lower bound

MyMorning=[,time'PT12H']

No upper bound

MyEvening=[time'PT18H',]

Exclude lower bound

MyLunchBreak=(time'PT12H', time'PT13H']

Exclude upper bound

MyLunchBreak=[time'PT12H', time'PT13H')

Multiple parameter values are specied by a sequence separated by commas. The values in the sequence can

be scalar, or range values, or a mixture of the two.

MyVacationDays=dateTime'2011-03-04T00:00',dateTime'2011-03-07T00:00',

[dateTime'2011-03-17T00:00',dateTime'2011-03-21T00:00']

Example: GET http://<baseURI>/infostore/<reportID>/rpt/data.svc/Rows?

Make a GET request to retrieve rows ltered by the specied parameter.

Request:

● Method: GET

● URL: http://<baseURI>/infostore/<reportID>/rpt/data.svc/Rows?Contact_title="Mr.'"

● Request header attributes: X-SAP-LogonToken

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

● Request body: none

Response:

● An entry is returned that contains rows ltered by the parameter set in the request.

<?xml version="1.0" encoding="utf-8"?>

<feed xmlns="http://www.w3.org/2005/Atom"

xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"

xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">

<id>http://localhost:6405/biprws/infostore/7422/rpt/data.svc/Rows?

Contact_Title='Mr.'</id>

<entry>

<id>http://localhost:6405/biprws/infostore/7422/rpt/data.svc/Rows(0)?

Contact_Title='Mr.'</id>

<category term="InteractiveKKNG.Row"

scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"></

category>

<m:properties>

<d:ID>0</d:ID>

<d:Contact_First_Name>Markus</d:Contact_First_Name>

<d:Contact_Title>Mr.</d:Contact_Title>

<d:Country>USA</d:Country>

<d:Last_Year_s_Sales>12013.955</d:Last_Year_s_Sales>

</m:properties>

</content>

</entry>

</feed>

Related Information

Exporting [page 63]

Rows [page 81]

Report instances [page 60]

Grand totals [page 74]

Groups [page 76]

4.7 OData Protocol

The Open Data Protocol (OData) is used to query and update report data. OData is a set of extensions to

AtomPub that allows users to discover, navigate, and retrieve data using the programming language of your

choice, or a web browser.

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

PUBLIC 73

4.7.1 Accessing the OData service document

Returns the service document at the root of the OData service.

URI Operations Supported format Is AtomPub

<baseURI>/

infostore/

<reportID>/rpt/

data.svc

GET

XML, JSON No

Example: GET http://<baseURI>/infostore/<reportID>/rpt/data.svc

Make a GET request to retrieve the OData service document.

Request:

● Method: GET

● URL: http://<baseURI>/infostore/<reportID>/rpt/data.svc

● Request header attributes: X-SAP-LogonToken

● Request body: none

Response:

● An entry that contains information provided by the root of the OData service.

<?xml version="1.0" encoding="utf-8"?>

<app:service xmlns:app="http://www.w3.org/2007/app"

xmlns="http://www.w3.org/2007/app"

xmlns:atom="http://www.w3.org/2005/Atom"

xml:base="http://localhost:6405/biprws/infostore/6311/rpt/data.svc">

<atom:title>Default</atom:title>

<atom:title>Rows</atom:title>

</collection>

<atom:title>GrandTotals</atom:title>

</collection>

</workspace>

</app:service>

4.7.2 Grand totals

Returns the grand totals collection in XML or JSON format. The grand totals collection includes all summaries

available in the report header and footer.

 Note

Running totals are not included in the collection.

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

URI Operations Supported format Is AtomPub

<baseURI>/

infostore/

<reportID>/rpt/

data.svc/

GrandTotals

GET

XML, JSON Yes

Optional parameters Type Description

GrandTotals(0)/<FIELDNAME>

string

Returns the eld value associated with

a grand total.<FIELDNAME> is the a

string that species the eld that you

want to retrieve.

GrandTotals(0)/

<FIELDNAME>/$value

string

Returns only the value associated with

a grand total.<FIELDNAME> is the a

string that species the eld that you

want to retrieve.

Example: GET http://<baseURI>/infostore/<reportID>/rpt/data.svc/

GrandTotals

Make a GET request to retrieve the grand totals in a report.

Request:

● Method: GET

● URL: http://<baseURI>/infostore/<reportID>/rpt/data.svc/GrandTotals

● Request header attributes: X-SAP-LogonToken

● Request body: none

Response:

● An that contains the grand totals of the report is returned.

<?xml version="1.0" encoding="utf-8"?>

<feed xmlns="http://www.w3.org/2005/Atom"

xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"

xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">

<title type="text">GrandTotals</title>

<id>http://localhost:6405/biprws/infostore/6141/rpt/data.svc/

GrandTotals</id>

<entry>

<id>http://1ocalhost:6405/biprws/infostore/6141/rpt/data.svc/

GrandTotals(0)</id>

<category term="SummariesALLSectionsNG_rpt.GrandTotal"

scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"></

category>

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

PUBLIC 75

<m:properties>

<d:ID>0</d:ID>

<d:Count_Dealer_Price>331</d:Count_Dealer_Price>

<d:DistinctCount_List_Price>121</d:DistinctCount_List_Price>

</m:properties>

</content>

</entry>

</feed>

4.7.3 Groups

Returns group path, group name, and links to group contents.

 Note

Hierarchical groups are not supported.

URI Operations Supported format Is AtomPub

<baseURI>/

infostore/

<reportID>/rpt/

data.svc/

GET

XML, JSON Yes

Optional parameters Type Description

<GroupName>('<GroupPath>')

integer

Returns a linked list containing the data

associated with the specied group.

<GroupName> is the name of the top

level group. <GroupPath> is a string

that represents the index of the

subgroup to retrieve. Group paths are

zero-based.

 Note

To navigate through subgroups,

add the subgroup name and path

to the URL. For example:

http://<baseURI>/

infostore/

<reportID>/rpt/

data.svc/

Country('0')/

Region('0-2')/

City('0-2-4')

<GroupName1>('<GroupPath>'

)/$links/<GroupName2>

integer

Returns a linked list containing the data

associated with group specied by

76 PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

Optional parameters Type Description

<GroupName2>. <GroupName1> is

the name of the top level group.

<GroupPath> is a string that

represents the index of the top level

group. Group paths are zero-based.

The following example returns a linked

list of all cities associated with

Country('0'):

http://<baseURI>/

infostore/

<reportID>/rpt/data.svc/

Country('0')/$links/City

<GroupName>?

$select=<PROPERTY>

string

Returns row data containing only the

properties specied by <PROPERTY>.

The following values can be used:

● * = return all properties

● <PROPERTY> = the name of the

property to return.

● <PROPERTY1>,<PROPERTY2>

...

= the names of the properties

to return. Multiple properties are

separated by commas.

 Note

Case sensitive.

<GroupName>?

$select=<CATEGORY>,<PROPER

TY>...

string

Returns group data containing only the

properties specied by <PROPERTY>,

and only links to the category type

specied by

<CATEGORY>. Multiple

properties are separated by commas.

 Note

Case sensitive.

4.7.3.1 To navigate groups and subgroups

1. Create a new HTTP request.

2. Use the GET method to send a request to retrieve a list of links to the contents of the top-level group.

For example::

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

PUBLIC 77

○ In this example, the top level group is Customer_Country.

○ Method: GET

○ URL: <baseURI>/infostore/<reportID>/rpt/data.svc/Customer_Country

○ Request header attributes: X-SAP-LogonToken

○ Request body: none

Example response:

<?xml version="1.0" encoding="utf-8"?>

<feed xmlns="http://www.w3.org/2005/Atom"

xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"

xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">

<title type="text">Customer_Country</title>

<id>http://localhost:6405/biprws/infostore/6246/rpt/data.svc/

Customer_Country</id>

<entry>

<id>http://localhost:6405/biprws/infostore/6246/rpt/data.svc/

Customer_Country('0')</id>

<title type="text">0: Canada</title>

link>

<category term="ng_groupParams_rpt.Customer_Country"

scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"></

category>

rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/

Customer_Region"

type="application/atom+xml;type=feed" title="Customer_Region">

</link>

rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/

Customer_City"

type="application/atom+xml;type=feed" title="Customer_City">

</link>

<m:properties>

<d:ID>0</d:ID>

<d:Name>Canada</d:Name>

<d:Sum_of_Amount_of_Delivered_Items_2>377.0</

d:Sum_of_Amount_of_Delivered_Items_2>

</m:properties>

</content>

</entry>

<entry>

<id>http://localhost:6405/biprws/infostore/6246/rpt/data.svc/

Customer_Country('1')</id>

<title type="text">1: England</title>

link>

<category term="ng_groupParams_rpt.Customer_Country"

scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"></

category>

rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/

Customer_Region"

type="application/atom+xml;type=feed" title="Customer_Region">

</link>

rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/

Customer_City"

type="application/atom+xml;type=feed" title="Customer_City">

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

</link>

<m:properties>

<d:ID>1</d:ID>

<d:Name>England</d:Name>

<d:Sum_of_Amount_of_Delivered_Items_2>1553.0</

d:Sum_of_Amount_of_Delivered_Items_2>

</m:properties>

</content>

</entry>

</feed>

3. Use the GET method to send a request to a link retrieved in the previous step.

Example request:

○ Retrieve regions associated with Customer_Country('0').

○ Method: GET

○ URL: <baseURI>/infostore/<reportID>/rpt/data.svc/Customer_Country('0')/

Customer_Region

○ Request header attributes: X-SAP-LogonToken

○ Request body: none

Example response:

<?xml version="1.0" encoding="utf-8"?>

<feed xmlns="http://www.w3.org/2005/Atom"

xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"

xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">

<title type="text">Customer_Region</title>

<id>http://localhost:6405/biprws/infostore/6246/rpt/data.svc/

Customer_Country('0')/Customer_Region</id>

title="Customer_Region"></link>

<entry>

<id>http://localhost:6405/biprws/infostore/6246/rpt/data.svc/

Customer_Region('0-0')</id>

link>

<category term="ng_groupParams_rpt.Customer_Region"

scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"></

category>

rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/

Customer_City"

type="application/atom+xml;type=feed" title="Customer_City">

</link>

<m:properties>

<d:ID>0-0</d:ID>

<d:Name>130</d:Name>

<d:Sum_of_Amount_of_Delivered_Items_3>377.0</

d:Sum_of_Amount_of_Delivered_Items_3>

</m:properties>

</content>

</entry>

</feed>

4. Repeat steps 2 to 3 to drill down through group data.

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

PUBLIC 79

4.7.4 Metadata

Returns an EDMX document that contains a complete description of the feeds, types, properties, and

collections exposed by the OData service.

URI Operations Supported format Is AtomPub

<baseURI>/

infostore/

<reportID>/rpt/

data.svc/$metadata

GET

XML Yes

Example: GET http://<baseURI>/infostore/<reportID>/rpt/data.svc/

$metadata

Make a GET request to retrieve report metadata.

Request:

● Method: GET

● URL: http://<baseURI>/infostore/<reportID>/rpt/data.svc/$metadata

● Request header attributes: X-SAP-LogonToken

● Request body: none

Response:

● An EDMX document containing report metadata is returned.

<?xml version="1.0" encoding="utf-8"?>

<edmx:Edmx xmlns:edmx="http://schemas.microsoft.com/ado/2007/06/edmx"

Version="1.0">

<edmx:DataServices xmlns:m="http://schemas.microsoft.com/ado/2007/08/

dataservices/metadata" m:DataServiceVersion="1.0">

<Schema xmlns="http://schemas.microsoft.com/ado/2006/04/edm"

xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"

xmlns:crds="http://schemas.sap.com/crystalreports/crodataservice"

Namespace="DateTime_rpt">

<EntityContainer Name="DateTime_rpt_Container"

m:IsDefaultEntityContainer="true">

<EntitySet Name="Rows" EntityType="DateTime_rpt.Row"

crds:IsGroup="false">

</EntitySet>

<EntitySet Name="GrandTotals" EntityType="DateTime_rpt.GrandTotal"

crds:IsGroup="false">

</EntitySet>

</EntityContainer>

<Key>

</PropertyRef>

</Key>

</Property>

<Property Name="Customer_City" Type="Edm.String"

crds:FormulaForm="{SAPBW.Customer\City}" MaxLength="65534">

</Property>

</EntityType>

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

<Key>

</PropertyRef>

</Key>

</Property>

</EntityType>

</Schema>

</edmx:DataServices>

</edmx:Edmx>

4.7.5 Rows

Returns or updates data that corresponds to row data in the Details area of a report. Rows are represented by

an Atom Feed or an array of JSON objects.

When you POST a row to a report, you can also use both XML or JSON to specify the new row information. The

format of the request body is specied using the Content-Type attribute in the message header.

Note the following:

● You can POST database eld data only to a report, not formulas.

● You cannot POST to delegated elds.

● You cannot POST to reports with hierarchical groups.

● You cannot POST to OLAP member elds.

● You can POST row data only to a transient instance of a report.

 Note

Row IDs are automatically generated.

URI Operations Supported format Is AtomPub

<baseURI>/

infostore/

<reportID>/rpt/

data.svc/Rows

GET, POST

XML, JSON Yes

Optional parameters Type Description

Rows(<INDEX>)

integer

Returns a row of the report. <INDEX>

is an integer which species what row

to fetch information from.

Rows(<INDEX>)/<FIELDNAME>

integer

Returns information about a eld in a

report. <INDEX> is an integer that

species what row to fetch information

from.

<FIELDNAME> is the name of

the eld value to return.

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

PUBLIC 81

Optional parameters Type Description

Rows(<INDEX>)/<FIELDNAME>/

$value

integer

Returns the raw eld value of a

particular row index <INDEX> is an

integer that species what row to fetch

information from.

<FIELDNAME>is

the name of the eld value to return.

Rows?$select=<PROPERTY>

string

Returns row data containing only the

properties specied by <PROPERTY>.

The following values can be used:

● * = return all properties

● <PROPERTY> = the name of the

property to return.

● <PROPERTY1>,<PROPERTY2>

...

= the names of the properties

to return. Multiple properties are

separated by commas.

 Note

Case sensitive.

<GroupName>?

$select=<CATEGORY>,<PROPER

TY>...

string

Returns group data containing only the

properties specied by <PROPERTY>,

and only links to the category type

specied by

<CATEGORY>. Multiple

properties are separated by commas.

 Note

Case sensitive.

Rows?$skip=<VALUE>

integer

Returns the row data in chunks,

starting with the record number

specied. <VALUE> is an integer that

indicates the rst record to return.

Rows?$skiptoken=<VALUE>

integer

Returns the row data in chunks,

starting with the record number

specied. <VALUE> is an integer that

indicates the rst record to return.

Rows?$inlinecount=allpages

Adds a count entry to the xml that

species the count of all records.

Rows/$count

Return the count of records.

82 PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

Example: GET http://<baseURI>/infostore/<reportID>/rpt/data.svc/

Rows(0)

Use the GET method to request the rst row of a report.

Request:

● Method: GET

● URL: http://<baseURI>/infostore/<reportID>/rpt/data.svc/Rows(0)

● Required request header attributes: X-SAP-LogonToken

● Optional request header attributes: Accept

● Request body: none

Response:

● An entry is returned that contains information about the second row of the report.

<?xml version="1.0" encoding="UTF-8"?>

<entry xmlns="http://www.w3.org/2005/Atom"

xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"

xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">

<id>http://localhost:6405/biprws/infostore/6188/rpt/data.svc/Rows(1)</id>

<category term="EmployeeData.Row" scheme="http://schemas.microsoft.com/ado/

2007/08/dataservices/scheme"></category>

<m:properties>

<d:ID>1</d:ID>

<d:RTotal_max_emergency_last_name>Buchanan</

d:RTotal_max_emergency_last_name>

<d:RTotal_sum_salary>110000.0</d:RTotal_sum_salary>

<d:Employee_Birth_Date>1960-03-13T00:00:00.000</d:Employee_Birth_Date>

<d:Employee_Emergency_Contact_Last_Name>Hellstern</

d:Employee_Emergency_Contact_Last_Name>

<d:Employee_Employee_Id>10.0</d:Employee_Employee_Id>

<d:Employee_Extension>7559</d:Employee_Extension>

<d:Employee_First_Name>Albert</d:Employee_First_Name>

<d:Employee_Last_Name>Hellstern</d:Employee_Last_Name>

<d:Employee_Position>Business Manager</d:Employee_Position>

<d:Employee_Reports_To>2.0</d:Employee_Reports_To>

<d:Employee_Salary>60000.0</d:Employee_Salary>

<d:Employee_Supervisor_Id>2.0</d:Employee_Supervisor_Id>

<d:Employee_Home_Phone>(206)555-4869</d:Employee_Home_Phone>

</m:properties>

</content>

</entry>

Example: POST http://<baseURI>/infostore/<reportID>/rpt/<instanceID>/

data.svc/Rows

POST a row to an instance of a report.

Request:

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

PUBLIC 83

● Method: POST

● URL: http://<baseURI>/<reportID>/rpt/<instanceID>/data.svc/Rows

● Request header attributes:

accept-charset: UTF-8

content-type: application/atom+xml

host: <HostName>

content-length: 1000

X-SAP-LogonToken: COMMANDCOM-LCM:6400@{3&2=5328,U3&p=40676

.8926203819,Y7&4F=12,U3&63=secEnterprise,0P&66=60,03&68=secEnterprise:

Administrator,

0P&qe=100,U3&vz=IVD21LbMCB0eRiI4atz9sNL18Ux5anRBdYB9fFv5NrY,UP}

● Request body: Add row information.

<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<entry xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"

xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"

xmlns="http://www.w3.org/2005/Atom">

<m:properties>

<d:Orders_Order_Date m:type="Edm.DateTime">2011-01-28T00:00:00.000</

d:Orders_Order_Date>

</m:properties>

</content>

</entry>

 Note

term="Xtreme_OrderDate.Row" is the name of the row entity in the report. You can nd the names

of the entities in the report by getting the report metadata.

Response:

● An entry is returned that contains the row you have added to the report.

<?xml version='1.0' encoding='UTF-8'?>

<entry xmlns="http://www.w3.org/2005/Atom" xmlns:d="http://

schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://

schemas.microsoft.com/ado/2007/08/dataservices/metadata">

<id>http://localhost:6405/biprws/1667/rpt/data.svc/Rows(523)</id>

<category term="CRoDataService.Row" scheme="http://

schemas.microsoft.com/ado/2007/08/dataservices/scheme">

</category>

<m:properties>

<d:ID>523</d:ID>

<d:Orders_Order_Date>2011-01-28T00:00:00.000</d:Orders_Order_Date>

</m:properties>

</content>

</entry>

PUBLIC

SAP Crystal Reports RESTful Web Services Developer Guide

Using the SAP Crystal Reports RESTful web services API

Important Disclaimers and Legal Information

Hyperlinks

Some links are classied by an icon and/or a mouseover text. These links provide additional information.

About the icons:

● Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your

agreements with SAP) to this:

● The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.

● SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any

damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.

● Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such

links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this

information.

Videos Hosted on External Platforms

Some videos may point to third-party video hosting platforms. SAP cannot guarantee the future availability of videos stored on these platforms. Furthermore, any

advertisements or other content hosted on these platforms (for example, suggested videos or by navigating to other videos hosted on the same site), are not within

the control or responsibility of SAP.

Beta and Other Experimental Features

Experimental features are not part of the ocially delivered scope that SAP guarantees for future releases. This means that experimental features may be changed by

SAP at any time for any reason without notice. Experimental features are not for productive use. You may not demonstrate, test, examine, evaluate or otherwise use

the experimental features in a live operating environment or with data that has not been suciently backed up.

The purpose of experimental features is to get feedback early on, allowing customers and partners to inuence the future product accordingly. By providing your

feedback (e.g. in the SAP Community), you accept that intellectual property rights of the contributions or derivative works shall remain the exclusive property of SAP.

Example Code

Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax

and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of

example code unless damages have been caused by SAP's gross negligence or willful misconduct.

Gender-Related Language

We try not to use gender-specic word forms and formulations. As appropriate for context and readability, SAP may use masculine word forms to refer to all genders.

SAP Crystal Reports RESTful Web Services Developer Guide

Important Disclaimers and Legal Information

PUBLIC 85

www.sap.com/contactsap

No part of this publication may be reproduced or transmitted in any form

or for any purpose without the express permission of SAP SE or an SAP

aliate company. The information contained herein may be changed

without prior notice.

Some software products marketed by SAP SE and its distributors

contain proprietary software components of other software vendors.

National product specications may vary.

These materials are provided by SAP SE or an SAP aliate company for

informational purposes only, without representation or warranty of any

kind, and SAP or its aliated companies shall not be liable for errors or

omissions with respect to the materials. The only warranties for SAP or

SAP aliate company products and services are those that are set forth

in the express warranty statements accompanying such products and

services, if any. Nothing herein should be construed as constituting an

additional warranty.

SAP and other SAP products and services mentioned herein as well as

their respective logos are trademarks or registered trademarks of SAP

SE (or an SAP aliate company) in Germany and other countries. All

other product and service names mentioned are the trademarks of their

respective companies.

Please see https://www.sap.com/about/legal/trademark.html for

additional trademark information and notices.

THE BEST RUN