Skip to main content
API docs by Redocly

oracle API definition (1.0.0)

oracle API definition

/v1/esearch-bulk-documents

/v1/esearch-bulk-documents/

Request Body schema: application/json
required
object
type
required
string
Value: "esearch-bulk-documents"
required
object
required
Array of objects [ 1 .. 1000 ] items
Array ([ 1 .. 1000 ] items)
es-document
required
object
es-id
required
string <= 255 characters
spec-name
required
string <= 128 characters
start-index
boolean
Default: true
version-name
string <= 64 characters
meta
object

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/esearch-delete-documents

/v1/esearch-delete-documents/

Request Body schema: application/json
required
object
type
required
string
Value: "esearch-delete-documents"
required
object
required
Array of objects [ 1 .. 1000 ] items
Array ([ 1 .. 1000 ] items)
es-id
required
string <= 255 characters
spec-name
required
string <= 128 characters
version-name
string <= 64 characters
meta
object

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "task-id": "string"
}

/v1/esearch-documents

/v1/esearch-documents/

query Parameters
version-id
required
string <uuid>
filter[es-id]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/esearch-documents/

Request Body schema: application/json
required
object
type
required
string
Value: "esearch-documents"
required
object
es-document
required
object
es-id
required
string <= 255 characters
version-id
required
string <uuid>
meta
object

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/esearch-documents/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/esearch-documents/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/esearch-documents/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "esearch-documents"
required
object
es-document
object
id
required
string <uuid>
meta
object

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/esearch-spec-search/

Request Body schema: application/json
required
object
query
object
property name*
additional property
any
name
required
string <= 128 characters ^[^-/*?"<>|\ ,#:A-Z]+$
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
page[offset]
integer (PageOffset) >= 0

Responses

Request samples

Content type
application/json
{
  • "es-search-body": {
    },
  • "name": "string",
  • "page[limit]": 100,
  • "page[offset]": 0
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/esearch-spec-versions

/v1/esearch-spec-versions/

query Parameters
spec-id
required
string <uuid>
filter[name]
string <= 64 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/esearch-spec-versions/

Request Body schema: application/json
required
object
type
required
string
Value: "esearch-spec-versions"
required
object
spec-id
required
string <uuid>
description
string <= 255 characters
engine-type
string
Default: "elasticsearch"
Enum: "elasticsearch" "opensearch"
es-document-schema
object
es-index-spec
object
meta
object

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/esearch-spec-versions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/esearch-spec-versions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/esearch-spec-versions/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "esearch-spec-versions"
required
object
description
string <= 255 characters
es-document-schema
object
es-index-spec
object
id
required
string <uuid>
meta
object

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/esearch-specs

/v1/esearch-specs/

query Parameters
filter[name]
string <= 128 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/esearch-specs/

Request Body schema: application/json
required
object
type
required
string
Value: "esearch-specs"
required
object
name
required
string <= 128 characters ^[^-/*?"<>|\ ,#:A-Z]+$
meta
object

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/esearch-specs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/esearch-specs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/esearch-specs/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "esearch-specs"
required
object
current-version-id
string <uuid>
name
string <= 128 characters ^[^-/*?"<>|\ ,#:A-Z]+$
id
required
string <uuid>
meta
object

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/rxnorms

/v1/rxnorms/

query Parameters
filter[source-abbreviation]
string <= 255 characters
filter[term-type]
string <= 255 characters
page[limit]
integer [ 1 .. 1000 ]
Default: 20
page[offset]
integer (PageOffset) >= 0
Default: 0
text
string <= 255 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/rxnorms/{id}/

path Parameters
id
required
integer

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers

/v1/sniffers/

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/sniffers/

Request Body schema: application/json
required
object
type
required
string
Value: "sniffers"
required
object
user-id
required
string <uuid>
valid-until
required
string <datetime>
meta
object

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/sniffers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers/{id}/get-logs/

path Parameters
id
required
string

Resource identifier

query Parameters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/tasks

/v1/tasks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}