Skip to main content
API docs by Redocly

EDL API (0.39.0)

Download OpenAPI specification:Download

APIs for Enterprise Data Layer

EDL Documentation

KDP

Query KDP dataset schema

Retrieve KDP dataset schema

Authorizations:
(bearerAuthkoverseAuth)
query Parameters
datasetId
required
string

KDP dataset id

includeSecurityField
boolean
Default: false

whether to include the security field (_koverse_security_label) for each schema entry.

includeNestedFields
boolean
Default: false

whether to include nested fields of the schema such as the child fields of an object or map.

Responses

Response samples

Content type
application/json
{
  • "name": {
    },
  • "id": {
    },
  • "date": {
    }
}

List KDP datasets

Retrieve list of datasets from the KDP to which authenticated user has access

Authorizations:
(bearerAuthkoverseAuth)
query Parameters
limit
integer

Number of results to return

skip
integer

Number of results to skip

Responses

Response samples

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

Query KDP user

Query KDP user

Authorizations:
(bearerAuthkoverseAuth)
query Parameters
userId
required
string

KDP user id

Responses

Response samples

Content type
application/json
{
  • "id": "6bf7c1e5-xxx-xxx-xxxx-a4cc287941f6",
  • "email": "xxx@saic.com",
  • "workspaceId": "myworkspace",
  • "role": "admin",
  • "firstName": "edl",
  • "lastName": "test",
  • "avatar": null,
  • "githubId": null,
  • "googleId": null,
  • "keycloakId": "8a47c064-xxxx-xxxx-xxxx-a396255d5379",
  • "microsoftId": null,
  • "oktaId": null,
  • "stripeCustomerId": null,
  • "stripeLatestCharge": null,
  • "stripeSubscriptionId": null,
  • "changeEmailTokenExpiration": null,
  • "usedFreeTrial": false,
  • "verified": true,
  • "createdAt": "2024-06-25T19:59:50.326Z",
  • "updatedAt": "2024-07-29T20:59:45.546Z",
  • "deletedAt": null,
  • "linkedAccounts": [
    ],
  • "displayName": "edl test"
}

Authenticate KDP user

Authenticate a user and retrieve access token and user information

Authorizations:
bearerAuth
query Parameters
workspaceId
required
string

KDP workspace id

Responses

Response samples

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

Query KDP dataset

Query KDP dataset

Authorizations:
(bearerAuthkoverseAuth)
Request Body schema: application/json
required
expression
string

Query expression

limit
integer
Default: 10

Maximum number of results to return

offset
integer
Default: 0

Number of results to skip

datasetId
required
string <uuid>

UUID of the dataset to query

orderedResults
boolean
Default: true

Whether to return ordered results

Responses

Request samples

Content type
application/json
{
  • "expression": "",
  • "limit": 100,
  • "offset": 0,
  • "datasetId": null,
  • "orderedResults": true
}

Response samples

Content type
application/json
{
  • "records": [
    ],
  • "schema": {
    },
  • "more": false,
  • "partialCount": false,
  • "total": 10
}

Elasticsearch

Get Elasticsearch Document By Id

Get Document By Id in Elasticsearch

Authorizations:
bearerAuth
path Parameters
index_name
required
string

The name of the index to retrieve information from

doc_id
required
string

The id of the document to retrieve

Responses

Response samples

Content type
application/json
{
  • "error": "Get ElasticSearch by document id failed",
  • "context": {
    }
}

Get Elasticsearch Index

Get index in Elasticsearch

Authorizations:
bearerAuth
path Parameters
index_name
required
string

The name of the index to retrieve information from or '_all' for all indexes

Responses

Response samples

Content type
application/json
{
  • "sanctions": {
    }
}

Get Elasticsearch Index Names

Get Index names in Elasticsearch

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "edl_1": { },
  • "data.edl": { },
  • "electric_vehicle_population": { },
  • "sanctions": { }
}

Get Elasticsearch Pipeline

Get Pipeline in Elasticsearch

Authorizations:
bearerAuth
path Parameters
pipeline_name
required
string

The name of the pipeline

Responses

Response samples

Content type
application/json
{
  • "attachments": {
    }
}

Get Elasticsearch Pipeline Names

Get Pipeline names in Elasticsearch

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "attachments": { }
}

Get Elasticsearch Script

Get Script in Elasticsearch

Authorizations:
bearerAuth
path Parameters
script_name
required
string

The name of the script

Create Elasticsearch Index

Create Index in Elasticsearch

Authorizations:
bearerAuth
Request Body schema: application/json
required
indexName
required
string

Name of the index

required
object (ElasticsearchIndexConfig)

Responses

Request samples

Content type
application/json
{
  • "indexName": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "acknowledged": true,
  • "shards_acknowledged": true,
  • "index": "idx01"
}

Search Elasticsearch Documents

Search documents in Elasticsearch

Authorizations:
bearerAuth
Request Body schema: application/json
required
indexNames
required
Array of strings

Array of index names to search. Keep it empty to search all indexes.

data
required
object
object

Responses

Request samples

Content type
application/json
{
  • "indexNames": [
    ],
  • "data": {
    },
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "took": 0,
  • "timed_out": false,
  • "shared": {
    },
  • "hits": {
    },
  • "total": {
    }
}

Search Elasticsearch Document using template

Search documents in Elasticsearch using template

Authorizations:
bearerAuth
Request Body schema: application/json
required
templateName
required
string

Name of the template

indexNames
required
Array of strings

Array of index names to search. Keep it empty to search all indexes.

data
required
object
object

Responses

Request samples

Content type
application/json
{
  • "templateName": "match_all",
  • "indexNames": [
    ],
  • "data": {
    },
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "took": 0,
  • "timed_out": false,
  • "shared": {
    },
  • "hits": {
    },
  • "total": {
    }
}

Create Elasticsearch Pipeline

Create Pipeline in Elasticsearch

Authorizations:
bearerAuth
Request Body schema: application/json
required
pipelineName
required
string

Name of the pipeline

data
required
object

Responses

Request samples

Content type
application/json
{
  • "pipelineName": "attachments",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "acknowledged": true
}

SQL query search Elasticsearch Documents

SQL query search documents in Elasticsearch

Authorizations:
bearerAuth
Request Body schema: application/json
required
format
string
Default: "json"
Enum: "json" "txt" "csv" "tsv" "yaml" "cbor" "smile"

Response format

required
object
object

Optional parameters for ABAC filtering

Responses

Request samples

Content type
application/json
{
  • "format": "json",
  • "data": {
    },
  • "params": {
    }
}

Response samples

Content type
{
  • "columns": [
    ],
  • "rows": [
    ],
  • "cursor": "spCTBERGTACEkMFOAjEQhjt1EwQ1xAs34xOQENTEK2LQoIagG1EvTd2W3a5Li9sSXC6+golvYnwM30nbBQyrMc5pOvP3/9sP7hBECANy9WmrmncIVQAqQ8ETRrRKjUeYCj7nKlfwDmsIY9vkV8u2y6tsJ84FSlgwhDe5NMJkRNIR1whvaSoDI5QkJhtzhKuUsZRrTQI1kSbNEN5RaUilmNFcxbWh94nQEWeEUcNhV5tUBCY/EDV2IpoQI0bcRkil8fZ3gr1miGA2dWPxiHkmZG8vrx6Ul0JdO4paYYOc7F2F/ML3o5uzx3g26KNar5nU9wdx7Lcn0+Ztp9086LZ64eKfH8c1en3ux93upX9aH0/600582Bo3+gj+MrRMl4xLMLR8wEuUtIYwLHACz/An48ZFXlB64NlUpcytfqIrLP+huO7wOWjO6DexgtUqvNXFM0JfAAAA//8DAA=="
}

Delete Documents in Elasticsearch By Query

Delete Documents in Elasticsearch By Query

Authorizations:
bearerAuth
Request Body schema: application/json
required
indexName
required
string

Name of the index

data
required
object

Elasticsearch query

Responses

Request samples

Content type
application/json
{
  • "indexName": "idx01",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "batches": 1,
  • "deleted": 1,
  • "failures": [ ],
  • "noops": 0,
  • "requests_per_second": -1,
  • "retries": {
    },
  • "throttled_millis": 0,
  • "throttled_until_millis": 0,
  • "timed_out": false,
  • "took": 22,
  • "total": 1,
  • "version_conflicts": 0
}

Perfom percolation on Elasticsearch documents

Perfom percolation on Elasticsearch documents

Authorizations:
bearerAuth
Request Body schema: application/json
required
indexName
required
string

Name of the index

data
required
object

Document ids to be worked on

Responses

Request samples

Content type
application/json
{
  • "indexName": "edl_2",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "acknowledged": true
}

Update Documents in Elasticsearch By Query

Update Documents in Elasticsearch By Query

Authorizations:
bearerAuth
Request Body schema: application/json
required
indexName
required
string

Name of the index

data
required
object

Elasticsearch query

params
object

optional parameters

Responses

Request samples

Content type
application/json
{
  • "indexName": "idx01",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "batches": 1,
  • "failures": [ ],
  • "noops": 0,
  • "deleted": 0,
  • "requests_per_second": -1,
  • "retries": {
    },
  • "timed_out": false,
  • "took": 24,
  • "total": 1,
  • "updated": 1,
  • "version_conflicts": 0,
  • "throttled_millis": 0,
  • "throttled_until_millis": 0
}

Index Elasticsearch Document

Index Document in Elasticsearch

Authorizations:
bearerAuth
Request Body schema: application/json
required
indexName
required
string

Name of the index

pipelineName
string

Optional. Name of the pipeline

docId
string

optional document id to use

data
required
object

Responses

Request samples

Content type
application/json
{
  • "indexName": "string",
  • "pipelineName": "string",
  • "docId": "string",
  • "data": { }
}

Response samples

Content type
application/json
{
  • "index": "idx01",
  • "version": 1,
  • "result": "Updated",
  • "docId": "123"
}

Bulk Index Elasticsearch Document

Bulk Index Document in Elasticsearch

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array
Array (>= 2 items)
One of
required
object
_index
string

index name

_id
string

optional document id. If not provided, a new id will be generated.

pipeline
string

pipeline name

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Create/Update Elasticsearch Script

Create/Update Script in Elasticsearch

Authorizations:
bearerAuth
Request Body schema:
required
scripts
string <json>

JSON string containing script metadata

file
Array of strings <binary> [ items <binary > ]

Script files to be uploaded

Responses

Response samples

Content type
application/json
{
  • "script2": {
    },
  • "script1": {
    }
}

Index File into Elasticsearch

Index File into Elasticsearch

Authorizations:
bearerAuth
Request Body schema:
required
indexName
required
string

Name of the index

pipelineName
string

Optional. Name of the pipeline

docId
string

Optional document id to use

contentType
string

Optional. Content type of the file

file
required
string <binary>

File to be uploaded

Responses

Response samples

Content type
application/json
{
  • "index": "idx01",
  • "version": 1,
  • "result": "Updated",
  • "docId": "Eothb5QBPsB1kmmt_qn8"
}

User Authentication

User Connect

User Connect

Authorizations:
bearerAuth
query Parameters
workspaceId
string

KDP workspace id is required when callback is set to /kdp

callback
required
string
Enum: "/kdp" "/elasticsearch" "/neo4j" "/"

callback path

Responses

User Logout

User logout

Authorizations:
(bearerAuthidTokenAuth)

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Refresh Access Token

Reffresh Keycloak access token using refresh token

Authorizations:
refreshTokenAuth

Responses

Response samples

Content type
application/json
{
  • "access_token": "xxx",
  • "expires_in": 2907,
  • "refresh_expires_in": 2907,
  • "refresh_token": "xxx",
  • "id_token": "xxx",
  • "not-before-policy": 0,
  • "session_state": "xxx",
  • "scope": "openid email profile"
}

Authenticate User

Authenticate a user and retrieve access token

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
{
  • "access_token": "xxx",
  • "expires_in": 60,
  • "refresh_expires_in": 36000,
  • "refresh_token": "xxx",
  • "token_type": "Bearer",
  • "id_token": "xxx",
  • "not-before-policy": 0,
  • "session_state": "b3de8d89-6961-4554-8dd6-1829d935ddfb",
  • "scope": "openid email profile"
}

Keycloak

Query Keycloak user

Query Keycloak user

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "sub": "8a47c064-xxxx-xxxx-xxxx-a396255d5379",
  • "email_verified": true,
  • "name": "edl test",
  • "preferred_username": "edltest01",
  • "given_name": "edl",
  • "family_name": "test",
  • "email": "edltest01@saic.com"
}

WebSocket

WebSocket subscription

Subscription to WebSocket

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

API Log

Search API log

Search API log

Authorizations:
bearerAuth
Request Body schema: application/json
required
size
integer

Number of results to return. Defaults to 10 if not provided.

sort
string
Enum: "asc" "desc"

Sorting order (defaults to 'desc').

usernames
Array of strings

List of usernames to filter logs by.

path
string

Path to search in the API logs (e.g., '/search/apilog').

startDate
string

Start date for filtering logs. Can be in full ISO 8601 format (e.g., "2025-02-18T00:00:00.000000Z") or just a date (e.g., "2025-02-18").

endDate
string

End date for filtering logs. Can be in full ISO 8601 format (e.g., "2025-02-06T00:00:00.000000Z") or just a date (e.g., "2025-02-06").

startTime
integer

Start timestamp in milliseconds for filtering logs.

endTime
integer

End timestamp in milliseconds for filtering logs.

Responses

Request samples

Content type
application/json
{
  • "size": 100,
  • "sort": "asc",
  • "usernames": [
    ],
  • "path": "/search/apilog",
  • "startDate": "2025-02-06",
  • "endDate": "2025-02-10"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

EDL

High level SQL query search

SQL query search documents in KDP and Elasticsearch

Authorizations:
(bearerAuthkoverseAuth)
Request Body schema: application/json
required
required
object
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

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

Neo4j

Query Neo4j

Query databases in Neo4j

Authorizations:
bearerAuth
Request Body schema: application/json
required
databaseNames
required
Array of strings

Array of database names to search. Currently only first database is being used.

required
object

Responses

Request samples

Content type
application/json
{
  • "databaseNames": [
    ],
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "errors": [ ],
  • "lastBookmarks": [
    ]
}