SAP BusinessObjects Business Intelligence Platform RESTful Web Service

https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/
Admin
A RESTful web service API for SAP BusinessObjects Business Intelligence Platform that enables...
Tokens:64,432
Snippets:376
Trust Score:9.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET request for resource instances

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/361e5e50f84a42898724cc20d5411c31.html

Example XML response showing the details of schedule instances for a resource with ID 6148.

```xml
<feed xmlns="http://www.w3.org/2005/Atom">
    <title type="text">Schedules</title>
    <updated>2016-06-17T07:09:12.875Z</updated>
    <link href="http://localhost:6405/biprws/v1/infostore/6148/instances?page=1&amp;pagesize=50" rel="self"/>
    <link href="http://localhost:6405/biprws/v1/infostore/6148/instances?page=1&amp;pagesize=50" rel="first"/>
    <link href="http://localhost:6405/biprws/v1/infostore/6148/instances?page=1&amp;pagesize=50" rel="last"/>
    <entry>
        <title type="text">Drill Demo</title>
        <link href="http://localhost:6405/biprws/v1/infostore/6148/instances/6602"/>
        <content type="application/xml">
            <attrs xmlns="http://www.sap.com/rws/bip">
                <attr name="errormessage" type="string"></attr>
                <attr name="schedulestatus" type="string">9</attr>
                <attr name="uistatus" type="string">Pending</attr>
                <attr name="cuid" type="string">AV60GpT7ajVEpJtlZaie2pI</attr>
                <attr name="name" type="string">Drill Demo</attr>
                <attr name="nextruntime" type="string">Thu Jun 16 21:31:13 PDT 2016</attr>
                <attr name="id" type="string">6602</attr>
                <attr name="type" type="string">Webi</attr>
            </attrs>
        </content>
    </entry>
    <entry>
        <title type="text">Drill Demo</title>
        <link href="http://localhost:6405/biprws/v1/infostore/6148/instances/6603"/>
        <content type="application/xml">
            <attrs xmlns="http://www.sap.com/rws/bip">
                <attr name="errormessage" type="string"></attr>
                <attr name="schedulestatus" type="string">9</attr>
                <attr name="uistatus" type="string">Pending</attr>
                <attr name="cuid" type="string">AQyS4kjnjlxBooAkhTzpfBU</attr>
                <attr name="name" type="string">Drill Demo</attr>
                <attr name="nextruntime" type="string">Thu Jun 16 21:31:27 PDT 2016</attr>
                <attr name="id" type="string">6603</attr>
                <attr name="type" type="string">Webi</attr>
            </attrs>
        </content>
    </entry>
</feed>
```

--------------------------------

### GET Publications with Query Parameters

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/2935b64767a64253bfc425602ee07cd2.html

Example URL structure for performing a GET request on publications with sorting, filtering, and pagination parameters applied.

```text
URL: GET http://<baseURL>/v1/publications?sort=<name>&updated=<Start year-month-dateThh:mm:ss.727Z> , <End year-month-dateThh:mm:ss.727Z>&page=<page number>&pagesize=<number>
```

--------------------------------

### GET Infostore XML Response

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/2e36c6291ede4753ad590b4acac9ddcb.html

Example of an XML feed response returned when querying the Infostore for objects.

```xml
<feed xmlns="http://www.w3.org/2005/Atom">
    <title type="text">InfoStore (@W2K12R2:6400)</title>
    <updated>2016-05-31T08:51:05.128Z</updated>
    <link href="http://localhost:6405/biprws/v1/infostore?page=1&amp;pagesize=50" rel="self"/>
    <link href="http://localhost:6405/biprws/v1/infostore?page=1&amp;pagesize=50" rel="first"/>
    <link href="http://localhost:6405/biprws/v1/infostore?page=1&amp;pagesize=50" rel="last"/>
    <entry>
        <title type="text">Alert Notifications</title>
        <author>
            <name>System Account</name>
        </author>
        <updated>2016-05-30T08:15:10.953Z</updated>
        <link href="http://localhost:6405/biprws/v1/infostore/Alert%20Notifications" rel="alternate"/>
        <content type="application/xml">
            <attrs xmlns="http://www.sap.com/rws/bip">
                <attr name="cuid" type="string">ARZB.BFCQk9PqaqDpcFwo1w</attr>
                <attr name="name" type="string">Alert Notifications</attr>
                <attr name="description" type="string" null="true"/>
                <attr name="id" type="string">64</attr>
                <attr name="type" type="string">Folder</attr>
            </attrs>
        </content>
    </entry>
    <entry>
        <title type="text">Application Folder</title>
        <author>
            <name>System Account</name>
        </author>
        <updated>2016-05-30T08:15:26.157Z</updated>
        <link href="http://localhost:6405/biprws/v1/infostore/Application%20Folder" rel="alternate"/>
        <content type="application/xml">
            <attrs xmlns="http://www.sap.com/rws/bip">
                <attr name="cuid" type="string">AdoctK9h1sBHp3I6uG0Sh7M</attr>
                <attr name="name" type="string">Application Folder</attr>
                <attr name="description" type="string"></attr>
                <attr name="id" type="string">43</attr>
                <attr name="type" type="string">Folder</attr>
            </attrs>
        </content>
    </entry>
</feed>
```

--------------------------------

### Response for Fetching Available Calendars

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/0458f797ed1c4b7c846bc21c830fd29f.html

Example JSON response received after sending a GET request to the /v1/calendars endpoint.

```json
{
  "entries": [
    {
      "cuid": "Fo3LkVj_sgUAYhIAAAB3gAAAAFBWATGQ",
      "created": "Feb 1, 2017 5:20 PM",
      "name": "Bob's calendar",
      "description": "My calendar",
      "id": "10588",
      "updated": "Feb 1, 2017 5:21 PM"
    }
  ]
}
```

--------------------------------

### X-SAP-LogonToken Header Response

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45f57b086e041014910aba7db0e91070.html

Example of the X-SAP-LogonToken header returned in the response.

```text
X-SAP-LogonToken:"BI42SP03TF22:6400@{3&amp;2=6883,U3&amp;2v=BI42SP03TF22:6400,UP&amp;66=60,U3&amp;68=secEnterprise:Administrator,UP&amp;S9=12,U3&amp;qe=100,U3&amp;vz=4B.wHI5lWQ.SXHD7fEbc91qRmDdxju4oKHNr0OBJBTQ,UP}"
```

--------------------------------

### Response for Fetching Available Calendar Dates

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/0458f797ed1c4b7c846bc21c830fd29f.html

Example JSON response received after sending a GET request to the /v1/calendars/<calendar_ID>/dates endpoint.

```json
{
 "entries": [
    {
      "date": "01-02-2017"
    },
    {
      "date": "10-02-2017"
    },
    {
      "date": "24-02-2017"
    },
    {
      "date": "28-02-2017"
    },
    {
      "date": "01-03-2017"
    },
    {
      "date": "31-03-2017"
    }
  ]
}
```

--------------------------------

### Valid Logon Token Format

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45f56d286e041014910aba7db0e91070.html

Example of a valid logon token without extraneous data.

```text
BI42SP03TF22:6400@{3&;2=6990,U3&;2v=BI42SP03TF22:6400,UP&;66=60,U3&;68=secEnterprise:Administrator,UP&;S9=12,U3&;qe=100,U3&;vz=eh1rLdKtjx1bKRnyRppRzSG2eYnGWjBBlUVd1BoQRIY,UP}
```

--------------------------------

### GET /bionbi/server/list

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/310c56e1e46f47948d306082b568eca9.html

Retrieves a paginated list of servers, with optional sorting capabilities.

```APIDOC
## GET /bionbi/server/list

### Description
Lists server details with support for pagination and sorting by modified time.

### Method
GET

### Endpoint
/bionbi/server/list

### Parameters
#### Query Parameters
- **page** (int) - Optional - The page number to retrieve.
- **pageSize** (int) - Optional - The maximum number of items per page.
- **sortType** (string) - Optional - Sorting order, either 'ASC' (Ascending) or 'DESC' (Descending) based on modified time.
```

--------------------------------

### Initial GET Request Body for Logon

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45f61c236e041014910aba7db0e91070.html

The JSON structure returned by a GET request to the /logon/long endpoint, providing the template for user credentials.

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

--------------------------------

### GET /biprws/infostore

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45f61c236e041014910aba7db0e91070.html

Retrieves information from the BI platform repository using a logon token.

```APIDOC
## GET /biprws/infostore

### Description
Retrieves information from the BI platform repository. This request requires a valid logon token in the header.

### Method
GET

### Endpoint
http://commandcom-lcm:6405/biprws/infostore

### Parameters
#### Request Header Attributes
- **Accept** (string) - Required - Must be set to 'application/json'
- **X-SAP-LogonToken** (string) - Required - The authentication token for the session

### Response
#### Success Response (200)
- **__metadata** (object) - URI metadata for the resource
- **first** (object) - Deferred URI for the first page
- **next** (object) - Deferred URI for the next page
- **last** (object) - Deferred URI for the last page
- **entries** (array) - List of repository items

#### Response Example
{
   "__metadata": {"uri":"http://localhost:9998/biprws/infostore/Root%20Folder/children?page=1&pageSize=3"},
   "entries": [
     {
       "id": 4005,
       "cuid": "FnKsrkkctAcA8BAAALB7kkQAADAFzVMX",
       "name": "Data Federation",
       "type": "Folder"
     }
   ]
}
```

--------------------------------

### GET /v1/infostore

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/2e36c6291ede4753ad590b4acac9ddcb.html

Retrieves a list of objects from the Infostore. Supports sorting and pagination via query parameters.

```APIDOC
## GET http://<baseURL>/v1/infostore

### Description
Retrieves an XML feed of all objects created in the BOE system. The response can be sorted and paginated using query parameters.

### Method
GET

### Endpoint
http://<baseURL>/v1/infostore

### Parameters
#### Query Parameters
- **sort** (string) - Optional - Sorts objects sequentially. Format: sort=<+/-><attribute>. Supported attributes: Name, Description, ID, Type, cuid.
- **page** (integer) - Optional - Specifies the page number for results.
- **pagesize** (integer) - Optional - Specifies the number of objects to display per page.

### Request Example
GET http://<baseURL>/v1/infostore?sort=name&page=1&pagesize=50

### Response
#### Success Response (200)
- **Content-Type** (string) - application/xml
- **Body** (XML) - An Atom feed containing entries for objects in the Infostore.
```

--------------------------------

### Example of <updated> element

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45f638456e041014910aba7db0e91070.html

Displays the date and time a resource was last updated in ISO 8601 format.

```xml
<updated>2011-04-14T10:27:50.672Z</updated>
```

--------------------------------

### GET /logon/long

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45f61c236e041014910aba7db0e91070.html

Retrieves the JSON template required for the logon request.

```APIDOC
## GET /logon/long

### Description
Retrieves a JSON formatted request body template to be used for user authentication.

### Method
GET

### Endpoint
http://localhost:6405/biprws/logon/long

### Response
#### Success Response (200)
- **userName** (string) - Empty string placeholder for username
- **password** (string) - Empty string placeholder for password
- **auth** (string) - Authentication type (e.g., secEnterprise)

#### Response Example
{
  "userName": "",
  "password": "",
  "auth": "secEnterprise"
}
```

--------------------------------

### GET /v1/logon/token XML Template

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45f57b086e041014910aba7db0e91070.html

Retrieves the XML template required for the POST request body.

```xml
<attrs xmlns="http://www.sap.com/rws/bip">
    <attr name="clienttype" type="string"></attr>
    <attr name="logontoken" type="string"></attr>
    <attr name="tokentype" type="string" possibilities="token, serializedSession">token</attr>
</attrs>
```

--------------------------------

### GET /logon/token

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45f5abf06e041014910aba7db0e91070.html

Retrieves the XML template required to construct the request body for obtaining a logon token.

```APIDOC
## GET /logon/token

### Description
Retrieves an XML template that defines the structure required for the POST /logon/token request.

### Method
GET

### Endpoint
http://<baseURL>/logon/token

### Response
#### Success Response (200)
- **attrs** (XML) - An XML structure containing the required attributes: tokenType and logonToken.
```

--------------------------------

### GET /v1/logon/long

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45f5742c6e041014910aba7db0e91070.html

Retrieves an XML template that defines the required structure for the logon request body.

```APIDOC
## GET http://<baseURL>/v1/logon/long

### Description
Retrieves an XML template that can be used to populate the request body for the POST /v1/logon/long endpoint.

### Method
GET

### Endpoint
http://<baseURL>/v1/logon/long

### Response
#### Success Response (200)
- **Body** (XML) - An XML template containing attributes for clienttype, password, auth, and username.
```

--------------------------------

### Logon Token Extraction and Conversion

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45f57b086e041014910aba7db0e91070.html

Examples showing the raw token from the response body and the final converted format.

```text
BI42SP03TF22:6400@{3&amp;2=6883,U3&amp;2v=BI42SP03TF22:6400,UP&amp;66=60,U3&amp;68=secEnterprise:Administrator,UP&amp;S9=12,U3&amp;qe=100,U3&amp;vz=4B.wHI5lWQ.SXHD7fEbc91qRmDdxju4oKHNr0OBJBTQ,UP}</attr>
```

```text
BI42SP03TF22:6400@{3&;2=6883,U3&;2v=BI42SP03TF22:6400,UP&;66=60,U3&;68=secEnterprise:Administrator,UP&;S9=12,U3&;qe=100,U3&;vz=4B.wHI5lWQ.SXHD7fEbc91qRmDdxju4oKHNr0OBJBTQ,UP}
```

--------------------------------

### GET /infostore

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45aa99966e041014910aba7db0e91070.html

Retrieves the top-level folders and resources of the BI platform repository. Requires a valid X-SAP-LogonToken in the request header.

```APIDOC
## GET /infostore

### Description
Retrieves the top-level of the BI platform repository, also known as the InfoStore. The response provides links to navigate child folders and explore the repository.

### Method
GET

### Endpoint
http://<baseURL>/infostore/

### Parameters
#### Headers
- **X-SAP-LogonToken** (string) - Required - A valid logon token obtained from the authentication service.

### Request Example
GET http://localhost:6405/biprws/infostore
X-SAP-LogonToken: <your_logon_token>

### Response
#### Success Response (200)
- **feed** (XML) - An Atom feed containing links and entries describing the top-level folders of the repository.

#### Response Example
<feed xmlns="http://www.w3.org/2005/Atom">
  <id>tag:sap.com,2010:bip-rs/infostore</id>
  <title type="text">InfoStore (@COMMANDCOM-LCM:6400)</title>
  <entry>
    <title type="text">Alert Notifications</title>
    <link href="http://localhost:6405/biprws/infostore/Alert%20Notifications" rel="alternate"></link>
    <content type="application/xml">
      <attrs xmlns="http://www.sap.com/rws/bip">
        <attr name="id" type="int32">64</attr>
        <attr name="type" type="string">Folder</attr>
      </attrs>
    </content>
  </entry>
</feed>
```

--------------------------------

### GET enterprise user groups from publication

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/3845c027b6cf431dbca363dbdd05f2d5.html

Retrieves the enterprise user groups associated with a specific publication using a GET request.

```xml
<feed xmlns="http://www.w3.org/2005/Atom">
    <title type="text">Publication</title>
    <updated>2016-06-16T09:09:56.649Z</updated>
</feed>
```

--------------------------------

### GET Publications Response

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/2935b64767a64253bfc425602ee07cd2.html

The response body for a GET request to the publications endpoint, returning an Atom feed containing publication entries.

```xml
<feed xmlns="http://www.w3.org/2005/Atom">
    <id>tag:sap.com,2010:bip-rs/infostore</id>
    <title type="text">Publication</title>
    <updated>2016-06-15T11:45:25.152Z</updated>
    <link href="http://localhost:6405/biprws/v1/publications?page=1&amp;pagesize=50" rel="self"/>
    <link href="http://localhost:6405/biprws/v1/publications?page=1&amp;pagesize=50" rel="first"/>
    <link href="http://localhost:6405/biprws/v1/publications?page=1&amp;pagesize=50" rel="last"/>
    <entry>
        <title type="text">cons</title>
        <id>tag:sap.com,2010:bip-rs/AWYjO3zErThIpV2WKXZ9J78</id>
        <author>
            <name>Administrator</name>
            <uri>http://localhost:6405/biprws/infostore/12</uri>
        </author>
        <updated>2016-06-10T06:44:25.822Z</updated>
        <link href="http://localhost:6405/biprws/v1/publications/28919" rel="alternate"/>
        <content type="application/xml">
            <attrs xmlns="http://www.sap.com/rws/bip">
                <attr name="cuid" type="string">AWYjO3zErThIpV2WKXZ9J78</attr>
                <attr name="keywords" type="string"></attr>
                <attr name="name" type="string">cons</attr>
                <attr name="description" type="string"></attr>
                <attr name="id" type="string">28919</attr>
                <attr name="parentid" type="string">6283</attr>
            </attrs>
        </content>
    </entry>
    <entry>
        <title type="text">pubO</title>
        <id>tag:sap.com,2010:bip-rs/AcOetAbwASJJjVkYFMwU6jc</id>
        <author>
            <name>Administrator</name>
            <uri>http://localhost:6405/biprws/infostore/12</uri>
        </author>
        <updated>2016-06-09T19:26:04.041Z</updated>
        <link href="http://localhost:6405/biprws/v1/publications/28676" rel="alternate"/>
        <content type="application/xml">
            <attrs xmlns="http://www.sap.com/rws/bip">
                <attr name="cuid" type="string">AcOetAbwASJJjVkYFMwU6jc</attr>
                <attr name="keywords" type="string"></attr>
                <attr name="name" type="string">pubO</attr>
                <attr name="description" type="string"></attr>
                <attr name="id" type="string">28676</attr>
                <attr name="parentid" type="string">6283</attr>
            </attrs>
        </content>
    </entry>
</feed>
```

--------------------------------

### POST /logon/long

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45f61c236e041014910aba7db0e91070.html

Logs on to the BI platform repository using XML-formatted credentials.

```APIDOC
## POST /logon/long

### Description
Logs on to the BI platform repository to obtain a logon token for subsequent API requests.

### Method
POST

### Endpoint
http://localhost:6405/biprws/logon/long

### Request Body
- **userName** (string) - Required - The user's account name.
- **password** (string) - Required - The user's password.
- **auth** (string) - Required - The authentication type (e.g., secEnterprise, secLDAP, secWinAD).

### Request Example
<attrs xmlns="http://www.sap.com/rws/bip">
  <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
#### Success Response (200)
- **logonToken** (string) - The token returned in the response body and X-SAP-LogonToken header for authentication.

#### Response Example
<entry xmlns="http://www.w3.org/2005/Atom">
  <author><name>@COMMANDCOM-LCM:6400</name></author>
  <id>tag:sap.com,2010:bip-rs/logon/long</id>
  <title type="text">Logon Result</title>
  <updated>2011-05-17T21:33:03.471Z</updated>
  <content type="application/xml">
    <attrs xmlns="http://www.sap.com/rws/bip">
      <attr name="logonToken" type="string">COMMANDCOM-LCM:6400@{3&amp;2=5542,U3&amp;p=40680.8979564815,Y7&amp;4F=12,U3&amp;63=secEnterprise,0P&amp;66=60,03&amp;68=secEnterprise:Administrator,0P&amp;qe=100,U3&amp;vz=TZnoIE2yQyeLCkAlnHtaaYUHon5.p0yTkSaUiLC8SSM,UP}</attr>
    </attrs>
  </content>
</entry>
```

--------------------------------

### Retrieve base URL using IRestWebService interface

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45f6073a6e041014910aba7db0e91070.html

Java code snippet demonstrating how to query the InfoStore and use the getURL method of the IRestWebService interface to obtain the base URL.

```java
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();
```

--------------------------------

### GET /bionbi/application Response

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/3e44cb2e739b4fd08a9cf7a2ead7fd05.html

The XML response returned when performing a GET request to the /bionbi/application URI, providing metrics for report counts by kind.

```xml
<feed>
<id>tag:sap.com,2010:bip-rs/bionbi</id>
<title type="text">Metrics for ReportCountByKindForPeriod</title>
<updated>2015-08-20T06:07:10.139Z</updated>
<author>
<name>@win-2k8r2-x64:6400</name>
</author>
<entry>
<content type="application/xml">
 <attrs>
<attr name="KIND" type="string">Web Intelligence</attr>
<attr name="REPORT_COUNT" type="int32">5823</attr>
 </attrs>
</content>
</entry>
<entry>
<content type="application/xml">
 <attrs>
<attr name="KIND" type="string">Crystal Report</attr>
<attr name="REPORT_COUNT" type="int32">5823</attr>
 </attrs>
</content>
</entry>
<entry>
<content type="application/xml">
 <attrs>
<attr name="KIND" type="string">Publication</attr>
<attr name="REPORT_COUNT" type="int32">3</attr>
 </attrs>
</content>
</entry>
<entry>
<content type="application/xml">
 <attrs>
<attr name="KIND" type="string">Hyperlink</attr>
<attr name="REPORT_COUNT" type="int32">1</attr>
 </attrs>
</content>
</entry>
 </feed>
```

--------------------------------

### GET Monthly Schedule Template

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/0995135c631f4b1680593e20593dcde3.html

Retrieve an XML template for the monthly schedule request body by sending a GET request to the specified endpoint.

```xml
<entry xmlns="http://www.w3.org/2005/Atom">
    <author>
        <name>Administrator</name>
        <uri>http://localhost:6405/biprws/v1/infostore/12</uri>
    </author>
    <title type="text">Drill Demo</title>
    <updated>2016-06-15T06:02:47.494Z</updated>
    <content type="application/xml">
        <attrs xmlns="http://www.sap.com/rws/bip">
            <attr name="everynmonths" type="int32">0</attr>
            <attr name="retriesallowed" type="int32">0</attr>
            <attr name="retryintervalinseconds" type="int32">1800</attr>
            <attr name="endtime" type="datetime">2022-12-19T16:39:58.244Z</attr>
            <attr name="starttime" type="datetime">2012-12-19T16:39:58.244Z</attr>
        </attrs>
    </content>
</entry>
```

--------------------------------

### GET XML Template for Nth Day of Month Schedule

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/18049e3fb5e54a828362f2f18a7091ec.html

Retrieves an XML template for the request body by making a GET request to the specified endpoint.

```xml
<entry xmlns="http://www.w3.org/2005/Atom">
    <author>
        <name>Administrator</name>
        <uri>http://localhost:6405/biprws/v1/infostore/12</uri>
    </author>
    <title type="text">Drill Demo</title>
    <updated>2016-06-15T06:02:47.494Z</updated>
    <content type="application/xml">
        <attrs xmlns="http://www.sap.com/rws/bip">
            <attr name="nthday" type="int32">0</attr>
            <attr name="retriesallowed" type="int32">0</attr>
            <attr name="retryintervalinseconds" type="int32">1800</attr>
            <attr name="endtime" type="datetime">2022-12-19T16:39:58.244Z</attr>
            <attr name="starttime" type="datetime">2012-12-19T16:39:58.244Z</attr>
        </attrs>
    </content>
</entry>
```

--------------------------------

### Example of <link> element for pagination

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45f638456e041014910aba7db0e91070.html

Describes a link to the next page of results using the rel attribute set to next.

```xml
<link href="http://localhost:6405/biprws/infostore/Root%20Folder/children?page=3&pageSize=3" rel="next"></link>
```

--------------------------------

### GET Personalization XML Feed

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/09c11a6e3c2944fdbc7012e9d9447d06.html

The response to a GET request on the personalization URL returns an XML feed containing links to global and local profiles.

```xml
<feed xmlns="http://www.w3.org/2005/Atom">
    <author>
        <name>Administrator</name>
        <uri>http://localhost:6405/biprws/infostore/12</uri>
    </author>
    <id>6493</id>
    <updated>2016-03-17T14:04:23.267Z</updated>
    <entry>
        <title type="text">Global Profiles</title>
        <link href="http://localhost:6405/biprws/v1/publications/6493/personalization/globalProfiles" rel="alternate" />
    </entry>
    <entry>
        <title type="text">Local Profiles</title>
        <link href="http://localhost:6405/biprws/v1/publications/6493/personalization/localProfiles" rel="alternate" />
    </entry>
</feed>
```

--------------------------------

### GET Dynamic Recipients Local Profiles

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/0cdfac33a4cc4178b3de724ca135ddc4.html

Retrieves an XML feed of publications personalized for dynamic recipients by making a GET request to the specified publication endpoint.

```xml
<feed xmlns="http://www.w3.org/2005/Atom">
    <entry>
        <content type="application/xml">
            <attrs xmlns="http://www.sap.com/rws/bip">
                <attr name="mapping" type="string">Sheet1_.Country</attr>
                <attr name="subreportName" type="string"></attr>
                <attr name="sourceReportId" type="int32">7499</attr>
                <attr name="reportField" type="string">{Sheet1_.Country}</attr>
            </attrs>
        </content>
    </entry>
    <entry>
        <content type="application/xml">
            <attrs xmlns="http://www.sap.com/rws/bip">
                <attr name="mapping" type="string">Sheet1_.Country</attr>
                <attr name="subreportName" type="string">s1</attr>
                <attr name="sourceReportId" type="int32">7499</attr>
                <attr name="reportField" type="string">{?subcity}</attr>
            </attrs>
        </content>
    </entry>
</feed>
```

--------------------------------

### GET request to InfoStore

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45aa99966e041014910aba7db0e91070.html

Sends a request to the InfoStore URL to retrieve the top-level repository structure. Requires a valid logon token in the request header.

```HTTP
GET http://localhost:6405/biprws/infostore
```

--------------------------------

### GET Job Count Response

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/3f1e5188aeb94e36b33b9efcaa870824.html

The response body for a GET request to the /bionbi/job/ URI, providing an XML feed of job counts categorized by status type.

```xml
<feed>
<id>tag:sap.com,2010:bip-rs/bionbi</id>
<title type="text">Metrics for JobsCountByState</title>
<updated>2015-06-24T08:25:04.652Z</updated>
<author>
<name>@win-2k12r2-x64:6400</name>
</author>
<entry>
<content type="application/xml">
 <attrs>
<attr name="count" type="int32">1</attr>
<attr name="status_type" type="string">SUCCESS</attr>
 </attrs>
</content>
</entry>
<entry>
<content type="application/xml">
 <attrs>
<attr name="count" type="int32">0</attr>
<attr name="status_type" type="string">RUNNING</attr>
 </attrs>
</content>
</entry>
<entry>
<content type="application/xml">
 <attrs>
<attr name="count" type="int32">9</attr>
<attr name="status_type" type="string">TOTAL</attr>
 </attrs>
</content>
</entry>
<entry>
<content type="application/xml">
 <attrs>
<attr name="count" type="int32">8</attr>
<attr name="status_type" type="string">FAILED</attr>
 </attrs>
</content>
</entry>
 </feed>
```

--------------------------------

### GET XML Template for Scheduling

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45aa4d726e041014910aba7db0e91070.html

Retrieve an XML template for the request body by making a GET request to the schedule once endpoint. The response provides the structure required for the subsequent POST request.

```xml
<entry xmlns="http://www.w3.org/2005/Atom">
    <author>
        <name>Administrator</name>
        <uri>http://localhost:6405/biprws/v1/infostore/12</uri>
    </author>
    <title type="text">Drill Demo</title>
    <updated>2016-06-15T06:02:47.494Z</updated>
    <content type="application/xml">
        <attrs xmlns="http://www.sap.com/rws/bip">
            <attr name="starttime" type="datetime">2012-12-19T16:39:58.244Z</attr>
            <attr name="retriesallowed" type="int32">0</attr>
            <attr name="retryintervalinseconds" type="int32">1800</attr>
        </attrs>
    </content>
</entry>
```

--------------------------------

### GET /bionbi/server/list Response

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/310c56e1e46f47948d306082b568eca9.html

The XML response returned by the GET request to the server list endpoint, containing a feed of server entries with attributes such as name, type, status, and last modified details.

```xml
  <feed>
<id>
tag:sap.com,2010:bip-rs/bionbi
</id>
<updated>
2015-07-23T05:00:53.565Z
</updated>
<title type="text">
Metrics for ServersListForState - ALL
</title>
<link href="http://10.160.192.169:6405/biprws/bionbi/server/list/-1?page=2&pageSize=5&sortType=DESC" rel="self" />
<link href="http://10.160.192.169:6405/biprws/bionbi/server/list/-1?page=1&pageSize=5&sortType=DESC" rel="first" />
<link href="http://10.160.192.169:6405/biprws/bionbi/server/list/-1?page=3&pageSize=5&sortType=DESC" rel="next" />
<link href="http://10.160.192.169:6405/biprws/bionbi/server/list/-1?page=1&pageSize=5&sortType=DESC" rel="previous" />
<link href="http://10.160.192.169:6405/biprws/bionbi/server/list/-1?page=4&pageSize=5&sortType=DESC" rel="last" />
<entry>
<content type="application/xml">
 <attrs>
<attr name="cuid" type="string">
AR0rjLlQ8.ZMitZHciycY8E
</attr>
<attr name="parent_id" type="int32">
16
</attr>
<attr name="status_type" type="string">
RUNNING
</attr>
<attr name="description" type="string">
Web Intelligence Processing Server
</attr>
<attr name="disabled" type="string">
Enabled
</attr>
<attr name="id" type="int32">
1242
</attr>
<attr name="title" type="string">
MASTERSHAKE.WebIntelligenceProcessingServer
</attr>
<attr name="last_modified" type="string">
Jul 22, 2015 9:50 PM
</attr>
 </attrs>
</content>
</entry>
<entry>
<content type="application/xml">
 <attrs>
<attr name="cuid" type="string">
AalIHU17j45Kl7..G_7p6PE
</attr>
<attr name="parent_id" type="int32">
16
</attr>
<attr name="status_type" type="string">
RUNNING
</attr>
<attr name="description" type="string">
Connection Server (32-bit)
</attr>
<attr name="disabled" type="string">
Enabled
</attr>
<attr name="id" type="int32">
1226
</attr>
<attr name="title" type="string">
MASTERSHAKE.ConnectionServer32
</attr>
<attr name="last_modified" type="string">
Jul 22, 2015 9:50 PM
</attr>
 </attrs>
</content>
</entry>
<entry>
<content type="application/xml">
 <attrs>
<attr name="cuid" type="string">
Ac9.Y2465eRNvsXAojovONk
</attr>
<attr name="parent_id" type="int32">
16
</attr>
<attr name="status_type" type="string">
RUNNING
</attr>
<attr name="description" type="string">
Connection Server
</attr>
<attr name="disabled" type="string">
Enabled
</attr>
<attr name="id" type="int32">
1205
</attr>
<attr name="title" type="string">
MASTERSHAKE.ConnectionServer
</attr>
<attr name="last_modified" type="string">
Jul 22, 2015 9:50 PM
</attr>
 </attrs>
</content>
</entry>
<entry>
<content type="application/xml">
 <attrs>
<attr name="cuid" type="string">
Ad3iH88bXNlHnyVOC6r.ibU
</attr>
<attr name="parent_id" type="int32">
16
</attr>
<attr name="status_type" type="string">
RUNNING
</attr>
<attr name="description" type="string">
Event Server
</attr>
<attr name="disabled" type="string">
Enabled
</attr>
<attr name="id" type="int32">
1296
</attr>
<attr name="title" type="string">
MASTERSHAKE.EventServer
</attr>
<attr name="last_modified" type="string">
Jul 22, 2015 9:50 PM
</attr>
 </attrs>
</content>
</entry>
<entry>
<content type="application/xml">
 <attrs>
<attr name="cuid" type="string">
AXTecp48TA5Kk17rp9e0ZBo
</attr>
<attr name="parent_id" type="int32">
16
</attr>
<attr name="status_type" type="string">
RUNNING
</attr>
<attr name="description" type="string">
Dashboards Processing Server
</attr>
<attr name="disabled" type="string">
Enabled
</attr>
<attr name="id" type="int32">
1169
</attr>
<attr name="title" type="string">
MASTERSHAKE.DashboardsProcessingServer
</attr>
<attr name="last_modified" type="string">
Jul 22, 2015 9:50 PM
</attr>
 </attrs>
</content>
</entry>
 </feed>
```

--------------------------------

### POST /biprws/infostore/{id}/scheduleForms/{form}

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45aad19a6e041014910aba7db0e91070.html

Submits a populated scheduling template to schedule a resource.

```APIDOC
## POST /biprws/infostore/{id}/scheduleForms/{form}

### Description
Submits the populated XML template to schedule the resource.

### Method
POST

### Endpoint
http://<baseURL>/biprws/infostore/<id>/scheduleForms/<form>

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID or cuid_CUID of the resource.
- **form** (string) - Required - The frequency of scheduling.

### Request Body
- **body** (XML) - Required - The populated Atom entry template received from the GET request.

### Response
#### Success Response (201)
- **Location** (header) - A link to the location of the scheduled instance.
```

--------------------------------

### GET Request to Discover Scheduling URLs

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45aaca9c6e041014910aba7db0e91070.html

Use the GET method to retrieve the list of scheduling forms for a specific resource ID. Ensure the X-SAP-LogonToken and Accept headers are set correctly in your HTTP request.

```http
GET http://localhost:6405/biprws/infostore/4738/scheduleForms
```

--------------------------------

### Retrieve SFTP destination configuration

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/3d11c9ec8d904108a0c668bbbba7a794.html

Use the GET method to retrieve the current SFTP destination configuration for a publication. If the destination is not enabled, the response returns a default template.

```xml
<entry xmlns="http://www.w3.org/2005/Atom">
    <content type="application/xml">
        <attrs xmlns="http://www.sap.com/rws/bip">
            <attr name="fileextension" type="bool">true</attr>
            <attr name="zipfile" type="bool">false</attr>
            <attr name="password" type="string"></attr>
            <attr name="port" type="int32">22</attr>
            <attr name="deliverperuser" type="bool">true</attr>
            <attr name="fingerprint" type="string"></attr>
            <attr name="mergeexportedpdf" type="bool">false</attr>
            <attr name="servername" type="string"></attr>
            <attr name="targetobjectname" type="string"></attr>
            <attr name="directory" type="string">.</attr>
            <attr name="account" type="string"></attr>
            <attr name="username" type="string"></attr>
        </attrs>
    </content>
</entry>
```

--------------------------------

### GET /v1/calendars

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/0458f797ed1c4b7c846bc21c830fd29f.html

Fetches a list of all available calendars.

```APIDOC
## GET /v1/calendars

### Description
Retrieves the list of available calendars from the system.

### Method
GET

### Endpoint
http://<baseURL>/v1/calendars

### Parameters
#### Headers
- **Content-Type** (string) - Required - application/xml
- **Accept** (string) - Required - application/xml
- **X-SAP-LogonToken** (string) - Required - The logon token value, in quotation marks.

### Response
#### Success Response (200)
- **entries** (array) - List of calendar objects containing cuid, created, name, description, id, and updated fields.

#### Response Example
{
  "entries": [
    {
      "cuid": "Fo3LkVj_sgUAYhIAAAB3gAAAAFBWATGQ",
      "created": "Feb 1, 2017 5:20 PM",
      "name": "Bob's calendar",
      "description": "My calendar",
      "id": "10588",
      "updated": "Feb 1, 2017 5:21 PM"
    }
  ]
}
```

--------------------------------

### GET /biprws/infostore/{id}/scheduleForms/{form}

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45aad19a6e041014910aba7db0e91070.html

Retrieves an XML template for scheduling a specific resource. This template must be populated and used in a subsequent POST request.

```APIDOC
## GET /biprws/infostore/{id}/scheduleForms/{form}

### Description
Retrieves an XML template used to define scheduling parameters for a resource.

### Method
GET

### Endpoint
http://<baseURL>/biprws/infostore/<id>/scheduleForms/<form>

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID or cuid_CUID of the resource.
- **form** (string) - Required - The frequency of scheduling (e.g., now, daily, weekly, once).

### Response
#### Success Response (200)
- **body** (XML) - An Atom entry containing the scheduling template.
```

--------------------------------

### Query RESTful web service by KIND

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45f6073a6e041014910aba7db0e91070.html

SQL query string to retrieve the SI_ACCESS_URL property using the IRestWebService KIND constant.

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

--------------------------------

### Retrieve Scheduling Template

Source: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/db6a17c0d1214fd6971de66ea0122378/45aad19a6e041014910aba7db0e91070.html

Use the GET method to fetch the XML template required for scheduling a resource. Replace the URL components with your specific base URL and resource ID.

```http
GET http://localhost:6405/biprws/infostore/4738/scheduleForms/now
```
Tokens:
Raw