Create a Database View - RevoEngine

POST

/

api

/

v1

/

databases

/

views

Create a Database View

curl --request POST \
  --url https://api.revoengine.com/api/v1/databases/views \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "restricted": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', restricted: true})
};

fetch('https://api.revoengine.com/api/v1/databases/views', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revoengine.com/api/v1/databases/views"

payload = {
    "name": "<string>",
    "restricted": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Authorizations

Authorization

string

header

required

Bearer JWT token or API Key (sk-*).

Body

application/json

definitionMode

enum<string>

required

Available options:

STRUCTURED,

RAW_SQL

name

string

required

type

enum<string>

required

Available options:

VIEW,

MATERIALIZED_VIEW

restricted

boolean

required

request

object

output

object

Optional filters, fields, sorting and paging applied over the preview output.

rawQuery

string

take

number

default:100

Required range: 0 <= x <= 1000

category

string

desc

string

metadata

object | null

Optional resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

Example:

{ "costCenter": "ops" }

users

string[]

groups

string[]

uniqueKey

string[]

indexes

object[]

Structured composite, expression, covering, or partial indexes created on materialized output.

Show child attributes

Response

201

Create a Database View

curl --request POST \
  --url https://api.revoengine.com/api/v1/databases/views \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "restricted": true
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', restricted: true})
};

fetch('https://api.revoengine.com/api/v1/databases/views', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revoengine.com/api/v1/databases/views"

payload = {
    "name": "<string>",
    "restricted": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)