curl --request POST \
  --url https://{host}/activeviam/pivot/rest/v9/database/data/tables/{tableName} \
  --header 'Content-Type: application/json' \
  --data '
{
  "conditions": {
    "year": {
      "$in": [
        2010,
        2011
      ]
    }
  }
}
'

{
  "epoch": 185,
  "headers": [
    {
      "name": "Id",
      "type": "long"
    },
    {
      "name": "ProductId",
      "type": "int"
    },
    {
      "name": "Desk",
      "type": "String"
    }
  ],
  "pagination": {
    "currentPage": 2,
    "nextPage": 3,
    "nextPageUrl": "/data/tables/myTable?pageSize=20&page=3",
    "previousPage": 1,
    "previousPageUrl": "/data/tables/myTable?pageSize=20&page=1"
  },
  "rows": [
    [
      100001,
      128,
      "DeskA"
    ],
    [
      100001,
      128,
      "DeskA"
    ],
    [
      100002,
      64,
      "DeskB"
    ]
  ]
}

Execute a query on the database.

deprecated

Execute a query on the database, on a given table, via POST method. The query can be paginated using the parameters page and pageSize.

Deprecated for removal in 6.3.0: use POST /activeviam/database/rest/v10/data/tables/{tableName} instead, which also accepts distinct queries. The Atoti Server starter only serves the version 10 Database API when atoti.server.endpoint.database.security.enabled is true.

POST

activeviam

pivot

rest

database

data

tables

{tableName}

curl --request POST \
  --url https://{host}/activeviam/pivot/rest/v9/database/data/tables/{tableName} \
  --header 'Content-Type: application/json' \
  --data '
{
  "conditions": {
    "year": {
      "$in": [
        2010,
        2011
      ]
    }
  }
}
'

{
  "epoch": 185,
  "headers": [
    {
      "name": "Id",
      "type": "long"
    },
    {
      "name": "ProductId",
      "type": "int"
    },
    {
      "name": "Desk",
      "type": "String"
    }
  ],
  "pagination": {
    "currentPage": 2,
    "nextPage": 3,
    "nextPageUrl": "/data/tables/myTable?pageSize=20&page=3",
    "previousPage": 1,
    "previousPageUrl": "/data/tables/myTable?pageSize=20&page=1"
  },
  "rows": [
    [
      100001,
      128,
      "DeskA"
    ],
    [
      100001,
      128,
      "DeskA"
    ],
    [
      100002,
      64,
      "DeskB"
    ]
  ]
}

Path Parameters

tableName

string

default:""

required

Desired table name.

Query Parameters

queryAction

enum<string>

default:""

required

Action flag to indicate a query on this table.

Available options:

count,

select

page

string

default:""

The page to return. First page (and default) is 1.

pageSize

string

default:""

The maximum number of rows in the page. Default is 100.

query

string

default:ignored

Body

application/json

Query parameters in JSON format.

branch

string

conditions

object

Show child attributes

distinct

boolean

epoch

integer<int64>

fields

string[]

page

integer<int32>

pageSize

integer<int32>

timeout

integer<int64>

{key}

any

Response

200 - application/json

Query executed successfully.

epoch

integer<int64>

headers

object[]

Show child attributes

pagination

object

Show child attributes

rows

any[][]

{key}

any

AI Optimizer

Auto-Explain

BI Adapter REST API

Bulk REST API

Content Server REST API

Database REST API

Distribution Observability

JWT API

Configuration REST API

Data Export

Discovery REST API

Continuous GAQ Query REST API

GAQ Query REST API

Query REST API (V10)

Query REST API (V9)

Database REST API v9

Query History REST API (Experimental)

Version REST API

XMLA API

Execute a query on the database.

Path Parameters

Query Parameters

Body

Response