POST /Info/Pivots - Tools for Creating DeepSee Web Clients

docs.intersystems.com

Tools for Creating DeepSee Web Clients

POST /Info/Pivots

[Home] [Back] [Next]

InterSystems: The power behind what matters

InterSystems DeepSee > Tools for Creating DeepSee Web Clients > DeepSee REST API > POST /Info/Pivots

Search:

Returns information about the pivot tables available in the Caché namespace that you access via this REST call.

URL Parameters

None.

Request Body Details

This service uses the following property of the request body:

BASECUBE

Optional. If specified, this property should equal the logical name of a cube. In this case, the server sends information only about pivot tables based on this cube.

Example Request

Request Method:

POST
Request URL:

http://localhost:57772/api/deepsee/v1/Info/Pivots

For comments on the possible forms of the URL, see “Introduction to the DeepSee REST API” in the chapter “Introduction and Samples.”
Request Body:
```
{"BASECUBE":"PATIENTS"}
```

Example Response

{
   "Info":
      {"Error":"","BaseCube":""},
   "Result":
      {"Pivots":
        [
          {"fullName":"Calculated Members\/Alternative Avg Allergy Count",
           "name":"Alternative Avg Allergy Count",
           "lastModified":"2016-11-14 11:22:08",
           "itemType":"pivot"},
          {"fullName":"Calculated Members\/Average Patient Count per Decade",
           "name":"Average Patient Count per Decade",
           "lastModified":"2016-11-14 11:22:08",
           "itemType":"pivot"}
         ...]
      }
}

In the response object, the Result property contains a property called Pivots, which contains an array of objects, one for each pivot table.

For information that applies to all response objects, see the discussion at the start of this reference.