Koverse Data Platform (KDP) API (4.84.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. Please note that the Python client library follows Python's naming convention of snake casing for fields, even though they may appear in camel case in the API specification.
By default this api documentation targets the koverse production server at 'api.app.koverse.com' You can provide the hostname of your koverse instance to this documentation page via the 'host' query param.
For example providing host - https://documentation.koverse.com/api?host=api.myHost.com, will update requests to target the provided host.
Authentication request example with provided host - https://api.myHost.com/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
Creates a new Koverse Authentication Token
Authorizations:
Request Body schema: application/json
strategy required | string Enum: "local" "proxy" 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
- Payload
{- "strategy": "local",
- "email": "string",
- "password": "string",
- "workspaceId": "string"
}
Response samples
- 201
- 4XX
- 5XX
{- "accessToken": "string",
- "authentication": {
- "accessToken": "string",
- "payload": {
- "email": "string",
- "exp": 0,
- "iat": 0,
- "iss": "string",
- "jti": "string",
- "sub": "string"
}, - "strategy": "string"
}, - "user": {
- "avatar": "string",
- "changeEmailTokenExpiration": "string",
- "createdAt": "string",
- "deletedAt": "string",
- "displayName": "string",
- "email": "string",
- "firstName": "string",
- "githubId": "string",
- "googleId": "string",
- "id": "string",
- "lastName": "string",
- "linkedAccounts": [
- "string"
], - "microsoftId": "string",
- "oktaId": "string",
- "stripeCustomerId": "string",
- "updatedAt": "string",
- "verified": true,
- "workspaceCount": 0
}
}
Creates a new Koverse Authentication Token for Single Sign-On (SSO) users
Authorizations:
path Parameters
workspaceId required | string workspaceId for authentication |
Request Body schema: application/json
strategy required | string Enum: "keycloak" "microsoft" "google" "github" "otka" "custom" The method of authentication for single sign-on customers |
access_token required | string The access_token retrieved by signing into the SSO account |
Responses
Request samples
- Payload
{- "strategy": "keycloak",
- "access_token": "string"
}
Response samples
- 201
- 4XX
- 5XX
{- "accessToken": "string",
- "authentication": {
- "accessToken": "string",
- "payload": {
- "email": "string",
- "exp": 0,
- "iat": 0,
- "iss": "string",
- "jti": "string",
- "sub": "string"
}, - "strategy": "string"
}, - "user": {
- "avatar": "string",
- "changeEmailTokenExpiration": "string",
- "createdAt": "string",
- "deletedAt": "string",
- "displayName": "string",
- "email": "string",
- "firstName": "string",
- "githubId": "string",
- "googleId": "string",
- "id": "string",
- "lastName": "string",
- "linkedAccounts": [
- "string"
], - "microsoftId": "string",
- "oktaId": "string",
- "stripeCustomerId": "string",
- "updatedAt": "string",
- "verified": true,
- "workspaceCount": 0
}
}
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:
path Parameters
id required | string accessToken of authentication to remove |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "strategy": "local",
- "email": "string",
- "password": "string",
- "workspaceId": "string"
}
The abac-label-parsers service can be used to retrieve a list of ABAC Label Parsers.
Retrieves a list of Abac Label Parsers
Authorizations:
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
- 200
- 4XX
- 5XX
{- "total": 0,
- "limit": 0,
- "skip": 0,
- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "parserClassName": "IdentityParser",
- "name": "string"
}
]
}
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:
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
- 200
- 4XX
- 5XX
{- "total": 0,
- "limit": 0,
- "skip": 0,
- "data": [
- {
- "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": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "requiredDatasetAccess": [
- {
- "action": "read",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2"
}
]
}
]
}
Create a new Application
Authorizations:
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
- Payload
{- "name": "string",
- "url": "string",
- "redirectUrl": "string",
- "workspaceId": "string",
- "clientId": "string",
- "clientSecret": "string",
- "visible": true,
- "description": "string",
- "type": "mls",
- "allowedUsers": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "requiredDatasetAccess": [
- {
- "action": "read",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2"
}
]
}
Response samples
- 201
- 4XX
- 5XX
{- "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": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "requiredDatasetAccess": [
- {
- "action": "read",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2"
}
]
}
Retrieves Application with the given ID
Authorizations:
path Parameters
id required | string ID of application to return |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "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": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "requiredDatasetAccess": [
- {
- "action": "read",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2"
}
]
}
Updates Application with the given ID
Authorizations:
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
- Payload
{- "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": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "requiredDatasetAccess": [
- {
- "action": "read",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2"
}
], - "resetSecret": true
}
Response samples
- 200
- 4XX
- 5XX
{- "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": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "requiredDatasetAccess": [
- {
- "action": "read",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2"
}
]
}
Updates provided fields of Application with the given ID
Authorizations:
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
- Payload
{- "name": "string",
- "url": "string",
- "redirectUrl": "string",
- "workspaceId": "string",
- "clientId": "string",
- "clientSecret": "string",
- "visible": true,
- "description": "string",
- "type": "mls",
- "allowedUsers": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "requiredDatasetAccess": [
- {
- "action": "read",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2"
}
], - "resetSecret": true
}
Response samples
- 200
- 4XX
- 5XX
{- "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": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "requiredDatasetAccess": [
- {
- "action": "read",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2"
}
]
}
Removes Application with the given ID
Authorizations:
path Parameters
id required | string ID of application to remove |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "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": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "requiredDatasetAccess": [
- {
- "action": "read",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2"
}
]
}
The attributes service is used to create and modify attributes for attribute based access controls (abac)
Retrieves a list of Attributes
Authorizations:
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
- 200
- 4XX
- 5XX
{- "total": 0,
- "limit": 0,
- "skip": 0,
- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "token": "string",
- "description": "string",
- "workspaceId": "string"
}
]
}
Creates a new Attribute
Authorizations:
Request Body schema: application/json
name required | string |
token required | string |
description | string |
workspaceId | string <workspaceId> |
Responses
Request samples
- Payload
{- "name": "string",
- "token": "string",
- "description": "string",
- "workspaceId": "string"
}
Response samples
- 201
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "token": "string",
- "description": "string",
- "workspaceId": "string"
}
Retrieve Attribute with the given ID
Authorizations:
path Parameters
id required | string ID of attribute to return |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "token": "string",
- "description": "string",
- "workspaceId": "string"
}
Update Attribute with the given ID
Authorizations:
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
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "token": "string",
- "description": "string",
- "workspaceId": "string"
}
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "token": "string",
- "description": "string",
- "workspaceId": "string"
}
Update provided fields of Attribute with the given ID
Authorizations:
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
- Payload
{- "name": "string",
- "token": "string",
- "description": "string",
- "workspaceId": "string"
}
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "token": "string",
- "description": "string",
- "workspaceId": "string"
}
Remove Attribute with the given ID
Authorizations:
path Parameters
id required | string ID of attribute to remove |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "token": "string",
- "description": "string",
- "workspaceId": "string"
}
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:
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
- 200
- 4XX
- 5XX
{- "total": 0,
- "limit": 0,
- "skip": 0,
- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "attribute": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "token": "string",
- "description": "string",
- "workspaceId": "string"
}, - "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "workspaceId": "string",
- "role": "member",
- "stripeLatestCharge": {
- "id": "string",
- "failureCode": "string",
- "failureMessage": "string",
- "invoice": "string",
- "status": "failed"
}
}
}
]
}
Create a new Attribute Assignment
Authorizations:
Request Body schema: application/json
attributeId required | string <uuid> |
userId required | string <uuid> |
Responses
Request samples
- Payload
{- "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}
Response samples
- 201
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "attribute": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "token": "string",
- "description": "string",
- "workspaceId": "string"
}, - "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "workspaceId": "string",
- "role": "member",
- "stripeLatestCharge": {
- "id": "string",
- "failureCode": "string",
- "failureMessage": "string",
- "invoice": "string",
- "status": "failed"
}
}
}
Retrieve Attribute Assignment with the given ID
Authorizations:
path Parameters
id required | string ID of attribute-assignment to return |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "attribute": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "token": "string",
- "description": "string",
- "workspaceId": "string"
}, - "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "workspaceId": "string",
- "role": "member",
- "stripeLatestCharge": {
- "id": "string",
- "failureCode": "string",
- "failureMessage": "string",
- "invoice": "string",
- "status": "failed"
}
}
}
Update an Attribute Assignment by given ID
Authorizations:
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
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "attribute": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "token": "string",
- "description": "string",
- "workspaceId": "string"
}, - "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "workspaceId": "string",
- "role": "member",
- "stripeLatestCharge": {
- "id": "string",
- "failureCode": "string",
- "failureMessage": "string",
- "invoice": "string",
- "status": "failed"
}
}
}
Update provided fields of Attribute Assignment by given ID
Authorizations:
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
- Payload
{- "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "attribute": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "token": "string",
- "description": "string",
- "workspaceId": "string"
}, - "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "workspaceId": "string",
- "role": "member",
- "stripeLatestCharge": {
- "id": "string",
- "failureCode": "string",
- "failureMessage": "string",
- "invoice": "string",
- "status": "failed"
}
}
}
Remove Attribute Assignment with given ID
Authorizations:
path Parameters
id required | string ID of attribute-assignment to remove |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "attributeId": "4373db18-af63-40d4-ad40-80a2c734bfcf",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "attribute": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "token": "string",
- "description": "string",
- "workspaceId": "string"
}, - "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "workspaceId": "string",
- "role": "member",
- "stripeLatestCharge": {
- "id": "string",
- "failureCode": "string",
- "failureMessage": "string",
- "invoice": "string",
- "status": "failed"
}
}
}
Get audit log configuration
Get all audit log configuration of all workspaces
Authorizations:
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
- 200
- 4XX
- 5XX
{- "total": 0,
- "limit": 0,
- "skip": 0,
- "data": [
- {
- "keepForever": true,
- "ageInDays": 0,
- "workspaceId": "string",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2"
}
]
}
Patch audit log configuration of a workspace
Patch audit log configuration of a workspace
Authorizations:
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 configuration belongs |
datasetId | string <uuid> The id of the dataset in which the audit logs for this workspace is stored |
Responses
Request samples
- Payload
{- "keepForever": true,
- "ageInDays": 0,
- "workspaceId": "string",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2"
}
Response samples
- 200
- 4XX
- 5XX
{- "keepForever": true,
- "ageInDays": 0,
- "workspaceId": "string",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2"
}
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:
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
- Payload
{- "datasetId": "97d23549-fd63-41b2-9950-bcc7f566e4d4",
- "expression": "alphabet: a",
- "limit": 0,
- "offset": 0,
- "credentialsSubset": [
- "string"
]
}
Response samples
- 200
- 4XX
- 5XX
{- "total": 0,
- "limit": 0,
- "skip": 0,
- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "Login",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "timestampMs": 0,
- "description": "string",
- "sourceIP": "string",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "actor": "string",
- "details": { }
}
]
}
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:
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
- 200
- 4XX
- 5XX
{- "total": 0,
- "limit": 0,
- "skip": 0,
- "data": [
- {
- "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": {
- "read": true,
- "write": true,
- "manage": true
}
}
]
}
Create a new Dataset
Authorizations:
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
- Payload
{- "name": "string",
- "recordCount": 0,
- "description": "string",
- "autoCreateIndexes": true,
- "schema": { },
- "searchAnyField": true,
- "workspaceId": "string"
}
Response samples
- 201
- 4XX
- 5XX
{- "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": {
- "read": true,
- "write": true,
- "manage": true
}
}
Retrieve a Dataset with the given ID
Authorizations:
path Parameters
id required | string ID of dataset to return |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "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": {
- "read": true,
- "write": true,
- "manage": true
}
}
Updates Dataset with given ID
Authorizations:
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
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "recordCount": 0,
- "description": "string",
- "autoCreateIndexes": true,
- "schema": { },
- "searchAnyField": true
}
Response samples
- 200
- 4XX
- 5XX
{- "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": {
- "read": true,
- "write": true,
- "manage": true
}
}
Updates the provided fields of Dataset with given ID
Authorizations:
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
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "recordCount": 0,
- "description": "string",
- "autoCreateIndexes": true,
- "schema": { },
- "searchAnyField": true
}
Response samples
- 200
- 4XX
- 5XX
{- "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": {
- "read": true,
- "write": true,
- "manage": true
}
}
Remove Dataset with given ID
Authorizations:
path Parameters
id required | string ID of dataset to remove |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "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": {
- "read": true,
- "write": true,
- "manage": true
}
}
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:
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
- 200
- 4XX
- 5XX
{- "total": 0,
- "limit": 0,
- "skip": 0,
- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "action": "read",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}
]
}
Create a new Dataset Permission
Authorizations:
Request Body schema: application/json
action required | string Enum: "read" "write" "manage" |
datasetId required | string <uuid> |
groupId required | string <uuid> |
Responses
Request samples
- Payload
{- "action": "read",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}
Response samples
- 201
- 4XX
- 5XX
{- "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:
path Parameters
id required | string ID of dataset-permission to return |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "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:
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
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "action": "read",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}
Response samples
- 200
- 4XX
- 5XX
{- "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:
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
- Payload
{- "action": "read",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}
Response samples
- 200
- 4XX
- 5XX
{- "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:
path Parameters
id required | string ID of dataset-permission to remove |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "action": "read",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}
The dataset-syncs service can be used to create and modify dataset-syncs. A dataset-sync is for syncing a dataset in an origin workspace with a dataset in another workspace. These workspaces can be in different koverse instances.
A dataset-sync can be used for replication of a dataset or collecting data from distributed datasets. It also enables a dataset to be a distributed dataset, receiving records via the sync, adding and deleting records to other synced distributed datasets via the dataset-sync.
See more on Managing Dataset Sync and Replication
Retrieve a list of Dataset Syncs
Authorizations:
query Parameters
datasetId | string <uuid> Dataset ID |
status | string Enum: "pending" "active" "canceled" Status of the Dataset Sync |
type | string Enum: "read" "write" "manage" Type of the Dataset Sync |
$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
- 200
- 4XX
- 5XX
{- "total": 0,
- "limit": 0,
- "skip": 0,
- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "status": "pending",
- "type": "read",
- "key": "string",
- "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
- "isOriginWorkspace": true,
- "host": "myKoverseWorkspaceName.api.myKoverseHostName.com",
- "workspaceId": "myWorkspace",
- "workspaceUniqueId": "b9569c3a-1a3e-433b-87e2-f8462dfd83a3",
- "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
- "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
- "syncDatasetId": "ff86e890-19c7-4534-bc79-01f4f62d141c",
- "syncWorkspaceId": null,
- "syncWorkspaceUniqueId": "0e71e4c7-8672-4407-95c6-b6a409f2a296",
- "lastSyncAt": "2019-08-24T14:15:22Z"
}
]
}
Create Sync Key (Create Origin Dataset Sync)
Authorizations:
Request Body schema: application/json
datasetId required | string <uuid> dataset ID |
type required | string Enum: "read" "write" "manage" Type of the Dataset Sync |
Responses
Request samples
- Payload
{- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "type": "read"
}
Response samples
- 201
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "status": "pending",
- "type": "read",
- "key": "string",
- "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
- "isOriginWorkspace": true,
- "host": "myKoverseWorkspaceName.api.myKoverseHostName.com",
- "workspaceId": "myWorkspace",
- "workspaceUniqueId": "b9569c3a-1a3e-433b-87e2-f8462dfd83a3",
- "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
- "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
- "syncDatasetId": "ff86e890-19c7-4534-bc79-01f4f62d141c",
- "syncWorkspaceId": null,
- "syncWorkspaceUniqueId": "0e71e4c7-8672-4407-95c6-b6a409f2a296",
- "lastSyncAt": "2019-08-24T14:15:22Z"
}
Create and activate a Dataset Sync from key (Create Replica Dataset Sync)
Authorizations:
Request Body schema: application/json
key required | string Security key used for the dataset sync Is the key field from Create Sync Key (Create Origin Dataset Sync) response body. Plain Text key is only available from the Create Sync Key (Create Origin Dataset Sync) POST response, key is encrypted on GET requests. |
syncHost required | string The Host Name of the paired Sync Workspace |
syncId required | string <uuid> The ID of the dataset-sync in paired Sync Workspace For a paired replica, this is the Origin Dataset Sync ID For the origin sync, this is the Paired Replica Dataset Sync ID |
Responses
Request samples
- Payload
{- "key": "string",
- "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
- "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964"
}
Response samples
- 201
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "status": "pending",
- "type": "read",
- "key": "string",
- "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
- "isOriginWorkspace": true,
- "host": "myKoverseWorkspaceName.api.myKoverseHostName.com",
- "workspaceId": "myWorkspace",
- "workspaceUniqueId": "b9569c3a-1a3e-433b-87e2-f8462dfd83a3",
- "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
- "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
- "syncDatasetId": "ff86e890-19c7-4534-bc79-01f4f62d141c",
- "syncWorkspaceId": null,
- "syncWorkspaceUniqueId": "0e71e4c7-8672-4407-95c6-b6a409f2a296",
- "lastSyncAt": "2019-08-24T14:15:22Z"
}
Retrieve a Dataset Sync with the given ID
Authorizations:
path Parameters
id required | string ID of dataset-sync to return |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "status": "pending",
- "type": "read",
- "key": "string",
- "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
- "isOriginWorkspace": true,
- "host": "myKoverseWorkspaceName.api.myKoverseHostName.com",
- "workspaceId": "myWorkspace",
- "workspaceUniqueId": "b9569c3a-1a3e-433b-87e2-f8462dfd83a3",
- "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
- "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
- "syncDatasetId": "ff86e890-19c7-4534-bc79-01f4f62d141c",
- "syncWorkspaceId": null,
- "syncWorkspaceUniqueId": "0e71e4c7-8672-4407-95c6-b6a409f2a296",
- "lastSyncAt": "2019-08-24T14:15:22Z"
}
Update Dataset Sync with the given ID
Authorizations:
path Parameters
id required | string ID of dataset-sync to update |
Request Body schema: application/json
id required | string <uuid> dataset sync ID |
datasetId required | string <uuid> dataset ID |
status required | string Enum: "pending" "active" "canceled" Status of the dataset sync. |
type required | string Enum: "read" "write" "manage" Type of the Dataset Sync |
key required | string Security key used for the dataset sync |
createdByUserId required | string <uuid> ID of User that created the dataset sync |
isOriginWorkspace required | boolean Indicates if dataset for sync originates in this workspace |
host required | string Our Host name |
workspaceId required | string Our workspace ID |
workspaceUniqueId required | string <uuid> Our workspace uniqueId |
syncId | string <uuid> The ID of the dataset-sync in paired Sync Workspace For a paired replica, this is the Origin Dataset Sync ID For the origin sync, this is the Paired Replica Dataset Sync ID |
syncHost | string The Host Name of the paired Sync Workspace |
syncDatasetId | string <uuid> The ID of the dataset in paired Sync Workspace |
syncWorkspaceId | any The ID of the paired Sync Workspace |
syncWorkspaceUniqueId | string <uuid> UniqueId of the paired Sync Workspace |
lastSyncAt | string <date-time> Last Sync At - Time of last successful Sync |
Responses
Request samples
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "status": "pending",
- "type": "read",
- "key": "string",
- "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
- "isOriginWorkspace": true,
- "host": "myKoverseWorkspaceName.api.myKoverseHostName.com",
- "workspaceId": "myWorkspace",
- "workspaceUniqueId": "b9569c3a-1a3e-433b-87e2-f8462dfd83a3",
- "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
- "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
- "syncDatasetId": "ff86e890-19c7-4534-bc79-01f4f62d141c",
- "syncWorkspaceId": null,
- "syncWorkspaceUniqueId": "0e71e4c7-8672-4407-95c6-b6a409f2a296",
- "lastSyncAt": "2019-08-24T14:15:22Z"
}
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "status": "pending",
- "type": "read",
- "key": "string",
- "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
- "isOriginWorkspace": true,
- "host": "myKoverseWorkspaceName.api.myKoverseHostName.com",
- "workspaceId": "myWorkspace",
- "workspaceUniqueId": "b9569c3a-1a3e-433b-87e2-f8462dfd83a3",
- "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
- "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
- "syncDatasetId": "ff86e890-19c7-4534-bc79-01f4f62d141c",
- "syncWorkspaceId": null,
- "syncWorkspaceUniqueId": "0e71e4c7-8672-4407-95c6-b6a409f2a296",
- "lastSyncAt": "2019-08-24T14:15:22Z"
}
Update provided fields of Dataset Sync with given ID
Authorizations:
path Parameters
id required | string ID of dataset-sync to update |
Request Body schema: application/json
id | string <uuid> dataset sync ID |
datasetId | string <uuid> dataset ID |
status | string Enum: "pending" "active" "canceled" Status of the dataset sync. |
type | string Enum: "read" "write" "manage" Type of the Dataset Sync |
key | string Security key used for the dataset sync |
createdByUserId | string <uuid> ID of User that created the dataset sync |
isOriginWorkspace | boolean Indicates if dataset for sync originates in this workspace |
host | string Our Host name |
workspaceId | string Our workspace ID |
workspaceUniqueId | string <uuid> Our workspace uniqueId |
syncId | string <uuid> The ID of the dataset-sync in paired Sync Workspace For a paired replica, this is the Origin Dataset Sync ID For the origin sync, this is the Paired Replica Dataset Sync ID |
syncHost | string The Host Name of the paired Sync Workspace |
syncDatasetId | string <uuid> The ID of the dataset in paired Sync Workspace |
syncWorkspaceId | any The ID of the paired Sync Workspace |
syncWorkspaceUniqueId | string <uuid> UniqueId of the paired Sync Workspace |
lastSyncAt | string <date-time> Last Sync At - Time of last successful Sync |
Responses
Request samples
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "status": "pending",
- "type": "read",
- "key": "string",
- "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
- "isOriginWorkspace": true,
- "host": "myKoverseWorkspaceName.api.myKoverseHostName.com",
- "workspaceId": "myWorkspace",
- "workspaceUniqueId": "b9569c3a-1a3e-433b-87e2-f8462dfd83a3",
- "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
- "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
- "syncDatasetId": "ff86e890-19c7-4534-bc79-01f4f62d141c",
- "syncWorkspaceId": null,
- "syncWorkspaceUniqueId": "0e71e4c7-8672-4407-95c6-b6a409f2a296",
- "lastSyncAt": "2019-08-24T14:15:22Z"
}
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "status": "pending",
- "type": "read",
- "key": "string",
- "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
- "isOriginWorkspace": true,
- "host": "myKoverseWorkspaceName.api.myKoverseHostName.com",
- "workspaceId": "myWorkspace",
- "workspaceUniqueId": "b9569c3a-1a3e-433b-87e2-f8462dfd83a3",
- "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
- "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
- "syncDatasetId": "ff86e890-19c7-4534-bc79-01f4f62d141c",
- "syncWorkspaceId": null,
- "syncWorkspaceUniqueId": "0e71e4c7-8672-4407-95c6-b6a409f2a296",
- "lastSyncAt": "2019-08-24T14:15:22Z"
}
Terminate a Dataset-Sync Connection
Authorizations:
Request Body schema: application/json
action required | string The dataset sync management action |
datasetSyncId required | string <uuid> The ID of the dataset-sync with the connection |
Responses
Request samples
- Payload
{- "action": "terminateConnection",
- "datasetSyncId": "a267d4aa-efa2-42d1-87ad-fd049329a5a5"
}
Response samples
- 201
- 4XX
- 5XX
{- "message": "string",
- "error": "string",
- "sync": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "status": "pending",
- "type": "read",
- "key": "string",
- "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
- "isOriginWorkspace": true,
- "host": "myKoverseWorkspaceName.api.myKoverseHostName.com",
- "workspaceId": "myWorkspace",
- "workspaceUniqueId": "b9569c3a-1a3e-433b-87e2-f8462dfd83a3",
- "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
- "syncHost": "myReplicaWorkspaceName.api.myReplicaKoverseHostName.com",
- "syncDatasetId": "ff86e890-19c7-4534-bc79-01f4f62d141c",
- "syncWorkspaceId": null,
- "syncWorkspaceUniqueId": "0e71e4c7-8672-4407-95c6-b6a409f2a296",
- "lastSyncAt": "2019-08-24T14:15:22Z"
}
}
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:
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
- 200
- 4XX
- 5XX
{- "total": 0,
- "limit": 0,
- "skip": 0,
- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "workspaceId": "string",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "memberCount": 0,
- "autoCreateIndexes": true
}
]
}
Create a new group
Authorizations:
Request Body schema: application/json
id | string <uuid> |
name required | string |
workspaceId required | string <workspaceId> |
userId | string <uuid> |
autoCreateIndexes | boolean |
Responses
Request samples
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "workspaceId": "string",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "autoCreateIndexes": true
}
Response samples
- 201
- 4XX
- 5XX
{- "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:
path Parameters
id required | string ID of group to return |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "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:
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
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "workspaceId": "string",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "autoCreateIndexes": true
}
Response samples
- 200
- 4XX
- 5XX
{- "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:
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
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "autoCreateIndexes": true
}
Response samples
- 200
- 4XX
- 5XX
{- "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:
path Parameters
id required | string ID of group to remove |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "workspaceId": "string",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "memberCount": 0,
- "autoCreateIndexes": true
}
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:
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
- 200
- 4XX
- 5XX
{- "total": 0,
- "limit": 0,
- "skip": 0,
- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "role": "member",
- "group": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "workspaceId": "string",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "memberCount": 0,
- "autoCreateIndexes": true
}, - "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "workspaceId": "string",
- "role": "member",
- "stripeLatestCharge": {
- "id": "string",
- "failureCode": "string",
- "failureMessage": "string",
- "invoice": "string",
- "status": "failed"
}
}
}
]
}
Create a new group membership
Authorizations:
Request Body schema: application/json
groupId required | string <uuid> |
userId required | string <uuid> |
role required | string Enum: "member" "admin" |
Responses
Request samples
- Payload
{- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "role": "member"
}
Response samples
- 201
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "role": "member",
- "group": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "workspaceId": "string",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "memberCount": 0,
- "autoCreateIndexes": true
}, - "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "workspaceId": "string",
- "role": "member",
- "stripeLatestCharge": {
- "id": "string",
- "failureCode": "string",
- "failureMessage": "string",
- "invoice": "string",
- "status": "failed"
}
}
}
Retrieves a group membership with the given id
Authorizations:
path Parameters
id required | string ID of group-membership to return |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "role": "member",
- "group": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "workspaceId": "string",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "memberCount": 0,
- "autoCreateIndexes": true
}, - "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "workspaceId": "string",
- "role": "member",
- "stripeLatestCharge": {
- "id": "string",
- "failureCode": "string",
- "failureMessage": "string",
- "invoice": "string",
- "status": "failed"
}
}
}
Updates the group membership with the given ID
Authorizations:
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
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "role": "member"
}
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "role": "member",
- "group": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "workspaceId": "string",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "memberCount": 0,
- "autoCreateIndexes": true
}, - "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "workspaceId": "string",
- "role": "member",
- "stripeLatestCharge": {
- "id": "string",
- "failureCode": "string",
- "failureMessage": "string",
- "invoice": "string",
- "status": "failed"
}
}
}
Updates the provided properties of group membership with the given ID
Authorizations:
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
- Payload
{- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "role": "member"
}
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "role": "member",
- "group": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "workspaceId": "string",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "memberCount": 0,
- "autoCreateIndexes": true
}, - "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "workspaceId": "string",
- "role": "member",
- "stripeLatestCharge": {
- "id": "string",
- "failureCode": "string",
- "failureMessage": "string",
- "invoice": "string",
- "status": "failed"
}
}
}
Deletes the group membership with the given ID
Authorizations:
path Parameters
id required | string ID of group-membership to remove |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "role": "member",
- "group": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "workspaceId": "string",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "memberCount": 0,
- "autoCreateIndexes": true
}, - "user": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "workspaceId": "string",
- "role": "member",
- "stripeLatestCharge": {
- "id": "string",
- "failureCode": "string",
- "failureMessage": "string",
- "invoice": "string",
- "status": "failed"
}
}
}
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:
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
- 200
- 4XX
- 5XX
{- "total": 0,
- "limit": 0,
- "skip": 0,
- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "fields": [
- "string"
]
}
]
}
Create a new Index
Authorizations:
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
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "fields": [
- "string"
]
}
Response samples
- 201
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "fields": [
- "string"
]
}
Updates Index with given ID
Authorizations:
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
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "fields": [
- "string"
]
}
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "fields": [
- "string"
]
}
Updates fields provided for Index with the ID given
Authorizations:
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
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "fields": [
- "string"
]
}
Response samples
- 200
- 4XX
- 5XX
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "fields": [
- "string"
]
}
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:
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
- Payload
{- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "dataSourceParams": {
- "type": "URL",
- "connectionInfo": {
- "urls": "- \"https://kisp-test.s3-us-west-2.amazonaws.com/nightly_tests/test.csv\"\n- \"https://kisp-test.s3-us-west-2.amazonaws.com/nightly_tests/test.xls\"\n",
- "processAsDocument": true
}, - "securityLabelInfo": {
- "fields": [
- "string"
], - "label": "string",
- "labelHandlingPolicy": "ignore",
- "parserClassName": "simple-parser",
- "replacementString": "string"
}, - "securityLabeled": true
}
}
Response samples
- 4XX
- 5XX
{- "name": "string",
- "message": "string",
- "code": 0
}
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:
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
- 200
- 4XX
- 5XX
{- "total": 0,
- "limit": 0,
- "skip": 0,
- "data": [
- {
- "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"
}
]
}
Creates a new Job
Authorizations:
Request Body schema: application/json
id | string <uuid> job ID |
type required | string Enum: "ingest" "reindex" "clear-dataset" "delete-record" "delete-document" 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
- Payload
{- "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
- 201
- 4XX
- 5XX
{- "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:
path Parameters
id required | string ID of job to return |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "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:
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" "delete-record" "delete-document" 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
- Payload
{- "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
- 200
- 4XX
- 5XX
{- "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:
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" "delete-record" "delete-document" 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
- Payload
{- "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
- 200
- 4XX
- 5XX
{- "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"
}
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:
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
- Payload
{- "datasetId": "97d23549-fd63-41b2-9950-bcc7f566e4d4",
- "expression": "select * from \"97d23549-fd63-41b2-9950-bcc7f566e4d4\" where \"alphabet\" = 'a'",
- "limit": 0,
- "offset": 0,
- "credentialsSubset": [
- "string"
]
}
Response samples
- 4XX
- 5XX
{- "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:
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
- Payload
{- "datasetId": "97d23549-fd63-41b2-9950-bcc7f566e4d4",
- "expression": "alphabet:a",
- "limit": 0,
- "offset": 0,
- "credentialsSubset": [
- "string"
]
}
Response samples
- 4XX
- 5XX
{- "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:
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
- Payload
{- "datasetId": "97d23549-fd63-41b2-9950-bcc7f566e4d4",
- "expression": "alphabet: a",
- "limit": 0,
- "offset": 0,
- "credentialsSubset": [
- "string"
]
}
Response samples
- 4XX
- 5XX
{- "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:
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
- Payload
{- "expression": "Seattle",
- "searchId": "34bc843d-c96f-476b-96c3-e286e83ae311",
- "limit": 0,
- "offset": 0,
- "credentialsSubset": [
- "string"
]
}
Response samples
- 4XX
- 5XX
{- "name": "string",
- "message": "string",
- "code": 0
}
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:
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 |
includeInternalRecordId | boolean Boolean that indicates if the Koverse Internal Record Id should be included |
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
- Payload
{- "datasetId": "0fc3f37a-6e55-4879-b085-c541859ab456",
- "startingRecordId": "string",
- "endingRecordId": "string",
- "excludeStartingRecordId": true,
- "includeInternalRecordId": true,
- "batchSize": 0,
- "credentialsSubset": [
- "string"
]
}
Response samples
- 4XX
- 5XX
{- "name": "string",
- "message": "string",
- "code": 0
}
Read records from dataset in sequence
Authorizations:
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 |
includeInternalRecordId | boolean Boolean that indicates if the Koverse Internal Record Id should be included |
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
- Payload
{- "datasetId": "0fc3f37a-6e55-4879-b085-c541859ab456",
- "startingRecordId": "string",
- "endingRecordId": "string",
- "excludeStartingRecordId": true,
- "includeInternalRecordId": true,
- "batchSize": 0,
- "credentialsSubset": [
- "string"
]
}
Response samples
- 4XX
- 5XX
{- "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:
path Parameters
datasetId required | string dataset ID |
Responses
Response samples
- 200
- 4XX
- 5XX
[ { "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" ] ] } ]
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:
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
- 200
- 4XX
- 5XX
{- "total": 0,
- "limit": 0,
- "skip": 0,
- "data": [
- {
- "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"
}
]
}
Retrieves Segment with the given ID
Authorizations:
path Parameters
id required | string ID of segment to return |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "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"
}
This service can be used to get a source url for uploaded media and can be used to stream or download video/mp4 content
Performs authentication and authorization checks for users before providing a media url
Authorizations:
path Parameters
datasetId required | string Dataset ID containing the document |
query Parameters
documentId required | string Document ID |
download | boolean Optional parameter to request the url as content to be downloaded |
Responses
Response samples
- 200
- 4XX
- 5XX
{- "url": "string"
}
Retrieves list of Source Types
Authorizations:
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
- 200
- 4XX
- 5XX
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "parameters": { }
}
]
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:
path Parameters
datasetId required | string ID of dataset to be cleared |
Responses
Response samples
- 202
- 4XX
- 5XX
{- "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"
}
Deletes documents from a dataset based on a given query
Authorizations:
path Parameters
datasetId required | string Dataset ID |
Request Body schema: application/json
query required | string Documents identified by running this query will be deleted |
Responses
Request samples
- Payload
{- "query": "string"
}
Response samples
- 202
- 4XX
- 5XX
{- "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"
}
Deletes records from a dataset based on the given ids
Authorizations:
path Parameters
datasetId required | string <uuid> Dataset ID |
Request Body schema: application/json
recordIds required | Array of strings Ids of the records to be deleted. To delete all the records in the dataset set this to empty array and set deleteAll parameter to true |
deleteAll | boolean Default: false If this boolean is set to true, delete all records in the dataset that are visible to the user |
Responses
Request samples
- Payload
{- "recordIds": [
- "string"
], - "deleteAll": false
}
Response samples
- 202
- 4XX
- 5XX
{- "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"
}
Deletes records from a dataset based on a given query
Authorizations:
path Parameters
datasetId required | string Dataset ID |
Request Body schema: application/json
query required | string Records identified by running this query will be deleted |
Responses
Request samples
- Payload
{- "query": "string"
}
Response samples
- 202
- 4XX
- 5XX
{- "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"
}
Setup the origin dataset for synchronization
Setup the origin dataset for synchronization
Authorizations:
Request Body schema: application/json
id required | string <uuid> synchronization ID |
datasetId required | string <uuid> ID dataset to be synchronized |
status required | string Enum: "pending" "active" "canceled" synchronization status |
type required | string Enum: "read" "write" "manage" synchronization type |
workspaceId required | string Workspace ID |
workspaceUniqueId required | string <uuid> Workspace uniqueId |
syncWorkspaceId required | string Sync Workspace ID |
syncWorkspaceUniqueId required | string <uuid> Sync Workspace uniqueId |
host required | string Host |
syncHost required | string Sync Host |
Responses
Request samples
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
- "status": "pending",
- "type": "read",
- "workspaceId": "myWorkspace",
- "workspaceUniqueId": "b9569c3a-1a3e-433b-87e2-f8462dfd83a3",
- "syncWorkspaceId": "string",
- "syncWorkspaceUniqueId": "0e71e4c7-8672-4407-95c6-b6a409f2a296",
- "host": "string",
- "syncHost": "string"
}
Response samples
- 4XX
- 5XX
{- "name": "string",
- "message": "string",
- "code": 0
}
Setup the replica dataset for synchronization
Setup the replica dataset for synchronization
Authorizations:
Request Body schema: application/json
id required | string <uuid> synchronization ID |
datasetId required | string <uuid> ID dataset to be synchronized |
status required | string Enum: "pending" "active" "canceled" synchronization status |
type required | string Enum: "read" "write" "manage" synchronization type |
workspaceId required | string Workspace ID |
workspaceUniqueId required | string <uuid> Workspace uniqueId |
syncWorkspaceId required | string Sync Workspace ID |
syncWorkspaceUniqueId required | string <uuid> Sync Workspace uniqueId |
host required | string Host |
syncHost required | string Sync Host |
Responses
Request samples
- Payload