API docs by Redocly

Data Pipeline service API docs (1.3.0)

Download OpenAPI specification:

REST API for BAO Data Pipeline service

Kobo Toolbox data pipelines

Get surveys for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
url
required
string
username
required
string
password
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get surveys for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
url
required
string
username
required
string
password
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "survey": "string",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (AuthTokenApiSource)
survey
required
string
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "survey": "string",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (AuthTokenApiSource)
survey
required
string
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "survey": "string",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Test connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
url
required
string
authToken
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "authToken": "string"
}

Get surveys for payload

Request Body schema: application/json
required
url
required
string
authToken
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "authToken": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create many data pipelines

Request Body schema: application/json
required
Array of objects (KoboDataPipeline)

Responses

Request samples

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

Test connection for payload

Request Body schema: application/json
required
url
required
string
authToken
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "authToken": "string"
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

Workflows

Get workflow

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "continuouslyUpdated": true,
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "cronExpression": "string",
  • "steps": {
    },
  • "status": {
    },
  • "access": {
    },
  • "triggerExpression": "string",
  • "displayDescription": "string",
  • "scheduleable": true,
  • "displayName": "string"
}

Update workflow

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
continuouslyUpdated
required
boolean
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
cronExpression
string
required
object (WorkflowSteps)
object (WorkflowStatus)
object (Access)
triggerExpression
string
displayDescription
string
scheduleable
boolean
createdByLastUpdatedBy
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "continuouslyUpdated": true,
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "cronExpression": "string",
  • "steps": {
    },
  • "status": {
    },
  • "access": {
    },
  • "triggerExpression": "string",
  • "displayDescription": "string",
  • "scheduleable": true,
  • "createdByLastUpdatedBy": "string",
  • "displayName": "string"
}

Remove workflow

path Parameters
uid
required
string

Responses

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get workflows

query Parameters
filter
Array of strings
order
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create workflow

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
continuouslyUpdated
required
boolean
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
cronExpression
string
required
object (WorkflowSteps)
object (WorkflowStatus)
object (Access)
triggerExpression
string
displayDescription
string
scheduleable
boolean
createdByLastUpdatedBy
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "continuouslyUpdated": true,
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "cronExpression": "string",
  • "steps": {
    },
  • "status": {
    },
  • "access": {
    },
  • "triggerExpression": "string",
  • "displayDescription": "string",
  • "scheduleable": true,
  • "createdByLastUpdatedBy": "string",
  • "displayName": "string"
}

Execute workflow

path Parameters
uid
required
string

Responses

Get workflows V2

query Parameters
required
object (SearchRequestDto)

Responses

Response samples

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

Views

Get view

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "schema": {
    },
  • "description": "string",
  • "dataWarehouseViewName": "string",
  • "query": "string",
  • "materialized": true,
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "tags": [
    ],
  • "status": {
    },
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "triggerExpression": "string",
  • "displayDescription": "string",
  • "tagString": "string",
  • "qualifiedDataWarehouseViewName": "string",
  • "redshiftViewName": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayName": "string"
}

Update view

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
required
object (Schema)
description
string
dataWarehouseViewName
string
query
required
string
materialized
required
boolean
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
tags
Array of strings unique
object (ViewStatus)
object (AnonymousAccess)
object (Access)
triggerExpression
string
displayDescription
string
tagString
string
qualifiedDataWarehouseViewName
string
redshiftViewName
string
Deprecated
scheduleable
boolean
continuouslyUpdated
boolean
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
createdByLastUpdatedBy
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "schema": {
    },
  • "description": "string",
  • "dataWarehouseViewName": "string",
  • "query": "string",
  • "materialized": true,
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "tags": [
    ],
  • "status": {
    },
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "triggerExpression": "string",
  • "displayDescription": "string",
  • "tagString": "string",
  • "qualifiedDataWarehouseViewName": "string",
  • "redshiftViewName": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "createdByLastUpdatedBy": "string",
  • "displayName": "string"
}

Remove view

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

getViews

query Parameters
filter
Array of strings
order
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create view

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
required
object (Schema)
description
string
dataWarehouseViewName
string
query
required
string
materialized
required
boolean
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
tags
Array of strings unique
object (ViewStatus)
object (AnonymousAccess)
object (Access)
triggerExpression
string
displayDescription
string
tagString
string
qualifiedDataWarehouseViewName
string
redshiftViewName
string
Deprecated
scheduleable
boolean
continuouslyUpdated
boolean
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
createdByLastUpdatedBy
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "schema": {
    },
  • "description": "string",
  • "dataWarehouseViewName": "string",
  • "query": "string",
  • "materialized": true,
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "tags": [
    ],
  • "status": {
    },
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "triggerExpression": "string",
  • "displayDescription": "string",
  • "tagString": "string",
  • "qualifiedDataWarehouseViewName": "string",
  • "redshiftViewName": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "createdByLastUpdatedBy": "string",
  • "displayName": "string"
}

Unload view

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy view

path Parameters
uid
required
string

Responses

Get structure

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Download data

path Parameters
uid
required
string

Responses

Get data preview

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Variables

Get variable

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "secured": true,
  • "value": "string",
  • "displayName": "string"
}

Update variable

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
secured
required
boolean
value
required
string [ 1 .. 5000 ] characters
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "secured": true,
  • "value": "string",
  • "displayName": "string"
}

Remove variable

path Parameters
uid
required
string

Responses

Get variable

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "secured": true,
  • "value": "string",
  • "displayName": "string"
}

Update variable

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
secured
required
boolean
value
required
string [ 1 .. 5000 ] characters
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "secured": true,
  • "value": "string",
  • "displayName": "string"
}

Remove variable

path Parameters
uid
required
string

Responses

Get variables

query Parameters
filter
Array of strings
order
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create variable

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
secured
required
boolean
value
required
string [ 1 .. 5000 ] characters
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "secured": true,
  • "value": "string",
  • "displayName": "string"
}

Get variables

query Parameters
filter
Array of strings
order
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create variable

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
secured
required
boolean
value
required
string [ 1 .. 5000 ] characters
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "secured": true,
  • "value": "string",
  • "displayName": "string"
}

Settings

Get setting

path Parameters
key
required
string
Enum: "ALERT_EMAIL" "DEFAULT_ACCESS_LEVEL" "DATA_PIPELINE_ERROR_ACTION_STAGING_TABLES" "RETAIN_TEMP_FILES" "THEME"

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "client": "string",
  • "key": "ALERT_EMAIL",
  • "value": "string"
}

Update setting

path Parameters
key
required
string
Enum: "ALERT_EMAIL" "DEFAULT_ACCESS_LEVEL" "DATA_PIPELINE_ERROR_ACTION_STAGING_TABLES" "RETAIN_TEMP_FILES" "THEME"
Request Body schema: application/json
required
id
string
created
string <date-time>
lastUpdated
string <date-time>
client
required
string
key
required
string
Enum: "ALERT_EMAIL" "DEFAULT_ACCESS_LEVEL" "DATA_PIPELINE_ERROR_ACTION_STAGING_TABLES" "RETAIN_TEMP_FILES" "THEME"
value
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "client": "string",
  • "key": "ALERT_EMAIL",
  • "value": "string"
}

Get all settings

Responses

Response samples

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

Create setting

Request Body schema: application/json
required
object

Responses

Request samples

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

Schemas

Get schema

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "schemaName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "access": {
    },
  • "permanent": true,
  • "providerSchema": "REDSHIFT",
  • "statistics": {
    },
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update schema

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
schemaName
string
description
string
tags
Array of strings unique
object (Access)
permanent
required
boolean
providerSchema
required
string
Enum: "REDSHIFT" "POSTGRESQL" "CLICKHOUSE" "SYNAPSE" "SQL_SERVER" "NA"
object (SchemaStatistics)
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "schemaName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "access": {
    },
  • "permanent": true,
  • "providerSchema": "REDSHIFT",
  • "statistics": {
    },
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove schema

path Parameters
uid
required
string

Responses

Get schemas

query Parameters
filter
Array of strings
order
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create schema

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
schemaName
string
description
string
tags
Array of strings unique
object (Access)
permanent
required
boolean
providerSchema
required
string
Enum: "REDSHIFT" "POSTGRESQL" "CLICKHOUSE" "SYNAPSE" "SQL_SERVER" "NA"
object (SchemaStatistics)
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "schemaName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "access": {
    },
  • "permanent": true,
  • "providerSchema": "REDSHIFT",
  • "statistics": {
    },
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create schema snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Remove schema snapshot

path Parameters
uid
required
string

Responses

Get views of schema

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get tables in schema

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get table in schema

path Parameters
uid
required
string
tableName
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get columns in table

path Parameters
uid
required
string
tableName
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Public datasets

Get public dataset

path Parameters
key
required
string

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "owner": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "tags": [
    ],
  • "headerRow": true,
  • "table": {
    },
  • "tagString": "string"
}

Update public dataset

path Parameters
key
required
string
Request Body schema: application/json
required
key
string
lastUpdated
string <date-time>
name
string
description
string
owner
string
reference
string
source
string
termsOfUse
string
tags
Array of strings unique
headerRow
boolean
object (Table)
tagString
string

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "owner": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "tags": [
    ],
  • "headerRow": true,
  • "table": {
    },
  • "tagString": "string"
}

Remove public dataset

path Parameters
key
required
string

Responses

Get all public datasets

query Parameters
filter
Array of strings
page
integer <int32>
pageSize
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create public dataset

query Parameters
key
required
string
name
required
string
description
string
owner
string
reference
string
source
string
termsOfUse
string
tags
string
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

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

DHIS2 destinations

Get destination

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "viewSource": {
    },
  • "status": {
    },
  • "access": {
    },
  • "importOptions": {
    },
  • "apiTarget": {
    },
  • "apiTokenTarget": {
    },
  • "type": "DHIS2",
  • "triggerExpression": "string",
  • "displayDescription": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayName": "string"
}

Update destination

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
required
object (View)
object (DestinationStatus)
object (Access)
object (ImportOptions)
object (UsernamePasswordApiTarget)
object (AuthTokenApiTarget)
type
string
Value: "DHIS2"
triggerExpression
string
displayDescription
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "viewSource": {
    },
  • "status": {
    },
  • "access": {
    },
  • "importOptions": {
    },
  • "apiTarget": {
    },
  • "apiTokenTarget": {
    },
  • "type": "DHIS2",
  • "triggerExpression": "string",
  • "displayDescription": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayName": "string"
}

Remove destination

path Parameters
uid
required
string

Responses

Update destination access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get destinations

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create destination

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
required
object (View)
object (DestinationStatus)
object (Access)
object (ImportOptions)
object (UsernamePasswordApiTarget)
object (AuthTokenApiTarget)
type
string
Value: "DHIS2"
triggerExpression
string
displayDescription
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "viewSource": {
    },
  • "status": {
    },
  • "access": {
    },
  • "importOptions": {
    },
  • "apiTarget": {
    },
  • "apiTokenTarget": {
    },
  • "type": "DHIS2",
  • "triggerExpression": "string",
  • "displayDescription": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayName": "string"
}

Load data

path Parameters
uid
required
string

Responses

Copy destination

path Parameters
uid
required
string

Responses

Test connection for destination

path Parameters
uid
required
string
Request Body schema: application/json
required
url
required
string
username
string
password
string
authToken
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string",
  • "authToken": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Test connection for payload

Request Body schema: application/json
required
url
required
string
username
string
password
string
authToken
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string",
  • "authToken": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Test connection

path Parameters
uid
required
string

Responses

Test connection

path Parameters
uid
required
string

Responses

Get destination as attachment

path Parameters
uid
required
string

Responses

Data quality checks

Create data quality check

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "access": {
    },
  • "shortName": "string",
  • "labels": [
    ],
  • "code": "string",
  • "description": "string",
  • "query": "string",
  • "displayDescription": "string",
  • "displayLabels": [
    ],
  • "displayShortName": "string",
  • "displayName": "string"
}

Update data quality check

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
object (Access)
shortName
required
string [ 0 .. 50 ] characters
Array of objects (Label)
code
required
string [ 0 .. 50 ] characters
description
string
query
required
string [ 2 .. 2147483647 ] characters
displayDescription
string
Array of objects (Label)
displayShortName
string
createdByLastUpdatedBy
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "access": {
    },
  • "shortName": "string",
  • "labels": [
    ],
  • "code": "string",
  • "description": "string",
  • "query": "string",
  • "displayDescription": "string",
  • "displayLabels": [
    ],
  • "displayShortName": "string",
  • "createdByLastUpdatedBy": "string",
  • "displayName": "string"
}

Remove data quality check

path Parameters
uid
required
string

Responses

Update data quality check access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data quality checks

query Parameters
filter
Array of strings
order
Array of strings
required
object (PagingRequest)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data quality check

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
object (Access)
shortName
required
string [ 0 .. 50 ] characters
Array of objects (Label)
code
required
string [ 0 .. 50 ] characters
description
string
query
required
string [ 2 .. 2147483647 ] characters
displayDescription
string
Array of objects (Label)
displayShortName
string
createdByLastUpdatedBy
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "access": {
    },
  • "shortName": "string",
  • "labels": [
    ],
  • "code": "string",
  • "description": "string",
  • "query": "string",
  • "displayDescription": "string",
  • "displayLabels": [
    ],
  • "displayShortName": "string",
  • "createdByLastUpdatedBy": "string",
  • "displayName": "string"
}

Get data quality check result

path Parameters
uid
required
string
Request Body schema: application/json
required
Array of objects (Variable)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "dataQualityCheckId": "string",
  • "status": "OK",
  • "data": {
    }
}

Data quality check groups

Get data quality check group

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "access": {
    },
  • "shortName": "string",
  • "labels": [
    ],
  • "description": "string",
  • "dataQualityChecks": [
    ],
  • "displayDescription": "string",
  • "displayLabels": [
    ],
  • "displayShortName": "string",
  • "displayName": "string"
}

Update data quality check group

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
object (Access)
shortName
required
string [ 0 .. 50 ] characters
Array of objects (Label)
description
string
Array of objects (DataQualityCheck) unique
displayDescription
string
Array of objects (Label)
displayShortName
string
createdByLastUpdatedBy
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "access": {
    },
  • "shortName": "string",
  • "labels": [
    ],
  • "description": "string",
  • "dataQualityChecks": [
    ],
  • "displayDescription": "string",
  • "displayLabels": [
    ],
  • "displayShortName": "string",
  • "createdByLastUpdatedBy": "string",
  • "displayName": "string"
}

Remove data quality check group

path Parameters
uid
required
string

Responses

Update data quality check group access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data quality check groups

query Parameters
filter
Array of strings
order
Array of strings
required
object (PagingRequest)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data quality check group

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
object (Access)
shortName
required
string [ 0 .. 50 ] characters
Array of objects (Label)
description
string
Array of objects (DataQualityCheck) unique
displayDescription
string
Array of objects (Label)
displayShortName
string
createdByLastUpdatedBy
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "access": {
    },
  • "shortName": "string",
  • "labels": [
    ],
  • "description": "string",
  • "dataQualityChecks": [
    ],
  • "displayDescription": "string",
  • "displayLabels": [
    ],
  • "displayShortName": "string",
  • "createdByLastUpdatedBy": "string",
  • "displayName": "string"
}

Get data quality check group result

path Parameters
uid
required
string
Request Body schema: application/json
Array of objects (Variable)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "name": "string",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "variables": [
    ],
  • "results": [
    ]
}

Get data quality check result async

path Parameters
uid
required
string
Request Body schema: application/json
Array of objects (Variable)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Talamus data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "facilities": [
    ],
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (AuthTokenApiSource)
facilities
required
Array of strings [ 1 .. 2147483647 ] items
startDate
required
string <date>
endDate
required
string <date>
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "facilities": [
    ],
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (AuthTokenApiSource)
facilities
required
Array of strings [ 1 .. 2147483647 ] items
startDate
required
string <date>
endDate
required
string <date>
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "facilities": [
    ],
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Test connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
url
required
string
authToken
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "authToken": "string"
}

Create many data pipelines

Request Body schema: application/json
required
Array of objects (TalamusDataPipeline)

Responses

Request samples

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

Test connection for payload

Request Body schema: application/json
required
url
required
string
authToken
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "authToken": "string"
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

S3 data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "s3Source": {
    },
  • "key": "string",
  • "delimiter": "PIPE",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (S3Source)
key
required
string
delimiter
required
string
Enum: "PIPE" "COMMA" "TAB" "SEMI_COLON"
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "s3Source": {
    },
  • "key": "string",
  • "delimiter": "PIPE",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (S3Source)
key
required
string
delimiter
required
string
Enum: "PIPE" "COMMA" "TAB" "SEMI_COLON"
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "s3Source": {
    },
  • "key": "string",
  • "delimiter": "PIPE",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Test connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
bucket
required
string
objectKey
required
string
accessKey
string
secretKey
string

Responses

Request samples

Content type
application/json
{
  • "bucket": "string",
  • "objectKey": "string",
  • "accessKey": "string",
  • "secretKey": "string"
}

Create many data pipelines

Request Body schema: application/json
required
Array of objects (S3DataPipeline)

Responses

Request samples

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

Test connection for payload

Request Body schema: application/json
required
bucket
required
string
objectKey
required
string
accessKey
string
secretKey
string

Responses

Request samples

Content type
application/json
{
  • "bucket": "string",
  • "objectKey": "string",
  • "accessKey": "string",
  • "secretKey": "string"
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

Redshift data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "iamRoleArn": "string",
  • "region": "DEFAULT",
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
iamRoleArn
required
string
region
required
string
Enum: "DEFAULT" "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "AF_SOUTH_1" "EU_CENTRAL_1" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_SOUTH_1" "EU_NORTH_1"
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "iamRoleArn": "string",
  • "region": "DEFAULT",
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
iamRoleArn
required
string
region
required
string
Enum: "DEFAULT" "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "AF_SOUTH_1" "EU_CENTRAL_1" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_SOUTH_1" "EU_NORTH_1"
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "iamRoleArn": "string",
  • "region": "DEFAULT",
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Test JDBC connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
iamRoleArn
required
string
region
required
string
Enum: "DEFAULT" "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "AF_SOUTH_1" "EU_CENTRAL_1" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_SOUTH_1" "EU_NORTH_1"
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "iamRoleArn": "string",
  • "region": "DEFAULT",
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Test JDBC connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
iamRoleArn
required
string
region
required
string
Enum: "DEFAULT" "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "AF_SOUTH_1" "EU_CENTRAL_1" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_SOUTH_1" "EU_NORTH_1"
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "iamRoleArn": "string",
  • "region": "DEFAULT",
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Create many data pipelines

Request Body schema: application/json
required
Array of objects (RedshiftDataPipeline)

Responses

Request samples

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

Test JDBC connection for payload

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
iamRoleArn
required
string
region
required
string
Enum: "DEFAULT" "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "AF_SOUTH_1" "EU_CENTRAL_1" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_SOUTH_1" "EU_NORTH_1"
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "iamRoleArn": "string",
  • "region": "DEFAULT",
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Test JDBC connection for payload

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
iamRoleArn
required
string
region
required
string
Enum: "DEFAULT" "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "AF_SOUTH_1" "EU_CENTRAL_1" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_SOUTH_1" "EU_NORTH_1"
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "iamRoleArn": "string",
  • "region": "DEFAULT",
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

Public dataset data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "key": "string",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
key
required
string
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "key": "string",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
key
required
string
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "key": "string",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Create many data pipelines

Request Body schema: application/json
required
Array of objects (PublicDatasetDataPipeline)

Responses

Request samples

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

Ingest all public datasets

Responses

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

PostgreSQL data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Get tables for data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Test JDBC connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Test JDBC connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Get tables for payload

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create many data pipelines

Request Body schema: application/json
required
Array of objects (PostgreSqlDataPipeline)

Responses

Request samples

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

Test JDBC connection for payload

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Test JDBC connection for payload

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

Parquet uploads data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "file": {
    },
  • "type": "AZURE_BLOB_STORAGE",
  • "scheduleable": true,
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
object (FileMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
scheduleable
boolean
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "file": {
    },
  • "type": "AZURE_BLOB_STORAGE",
  • "scheduleable": true,
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
object (FileMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
scheduleable
boolean
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "file": {
    },
  • "type": "AZURE_BLOB_STORAGE",
  • "scheduleable": true,
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Upload Parquet file for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

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

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Create many data pipelines

Request Body schema: application/json
required
Array of objects (ParquetUploadDataPipeline)

Responses

Request samples

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

Upload Parquet file

query Parameters
name
required
string
description
string
owner
string
reference
string
source
string
termsOfUse
string
tags
string
schema
string
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

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

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

Oracle data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Test JDBC connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Test JDBC connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Create many data pipelines

Request Body schema: application/json
required
Array of objects (OracleDataPipeline)

Responses

Request samples

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

Test JDBC connection for payload

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Test JDBC connection for payload

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

Ona data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "form": 0,
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (AuthTokenApiSource)
form
required
integer <int32>
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "form": 0,
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (AuthTokenApiSource)
form
required
integer <int32>
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "form": 0,
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Test connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
url
required
string
authToken
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "authToken": "string"
}

Create many data pipelines

Request Body schema: application/json
required
Array of objects (OnaDataPipeline)

Responses

Request samples

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

Get forms for payload

Request Body schema: application/json
required
url
required
string
authToken
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "authToken": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Test connection for payload

Request Body schema: application/json
required
url
required
string
authToken
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "authToken": "string"
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get forms for data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

ODK data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "project": "string",
  • "form": "string",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (UsernamePasswordApiSource)
project
required
string
form
required
string
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "project": "string",
  • "form": "string",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (UsernamePasswordApiSource)
project
required
string
form
required
string
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "project": "string",
  • "form": "string",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Test connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
url
required
string
username
required
string
password
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string"
}

Get projects for payload

Request Body schema: application/json
required
url
required
string
username
required
string
password
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get forms for payload

path Parameters
project
required
string
Request Body schema: application/json
required
url
required
string
username
required
string
password
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create many data pipelines

Request Body schema: application/json
required
Array of objects (OdkDataPipeline)

Responses

Request samples

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

Test connection for payload

Request Body schema: application/json
required
url
required
string
username
required
string
password
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string"
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get projects for data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get forms for data pipeline

path Parameters
uid
required
string
project
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

MySQL data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Test JDBC connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Test JDBC connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Create many data pipelines

Request Body schema: application/json
required
Array of objects (MySqlDataPipeline)

Responses

Request samples

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

Test JDBC connection for payload

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Test JDBC connection for payload

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

MS SQL data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Get tables for data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Test JDBC connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Test JDBC connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Get tables for payload

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create many data pipelines

Request Body schema: application/json
required
Array of objects (MsSqlDataPipeline)

Responses

Request samples

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

Test JDBC connection for payload

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Test JDBC connection for payload

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (JdbcSource)
sqlQuery
string
Array of objects (TableMetadata)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "sqlQuery": "string",
  • "tables": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

iHRIS 5.0 data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "questionnaires": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (UsernamePasswordApiSource)
questionnaires
Array of strings
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "questionnaires": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (UsernamePasswordApiSource)
questionnaires
Array of strings
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "questionnaires": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Get questionnaires for payload

Request Body schema: application/json
required
url
required
string
username
required
string
password
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create many data pipelines

Request Body schema: application/json
required
Array of objects (Ihris5DataPipeline)

Responses

Request samples

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

Test connection for payload

Request Body schema: application/json
required
url
required
string
username
required
string
password
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string"
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

IHRIS data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "forms": [
    ],
  • "includeRecordHistory": true,
  • "references": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
object (JdbcSource)
forms
Array of strings
includeRecordHistory
required
boolean
references
Array of strings unique
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "forms": [
    ],
  • "includeRecordHistory": true,
  • "references": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
object (JdbcSource)
forms
Array of strings
includeRecordHistory
required
boolean
references
Array of strings unique
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "forms": [
    ],
  • "includeRecordHistory": true,
  • "references": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Get references for data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Test JDBC connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
object (JdbcSource)
forms
Array of strings
includeRecordHistory
required
boolean
references
Array of strings unique
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "forms": [
    ],
  • "includeRecordHistory": true,
  • "references": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Test JDBC connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
object (JdbcSource)
forms
Array of strings
includeRecordHistory
required
boolean
references
Array of strings unique
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "forms": [
    ],
  • "includeRecordHistory": true,
  • "references": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Get forms for data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Get references for data pipeline

Request Body schema: application/json
required
hostname
required
string [ 1 .. 2147483647 ] characters
port
integer <int32>
database
required
string [ 1 .. 2147483647 ] characters
username
required
string [ 1 .. 2147483647 ] characters
password
string
ssl
required
boolean
trustServerCertificate
required
boolean

Responses

Request samples

Content type
application/json
{
  • "hostname": "string",
  • "port": 0,
  • "database": "string",
  • "username": "string",
  • "password": "string",
  • "ssl": true,
  • "trustServerCertificate": true
}

Response samples

Content type
application/json
[
  • "string"
]

Create many data pipelines

Request Body schema: application/json
required
Array of objects (IhrisDataPipeline)

Responses

Request samples

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

Test JDBC connection for payload

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
object (JdbcSource)
forms
Array of strings
includeRecordHistory
required
boolean
references
Array of strings unique
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "forms": [
    ],
  • "includeRecordHistory": true,
  • "references": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Test JDBC connection for payload

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
object (JdbcSource)
forms
Array of strings
includeRecordHistory
required
boolean
references
Array of strings unique
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "jdbcSource": {
    },
  • "forms": [
    ],
  • "includeRecordHistory": true,
  • "references": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Get forms for payload

Request Body schema: application/json
required
hostname
required
string [ 1 .. 2147483647 ] characters
port
integer <int32>
database
required
string [ 1 .. 2147483647 ] characters
username
required
string [ 1 .. 2147483647 ] characters
password
string
ssl
required
boolean
trustServerCertificate
required
boolean

Responses

Request samples

Content type
application/json
{
  • "hostname": "string",
  • "port": 0,
  • "database": "string",
  • "username": "string",
  • "password": "string",
  • "ssl": true,
  • "trustServerCertificate": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Get form fields for payload

Request Body schema: application/json
required
hostname
required
string [ 1 .. 2147483647 ] characters
port
integer <int32>
database
required
string [ 1 .. 2147483647 ] characters
username
required
string [ 1 .. 2147483647 ] characters
password
string
ssl
required
boolean
trustServerCertificate
required
boolean

Responses

Request samples

Content type
application/json
{
  • "hostname": "string",
  • "port": 0,
  • "database": "string",
  • "username": "string",
  • "password": "string",
  • "ssl": true,
  • "trustServerCertificate": true
}

Response samples

Content type
application/json
[
  • {
    }
]

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

Google Sheets data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "sheetUrl": "string",
  • "schemas": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
sheetUrl
required
string
required
Array of objects (GoogleSheetsSchema)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "sheetUrl": "string",
  • "schemas": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
sheetUrl
required
string
required
Array of objects (GoogleSheetsSchema)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "sheetUrl": "string",
  • "schemas": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Create many data pipelines

Request Body schema: application/json
required
Array of objects (GoogleSheetsDataPipeline)

Responses

Request samples

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

Test connection for payload

Request Body schema: application/json
required
url
string

Responses

Request samples

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

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

Function data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "functionParams": {
    },
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
object (FunctionParams)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "functionParams": {
    },
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
object (FunctionParams)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "functionParams": {
    },
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Create many data pipelines

Request Body schema: application/json
required
Array of objects (FunctionDataPipeline)

Responses

Request samples

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

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

FHIR data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "questionnaires": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (UsernamePasswordApiSource)
questionnaires
Array of strings
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "questionnaires": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (UsernamePasswordApiSource)
questionnaires
Array of strings
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "questionnaires": [
    ],
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Get questionnaires for data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Get questionnaires for payload

Request Body schema: application/json
required
url
required
string
username
required
string
password
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create many data pipelines

Request Body schema: application/json
required
Array of objects (FhirDataPipeline)

Responses

Request samples

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

Test connection for payload

Request Body schema: application/json
required
url
required
string
username
required
string
password
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string"
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

DHIS2 data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "continuouslyUpdated": true,
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "apiSource": {
    },
  • "apiTokenSource": {
    },
  • "jdbcSource": {
    },
  • "dataTypes": [
    ],
  • "programs": [
    ],
  • "orgUnits": [
    ],
  • "dataElementGroups": [
    ],
  • "dataElements": [
    ],
  • "dataSets": [
    ],
  • "dateRange": {
    },
  • "dataLoadingPageSize": 0,
  • "dataLoadingDelayMs": 0,
  • "includeSoftDeletedData": true,
  • "includeZeroDataValues": true,
  • "skipWideAggregateDataTable": true,
  • "includeNarrowEventTable": true,
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "triggerExpression": "string",
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
continuouslyUpdated
required
boolean
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
object (UsernamePasswordApiSource)
object (AuthTokenApiSource)
object (JdbcSource)
dataTypes
required
Array of strings
Items Enum: "AGGREGATE" "PROGRAM" "METADATA" "USAGE_STATISTICS" "AUDIT" "USER_INFO"
programs
Array of strings
orgUnits
Array of strings
dataElementGroups
Array of strings
dataElements
Array of strings
dataSets
Array of strings
object (DateRange)
dataLoadingPageSize
integer <int32>
dataLoadingDelayMs
integer <int32>
includeSoftDeletedData
required
boolean
includeZeroDataValues
required
boolean
skipWideAggregateDataTable
required
boolean
includeNarrowEventTable
required
boolean
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
triggerExpression
string
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "continuouslyUpdated": true,
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "apiSource": {
    },
  • "apiTokenSource": {
    },
  • "jdbcSource": {
    },
  • "dataTypes": [
    ],
  • "programs": [
    ],
  • "orgUnits": [
    ],
  • "dataElementGroups": [
    ],
  • "dataElements": [
    ],
  • "dataSets": [
    ],
  • "dateRange": {
    },
  • "dataLoadingPageSize": 0,
  • "dataLoadingDelayMs": 0,
  • "includeSoftDeletedData": true,
  • "includeZeroDataValues": true,
  • "skipWideAggregateDataTable": true,
  • "includeNarrowEventTable": true,
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "triggerExpression": "string",
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
continuouslyUpdated
required
boolean
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
object (UsernamePasswordApiSource)
object (AuthTokenApiSource)
object (JdbcSource)
dataTypes
required
Array of strings
Items Enum: "AGGREGATE" "PROGRAM" "METADATA" "USAGE_STATISTICS" "AUDIT" "USER_INFO"
programs
Array of strings
orgUnits
Array of strings
dataElementGroups
Array of strings
dataElements
Array of strings
dataSets
Array of strings
object (DateRange)
dataLoadingPageSize
integer <int32>
dataLoadingDelayMs
integer <int32>
includeSoftDeletedData
required
boolean
includeZeroDataValues
required
boolean
skipWideAggregateDataTable
required
boolean
includeNarrowEventTable
required
boolean
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
triggerExpression
string
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "continuouslyUpdated": true,
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "apiSource": {
    },
  • "apiTokenSource": {
    },
  • "jdbcSource": {
    },
  • "dataTypes": [
    ],
  • "programs": [
    ],
  • "orgUnits": [
    ],
  • "dataElementGroups": [
    ],
  • "dataElements": [
    ],
  • "dataSets": [
    ],
  • "dateRange": {
    },
  • "dataLoadingPageSize": 0,
  • "dataLoadingDelayMs": 0,
  • "includeSoftDeletedData": true,
  • "includeZeroDataValues": true,
  • "skipWideAggregateDataTable": true,
  • "includeNarrowEventTable": true,
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "triggerExpression": "string",
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Test JDBC connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
continuouslyUpdated
required
boolean
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
object (UsernamePasswordApiSource)
object (AuthTokenApiSource)
object (JdbcSource)
dataTypes
required
Array of strings
Items Enum: "AGGREGATE" "PROGRAM" "METADATA" "USAGE_STATISTICS" "AUDIT" "USER_INFO"
programs
Array of strings
orgUnits
Array of strings
dataElementGroups
Array of strings
dataElements
Array of strings
dataSets
Array of strings
object (DateRange)
dataLoadingPageSize
integer <int32>
dataLoadingDelayMs
integer <int32>
includeSoftDeletedData
required
boolean
includeZeroDataValues
required
boolean
skipWideAggregateDataTable
required
boolean
includeNarrowEventTable
required
boolean
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
triggerExpression
string
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "continuouslyUpdated": true,
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "apiSource": {
    },
  • "apiTokenSource": {
    },
  • "jdbcSource": {
    },
  • "dataTypes": [
    ],
  • "programs": [
    ],
  • "orgUnits": [
    ],
  • "dataElementGroups": [
    ],
  • "dataElements": [
    ],
  • "dataSets": [
    ],
  • "dateRange": {
    },
  • "dataLoadingPageSize": 0,
  • "dataLoadingDelayMs": 0,
  • "includeSoftDeletedData": true,
  • "includeZeroDataValues": true,
  • "skipWideAggregateDataTable": true,
  • "includeNarrowEventTable": true,
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "triggerExpression": "string",
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Test JDBC connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
continuouslyUpdated
required
boolean
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
object (UsernamePasswordApiSource)
object (AuthTokenApiSource)
object (JdbcSource)
dataTypes
required
Array of strings
Items Enum: "AGGREGATE" "PROGRAM" "METADATA" "USAGE_STATISTICS" "AUDIT" "USER_INFO"
programs
Array of strings
orgUnits
Array of strings
dataElementGroups
Array of strings
dataElements
Array of strings
dataSets
Array of strings
object (DateRange)
dataLoadingPageSize
integer <int32>
dataLoadingDelayMs
integer <int32>
includeSoftDeletedData
required
boolean
includeZeroDataValues
required
boolean
skipWideAggregateDataTable
required
boolean
includeNarrowEventTable
required
boolean
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
triggerExpression
string
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "continuouslyUpdated": true,
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "apiSource": {
    },
  • "apiTokenSource": {
    },
  • "jdbcSource": {
    },
  • "dataTypes": [
    ],
  • "programs": [
    ],
  • "orgUnits": [
    ],
  • "dataElementGroups": [
    ],
  • "dataElements": [
    ],
  • "dataSets": [
    ],
  • "dateRange": {
    },
  • "dataLoadingPageSize": 0,
  • "dataLoadingDelayMs": 0,
  • "includeSoftDeletedData": true,
  • "includeZeroDataValues": true,
  • "skipWideAggregateDataTable": true,
  • "includeNarrowEventTable": true,
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "triggerExpression": "string",
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Test API connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
url
required
string
username
string
password
string
authToken
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string",
  • "authToken": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Get programs for payload

query Parameters
search
string
Request Body schema: application/json
required
url
required
string
username
string
password
string
authToken
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string",
  • "authToken": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get org units for payload

query Parameters
search
string
Request Body schema: application/json
required
url
required
string
username
string
password
string
authToken
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string",
  • "authToken": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create many data pipelines

Request Body schema: application/json
required
Array of objects (Dhis2DataPipeline)

Responses

Request samples

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

Test JDBC connection for payload

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
continuouslyUpdated
required
boolean
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
object (UsernamePasswordApiSource)
object (AuthTokenApiSource)
object (JdbcSource)
dataTypes
required
Array of strings
Items Enum: "AGGREGATE" "PROGRAM" "METADATA" "USAGE_STATISTICS" "AUDIT" "USER_INFO"
programs
Array of strings
orgUnits
Array of strings
dataElementGroups
Array of strings
dataElements
Array of strings
dataSets
Array of strings
object (DateRange)
dataLoadingPageSize
integer <int32>
dataLoadingDelayMs
integer <int32>
includeSoftDeletedData
required
boolean
includeZeroDataValues
required
boolean
skipWideAggregateDataTable
required
boolean
includeNarrowEventTable
required
boolean
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
triggerExpression
string
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "continuouslyUpdated": true,
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "apiSource": {
    },
  • "apiTokenSource": {
    },
  • "jdbcSource": {
    },
  • "dataTypes": [
    ],
  • "programs": [
    ],
  • "orgUnits": [
    ],
  • "dataElementGroups": [
    ],
  • "dataElements": [
    ],
  • "dataSets": [
    ],
  • "dateRange": {
    },
  • "dataLoadingPageSize": 0,
  • "dataLoadingDelayMs": 0,
  • "includeSoftDeletedData": true,
  • "includeZeroDataValues": true,
  • "skipWideAggregateDataTable": true,
  • "includeNarrowEventTable": true,
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "triggerExpression": "string",
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Test JDBC connection for payload

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
continuouslyUpdated
required
boolean
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
object (UsernamePasswordApiSource)
object (AuthTokenApiSource)
object (JdbcSource)
dataTypes
required
Array of strings
Items Enum: "AGGREGATE" "PROGRAM" "METADATA" "USAGE_STATISTICS" "AUDIT" "USER_INFO"
programs
Array of strings
orgUnits
Array of strings
dataElementGroups
Array of strings
dataElements
Array of strings
dataSets
Array of strings
object (DateRange)
dataLoadingPageSize
integer <int32>
dataLoadingDelayMs
integer <int32>
includeSoftDeletedData
required
boolean
includeZeroDataValues
required
boolean
skipWideAggregateDataTable
required
boolean
includeNarrowEventTable
required
boolean
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
defaultPort
integer <int32>
jdbcConnectionUrl
string
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
triggerExpression
string
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "continuouslyUpdated": true,
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "apiSource": {
    },
  • "apiTokenSource": {
    },
  • "jdbcSource": {
    },
  • "dataTypes": [
    ],
  • "programs": [
    ],
  • "orgUnits": [
    ],
  • "dataElementGroups": [
    ],
  • "dataElements": [
    ],
  • "dataSets": [
    ],
  • "dateRange": {
    },
  • "dataLoadingPageSize": 0,
  • "dataLoadingDelayMs": 0,
  • "includeSoftDeletedData": true,
  • "includeZeroDataValues": true,
  • "skipWideAggregateDataTable": true,
  • "includeNarrowEventTable": true,
  • "type": "AZURE_BLOB_STORAGE",
  • "defaultPort": 0,
  • "jdbcConnectionUrl": "string",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "triggerExpression": "string",
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Get data sets for payload

query Parameters
search
string
Request Body schema: application/json
required
url
required
string
username
string
password
string
authToken
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string",
  • "authToken": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get data elements for payload

query Parameters
search
string
Request Body schema: application/json
required
url
required
string
username
string
password
string
authToken
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string",
  • "authToken": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get data element groups for payload

query Parameters
search
string
Request Body schema: application/json
required
url
required
string
username
string
password
string
authToken
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string",
  • "authToken": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Test API connection for payload

Request Body schema: application/json
required
url
required
string
username
string
password
string
authToken
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string",
  • "authToken": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get programs for data pipeline

path Parameters
uid
required
string
query Parameters
search
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get org units for data pipeline

path Parameters
uid
required
string
query Parameters
search
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data sets for data pipeline

path Parameters
uid
required
string
query Parameters
search
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data elements for data pipeline

path Parameters
uid
required
string
query Parameters
search
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data element groups for data pipeline

path Parameters
uid
required
string
query Parameters
search
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

CSV upload data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "files": [
    ],
  • "delimiter": "PIPE",
  • "type": "AZURE_BLOB_STORAGE",
  • "scheduleable": true,
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
Array of objects (FileMetadata)
delimiter
required
string
Enum: "PIPE" "COMMA" "TAB" "SEMI_COLON"
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
scheduleable
boolean
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "files": [
    ],
  • "delimiter": "PIPE",
  • "type": "AZURE_BLOB_STORAGE",
  • "scheduleable": true,
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
Array of objects (FileMetadata)
delimiter
required
string
Enum: "PIPE" "COMMA" "TAB" "SEMI_COLON"
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
scheduleable
boolean
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "files": [
    ],
  • "delimiter": "PIPE",
  • "type": "AZURE_BLOB_STORAGE",
  • "scheduleable": true,
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Update CSV file for data pipeline

path Parameters
uid
required
string
query Parameters
delimiter
string
Enum: "PIPE" "COMMA" "TAB" "SEMI_COLON"
file
required
Array of strings <binary> [ items <binary > ]

Responses

Remove CSV files

path Parameters
uid
required
string
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Create many data pipelines

Request Body schema: application/json
required
Array of objects (CsvUploadDataPipeline)

Responses

Request samples

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

Upload CSV file

query Parameters
name
required
string
description
string
owner
string
reference
string
source
string
termsOfUse
string
tags
string
schema
string
delimiter
string
Enum: "PIPE" "COMMA" "TAB" "SEMI_COLON"
file
required
Array of strings <binary> [ items <binary > ]

Responses

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

CommCare data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "domain": "string",
  • "application": "string",
  • "hashColumnName": true,
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (UsernamePasswordApiSource)
domain
required
string
application
required
string
hashColumnName
required
boolean
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "domain": "string",
  • "application": "string",
  • "hashColumnName": true,
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (UsernamePasswordApiSource)
domain
required
string
application
required
string
hashColumnName
required
boolean
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "domain": "string",
  • "application": "string",
  • "hashColumnName": true,
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Test connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
url
required
string
username
required
string
password
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string"
}

Create many data pipelines

Request Body schema: application/json
required
Array of objects (CommCareDataPipeline)

Responses

Request samples

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

Get domains for payload

Request Body schema: application/json
required
url
required
string
username
required
string
password
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get domains and applications for payload

Request Body schema: application/json
required
url
required
string
username
required
string
password
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get applications for payload

path Parameters
domain
required
string
Request Body schema: application/json
required
url
required
string
username
required
string
password
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get forms for payload

path Parameters
domain
required
string
application
required
string
Request Body schema: application/json
required
url
required
string
username
required
string
password
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Test connection for payload

Request Body schema: application/json
required
url
required
string
username
required
string
password
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string"
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get domains for data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get applications for data pipeline

path Parameters
uid
required
string
domain
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get forms for data pipeline

path Parameters
uid
required
string
domain
required
string
application
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

BHIMA data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "project": 0,
  • "reportParams": {
    },
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (UsernamePasswordApiSource)
project
required
integer <int32>
object (BhimaReportParams)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "project": 0,
  • "reportParams": {
    },
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (UsernamePasswordApiSource)
project
required
integer <int32>
object (BhimaReportParams)
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "apiSource": {
    },
  • "project": 0,
  • "reportParams": {
    },
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

testConnectionForDataPipeline_6

path Parameters
uid
required
string
Request Body schema: application/json
required
url
string
username
string
password
string
project
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string",
  • "project": 0
}

Get projects

Request Body schema: application/json
required
url
string
username
string
password
string
project
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string",
  • "project": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Create many data pipelines

Request Body schema: application/json
required
Array of objects (BhimaDataPipeline)

Responses

Request samples

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

Get depots for payload

query Parameters
search
string
Request Body schema: application/json
required
url
string
username
string
password
string
project
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string",
  • "project": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Get inventories for payload

path Parameters
depotUuid
required
string
Request Body schema: application/json
required
url
string
username
string
password
string
project
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string",
  • "project": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Test connection for payload

Request Body schema: application/json
required
url
string
username
string
password
string
project
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string",
  • "project": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get depots for data pipeline

path Parameters
uid
required
string
query Parameters
search
string
uuid
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get inventories for data pipeline

path Parameters
uid
required
string
depotUuid
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

Azure Blob Storage data pipelines

Get data pipeline

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "azureBlobStorageSource": {
    },
  • "delimiter": "PIPE",
  • "fileName": "string",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Update data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (AzureBlobStorageSource)
delimiter
required
string
Enum: "PIPE" "COMMA" "TAB" "SEMI_COLON"
fileName
required
string
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "azureBlobStorageSource": {
    },
  • "delimiter": "PIPE",
  • "fileName": "string",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Remove data pipeline

path Parameters
uid
required
string

Responses

Update anonymous access

path Parameters
uid
required
string
Request Body schema: application/json
required
metadata
boolean
data
boolean

Responses

Request samples

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

Update access

path Parameters
uid
required
string
Request Body schema: application/json
required
publicAccess
string
Enum: "READ" "READ_WRITE" "NONE"
required
Array of objects (AccessObject) unique
required
Array of objects (AccessObject) unique

Responses

Request samples

Content type
application/json
{
  • "publicAccess": "READ",
  • "userAccess": [
    ],
  • "userGroupAccess": [
    ]
}

Get data pipelines

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create data pipeline

Request Body schema: application/json
required
id
string
name
required
string
created
string <date-time>
lastUpdated
string <date-time>
Array of objects (Translation) unique
client
string
createdBy
string
lastUpdatedBy
string
description
string
owner
string
url
string
reference
string
source
string
termsOfUse
string
disabled
required
boolean
runTrigger
required
string
Enum: "EVERY_15_MIN" "EVERY_30_MIN" "EVERY_HOUR" "EVERY_3_HOURS" "EVERY_DAY_0AM" "EVERY_DAY_2AM" "EVERY_NIGHT_RANDOM" "EVERY_WEEKDAY" "EVERY_SATURDAY" "EVERY_SATURDAY_NIGHT_RANDOM" "EVERY_MONTH" "EVERY_MONTH_RANDOM" "CUSTOM" "NEVER"
cronExpression
string
object (DataPipelineStatus)
tags
Array of strings unique
object (AnonymousAccess)
object (Access)
object (DataPipelineTransformation)
required
object (DataWarehouseTarget)
required
object (AzureBlobStorageSource)
delimiter
required
string
Enum: "PIPE" "COMMA" "TAB" "SEMI_COLON"
fileName
required
string
type
string
Enum: "AZURE_BLOB_STORAGE" "BHIMA" "COMMCARE" "CSV_UPLOAD" "DHIS2" "FUNCTION" "FHIR" "GOOGLE_SHEETS" "IHRIS" "IHRIS5" "KOBO_TOOLBOX" "MSSQL" "MYSQL" "ODK" "ONA" "ORACLE" "PARQUET_UPLOAD" "POSTGRESQL" "PUBLIC_DATASET" "REDSHIFT" "S3BUCKET" "TALAMUS"
typeName
string
dataWarehouseTargetSchemaName
string
dataWarehouseTargetTableName
string
dataPipelineSourceName
string
dataDownload
boolean
typeKey
string
createdByLastUpdatedBy
string
scheduleable
boolean
continuouslyUpdated
boolean
triggerExpression
string
continuousUpdateInterval
integer <int32>
fullRefreshInterval
integer <int32>
displayDescription
string
tagString
string
displayName
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "translations": [
    ],
  • "client": "string",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "description": "string",
  • "owner": "string",
  • "url": "string",
  • "reference": "string",
  • "source": "string",
  • "termsOfUse": "string",
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "cronExpression": "string",
  • "status": {
    },
  • "tags": [
    ],
  • "anonymousAccess": {
    },
  • "access": {
    },
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "azureBlobStorageSource": {
    },
  • "delimiter": "PIPE",
  • "fileName": "string",
  • "type": "AZURE_BLOB_STORAGE",
  • "typeName": "string",
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "createdByLastUpdatedBy": "string",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0,
  • "displayDescription": "string",
  • "tagString": "string",
  • "displayName": "string"
}

Create data pipeline snapshot

path Parameters
uid
required
string
Request Body schema: application/json
required
key
string
loadData
boolean

Responses

Request samples

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

Purge data files

path Parameters
uid
required
string

Responses

Load data

path Parameters
uid
required
string

Responses

Copy data pipeline

path Parameters
uid
required
string

Responses

Test connection for data pipeline

path Parameters
uid
required
string
Request Body schema: application/json
required
bucket
required
string
objectKey
required
string
accessKey
string
secretKey
string

Responses

Request samples

Content type
application/json
{
  • "bucket": "string",
  • "objectKey": "string",
  • "accessKey": "string",
  • "secretKey": "string"
}

Create many data pipelines

Request Body schema: application/json
required
Array of objects (AzureBlobStorageDataPipeline)

Responses

Request samples

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

Test connection for payload

Request Body schema: application/json
required
container
required
string
blobKey
required
string
connectionString
string

Responses

Request samples

Content type
application/json
{
  • "container": "string",
  • "blobKey": "string",
  • "connectionString": "string"
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get table structure

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get log entries

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data preview

path Parameters
uid
required
string
query Parameters
table
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Test connection

path Parameters
uid
required
string

Responses

Get data download keys

path Parameters
uid
required
string

Responses

Response samples

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

Download data for key

path Parameters
uid
required
string
objectKeyId
required
string

Responses

Get distinct values for column

path Parameters
uid
required
string
column
required
string

Responses

Response samples

Content type
application/json
{
  • "schema": "string",
  • "name": "string",
  • "displayName": "string",
  • "description": "string",
  • "size": 0,
  • "sizePretty": "string",
  • "rowCount": 0,
  • "columns": [
    ],
  • "foreignKeys": [
    ],
  • "queryStartTime": "2019-08-24T14:15:22Z",
  • "queryDuration": 0,
  • "rows": [
    ],
  • "height": 0,
  • "width": 0,
  • "qualifiedTableName": "string",
  • "tableName": "string",
  • "columnCount": 0,
  • "sizeMb": 0
}

Get data pipeline as attachment

path Parameters
uid
required
string

Responses

Data pipeline configuration

Update Superset configuration

path Parameters
client
required
string
Request Body schema: application/json
required
url
required
string
username
required
string
password
string
databaseId
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "username": "string",
  • "password": "string",
  • "databaseId": 0
}

Update data warehouse configuration

path Parameters
client
required
string
Request Body schema: application/json
required
hostname
required
string
publicHostname
string
database
required
string
username
string
password
string
port
integer <int32>
iamRoleArn
string
publicHostnameWithFallback
string

Responses

Request samples

Content type
application/json
{
  • "hostname": "string",
  • "publicHostname": "string",
  • "database": "string",
  • "username": "string",
  • "password": "string",
  • "port": 0,
  • "iamRoleArn": "string",
  • "publicHostnameWithFallback": "string"
}

Update blob store configuration

path Parameters
client
required
string
Request Body schema: application/json
required
identity
string
credential
string
container
required
string
account
string

Responses

Request samples

Content type
application/json
{
  • "identity": "string",
  • "credential": "string",
  • "container": "string",
  • "account": "string"
}

Create data pipeline configuration

Request Body schema: application/json
required
id
string
created
string <date-time>
lastUpdated
string <date-time>
createdBy
required
string
lastUpdatedBy
required
string
client
required
string = 11 characters
clientCode
string [ 2 .. 25 ] characters
provider
required
string
Enum: "AWS_REDSHIFT" "AWS_CLICKHOUSE" "AZURE_SQL_SERVER" "AZURE_SYNAPSE" "LOCAL_CLICKHOUSE" "LOCAL_SQL_SERVER" "LOCAL_POSTGRESQL"
required
object (BlobStoreConfig)
required
object (DataWarehouseConfig)
object (SupersetConfig)
blobStoreName
string
dataWarehouseName
string
dataWarehousePort
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "client": "stringstrin",
  • "clientCode": "string",
  • "provider": "AWS_REDSHIFT",
  • "blobStoreConfig": {
    },
  • "dataWarehouseConfig": {
    },
  • "supersetConfig": {
    },
  • "blobStoreName": "string",
  • "dataWarehouseName": "string",
  • "dataWarehousePort": 0
}

Test Superset connection

path Parameters
client
required
string

Responses

Initialize data warehouse

path Parameters
client
required
string

Responses

Test connection

path Parameters
client
required
string

Responses

Test blob store connection

path Parameters
client
required
string

Responses

Get data pipeline configuration

path Parameters
client
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "client": "stringstrin",
  • "clientCode": "string",
  • "provider": "AWS_REDSHIFT",
  • "blobStoreConfig": {
    },
  • "dataWarehouseConfig": {
    },
  • "supersetConfig": {
    },
  • "blobStoreName": "string",
  • "dataWarehouseName": "string",
  • "dataWarehousePort": 0
}

Remove data pipeline configuration

path Parameters
client
required
string

Responses

Remove all datasets

path Parameters
client
required
string

Responses

Databases V2

Get data query CSV download

Request Body schema: application/json
required
format
string
Enum: "SQL" "NATURAL_TEXT"
query
string
limit
integer <int32>
schemas
Array of strings

Responses

Request samples

Content type
application/json
{
  • "format": "SQL",
  • "query": "string",
  • "limit": 0,
  • "schemas": [
    ]
}

Get data query CSV download

Request Body schema: application/json
required
format
string
Enum: "SQL" "NATURAL_TEXT"
query
string
limit
integer <int32>
schemas
Array of strings

Responses

Request samples

Content type
application/json
{
  • "format": "SQL",
  • "query": "string",
  • "limit": 0,
  • "schemas": [
    ]
}

Get data query response

Request Body schema: application/json
required
format
string
Enum: "SQL" "NATURAL_TEXT"
query
string
limit
integer <int32>
schemas
Array of strings

Responses

Request samples

Content type
application/json
{
  • "format": "SQL",
  • "query": "string",
  • "limit": 0,
  • "schemas": [
    ]
}

Response samples

Content type
application/json
{
  • "startTime": "2019-08-24T14:15:22Z",
  • "duration": 0,
  • "sqlQuery": "string",
  • "result": {
    }
}

Get data query response

Request Body schema: application/json
required
format
string
Enum: "SQL" "NATURAL_TEXT"
query
string
limit
integer <int32>
schemas
Array of strings

Responses

Request samples

Content type
application/json
{
  • "format": "SQL",
  • "query": "string",
  • "limit": 0,
  • "schemas": [
    ]
}

Response samples

Content type
application/json
{
  • "startTime": "2019-08-24T14:15:22Z",
  • "duration": 0,
  • "sqlQuery": "string",
  • "result": {
    }
}

Get database V2

query Parameters
schemas
Array of strings

Responses

Response samples

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

Get database V2

query Parameters
schemas
Array of strings

Responses

Response samples

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

Firewall rules

Get firewall rules

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create firewall rule

Request Body schema: application/json
required
client
string
name
string
ipAddress
string
id
string

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "name": "string",
  • "ipAddress": "string",
  • "id": "string"
}

Remove firewall rule

path Parameters
uid
required
string

Responses

Workflow logs

Get logs for workflow

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download logs for workflow

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

View logs

Get logs for view

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download logs for view

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Tasks

Get tasks version 2

path Parameters
object
required
string
query Parameters
required
object (PagingRequest)

Responses

Response samples

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

Get tasks

path Parameters
object
required
string
query Parameters
required
object (PagingRequest)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Anonymous access views

Get views

query Parameters
client
required
string
filter
Array of strings
order
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Public data pipelines

Get public data pipelines

query Parameters
client
required
string
required
object (SearchRequestDto)

Responses

Response samples

Content type
application/json
{
  • "pager": {
    },
  • "dataPipelines": [
    ]
}

Get public data pipeline

path Parameters
typePath
required
string
uid
required
string
query Parameters
client
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "typeName": "string",
  • "type": "AZURE_BLOB_STORAGE",
  • "owner": "string",
  • "access": {
    },
  • "description": "string",
  • "tags": [
    ],
  • "status": {
    },
  • "dataWarehouseTargetSchemaName": "string",
  • "dataWarehouseTargetTableName": "string",
  • "dataPipelineSourceName": "string",
  • "transformation": {
    },
  • "dataWarehouseTarget": {
    },
  • "createdBy": "string",
  • "transformationCount": 0,
  • "lastUpdatedBy": "string",
  • "anonymousAccess": {
    },
  • "cronExpression": "string",
  • "dataDownload": true,
  • "typeKey": "string",
  • "client": "string",
  • "translations": [
    ],
  • "id": 0,
  • "uid": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "scheduleable": true,
  • "continuouslyUpdated": true,
  • "disabled": true,
  • "runTrigger": "EVERY_15_MIN",
  • "triggerExpression": "string",
  • "continuousUpdateInterval": 0,
  • "fullRefreshInterval": 0
}

Get data download keys

path Parameters
typePath
required
string
uid
required
string
query Parameters
client
required
string

Responses

Response samples

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

Download data for key

path Parameters
typePath
required
string
uid
required
string
objectKeyId
required
string
query Parameters
client
required
string

Responses

Job summaries

Get job summary for data quality check group

path Parameters
groupId
required
string
jobId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "client": "stringstrin",
  • "jobType": "DATA_QUALITY_CHECK",
  • "jobId": "stringstrin",
  • "object": "stringstrin",
  • "summary": { }
}

Destinations

Get destinations

query Parameters
filter
Array of strings
order
Array of strings
required
object (PagingRequest)

Responses

Response samples

Content type
application/json
{
  • "pager": {
    },
  • "destinations": [
    ]
}

Destination logs

Get logs for destination

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download logs for destination

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Get datasets

query Parameters
term
required
string
filtersParam
Array of strings
ordersParam
Array of strings
page
integer <int32>
pageSize
integer <int32>

Responses

Response samples

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

Data pipelines

Get data pipelines

query Parameters
required
object (SearchRequestDto)

Responses

Response samples

Content type
application/json
{
  • "pager": {
    },
  • "dataPipelines": [
    ]
}

Get tags

query Parameters
name
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Search tags

path Parameters
text
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get data pipeline sources

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Data pipeline logs

Get logs for data pipeline

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download logs for data pipeline

path Parameters
uid
required
string
query Parameters
taskId
string
logLevel
string
Enum: "DEBUG" "INFO" "WARN" "ERROR"
logImportance
string
Enum: "LOW" "MEDIUM" "HIGH"
order
string
Enum: "ASC" "DESC"

Responses

System

Get version info

Responses

Response samples

Content type
application/json
{
  • "group": "string",
  • "artifact": "string",
  • "version": "string",
  • "buildTime": "string"
}

Get system info

Responses

Response samples

Content type
application/json
{
  • "systemBaseUrl": "string",
  • "anonymousAccess": true,
  • "naturalTextQueries": true,
  • "openAiModel": "O3_MINI"
}

Status

Get status

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "httpStatus": "100 CONTINUE",
  • "httpStatusCode": 0,
  • "statusCode": 0,
  • "errorCode": "OK",
  • "message": "string",
  • "messageKey": "string",
  • "devMessage": "string",
  • "data": { }
}

Reports

Get data pipeline config report in JSON

Responses

Response samples

Content type
application/json
{
  • "table": "string",
  • "metaData": {
    },
  • "title": "string",
  • "headers": [
    ],
  • "rows": [
    ],
  • "subtitle": "string",
  • "height": 0,
  • "visibleHeaders": [
    ],
  • "width": 0,
  • "visibleWidth": 0,
  • "visibleRows": [
    ],
  • "metaColumnIndexes": [
    ]
}

Get data pipeline config report in HTML

Responses

Get data pipeline config report in CSV

Responses

Context

Get context

Responses

Response samples

Content type
application/json
{
  • "visualizationEnabled": true,
  • "visualizationUrl": "string"
}

Connection info

Get connection info

Responses

Response samples

Content type
application/json
{
  • "client": "string",
  • "cloudProvider": "AWS_REDSHIFT",
  • "hostname": "string",
  • "port": 0,
  • "database": "string",
  • "username": "string",
  • "container": "string",
  • "blobStoreKey": "string",
  • "blobStoreProvider": "FILESYSTEM",
  • "blobStoreName": "string",
  • "dataWarehouseName": "string",
  • "cloudProviderName": "string",
  • "dataWarehouseKey": "REDSHIFT"
}