Skip to main content
API docs by Redocly

pylon API definition (1.0.0)

pylon API definition

/v1/athena-accounts

/v1/athena-accounts/

query Parameters
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
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/athena-accounts/

Request Body schema: application/json
required
object
type
required
string
Value: "athena-accounts"
required
object
client-id
required
string <= 255 characters
client-secret
required
string <= 255 characters
name
required
string <= 255 characters
organization-id
required
string <uuid>
practice-id
required
string <= 255 characters
run-user-id
required
string <uuid>
system-type
string
Default: "prod"
Enum: "prod" "sandbox"
meta
object

Responses

Request samples

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

Response samples

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

/v1/athena-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/athena-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/athena-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "athena-accounts"
required
object
client-id
string <= 255 characters
client-secret
string <= 255 characters
name
string <= 255 characters
organization-id
string <uuid>
practice-id
string <= 255 characters
run-user-id
string <uuid>
system-type
string
Default: "prod"
Enum: "prod" "sandbox"
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/athena-calls

/v1/athena-calls/

Request Body schema: application/json
required
object
type
required
string
Value: "athena-calls"
required
object
account-id
required
string <uuid>
method
required
string
Enum: "delete" "get" "patch" "post"
path
required
string <= 255 characters
json
object
params
object
raw-path
boolean
Default: false
meta
object

Responses

Request samples

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

Response samples

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

/v1/athena-calls/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/cerner-appointments

/v1/cerner-appointments/

query Parameters
credential-id
required
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[cerner-id]
string <= 32 characters
filter[created-at][gt]
string <datetime>
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[last-modified-at][gt]
string <datetime>
filter[patient-cerner-id]
string <= 32 characters
filter[patient-id]
string <uuid>
Example: filter[patient-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

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

/v1/cerner-appointments/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/cerner-calls

/v1/cerner-calls/

Request Body schema: application/json
required
object
type
required
string
Value: "cerner-calls"
required
object
credential-id
required
string <uuid>
method
required
string
Enum: "delete" "get" "patch" "post"
path
required
string <= 64 characters
json
object
params
object
meta
object

Responses

Request samples

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

Response samples

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

/v1/cerner-calls/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/cerner-credentials

/v1/cerner-credentials/

query Parameters
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
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/cerner-credentials/

Request Body schema: application/json
required
object
type
required
string
Value: "cerner-credentials"
required
object
consumer-key
required
string <= 255 characters
consumer-secret
required
string <= 255 characters
name
required
string <= 255 characters
organization-id
required
string <uuid>
run-user-id
required
string <uuid>
tenant-id
required
string <= 255 characters
caredb-appointment-type
string <uuid>
scopes
string <= 9999 characters
Default: "system/Encounter.read system/Observation.read system/Observation.write system/Patient.read"
system-type
string
Default: "prod"
Enum: "prod" "sandbox"
meta
object

Responses

Request samples

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

Response samples

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

/v1/cerner-credentials/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/cerner-credentials/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/cerner-credentials/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "cerner-credentials"
required
object
caredb-appointment-type
string <uuid>
consumer-key
string <= 255 characters
consumer-secret
string <= 255 characters
name
string <= 255 characters
organization-id
string <uuid>
run-user-id
string <uuid>
scopes
string <= 9999 characters
system-type
string
Default: "prod"
Enum: "prod" "sandbox"
tenant-id
string <= 255 characters
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/cerner-document-references

/v1/cerner-document-references/

Request Body schema: application/json
required
object
type
required
string
Value: "cerner-document-references"
required
object
coding-code
required
string <= 32 characters
encounter-id
required
string <= 16 characters
file-content
required
string <= 99999 characters
patient-id
required
string <uuid>
time
required
string <datetime>
title
required
string <= 200 characters
meta
object

Responses

Request samples

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

Response samples

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

/v1/cerner-encounters

/v1/cerner-encounters/

query Parameters
credential-id
required
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[cerner-id]
string <= 32 characters
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[patient-cerner-id]
string <= 32 characters
filter[patient-id]
string <uuid>
Example: filter[patient-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

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

/v1/cerner-encounters/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/cerner-medication-statements

/v1/cerner-medication-statements/

query Parameters
filter[credential-id]
string <uuid>
Example: filter[credential-id]=11111111-1111-1111-1111-111111111111
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[patient-cerner-id]
string <= 32 characters
filter[patient-id]
string <uuid>
Example: filter[patient-id]=11111111-1111-1111-1111-111111111111
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/cerner-medication-statements/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/cerner-observations

/v1/cerner-observations/

Request Body schema: application/json
required
object
type
required
string
Value: "cerner-observations"
required
object
patient-id
required
string <uuid>
time
required
string <datetime>
type
required
string
Enum: "BloodGlucoseFasting" "BloodGlucosePostprandial" "BloodGlucosePreprandial" "BloodGlucoseRandom" "Diastolic" "Pulse" "Systolic" "Weight"
value
required
number
category
string
Default: "vital-signs"
Enum: "laboratory" "vital-signs"
encounter-cid
string <= 16 characters
encounter-id
string <= 16 characters
meta
object

Responses

Request samples

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

Response samples

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

/v1/cerner-patients

/v1/cerner-patients/

query Parameters
credential-id
required
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[birth-date]
string <date>
filter[cerner-id]
string <= 32 characters
filter[email]
string <= 255 characters
filter[first-name]
string <= 255 characters
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[is-registered]
boolean
filter[last-name]
string <= 255 characters
filter[mrn]
string <= 32 characters
filter[phone]
string <= 32 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/cerner-patients/

Request Body schema: application/json
required
object
type
required
string
Value: "cerner-patients"
required
object
credential-id
required
string <uuid>
mrn
required
string <= 32 characters
meta
object

Responses

Request samples

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

Response samples

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

/v1/cerner-patients/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/cerner-patients/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "cerner-patients"
required
object
individual-id
string <uuid>
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/cerner-patients/{id}/sync-objects/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object-type
required
string
Enum: "appointments" "medication-statements"
args
object

Responses

Request samples

Content type
application/json
{
  • "args": { },
  • "object-type": "appointments"
}

Response samples

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

/v1/cerner-patients/{id}/sync/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

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

/v1/cerner-tasks

/v1/cerner-tasks/

query Parameters
credential-id
required
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[method]
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/cerner-tasks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/customjob-events

/v1/customjob-events/

query Parameters
filter[event]
string <= 255 characters
filter[object-name]
string [ 4 .. 255 ] characters ^[a-z][a-z0-9-]+$
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/customjob-events/

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-events"
required
object
event
required
string <= 255 characters
object-name
required
string [ 4 .. 255 ] characters ^[a-z][a-z0-9-]+$
meta
object

Responses

Request samples

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

Response samples

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

/v1/customjob-events/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/customjob-events/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/customjob-executors

/v1/customjob-executors/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 16 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/customjob-executors/

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-executors"
required
object
name
required
string [ 2 .. 16 ] characters ^[a-z][a-zA-Z0-9-_]*[a-z0-9]$

Immutable name of the executor configuration.

organization-id
required
string <uuid>
memory-size
integer >= 0
Default: 128
Enum: 128 256 512

Memory size in MB

string or string or string (ExecutorRuntimeVersion)
One of
string
Value: "$LATEST"

Use the latest version of the executor runtime

meta
object

Responses

Request samples

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

Response samples

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

/v1/customjob-executors/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/customjob-executors/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

Modifies an existing job-executor

Modifies an existing job-executor

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-executors"
required
object
memory-size
integer
Enum: 128 256 512

Memory size in MB

string or string or string (ExecutorRuntimeVersion)
One of
string
Value: "$LATEST"

Use the latest version of the executor runtime

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/customjob-logs

Returns custom-job logs

Returns custom-job logs

query Parameters
spec-id
required
string <uuid>
Example: spec-id=11111111-1111-1111-1111-111111111111
filter[created-after]
string <uuid>
Example: filter[created-after]=11111111-1111-1111-1111-111111111111
filter[status]
string
Enum: "debounced" "dropped-dup" "dropped-filter" "dropped-rate" "failed" "running" "started" "success"
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": { }
}

Returns specific custom-job log

Returns specific custom-job log

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/customjob-logs/{id}/update-result/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
status
required
string <= 16 characters
stderr
required
string <= 249999 characters
stdout
required
string <= 249999 characters
null or object
Any of
null

Responses

Request samples

Content type
application/json
{
  • "return": { },
  • "status": "string",
  • "stderr": "string",
  • "stdout": "string"
}

Response samples

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

/v1/customjob-module-versions

/v1/customjob-module-versions/

query Parameters
filter[name]
string <= 32 characters
module-id
string <uuid>
Example: module-id=11111111-1111-1111-1111-111111111111
module-name
string <= 64 characters
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
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/customjob-module-versions/

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-module-versions"
required
object
code
required
string <= 999999 characters
module-id
required
string <uuid>
name
required
string <= 32 characters ^[0-9][a-z0-9.]*$
description
string <= 255 characters
meta
object

Responses

Request samples

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

Response samples

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

/v1/customjob-module-versions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/customjob-module-versions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/customjob-module-versions/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-module-versions"
required
object
code
string <= 999999 characters
description
string <= 255 characters
name
string <= 32 characters ^[0-9][a-z0-9.]*$
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/customjob-modules

/v1/customjob-modules/

query Parameters
filter[names]
Array of strings non-empty [^[a-z][a-z0-9_]+$]
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[spec-id]
string <uuid>
Example: filter[spec-id]=11111111-1111-1111-1111-111111111111
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/customjob-modules/

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-modules"
required
object
name
required
string [ 5 .. 64 ] characters ^[a-z][a-z0-9_]+$
description
string <= 255 characters
organization-id
string <uuid>
meta
object

Responses

Request samples

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

Response samples

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

/v1/customjob-modules/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/customjob-modules/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/customjob-modules/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-modules"
required
object
default-version-id
string <uuid>
description
string <= 255 characters
name
string [ 5 .. 64 ] characters ^[a-z][a-z0-9_]+$
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/customjob-pip-requirements

/v1/customjob-pip-requirements/

query Parameters
filter[names]
Array of strings non-empty [[0-9a-zA-Z]{5,32}]
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[spec-id]
string <uuid>
Example: filter[spec-id]=11111111-1111-1111-1111-111111111111
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/customjob-pip-requirements/

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-pip-requirements"
required
object
code
required
string <= 999999 characters
name
required
string [ 5 .. 64 ] characters [0-9a-zA-Z]{5,32}
description
string <= 255 characters
organization-id
string <uuid>
meta
object

Responses

Request samples

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

Response samples

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

/v1/customjob-pip-requirements/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/customjob-pip-requirements/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/customjob-pip-requirements/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-pip-requirements"
required
object
code
string <= 999999 characters
description
string <= 255 characters
name
string [ 5 .. 64 ] characters [0-9a-zA-Z]{5,32}
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/customjob-queue-entries

/v1/customjob-queue-entries/

query Parameters
queue-id
required
string <uuid>
Example: queue-id=11111111-1111-1111-1111-111111111111
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/customjob-queue-entries/

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-queue-entries"
required
object
data
required
object
queue-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/customjob-queue-entries/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/customjob-queues

Returns job-queues

Returns job-queues

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
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": { }
}

Creates a new job-queue

Creates a new job-queue

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-queues"
required
object
name
required
string <= 64 characters
organization-id
required
string <uuid>
spec-id
string <uuid>
worker-count
integer
Default: 1
meta
object

Responses

Request samples

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

Response samples

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

Deletes an existing job-queue

Deletes an existing job-queue

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific job-queue

Returns specific job-queue

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

Modifies an existing job-queue

Modifies an existing job-queue

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-queues"
required
object
name
string <= 64 characters
spec-id
string <uuid>
worker-count
integer
Default: 1
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/customjob-repositories

/v1/customjob-repositories/

query Parameters
filter[name]
string <= 255 characters
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
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/customjob-repositories/

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-repositories"
required
object
name
required
string <= 255 characters ^[a-z0-9_-]+$
url
required
string <= 255 characters
organization-id
string <uuid>
private-key
string <= 9999 characters
Default: ""
meta
object

Responses

Request samples

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

Response samples

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

/v1/customjob-repositories/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/customjob-repositories/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/customjob-repositories/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-repositories"
required
object
private-key
string <= 9999 characters
Default: ""
url
string <= 255 characters
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/customjob-secrets

Returns multiple job-secret

Returns multiple job-secret

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

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

Create a new secret

Create a new secret

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-secrets"
required
object
name
required
string <= 32 characters [a-zA-Z][A-Za-z0-9_]*
organization-id
required
string <uuid>
secret-json
required
object
type
required
string
Value: "json"
meta
object

Responses

Request samples

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

Response samples

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

Delete a job-secret

Delete a job-secret

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Get a specific job-secret with secret contents

Get a specific job-secret with secret contents

path Parameters
id
required
string

Resource identifier

query Parameters
include-secret
boolean
Default: false

Include secret contents

Responses

Response samples

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

Change a secret

Change a secret

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-secrets"
required
object
secret-json
required
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/customjob-settings

Returns job settings

Returns job settings

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
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": { }
}

Creates a new job-spec setting

Creates a new job-spec setting

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-settings"
required
object
name
required
string <= 64 characters
organization-id
required
string <uuid>
value
required
object
meta
object

Responses

Request samples

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

Response samples

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

Deletes an existing job-spec setting

Deletes an existing job-spec setting

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific job setting

Returns specific job setting

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

Modifies an existing job-spec setting

Modifies an existing job-spec setting

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-settings"
required
object
value
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/customjob-spec-events

Creates a new job-spec-event Deprecated

Creates a new job-spec-event

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-spec-events"
required
object
data
required
object
organization-id
required
string <uuid>
debounced-seconds
integer [ 1 .. 600 ]
event
string <= 255 characters
name
string <= 255 characters
object
string <= 255 characters
meta
object

Responses

Request samples

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

Response samples

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

/v1/customjob-spec-modules

/v1/customjob-spec-modules/

query Parameters
filter[module-id]
string <uuid>
Example: filter[module-id]=11111111-1111-1111-1111-111111111111
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[spec-id]
string <uuid>
Example: filter[spec-id]=11111111-1111-1111-1111-111111111111
include-code
boolean
Default: false
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/customjob-spec-modules/

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-spec-modules"
required
object
module-id
required
string <uuid>
spec-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/customjob-spec-modules/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/customjob-spec-modules/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/customjob-spec-pip-requirements

/v1/customjob-spec-pip-requirements/

query Parameters
filter[pip-requirement-id]
string <uuid>
Example: filter[pip-requirement-id]=11111111-1111-1111-1111-111111111111
filter[spec-id]
string <uuid>
Example: filter[spec-id]=11111111-1111-1111-1111-111111111111
include-code
boolean
Default: false
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/customjob-spec-pip-requirements/

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-spec-pip-requirements"
required
object
pip-requirement-id
required
string <uuid>
spec-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/customjob-spec-pip-requirements/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/customjob-spec-pip-requirements/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/customjob-spec-vcses

/v1/customjob-spec-vcses/

query Parameters
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[repository-id]
string <uuid>
Example: filter[repository-id]=11111111-1111-1111-1111-111111111111
filter[spec-id]
string <uuid>
Example: filter[spec-id]=11111111-1111-1111-1111-111111111111
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/customjob-spec-vcses/

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-spec-vcses"
required
object
path
required
string <= 255 characters
repository-id
required
string <uuid>
spec-id
required
string <uuid>
branch
string <= 255 characters
Default: "master"
meta
object

Responses

Request samples

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

Response samples

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

/v1/customjob-spec-vcses/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/customjob-spec-vcses/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/customjob-spec-vcses/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-spec-vcses"
required
object
branch
string <= 255 characters
path
string <= 255 characters
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/customjob-spec-vcses/{id}/sync/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

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

/v1/customjob-spec-vcses/{id}/update-status/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

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

/v1/customjob-specs

Returns custom-job specs

Returns custom-job specs

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[event]
string <= 255 characters
filter[executor-id]
string <uuid>
Example: filter[executor-id]=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
filter[object]
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": { }
}

Creates a new job-spec

Creates a new job-spec

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-specs"
required
object
class-name
required
string <= 255 characters
code
required
string <= 999999 characters
event
required
string <= 255 characters
object
required
string <= 255 characters
organization-id
required
string <uuid>
allow-continuation
boolean
Default: false
allow-participant
boolean
Default: false
allow-provider
boolean
args
object
args-schema
object
consecutive-threshold
integer [ 0 .. 9999 ]
Default: 30
Array of objects (JobSpecCredentialSpec) <= 1 items
Array (<= 1 items)
key
string [ 1 .. 32 ] characters [a-zA-Z][A-Za-z0-9_]*
type
string
Value: "sftp-write"
executor-id
string <uuid>
filter-args
object
log-level
string
Default: "warning"
Enum: "critical" "debug" "error" "info" "warning"
log-limit
integer
Default: 1000
monitored
boolean
Default: false
name
string <= 255 characters ^[a-z][a-z0-9-_:-]+$
run-as
string <uuid>
runs-per-minute
integer
Default: 60
schedule-rrule
string <rrule>
schedule-start
string <datetime>
schedule-timezone
string <timezone>
ui-args-schema
object
meta
object

Responses

Request samples

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

Response samples

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

Deletes an existing job-spec

Deletes an existing job-spec

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific job-spec

Returns specific job-spec

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

Modifies an existing job-spec

Modifies an existing job-spec

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-specs"
required
object
allow-continuation
boolean
allow-participant
boolean
allow-provider
boolean
args
object
args-schema
object
class-name
string <= 255 characters
code
string <= 999999 characters
consecutive-threshold
integer [ 0 .. 9999 ]
Array of objects (JobSpecCredentialSpec) <= 1 items
Array (<= 1 items)
key
string [ 1 .. 32 ] characters [a-zA-Z][A-Za-z0-9_]*
type
string
Value: "sftp-write"
event
string <= 255 characters
executor-id
string <uuid>
filter-args
object
log-level
string
Enum: "critical" "debug" "error" "info" "warning"
log-limit
integer
Default: 1000
monitored
boolean
name
string <= 255 characters ^[a-z][a-z0-9-_:-]+$
object
string <= 255 characters
run-as
string <uuid>
runs-per-minute
integer
Default: 60
schedule-rrule
string <rrule>
schedule-start
string <datetime>
string or null
Any of
string <timezone>
ui-args-schema
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": { }
}

Bind a secret

Bind a secret

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
key
required
string [ 1 .. 32 ] characters ^[a-z][a-z0-9-_:-]+$
secret-id
string <uuid>
secret-name
string [ 1 .. 32 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "secret-id": "11111111-1111-1111-1111-111111111111",
  • "secret-name": "string"
}

Response samples

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

/v1/customjob-specs/{id}/get-logs/ Deprecated

path Parameters
id
required
string

Resource identifier

query Parameters
created-after
string <uuid>
Example: created-after=11111111-1111-1111-1111-111111111111
id
string <uuid>
Example: id=11111111-1111-1111-1111-111111111111

Responses

Response samples

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

/v1/customjob-specs/{id}/inject-event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
data
required
object
debounced-seconds
integer [ 1 .. 600 ]

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "debounced-seconds": 1
}

Response samples

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

Unbind a secret

Unbind a secret

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
key
required
string [ 1 .. 32 ] characters ^[a-z][a-z0-9-_:-]+$

Responses

Request samples

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

Response samples

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

/v1/customjob-storages

Returns job-spec storages

Returns job-spec storages

query Parameters
spec-id
required
string <uuid>
Example: spec-id=11111111-1111-1111-1111-111111111111
filter[index]
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": { }
}

Creates a new job-spec storage

Creates a new job-spec storage

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-storages"
required
object
index
required
string <= 255 characters
spec-id
required
string <uuid>
value
required
object
meta
object

Responses

Request samples

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

Response samples

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

Deletes an existing job-spec storage

Deletes an existing job-spec storage

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific job-spec storage

Returns specific job-spec storage

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

Modifies an existing job-spec storage

Modifies an existing job-spec storage

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-storages"
required
object
index
string <= 255 characters
value
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/elation-appointments

/v1/elation-appointments/

query Parameters
credential-id
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[created-at][gt]
string <datetime>
filter[elation-id]
integer
filter[last-modified-at][gt]
string <datetime>
filter[patient-elation-id]
integer
organization-id
string <uuid>
Deprecated
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

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

/v1/elation-appointments/

Request Body schema: application/json
required
object
type
required
string
Value: "elation-appointments"
required
object
patient-id
required
string <uuid>
reason
required
string <= 50 characters
scheduled-time
required
string <datetime>
duration
integer <= 1440
Default: 15

Appointment duration in minutes

physician-id
string <uuid>
practice-id
string <uuid>
meta
object

Responses

Request samples

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

Response samples

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

/v1/elation-appointments/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-calls

/v1/elation-calls/

Request Body schema: application/json
required
object
type
required
string
Value: "elation-calls"
required
object
credential-id
required
string <uuid>
method
required
string
Enum: "delete" "get" "patch" "post"
path
required
string <= 64 characters
json
object
params
object
meta
object

Responses

Request samples

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

Response samples

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

/v1/elation-calls/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-credentials

/v1/elation-credentials/

query Parameters
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
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/elation-credentials/

Request Body schema: application/json
required
object
type
required
string
Value: "elation-credentials"
required
object
client-id
required
string <= 255 characters
client-secret
required
string <= 255 characters
organization-id
required
string <uuid>
password
required
string <= 255 characters
username
required
string <= 255 characters
base-url
string <= 255 characters
elation-patient-url
string <= 255 characters
Default: "https://{host}/participants/?id={individual_id}"
notifications
object
patient-external-url
string <= 255 characters
run-user-id
string <uuid>
meta
object

Responses

Request samples

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

Response samples

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

/v1/elation-credentials/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/elation-credentials/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-credentials/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "elation-credentials"
required
object
base-url
string <= 255 characters
client-id
string <= 255 characters
client-secret
string <= 255 characters
elation-patient-url
string <= 255 characters
notifications
object
password
string <= 255 characters
patient-external-url
string <= 255 characters
run-user-id
string <uuid>
username
string <= 255 characters
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/elation-credentials/{id}/setup-subscriptions/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

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

/v1/elation-credentials/{id}/sync-all-objects/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
class
required
string
Enum: "appointments" "imaging_orders" "lab_orders" "lab_vendors" "letters" "medications" "message_threads" "non_visit_notes" "patients" "physicians" "problems" "referral_orders" "reports" "visit_notes"

Responses

Request samples

Content type
application/json
{
  • "class": "appointments"
}

Response samples

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

/v1/elation-credentials/{id}/sync-object/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
class
required
string
Enum: "appointments" "imaging_orders" "lab_orders" "lab_vendors" "letters" "medications" "message_threads" "non_visit_notes" "patients" "physicians" "problems" "referral_orders" "reports" "visit_notes"
elation-id
required
integer

Responses

Request samples

Content type
application/json
{
  • "class": "appointments",
  • "elation-id": 0
}

Response samples

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

/v1/elation-handouts

/v1/elation-handouts/

query Parameters
credential-id
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[created-at][gt]
string <datetime>
filter[elation-id]
integer
filter[last-modified-at][gt]
string <datetime>
filter[object-class]
string
Enum: "VisitNote" "VisitNoteBullet"
filter[object-id]
string <uuid>
Example: filter[object-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

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

/v1/elation-handouts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-hooks

Elation web-hooks

Elation web-hooks

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{ }

/v1/elation-imaging-orders

/v1/elation-imaging-orders/

query Parameters
credential-id
required
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[created-at][gt]
string <datetime>
filter[elation-id]
integer
filter[last-modified-at][gt]
string <datetime>
filter[patient-elation-id]
integer
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

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

/v1/elation-imaging-orders/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-lab-orders

/v1/elation-lab-orders/

query Parameters
credential-id
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[created-at][gt]
string <datetime>
filter[elation-id]
integer
filter[last-modified-at][gt]
string <datetime>
filter[patient-elation-id]
integer
organization-id
string <uuid>
Deprecated
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

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

/v1/elation-lab-orders/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-letters

/v1/elation-letters/

query Parameters
credential-id
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[created-at][gt]
string <datetime>
filter[elation-id]
integer
filter[last-modified-at][gt]
string <datetime>
filter[patient-elation-id]
integer
organization-id
string <uuid>
Deprecated
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

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

/v1/elation-letters/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-medications

/v1/elation-medications/

query Parameters
credential-id
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[created-at][gt]
string <datetime>
filter[elation-id]
integer
filter[last-modified-at][gt]
string <datetime>
filter[patient-elation-id]
integer
organization-id
string <uuid>
Deprecated
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

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

/v1/elation-medications/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-message-threads

/v1/elation-message-threads/

query Parameters
credential-id
required
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[created-at][gt]
string <datetime>
filter[elation-id]
integer
filter[last-modified-at][gt]
string <datetime>
filter[patient-elation-id]
integer
include[archived-messages]
boolean
Default: false
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

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

/v1/elation-message-threads/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-non-visit-notes

/v1/elation-non-visit-notes/

query Parameters
credential-id
required
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[created-at][gt]
string <datetime>
filter[elation-id]
integer
filter[last-modified-at][gt]
string <datetime>
filter[patient-elation-id]
integer
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

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

/v1/elation-non-visit-notes/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-patients

/v1/elation-patients/

query Parameters
credential-id
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[birth-date]
string <date>
filter[elation-id]
integer
filter[email]
string <= 255 characters
filter[first-name]
string <= 255 characters
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[is-registered]
boolean
filter[last-name]
string <= 255 characters
filter[phone]
string <= 32 characters
filter[tags]
Array of strings non-empty [ items <= 255 characters ]
organization-id
string <uuid>
Deprecated
Example: organization-id=11111111-1111-1111-1111-111111111111
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/elation-patients/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-patients/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "elation-patients"
required
object
null or string
Any of
null
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/elation-patients/{id}/add-notes/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
template
required
string
Value: "Simple"
type
required
string <= 255 characters
document-time
string <datetime>
followup
string <= 9999 characters
narrative
string <= 99999 characters
physician-id
integer
reason
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "document-time": "string",
  • "followup": "string",
  • "narrative": "string",
  • "physician-id": 0,
  • "reason": "string",
  • "template": "Simple",
  • "type": "string"
}

Response samples

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

/v1/elation-patients/{id}/add-tags/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
tags
required
Array of strings non-empty [ items <= 100 characters ]

Responses

Request samples

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

Response samples

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

/v1/elation-patients/{id}/remove-tags/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
tags
required
Array of strings non-empty [ items <= 100 characters ]

Responses

Request samples

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

Response samples

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

/v1/elation-patients/{id}/sync/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

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

/v1/elation-physicians

/v1/elation-physicians/

query Parameters
credential-id
string <uuid>
Deprecated
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[elation-id]
integer
filter[email]
string <= 255 characters
filter[first-name]
string <= 255 characters
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[last-name]
string <= 255 characters
organization-id
string <uuid>
Deprecated
Example: organization-id=11111111-1111-1111-1111-111111111111
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/elation-physicians/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-referrals

/v1/elation-referrals/

query Parameters
credential-id
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[created-at][gt]
string <datetime>
filter[elation-id]
integer
filter[last-modified-at][gt]
string <datetime>
filter[patient-elation-id]
integer
organization-id
string <uuid>
Deprecated
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

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

/v1/elation-referrals/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-report-attachments

/v1/elation-report-attachments/

query Parameters
report-id
required
string <uuid>
Example: report-id=11111111-1111-1111-1111-111111111111
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/elation-report-attachments/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-report-attachments/{id}/get-download-url/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "expiration-time": 0,
  • "url": "string"
}

/v1/elation-report-uploads

/v1/elation-report-uploads/

Request Body schema: application/json
required
object
type
required
string
Value: "elation-report-uploads"
required
object
content-type
required
string <= 127 characters
filename
required
string <= 255 characters
patient-id
required
string <uuid>
title
required
string <= 255 characters
chart-time
string <datetime>
document-time
string <datetime>
physician-id
integer
report-type
string <= 255 characters
Default: "Misc"
meta
object

Responses

Request samples

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

Response samples

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

/v1/elation-report-uploads/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-report-uploads/{id}/process-upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

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

/v1/elation-reports

/v1/elation-reports/

query Parameters
credential-id
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[created-at][gt]
string <datetime>
filter[elation-id]
integer
filter[last-modified-at][gt]
string <datetime>
filter[patient-elation-id]
integer
filter[status]
string
Enum: "" "AMENDED" "CORRECTED" "DELETED" "ERROR" "FINAL" "PARTIAL" "PENDING" "PRELIMINARY" "RESULT CANCELED DUE TO NON-PERFORMANCE" "RESULTS DID NOT CHANGE" "RESULTS ENTERED -- NOT VERIFIED" "RESULTS STATUS CHANGE TO FINAL"
organization-id
string <uuid>
Deprecated
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

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

/v1/elation-reports/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-reports/{id}/sync/ Deprecated

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

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

/v1/elation-tasks

/v1/elation-tasks/

query Parameters
credential-id
required
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[method]
string <= 64 characters
filter[patient-id]
string <uuid>
Example: filter[patient-id]=11111111-1111-1111-1111-111111111111
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/elation-tasks/

Request Body schema: application/json
required
object
type
required
string
Value: "elation-tasks"
required
object
credential-id
required
string <uuid>
kwargs
required
object
method
required
string
Value: "query"
meta
object

Responses

Request samples

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

Response samples

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

/v1/elation-tasks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-visit-note-bullets

/v1/elation-visit-note-bullets/

query Parameters
visit-note-id
required
string <uuid>
Example: visit-note-id=11111111-1111-1111-1111-111111111111
filter[created-at][gt]
string <datetime>
filter[last-modified-at][gt]
string <datetime>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

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

/v1/elation-visit-note-bullets/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-visit-notes

/v1/elation-visit-notes/

query Parameters
credential-id
required
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[created-at][gt]
string <datetime>
filter[elation-id]
integer
filter[last-modified-at][gt]
string <datetime>
filter[patient-elation-id]
integer
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

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

/v1/elation-visit-notes/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-whitelists

/v1/elation-whitelists/

query Parameters
credential-id
string <uuid>
Example: credential-id=11111111-1111-1111-1111-111111111111
filter[resource]
string
Enum: "appointments" "medications" "reports"
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/elation-whitelists/

Request Body schema: application/json
required
object
type
required
string
Value: "elation-whitelists"
required
object
args
required
object
credential-id
required
string <uuid>
resource
required
string
Enum: "appointments" "medications" "reports"
meta
object

Responses

Request samples

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

Response samples

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

/v1/elation-whitelists/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/elation-whitelists/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/elation-whitelists/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "elation-whitelists"
required
object
args
required
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/epic-accounts

/v1/epic-accounts/

query Parameters
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
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/epic-accounts/

Request Body schema: application/json
required
object
type
required
string
Value: "epic-accounts"
required
object
base-url
required
string <= 255 characters
client-id
required
string <= 255 characters
name
required
string <= 255 characters
organization-id
required
string <uuid>
private-key
required
string <= 9999 characters
run-user-id
required
string <uuid>
token-url
required
string <= 255 characters
caredb-appointment-type
string <uuid>
fhir-id-type
string <= 255 characters
hl7-msh-sender
string <= 255 characters
hl7-msh-sender-facility
string <= 255 characters
hl7-pid-authority
string <= 255 characters
hl7-sqs-url
string <= 255 characters
system-type
string
Default: "prod"
Enum: "prod" "sandbox"
meta
object

Responses

Request samples

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

Response samples

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

/v1/epic-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/epic-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/epic-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "epic-accounts"
required
object
base-url
string <= 255 characters
caredb-appointment-type
string <uuid>
client-id
string <= 255 characters
fhir-id-type
string <= 255 characters
hl7-msh-sender
string <= 255 characters
hl7-msh-sender-facility
string <= 255 characters
hl7-pid-authority
string <= 255 characters
hl7-sqs-url
string <= 255 characters
name
string <= 255 characters
organization-id
string <uuid>
private-key
string <= 9999 characters
run-user-id
string <uuid>
system-type
string
Default: "prod"
Enum: "prod" "sandbox"
token-url
string <= 255 characters
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/epic-calls

/v1/epic-calls/

Request Body schema: application/json
required
object
type
required
string
Value: "epic-calls"
required
object
account-id
required
string <uuid>
method
required
string
Enum: "delete" "get" "patch" "post"
path
required
string <= 255 characters
json
object
params
object
meta
object

Responses

Request samples

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

Response samples

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

/v1/epic-calls/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/epic-document-references

/v1/epic-document-references/

Request Body schema: application/json
required
object
type
required
string
Value: "epic-document-references"
required
object
content
required
string <= 99999 characters
encounter-epic-id
required
string <= 64 characters
patient-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/epic-encounters

/v1/epic-encounters/

query Parameters
account-id
required
string <uuid>
Example: account-id=11111111-1111-1111-1111-111111111111
filter[epic-id]
string <= 255 characters
filter[patient-id]
string <uuid>
Example: filter[patient-id]=11111111-1111-1111-1111-111111111111
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/epic-encounters/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/epic-hl7-calls

/v1/epic-hl7-calls/

Request Body schema: application/json
required
object
type
required
string
Value: "epic-hl7-calls"
required
object
account-id
required
string <uuid>
lines
required
Array of strings non-empty [ items <= 999999 characters ]
meta
object

Responses

Request samples

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

Response samples

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

/v1/epic-mdms

/v1/epic-mdms/

Request Body schema: application/json
required
object
type
required
string
Value: "epic-mdms"
required
object
required
object
identifier
required
string <= 80 characters
value
required
string <= 999999 characters
patient-id
required
string <uuid>
time
required
string <datetime>
required
object
document-id
required
string <= 200 characters
document-type
required
string <= 200 characters
availability-status
string <= 200 characters
completion-status
string <= 200 characters
provider
string <= 200 characters
object
comment
required
string <= 255 characters
object
provider
required
string <= 200 characters
service-id
required
string <= 200 characters
object
location
string <= 128 characters
practitioner-id
string <uuid>
provider
string <= 128 characters
visit-id
string <= 128 characters
meta
object

Responses

Request samples

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

Response samples

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

/v1/epic-medication-statements

/v1/epic-medication-statements/

query Parameters
filter[account-id]
string <uuid>
Example: filter[account-id]=11111111-1111-1111-1111-111111111111
filter[patient-id]
string <uuid>
Example: filter[patient-id]=11111111-1111-1111-1111-111111111111
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/epic-medication-statements/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/epic-orus

/v1/epic-orus/

Request Body schema: application/json
required
object
type
required
string
Value: "epic-orus"
required
object
required
Array of objects non-empty
Array (non-empty)
identifier
required
string <= 80 characters
unit
required
string <= 128 characters
value
required
string <= 999 characters
time
string <datetime>
value-type
string <= 10 characters
Default: "ST"
patient-id
required
string <uuid>
time
required
string <datetime>
object
filler-id
required
string <= 200 characters
provider
required
string <= 200 characters
service-id
required
string <= 200 characters
object
location
string <= 128 characters
practitioner-id
string <uuid>
provider
string <= 128 characters
visit-id
string <= 128 characters
meta
object

Responses

Request samples

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

Response samples

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

/v1/epic-patients

/v1/epic-patients/

query Parameters
account-id
required
string <uuid>
Example: account-id=11111111-1111-1111-1111-111111111111
filter[birth-date]
string <date>
filter[email]
string <= 255 characters
filter[epic-id]
string <= 255 characters
filter[family-name]
string <= 255 characters
filter[given-name]
string <= 255 characters
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[is-registered]
boolean
filter[mrn]
string <= 32 characters
filter[phone]
string <= 32 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/epic-patients/

Request Body schema: application/json
required
object
type
required
string
Value: "epic-patients"
required
object
account-id
required
string <uuid>
identifier
required
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/epic-patients/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/epic-patients/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "epic-patients"
required
object
individual-id
string <uuid>
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/epic-patients/{id}/sync-objects/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object-type
required
string
Enum: "appointments" "medication-statements"
args
object

Responses

Request samples

Content type
application/json
{
  • "args": { },
  • "object-type": "appointments"
}

Response samples

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

/v1/epic-patients/{id}/sync/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

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

/v1/epic-practitioners

/v1/epic-practitioners/

query Parameters
account-id
required
string <uuid>
Example: account-id=11111111-1111-1111-1111-111111111111
filter[npi]
string <= 32 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/epic-practitioners/

Request Body schema: application/json
required
object
type
required
string
Value: "epic-practitioners"
required
object
account-id
required
string <uuid>
identifier
required
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/epic-practitioners/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/epic-tasks

/v1/epic-tasks/

query Parameters
account-id
required
string <uuid>
Example: account-id=11111111-1111-1111-1111-111111111111
filter[method]
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/epic-tasks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/mdm-sources

/v1/mdm-sources/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]
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/mdm-sources/

Request Body schema: application/json
required
object
type
required
string
Value: "mdm-sources"
required
object
name
required
string <= 255 characters
organization-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/mdm-sources/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/micromd-instances

/v1/micromd-instances/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[account-id]
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/micromd-instances/

Request Body schema: application/json
required
object
type
required
string
Value: "micromd-instances"
required
object
account-id
required
string <= 64 characters
account-key
required
string <= 64 characters
endpoint-url
required
string <= 255 characters
organization-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/micromd-instances/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/micromd-instances/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/micromd-instances/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "micromd-instances"
required
object
account-id
string <= 64 characters
account-key
string <= 64 characters
endpoint-url
string <= 255 characters
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/micromd-instances/{id}/sync-individual/

path Parameters
id
required
string

Resource identifier

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

Responses

Request samples

Content type
application/json
{
  • "individual-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

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

/v1/micromd-patient-file-uploads

/v1/micromd-patient-file-uploads/

Request Body schema: application/json
required
object
type
required
string
Value: "micromd-patient-file-uploads"
required
object
content-type
required
string <= 127 characters
filename
required
string <= 255 characters
folder-id
required
string <= 10 characters
patient-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/micromd-patient-file-uploads/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/micromd-patient-file-uploads/{id}/process-upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

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

/v1/micromd-patients

/v1/micromd-patients/

query Parameters
instance-id
required
string <uuid>
Example: instance-id=11111111-1111-1111-1111-111111111111
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[internal-id]
string <= 64 characters
filter[mrn]
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/micromd-patients/

Request Body schema: application/json
required
object
type
required
string
Value: "micromd-patients"
required
object
individual-id
required
string <uuid>
instance-id
required
string <uuid>
internal-id
required
string <= 64 characters
mrn
required
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/micromd-patients/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/micromd-patients/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/micromd-patients/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "micromd-patients"
required
object
internal-id
string <= 64 characters
mrn
string <= 64 characters
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/micromd-tasks

/v1/micromd-tasks/

query Parameters
instance-id
required
string <uuid>
Example: instance-id=11111111-1111-1111-1111-111111111111
filter[method]
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/micromd-tasks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/pdf-creators

/v1/pdf-creators/

Request Body schema: application/json
required
object
type
required
string
Value: "pdf-creators"
required
object
html
required
string <= 999999 characters
organization-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/pdf-creators/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/pdf-creators/{id}/get-download-url/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "expiration-time": 0,
  • "url": "string"
}

/v1/purge-data

/v1/purge-data/

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/purge-data/

Request Body schema: application/json
required
object
type
required
string
Value: "system-purges"
required
object
entity-id
required
string <= 255 characters
entity-type
required
string
Enum: "individual" "organization" "user"
reference-id
required
string <= 255 characters
request-id
required
string <= 255 characters
archive
boolean
Default: false
property name*
additional property
any
meta
object

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
null

/v1/redox-data

/v1/redox-data/

Request Body schema: application/json
challenge
string <= 9999 characters
verification-token
string <= 9999 characters
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "challenge": "string",
  • "verification-token": "string"
}

Response samples

Content type
application/vnd.api+json
"string"

/v1/replicators

/v1/replicators/

query Parameters
filter[classpath]
string <= 255 characters

Responses

Response samples

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

/v1/replicators/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/s3-event-files

/v1/s3-event-files/

query Parameters
map-id
required
string <uuid>
Example: map-id=11111111-1111-1111-1111-111111111111
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/s3-event-files/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/s3-event-files/{id}/get-download-url/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "expiration-time": 0,
  • "url": "string"
}

/v1/s3-event-files/{id}/trigger-event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

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

/v1/s3-event-maps

/v1/s3-event-maps/

query Parameters
filter[bucket-name]
string <= 255 characters
filter[event]
string <= 255 characters
filter[key-prefix]
string <= 255 characters
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
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/s3-event-maps/

Request Body schema: application/json
required
object
type
required
string
Value: "s3-event-maps"
required
object
bucket-name
required
string <= 255 characters
key-prefix
required
string <= 255 characters
organization-id
required
string <uuid>
event
string <= 255 characters
Default: "ObjectCreated"
meta
object

Responses

Request samples

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

Response samples

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

/v1/s3-event-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/s3-event-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/s3-event-maps/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "s3-event-maps"
required
object
bucket-name
string <= 255 characters
event
string <= 255 characters
Default: "ObjectCreated"
key-prefix
string <= 255 characters
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/sftp-files

/v1/sftp-files/

Request Body schema: application/json
required
object
type
required
string
Value: "sftp-files"
required
object
content-type
required
string <= 255 characters
organization-id
required
string <uuid>
path
required
string <= 128 characters ^(/[a-zA-Z0-9_\-][a-zA-Z0-9_\-. ]*)+$
meta
object

Responses

Request samples

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

Response samples

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

/v1/sftp-remote-clis

/v1/sftp-remote-clis/

query Parameters
remote-id
required
string <uuid>
Example: remote-id=11111111-1111-1111-1111-111111111111
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/sftp-remote-clis/

Request Body schema: application/json
required
object
type
required
string
Value: "sftp-remote-clis"
required
object
command
required
string
Value: "ls"
remote-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/sftp-remote-clis/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/sftp-remote-puts

/v1/sftp-remote-puts/

query Parameters
remote-id
required
string <uuid>
Example: remote-id=11111111-1111-1111-1111-111111111111
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/sftp-remote-puts/

Request Body schema: application/json
required
object
type
required
string
Value: "sftp-remote-puts"
required
object
remote-filepath
required
string <= 255 characters
remote-id
required
string <uuid>
source-content-type
required
string <= 255 characters
source-filename
required
string <= 255 characters
meta
object

Responses

Request samples

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

Response samples

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

/v1/sftp-remote-puts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/sftp-remote-puts/{id}/get-upload-info/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/sftp-remote-puts/{id}/process-upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

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

/v1/sftp-remotes

/v1/sftp-remotes/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]
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/sftp-remotes/

Request Body schema: application/json
required
object
type
required
string
Value: "sftp-remotes"
required
object
host
required
string <= 255 characters
name
required
string <= 255 characters ^[a-z][a-z0-9-_:-\\.]+$
organization-id
required
string <uuid>
username
required
string <= 255 characters
port
integer
Default: 22
meta
object

Responses

Request samples

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

Response samples

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

/v1/sftp-remotes/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/sftp-remotes/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/sftp-users

List SFTP Users

List SFTP Users

query Parameters
filter[username]
string <= 32 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": { }
}

Create a new SFTP User

Create a new SFTP User

Request Body schema: application/json
required
object
type
required
string
Value: "sftp-users"
required
object
organization-id
required
string <uuid>

Organization for which the SFTP user is being created and owned

username
required
string [ 3 .. 64 ] characters ^[a-z][a-z\d-]+$

SFTP username. Must be lowercase alphanumeric and dashes

meta
object

Responses

Request samples

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

Response samples

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

Deletes an existing job-spec

Deletes an existing job-spec

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Retrieve details for single SFTP User

Retrieve details for single SFTP User

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

Add an SSH access key to a user. There can be at m

Add an SSH access key to a user. There can be at most 10 added to each user

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
public-key
required
string <= 9999 characters

Public key body to add in either the OpenSSH or RFC4716 formats

Responses

Request samples

Content type
application/json
{
  • "public-key": "string"
}

Response samples

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

Remove an SSH key from a user

Remove an SSH key from a user

path Parameters
id
required
string

Resource identifier

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

ID of key to remove

Responses

Request samples

Content type
application/json
{
  • "key-id": "11111111-1111-1111-1111-111111111111"
}

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": { }
}

/v2/customjob-spec-events

Creates a new job-spec-event

Creates a new job-spec-event

Request Body schema: application/json
required
object
type
required
string
Value: "customjob-spec-events"
required
object
data
required
object
organization-id
required
string <uuid>
debounced-seconds
integer [ 1 .. 600 ]
event
string <= 255 characters
name
string <= 255 characters
object
string <= 255 characters
meta
object

Responses

Request samples

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

Response samples

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