Skip to main content
API docs by Redocly

Koverse Data Platform (KDP) API (4.57.0)

Download OpenAPI specification:Download

The KDP API is a REST API that can be used to create, access, and update data in KDP Workspaces

KDP Documentation

authentication

The authentication service can be used to generate an accessToken. The accessToken can be used for other REST requests that require authentication by sending the Authorization: Bearer HTTP header.

Creates a new Authentication

Authorizations:
Bearer
Request Body schema: application/json
strategy
required
string
Value: "local"

The method of authentication

email
required
string

The email associated with the user account

password
required
string

The password of the KDP account

workspaceId
string

The ID of the Workspace

Responses

Request samples

Content type
application/json
{
  • "strategy": "local",
  • "email": "string",
  • "password": "string",
  • "workspaceId": "string"
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "authentication": {
    },
  • "user": {
    }
}

Remove authentication with accessToken

Should be called with id set to null or to the authenticated access token. Will verify the authentication and emit the logout event if successful.

Authorizations:
Bearer
path Parameters
id
required
string

accessToken of authentication to remove

Responses

Response samples

Content type
application/json
{
  • "strategy": "local",
  • "email": "string",
  • "password": "string",
  • "workspaceId": "string"
}

abac-label-parsers

The abac-label-parsers service can be used to retrieve a list of ABAC Label Parsers.

Retrieves a list of Abac Label Parsers

Authorizations:
Bearer
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Retrieves Abac Label Parser with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of abac-label-parsers to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parserClassName": "IdentityParser",
  • "name": "string"
}

applications

The applications service can be used to allow KDP access for an external application. The applications service can create a new application, retrieve a list of applications for the workspace, retrieve a workspace by ID, and to remove an application.

See more on Creating Applications

Retrieves a list of Applications

Authorizations:
Bearer
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new Application

Authorizations:
Bearer
Request Body schema: application/json
name
required
string
url
required
string <applicationUrl>
redirectUrl
required
string <applicationUrl>
workspaceId
required
string <workspaceId>
clientId
string
clientSecret
string
visible
boolean
description
string
type
string
Enum: "mls" "sls"
allowedUsers
Array of strings <uuid>
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "url": "string",
  • "redirectUrl": "string",
  • "workspaceId": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "visible": true,
  • "description": "string",
  • "type": "mls",
  • "allowedUsers": [
    ],
  • "requiredDatasetAccess": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "url": "string",
  • "redirectUrl": "string",
  • "workspaceId": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "visible": true,
  • "description": "string",
  • "type": "mls",
  • "allowedUsers": [
    ],
  • "requiredDatasetAccess": [
    ]
}

Retrieves Application with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of application to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "url": "string",
  • "redirectUrl": "string",
  • "workspaceId": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "visible": true,
  • "description": "string",
  • "type": "mls",
  • "allowedUsers": [
    ],
  • "requiredDatasetAccess": [
    ]
}

Updates Application with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of application to update

Request Body schema: application/json
id
required
string <uuid>
name
required
string
url
required
string <applicationUrl>
redirectUrl
required
string <applicationUrl>
workspaceId
required
string <workspaceId>
clientId
string
clientSecret
string
visible
boolean
description
string
type
string
Enum: "mls" "sls"
allowedUsers
Array of strings <uuid>
Array of objects
resetSecret
boolean

If set to true, a new clientSecret will be generated for the application

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "url": "string",
  • "redirectUrl": "string",
  • "workspaceId": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "visible": true,
  • "description": "string",
  • "type": "mls",
  • "allowedUsers": [
    ],
  • "requiredDatasetAccess": [
    ],
  • "resetSecret": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "url": "string",
  • "redirectUrl": "string",
  • "workspaceId": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "visible": true,
  • "description": "string",
  • "type": "mls",
  • "allowedUsers": [
    ],
  • "requiredDatasetAccess": [
    ]
}

Updates provided fields of Application with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of application to update

Request Body schema: application/json
name
string
url
string <applicationUrl>
redirectUrl
string <applicationUrl>
workspaceId
string <workspaceId>
clientId
string
clientSecret
string
visible
boolean
description
string
type
string
Enum: "mls" "sls"
allowedUsers
Array of strings <uuid>
Array of objects
resetSecret
boolean

If set to true, a new clientSecret will be generated for the application

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "url": "string",
  • "redirectUrl": "string",
  • "workspaceId": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "visible": true,
  • "description": "string",
  • "type": "mls",
  • "allowedUsers": [
    ],
  • "requiredDatasetAccess": [
    ],
  • "resetSecret": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "url": "string",
  • "redirectUrl": "string",
  • "workspaceId": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "visible": true,
  • "description": "string",
  • "type": "mls",
  • "allowedUsers": [
    ],
  • "requiredDatasetAccess": [
    ]
}

Removes Application with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of application to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "url": "string",
  • "redirectUrl": "string",
  • "workspaceId": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "visible": true,
  • "description": "string",
  • "type": "mls",
  • "allowedUsers": [
    ],
  • "requiredDatasetAccess": [
    ]
}

attributes

The attributes service is used to create and modify attributes for attribute based access controls (abac)

Retrieves a list of Attributes

Authorizations:
Bearer
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Creates a new Attribute

Authorizations:
Bearer
Request Body schema: application/json
name
required
string
token
required
string
description
string
workspaceId
string <workspaceId>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "token": "string",
  • "description": "string",
  • "workspaceId": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "token": "string",
  • "description": "string",
  • "workspaceId": "string"
}

Retrieve Attribute with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of attribute to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "token": "string",
  • "description": "string",
  • "workspaceId": "string"
}

Update Attribute with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of attribute to update

Request Body schema: application/json
id
required
string <uuid>
name
required
string
token
required
string
description
string
workspaceId
string <workspaceId>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "token": "string",
  • "description": "string",
  • "workspaceId": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "token": "string",
  • "description": "string",
  • "workspaceId": "string"
}

Update provided fields of Attribute with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of attribute to update

Request Body schema: application/json
name
string
token
string
description
string
workspaceId
string <workspaceId>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "token": "string",
  • "description": "string",
  • "workspaceId": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "token": "string",
  • "description": "string",
  • "workspaceId": "string"
}

Remove Attribute with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of attribute to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "token": "string",
  • "description": "string",
  • "workspaceId": "string"
}

attribute-assignments

The attribute-assignments service is used to assign, modify or remove an attribute-assignment. An attribute-assignment is used for attribute based access controls (abac) to assign an attribute to a user

See more on Managing Users and Attributes

Retrieve a list of Attribute Assignments

Authorizations:
Bearer
query Parameters
workspaceId
string

workspace id

attributeId
string

attributeId

userId
string

userId

attribute
string

attribute

$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new Attribute Assignment

Authorizations:
Bearer
Request Body schema: application/json
attributeId
required
string <uuid>
userId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "attribute": {
    },
  • "user": {
    }
}

Retrieve Attribute Assignment with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of attribute-assignment to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "attribute": {
    },
  • "user": {
    }
}

Update an Attribute Assignment by given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of attribute-assignment to update

Request Body schema: application/json
id
required
string <uuid>
attributeId
required
string <uuid>
userId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "attribute": {
    },
  • "user": {
    }
}

Update provided fields of Attribute Assignment by given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of attribute-assignment to update

Request Body schema: application/json
attributeId
string <uuid>
userId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "attribute": {
    },
  • "user": {
    }
}

Remove Attribute Assignment with given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of attribute-assignment to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "attribute": {
    },
  • "user": {
    }
}

audit-log-configs

This service is used to retrieve and manage audit log configuration

Get audit log configuration

Get all audit log configuration of all workspaces

Authorizations:
Bearer
query Parameters
workspaceId
string

Return the audit log configurations

keepForever
boolean

Return the audit log configurations

$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Patch audit log configuration of a workspace

Patch audit log configuration of a workspace

Authorizations:
Bearer
path Parameters
auditLogConfigsId
required
string

ID of the audit log configuration

Request Body schema: application/json
keepForever
required
boolean

flag to never delete the logs

ageInDays
integer

The age of the logs- Logs older than that would be deleted, if the keepForever flag is false

workspaceId
string

The id of the workspace to which this congiguration belongs

datasetId
string <uuid>

The id of the dataset in which the audit logs for this workspace is stored

Responses

Request samples

Content type
application/json
{
  • "keepForever": true,
  • "ageInDays": 0,
  • "workspaceId": "string",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2"
}

Response samples

Content type
application/json
{
  • "keepForever": true,
  • "ageInDays": 0,
  • "workspaceId": "string",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2"
}

audit-log

This service is used to retrieve audit log events

Queries audit log datasets

Search an audit log dataset using lucene query syntax. Supported features include wildcards, range queries, search across all fields, and many more.

Authorizations:
Bearer
query Parameters
includeInternalFields
boolean
Default: false

(Advanced) If true, include koverse internal fields in the response body

Request Body schema: application/json
datasetId
string <uuid>

The ID of the dataset where this query will run

expression
string

The query in lucene query syntax

limit
integer <int32>

The maximum number of records to return for the query, providing 0 returns all records

offset
integer <int32>

The number of records from the beginning of a record batch where the current batch will start, used for paging results

credentialsSubset
Array of strings

A list of credentials that can be provided to return records of a more limited subset than that of the authenticated caller

Responses

Request samples

Content type
application/json
{
  • "datasetId": "97d23549-fd63-41b2-9950-bcc7f566e4d4",
  • "expression": "alphabet: a",
  • "limit": 0,
  • "offset": 0,
  • "credentialsSubset": [
    ]
}

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

datasets

The datasets service can be used to create and modify datasets for a workspace. The datasets service can create a dataset, retrieve a list of datasets, modify a dataset, or remove a dataset.

See more on Configuring Datasets

Retrieve a list of datasets

Authorizations:
Bearer
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new Dataset

Authorizations:
Bearer
Request Body schema: application/json
name
required
string
recordCount
number
description
string
autoCreateIndexes
boolean
schema
object
searchAnyField
boolean
workspaceId
required
string <workspaceId>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "recordCount": 0,
  • "description": "string",
  • "autoCreateIndexes": true,
  • "schema": { },
  • "searchAnyField": true,
  • "workspaceId": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recordCount": 0,
  • "description": "string",
  • "autoCreateIndexes": true,
  • "schema": { },
  • "searchAnyField": true,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "workspaceId": "string",
  • "currentUserPermissions": {
    }
}

Retrieve a Dataset with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of dataset to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recordCount": 0,
  • "description": "string",
  • "autoCreateIndexes": true,
  • "schema": { },
  • "searchAnyField": true,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "workspaceId": "string",
  • "currentUserPermissions": {
    }
}

Updates Dataset with given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of dataset to update

Request Body schema: application/json
id
string <uuid>
name
required
string
recordCount
number
description
string
autoCreateIndexes
boolean
schema
object
searchAnyField
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recordCount": 0,
  • "description": "string",
  • "autoCreateIndexes": true,
  • "schema": { },
  • "searchAnyField": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recordCount": 0,
  • "description": "string",
  • "autoCreateIndexes": true,
  • "schema": { },
  • "searchAnyField": true,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "workspaceId": "string",
  • "currentUserPermissions": {
    }
}

Updates the provided fields of Dataset with given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of dataset to update

Request Body schema: application/json
id
string <uuid>
name
string
recordCount
number
description
string
autoCreateIndexes
boolean
schema
object
searchAnyField
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recordCount": 0,
  • "description": "string",
  • "autoCreateIndexes": true,
  • "schema": { },
  • "searchAnyField": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recordCount": 0,
  • "description": "string",
  • "autoCreateIndexes": true,
  • "schema": { },
  • "searchAnyField": true,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "workspaceId": "string",
  • "currentUserPermissions": {
    }
}

Remove Dataset with given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of dataset to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "recordCount": 0,
  • "description": "string",
  • "autoCreateIndexes": true,
  • "schema": { },
  • "searchAnyField": true,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "workspaceId": "string",
  • "currentUserPermissions": {
    }
}

dataset-permissions

The dataset-permissions service can be used to create and modify dataset-permissions. A dataset-permission is for assigning the users in a group the ability to take an action on the dataset. The dataset-permission service can be used to create a dataset-permission, retrieve a list of dataset-permissions, update a dataset-permission, or remove a dataset-permission.

See more on Managing Users and Attributes

Retrieve list of dataset permissions

Authorizations:
Bearer
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new Dataset Permission

Authorizations:
Bearer
Request Body schema: application/json
action
required
string
Enum: "read" "write" "manage"
datasetId
required
string <uuid>
groupId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "action": "read",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "action": "read",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Retrieve a Dataset Permission with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of dataset-permission to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "action": "read",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Update Dataset Permission with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of dataset-permission to update

Request Body schema: application/json
id
required
string <uuid>
action
required
string
Enum: "read" "write" "manage"
datasetId
required
string <uuid>
groupId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "action": "read",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "action": "read",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Update provided fields of Dataset Permission with given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of dataset-permission to update

Request Body schema: application/json
action
string
Enum: "read" "write" "manage"
datasetId
string <uuid>
groupId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "action": "read",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "action": "read",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Remove Dataset Permission with given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of dataset-permission to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "action": "read",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

groups

The groups service can be used to create groups, get a group by the ID, update a group, or remove a group.

Retrieves a list of groups from the groups service

Authorizations:
Bearer
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new group

Authorizations:
Bearer
Request Body schema: application/json
id
string <uuid>
name
required
string
workspaceId
required
string <workspaceId>
userId
string <uuid>
autoCreateIndexes
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "autoCreateIndexes": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "memberCount": 0,
  • "autoCreateIndexes": true
}

Retrieves a group with the given id from the service

Authorizations:
Bearer
path Parameters
id
required
string

ID of group to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "memberCount": 0,
  • "autoCreateIndexes": true
}

Updates the group with given id

Authorizations:
Bearer
path Parameters
id
required
string

ID of group to update

Request Body schema: application/json
id
string <uuid>
name
required
string
workspaceId
required
string <workspaceId>
userId
string <uuid>
autoCreateIndexes
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "autoCreateIndexes": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "memberCount": 0,
  • "autoCreateIndexes": true
}

Updates the resource with the given id

Authorizations:
Bearer
path Parameters
id
required
string

ID of group to update

Request Body schema: application/json
id
string <uuid>
name
string
userId
string <uuid>
autoCreateIndexes
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "autoCreateIndexes": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "memberCount": 0,
  • "autoCreateIndexes": true
}

Removes the group with the given id

Authorizations:
Bearer
path Parameters
id
required
string

ID of group to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "memberCount": 0,
  • "autoCreateIndexes": true
}

group-memberships

The group-memberships service can be used to assign and edit user's group memberships. The group-memberships service can be used to create a group-membership for a user, modify a user's group-membership or remove a user's group-membership.

Retrieves a list of group memberships

Authorizations:
Bearer
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new group membership

Authorizations:
Bearer
Request Body schema: application/json
groupId
required
string <uuid>
userId
required
string <uuid>
role
required
string
Enum: "member" "admin"

Responses

Request samples

Content type
application/json
{
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "role": "member",
  • "group": {
    },
  • "user": {
    }
}

Retrieves a group membership with the given id

Authorizations:
Bearer
path Parameters
id
required
string

ID of group-membership to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "role": "member",
  • "group": {
    },
  • "user": {
    }
}

Updates the group membership with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of group-membership to update

Request Body schema: application/json
id
required
string <uuid>
groupId
required
string <uuid>
userId
required
string <uuid>
role
required
string
Enum: "member" "admin"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "role": "member",
  • "group": {
    },
  • "user": {
    }
}

Updates the provided properties of group membership with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of group-membership to update

Request Body schema: application/json
groupId
string <uuid>
userId
string <uuid>
role
string
Enum: "member" "admin"

Responses

Request samples

Content type
application/json
{
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "role": "member",
  • "group": {
    },
  • "user": {
    }
}

Deletes the group membership with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of group-membership to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "role": "member",
  • "group": {
    },
  • "user": {
    }
}

indexes

The indexes service can be used to create and modify indexes. Indexes are copies of fields of a dataset stored to enable very efficient search. The index service can be used to create an index, retrieve a list of indexes, retrieve an index by ID, update an index, or remove an index.

Retrieve list of Indexes

Authorizations:
Bearer
query Parameters
datasetId
required
string

dataset id

fields
boolean

populate fields

$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Create a new Index

Authorizations:
Bearer
Request Body schema: application/json
id
string <uuid>

index ID

datasetId
required
string <uuid>

dataset ID

fields
required
Array of strings

dataset fields

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "fields": [
    ]
}

Retrieve Index with given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of index to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "fields": [
    ]
}

Updates Index with given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of index to update

Request Body schema: application/json
id
string <uuid>

index ID

datasetId
required
string <uuid>

dataset ID

fields
required
Array of strings

dataset fields

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "fields": [
    ]
}

Updates fields provided for Index with the ID given

Authorizations:
Bearer
path Parameters
id
required
string

ID of index to update

Request Body schema: application/json
id
string <uuid>

index ID

datasetId
required
string <uuid>

dataset ID

fields
required
Array of strings

dataset fields

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "fields": [
    ]
}

Removes Index with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of index to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "fields": [
    ]
}

ingest

The ingest service can be used to create jobs for importing data.

Create an Ingest Job

For creating an ingest job to import data into the Koverse Data Platform from many sources including via Amazon S3, url datasources, Kafka Streaming, Postgres Databases and many others.

Authorizations:
Bearer
query Parameters
isAsync
boolean
Default: false
Request Body schema: application/json
datasetId
string <uuid>

id of the dataset that will receive the data from the ingest job

object (Data Source Params)

Contains the configuration parameters for the datasource

Responses

Request samples

Content type
application/json
{
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "dataSourceParams": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}

jobs

The jobs service can be used to create and modify jobs. The jobs service can be used to create a job, retrieve a list of jobs, retrieve a job by ID, or to update a job.

Retrieves list of Jobs

Authorizations:
Bearer
query Parameters
workspaceId
string

workspaceId

datasetId
required
string

datasetId

$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Creates a new Job

Authorizations:
Bearer
Request Body schema: application/json
id
string <uuid>

job ID

type
required
string
Enum: "ingest" "reindex" "clear-dataset"

job type

status
string
Enum: "queued" "running" "completed" "canceled" "failed"

job status

config
object

job config

error
object

job error

stage
number

job stage

totalStages
number

count of stages

datasetId
required
string <uuid>

dataset ID

workspaceId
required
string <workspaceId>

workspace ID

userId
required
string <uuid>

user ID

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Retrieve Job with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of job to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Updates Job with the ID given

Authorizations:
Bearer
path Parameters
id
required
string

ID of job to update

Request Body schema: application/json
id
string <uuid>

job ID

type
required
string
Enum: "ingest" "reindex" "clear-dataset"

job type

status
string
Enum: "queued" "running" "completed" "canceled" "failed"

job status

config
object

job config

error
object

job error

stage
number

job stage

totalStages
number

count of stages

datasetId
required
string <uuid>

dataset ID

workspaceId
required
string <workspaceId>

workspace ID

userId
required
string <uuid>

user ID

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Updates fields provided for Jobs with the ID given

Authorizations:
Bearer
path Parameters
id
required
string

ID of job to update

Request Body schema: application/json
id
string <uuid>

job ID

type
required
string
Enum: "ingest" "reindex" "clear-dataset"

job type

status
string
Enum: "queued" "running" "completed" "canceled" "failed"

job status

config
object

job config

error
object

job error

stage
number

job stage

totalStages
number

count of stages

datasetId
required
string <uuid>

dataset ID

workspaceId
required
string <workspaceId>

workspace ID

userId
required
string <uuid>

user ID

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

query

The query service can be used to query data from datasets. Options for query include Standard SQL and queries using the lucene query syntax.

Query a dataset

Search a dataset using a SQL query string. Standard SQL is supported in the expression.

Authorizations:
Bearer
Request Body schema: application/json
datasetId
string <uuid>

The ID of the dataset where this query will run

expression
string

The Sql Expression written in query language made up of one or more values, operators, or SQL functions

limit
integer <int32>

The maximum number of records to return for the query, providing 0 returns all records

offset
integer <int32>

The number of records from the beginning of a record batch where the current batch will start, used for paging results

credentialsSubset
Array of strings

A list of credentials that can be provided to return records of a more limited subset than that of the authenticated caller

Responses

Request samples

Content type
application/json
{
  • "datasetId": "97d23549-fd63-41b2-9950-bcc7f566e4d4",
  • "expression": "select * from \"97d23549-fd63-41b2-9950-bcc7f566e4d4\" where \"alphabet\" = 'a'",
  • "limit": 0,
  • "offset": 0,
  • "credentialsSubset": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}

Query document for a dataset using the lucene query syntax

Search document records for a dataset using lucene query syntax. Supported features include wildcards, range queries, search across all fields, and many more.

Authorizations:
Bearer
Request Body schema: application/json
datasetId
string <uuid>

The ID of the dataset where this query will run

expression
string

The query in lucene query syntax

limit
integer <int32>

The maximum number of records to return for the query, providing 0 returns all records

offset
integer <int32>

The number of records from the beginning of a record batch where the current batch will start, used for paging results

credentialsSubset
Array of strings

A list of credentials that can be provided to return records of a more limited subset than that of the authenticated caller

Responses

Request samples

Content type
application/json
{
  • "datasetId": "97d23549-fd63-41b2-9950-bcc7f566e4d4",
  • "expression": "alphabet:a",
  • "limit": 0,
  • "offset": 0,
  • "credentialsSubset": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}

Query a dataset using the lucene query syntax

Search a dataset using lucene query syntax. Supported features include wildcards, range queries, search across all fields, and many more.

Authorizations:
Bearer
query Parameters
includeInternalFields
boolean
Default: false

(Advanced) If true, include koverse internal fields in the response body

Request Body schema: application/json
datasetId
string <uuid>

The ID of the dataset where this query will run

expression
string

The query in lucene query syntax

limit
integer <int32>

The maximum number of records to return for the query, providing 0 returns all records

offset
integer <int32>

The number of records from the beginning of a record batch where the current batch will start, used for paging results

credentialsSubset
Array of strings

A list of credentials that can be provided to return records of a more limited subset than that of the authenticated caller

Responses

Request samples

Content type
application/json
{
  • "datasetId": "97d23549-fd63-41b2-9950-bcc7f566e4d4",
  • "expression": "alphabet: a",
  • "limit": 0,
  • "offset": 0,
  • "credentialsSubset": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}

Query all datasets

Search in all fields across all datasets you have access to for the same value. Returns a list of datasets and the number of matching records found in each dataset. Supported features include wildcards and range queries.

Authorizations:
Bearer
Request Body schema: application/json
expression
string

The term that you want to search for

searchId
string <uuid>

A uuid used for paging through search results.

limit
integer <int32>

The maximum number of datasets to return for the query, providing 0 returns all datasets that contain matching records

offset
integer <int32>

The number of datasets from the beginning where the current results will start, used for paging results

credentialsSubset
Array of strings

A list of credentials that can be provided to return records of a more limited subset than that of the authenticated caller

Responses

Request samples

Content type
application/json
{
  • "expression": "Seattle",
  • "searchId": "34bc843d-c96f-476b-96c3-e286e83ae311",
  • "limit": 0,
  • "offset": 0,
  • "credentialsSubset": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}

read

The read service can be used for fast access to records in KDP datasets.

Read records

Read a batch of records from partitions.

Dataset partitions can be read in parallel, using the record ranges of partitions (from the splits endpoint), and calling the read endpoint with each partition range. In the read in parallel use case, the startingRecordId is the start of each partition range, and the endingRecordId is the last record of each partition range.

Authorizations:
Bearer
Request Body schema: application/json
datasetId
string

ID of the dataset (uuid)

startingRecordId
string

ID of the record that will be the start of the range for the read request

endingRecordId
string

ID of the record that will be the end of the range for the read request

excludeStartingRecordId
boolean

Boolean that indicates if the first record should be included in the range of the read request

batchSize
integer <int32>

Maximum number of records that should be included in this batch

credentialsSubset
Array of strings

A list of credentials that can be provided to return records of a more limited subset than that of the authenticated caller

Responses

Request samples

Content type
application/json
{
  • "datasetId": "0fc3f37a-6e55-4879-b085-c541859ab456",
  • "startingRecordId": "string",
  • "endingRecordId": "string",
  • "excludeStartingRecordId": true,
  • "batchSize": 0,
  • "credentialsSubset": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}

Read records from dataset in sequence

Authorizations:
Bearer
Request Body schema: application/json
datasetId
string

ID of the dataset (uuid)

startingRecordId
string

ID of the record that will be the start of the range for the read request

endingRecordId
string

ID of the record that will be the end of the range for the read request

excludeStartingRecordId
boolean

Boolean that indicates if the first record should be included in the range of the read request

batchSize
integer <int32>

Maximum number of records that should be included in this batch

credentialsSubset
Array of strings

A list of credentials that can be provided to return records of a more limited subset than that of the authenticated caller

Responses

Request samples

Content type
application/json
{
  • "datasetId": "0fc3f37a-6e55-4879-b085-c541859ab456",
  • "startingRecordId": "string",
  • "endingRecordId": "string",
  • "excludeStartingRecordId": true,
  • "batchSize": 0,
  • "credentialsSubset": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}

Get record ranges of partitions

Get a list of record ranges. Each range consists of an array containing the starting record ID of the partition, followed by the ending record ID of the partition. For use by applications that want to read data partitions in parallel, such as with spark. Each partition's records can be read via the read endpoint in parallel to proficiently read large datasets.

Authorizations:
Bearer
path Parameters
datasetId
required
string

dataset ID

Responses

Response samples

Content type
*/*
[
  {
    "ranges": [
      [
        "0.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "0.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "1.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "1.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "2.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "2.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "3.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "3.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "4.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "4.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "5.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "5.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "6.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "6.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "7.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "7.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "8.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "8.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ],
      [
        "9.b910ceca-4718-4240-ac6a-ce926006bd2c",
        "9.b910ceca-4718-4240-ac6a-ce926006bd2d"
      ]
    ]
  }
]

segments

The segments service can be used to create and modify segments. The segments service can be used to create a new segment, retrieve a list of segments, or to retrieve a segment by ID.

Retrieves a list of Segments

Authorizations:
Bearer
query Parameters
workspaceId
string

workspaceId

datasetId
required
string

datasetId

jobId
string

jobId

$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Retrieves Segment with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of segment to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "config": { },
  • "stage": 0,
  • "status": "queued",
  • "error": { },
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "processedBy": "string"
}

source-types

The source-types service can be used to retrieve a list of Source Types.

Retrieves list of Source Types

Authorizations:
Bearer
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

object (SourceTypes)

Query parameters to filter

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieves Source Type with the given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of source-types to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "parameters": { }
}

storage

This service handles various aspects of management of accumulo storage like reporting on usage and removing data that are not needed anymore

Clear a dataset

Remove all the records and indices for the dataset but keep the empty dataset available for use

Authorizations:
Bearer
path Parameters
datasetId
required
string

ID of dataset to be cleared

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "ingest",
  • "status": "queued",
  • "config": { },
  • "error": { },
  • "stage": 0,
  • "totalStages": 0,
  • "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
  • "workspaceId": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

users

The users service can be used to create users, get a list of all users of the workspace, update a user or their workspace role, or to delete users.

Create a user

Authorizations:
Bearer
Request Body schema: application/json
email
required
string <email>

email of the new user

firstName
required
string

first name of the new user

lastName
required
string

last name of the new user

password
required
string <password>

authentication password for the new user

workspaceId
string <workspaceId>

ID of the KDP workspace that the new user will access. Does not grant permissions to data.

role
string
Enum: "member" "admin"

role for the new user

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "password": "pa$$word",
  • "workspaceId": "string",
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "workspaceId": "string",
  • "role": "member",
  • "stripeLatestCharge": {
    }
}

Retrieves a list of users

Authorizations:
Bearer
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Retrieves a user with the given id from the users service.

Authorizations:
Bearer
path Parameters
id
required
string

ID of user to return

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "workspaceId": "string",
  • "role": "member",
  • "stripeLatestCharge": {
    }
}

Updates a user with given id

Authorizations:
Bearer
path Parameters
id
required
string

ID of user to update

Request Body schema: application/json
id
string <uuid>

provide current or updated ID of the user

email
required
string <email>

provide current or updated email of the user

firstName
required
string

the current or updated first name of the user

lastName
required
string

the current or updated last name of the user

password
required
string <password>

the current or updated authentication password of the user

workspaceId
string <workspaceId>

the current or updated workspaceId the user can access

role
string
Enum: "member" "admin"

the current or updated workspace role for the user

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "password": "pa$$word",
  • "workspaceId": "string",
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "workspaceId": "string",
  • "role": "member",
  • "stripeLatestCharge": {
    }
}

Updates the resource by id for the fields provided

Authorizations:
Bearer
path Parameters
id
required
string

ID of user to update

Request Body schema: application/json
id
string <uuid>
email
string <email>
firstName
string
lastName
string
password
string <password>
workspaceId
string <workspaceId>
role
string
Enum: "member" "admin"
object (stripeLatestCharge)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "password": "pa$$word",
  • "workspaceId": "string",
  • "role": "member",
  • "stripeLatestCharge": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "workspaceId": "string",
  • "role": "member",
  • "stripeLatestCharge": {
    }
}

Removes the user by given id

Authorizations:
Bearer
path Parameters
id
required
string

ID of user to remove

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "workspaceId": "string",
  • "role": "member",
  • "stripeLatestCharge": {
    }
}

workspaces

The workspaces service can be used to create and modify workspaces. The workspaces service can be used to create a workspace, retrieve a list workspaces, retrieve a workspace by ID, update a workspace, and to delete a workspace.

See more about workspaces on Creating Your Workspace

Retrieves a list of workspaces

Authorizations:
Bearer
query Parameters
$limit
integer

Number of results to return

$skip
integer

Number of results to skip

$sort
object

Property to sort results

filter
object

Query parameters to filter

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "skip": 0,
  • "data": [
    ]
}

Creates a new Workspace

Authorizations:
Bearer
Request Body schema: application/json
id
string <workspaceId>
name
required
string
userId
string
object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "userId": "string",
  • "subscription": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "userId": "string",
  • "subscription": {
    }
}

Retrieves Workspace with given ID

Authorizations:
Bearer
path Parameters
id
required
string

ID of workspace to return

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "userId": "string",
  • "subscription": {
    }
}

Updates Workspace with the ID given

Authorizations:
Bearer
path Parameters
id
required
string

ID of workspace to update

Request Body schema: application/json
id
required
string <workspaceId>
name
required
string
userId
string
object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "userId": "string",
  • "subscription": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "userId": "string",
  • "subscription": {
    }
}

Updates provided fields of Workspace with the ID given

Authorizations:
Bearer
path Parameters
id
required
string

ID of workspace to update

Request Body schema: application/json
id
string <workspaceId>
name
string
userId
string
object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "userId": "string",
  • "subscription": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "userId": "string",
  • "subscription": {
    }
}

write

The write service can be used to create records in KDP datasets.

Write records

Writes a batch of records to random partitions and returns the list of partitions

Authorizations:
Bearer
path Parameters
datasetId
required
string <uuid>
query Parameters
isAsync
boolean
Default: false
Request Body schema: application/json
Array
property name*
additional property
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}

Write records (v2)

Writes a batch of records to random partitions with the option of configuring security label parser and returns the list of partitions

Authorizations:
Bearer
path Parameters
datasetId
required
string <uuid>
query Parameters
isAsync
boolean
Default: false
Request Body schema: application/json
Array of objects (JsonRecord)

Array of json documents to write into KDP.

object (Security Label Info)

Contains the configuration parameters for the security label parser

Responses

Request samples

Content type
application/json
{
  • "records": [
    ],
  • "securityLabelInfo": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "message": "string",
  • "code": 0
}