Skip to content

@sourceloop/reporting-service v0.7.6

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

reporting-service

Base URLs:

Email: Sourav Bhargava

DashboardController

DashboardController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/dashboards/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/dashboards/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /dashboards/count

Permissions
ViewDashboardList

Parameters

Name In Type Required Description
filter query dashboards.Filter false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Count Dashboard Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» count number false none none

DashboardController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const inputBody = '{}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/dashboards/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');
const inputBody = {};
const headers = {
  'Content-Type':'application/json'
};

fetch('/dashboards/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /dashboards/{id}

Permissions
UpdateDashboard

Body parameter

1
{}

Parameters

Name In Type Required Description
id path string true none
body body object false none

Responses

Status Meaning Description Schema
204 No Content Dashboard PATCH success None

DashboardController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/dashboards/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/dashboards/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /dashboards/{id}

Permissions
ViewDashboard

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "description": "string",
  "layout": {},
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Dashboard model instance Dashboard

DashboardController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
fetch('/dashboards/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
const fetch = require('node-fetch');

fetch('/dashboards/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /dashboards/{id}

Permissions
DeleteDashboard

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content Dashboard DELETE success None

DashboardController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
const inputBody = '{
  "name": "string",
  "description": "string",
  "layout": {},
  "widgetIds": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/dashboards',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
const fetch = require('node-fetch');
const inputBody = {
  "name": "string",
  "description": "string",
  "layout": {},
  "widgetIds": [
    "string"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/dashboards',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /dashboards

Permissions
CreateDashboard

Body parameter

1
2
3
4
5
6
7
8
{
  "name": "string",
  "description": "string",
  "layout": {},
  "widgetIds": [
    "string"
  ]
}

Parameters

Name In Type Required Description
body body NewDashboard false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "description": "string",
  "layout": {},
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Dashboard model instance Dashboard

DashboardController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/dashboards',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/dashboards',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /dashboards

Permissions
ViewDashboardList

Parameters

Name In Type Required Description
filter query dashboards.Filter false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "description": "string",
  "layout": {},
  "extId": "string",
  "extMetadata": {},
  "widgets": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "datasetId": "string",
      "visualizationType": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Array of Dashboard model instances DashboardWithRelations

DataSetsController

DataSetsController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/data-sets/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/data-sets/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /data-sets/count

Permissions
ViewDataSetsList

Parameters

Name In Type Required Description
filter query data_sets.Filter false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK API to get the count of DataSets loopback.Count

DataSetsController.fetchDataByIdCount

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/data-sets/{id}/fetch-data/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/data-sets/{id}/fetch-data/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /data-sets/{id}/fetch-data/count

Permissions
FetchDataFromDataSet

Parameters

Name In Type Required Description
id path string true none
filter query string false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK API to fetch count of data from a data set based on ID loopback.Count

DataSetsController.fetchDataById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/data-sets/{id}/fetch-data',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/data-sets/{id}/fetch-data',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /data-sets/{id}/fetch-data

Permissions
FetchDataFromDataSet

Parameters

Name In Type Required Description
id path string true none
filter query object false none

Example responses

Responses

Status Meaning Description Schema
200 OK API to fetch data from a data set based on ID None

Response Schema

DataSetsController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "dataSetQuery": {},
  "dataSetQueryHash": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/data-sets/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "dataSetQuery": {},
  "dataSetQueryHash": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/data-sets/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /data-sets/{id}

Permissions
UpdateDataSets

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "dataSetQuery": {},
  "dataSetQueryHash": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
id path string true none
body body updateDataSet false none

Example responses

Responses

Status Meaning Description Schema
200 OK API to update Data Set based on ID None

Response Schema

DataSetsController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/data-sets/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/data-sets/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /data-sets/{id}

Permissions
ViewDataSets

Parameters

Name In Type Required Description
id path string true none

Example responses

Responses

Status Meaning Description Schema
200 OK API to fetch info for a particular data set based on ID None

Response Schema

DataSetsController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/data-sets/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/data-sets/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /data-sets/{id}

Permissions
DeleteDataSets

Parameters

Name In Type Required Description
id path string true none

Example responses

Responses

Status Meaning Description Schema
200 OK Delete a given Data Set based on ID None

Response Schema

DataSetsController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "name": "string",
  "dataSetQuery": {},
  "dataSetQueryHash": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/data-sets',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "name": "string",
  "dataSetQuery": {},
  "dataSetQueryHash": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/data-sets',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /data-sets

Permissions
CreateDataSets

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "name": "string",
  "dataSetQuery": {},
  "dataSetQueryHash": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
body body NewDataSet false none

Example responses

Responses

Status Meaning Description Schema
200 OK API to create a new DataSet None

Response Schema

DataSetsController.getDataSets

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/data-sets',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/data-sets',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /data-sets

Permissions
ViewDataSetsList

Parameters

Name In Type Required Description
filter query data_sets.Filter false none

Example responses

Responses

Status Meaning Description Schema
200 OK API to get list of all data sets None

Response Schema

DataSourcesController

DataSourcesController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/data-sources/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/data-sources/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /data-sources/count

Permissions
ViewDataSources

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK data sources model count loopback.Count

DataSourcesController.findBydataSourceName

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/data-sources/{dataSource}/columns',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/data-sources/{dataSource}/columns',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /data-sources/{dataSource}/columns

Permissions
ViewDataSourcesColumns

Parameters

Name In Type Required Description
dataSource path string true none

Example responses

200 Response

1
2
3
4
5
6
7
8
9
[
  {
    "columnName": "string",
    "dataSourceName": "string",
    "displayName": "string",
    "originalDataType": "string",
    "dataType": "String"
  }
]

Responses

Status Meaning Description Schema
200 OK List of columns for the specified data source Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ColumnForDataSourceModel] false none [Schema for ColumnForDataSource]
» ColumnForDataSourceModel ColumnForDataSourceModel false none Schema for ColumnForDataSource
»» columnName string false none The name of the column
»» dataSourceName string false none Name of the data source
»» displayName string false none Display name of the column
»» originalDataType string false none Original data type of the column
»» dataType string false none Data type of the column

Enumerated Values

Property Value
dataType String
dataType Number
dataType Boolean
dataType Array
dataType Object
dataType Json
dataType Date
dataType Unknown

DataSourcesController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/data-sources',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/data-sources',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /data-sources

Permissions
ViewDataSources

Example responses

200 Response

1
2
3
4
5
6
[
  {
    "dataSourceName": "string",
    "displayName": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK List of data-sources Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» dataSourceName string false none none
» displayName string false none none

IngestionMappingsController

IngestionMappingsController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/ingestion-mapping/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/ingestion-mapping/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /ingestion-mapping/count

Permissions
ViewIngestionMappings

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Ingestion mapping model count loopback.Count

IngestionMappingsController.update

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
const inputBody = '{
  "dataSourceName": "string",
  "recordType": "string",
  "primaryColumn": "string",
  "columnTransformations": {
    "property1": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    },
    "property2": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    }
  },
  "permissions": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/ingestion-mapping/{dataSource}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
const fetch = require('node-fetch');
const inputBody = {
  "dataSourceName": "string",
  "recordType": "string",
  "primaryColumn": "string",
  "columnTransformations": {
    "property1": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    },
    "property2": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    }
  },
  "permissions": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/ingestion-mapping/{dataSource}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /ingestion-mapping/{dataSource}

Permissions
UpdateIngestionMappings

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "dataSourceName": "string",
  "recordType": "string",
  "primaryColumn": "string",
  "columnTransformations": {
    "property1": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    },
    "property2": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    }
  },
  "permissions": {}
}

Parameters

Name In Type Required Description
dataSource path string true none
body body IngestionMappingPartial false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "dataSourceName": "string",
  "recordType": "string",
  "primaryColumn": "string",
  "columnTransformations": {
    "property1": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    },
    "property2": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    }
  },
  "permissions": {}
}

Responses

Status Meaning Description Schema
200 OK Update a mapping for data ingestion IngestionMapping

IngestionMappingsController.get

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/ingestion-mapping/{dataSource}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/ingestion-mapping/{dataSource}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /ingestion-mapping/{dataSource}

Permissions
ViewIngestionMapping

Parameters

Name In Type Required Description
dataSource path string true none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "dataSourceName": "string",
  "recordType": "string",
  "primaryColumn": "string",
  "columnTransformations": {
    "property1": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    },
    "property2": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    }
  },
  "permissions": {}
}

Responses

Status Meaning Description Schema
200 OK Get a mapping for data ingestion IngestionMapping

IngestionMappingsController.delete

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/ingestion-mapping/{dataSource}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/ingestion-mapping/{dataSource}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /ingestion-mapping/{dataSource}

Permissions
DeleteIngestionMappings

Parameters

Name In Type Required Description
dataSource path string true none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "dataSourceName": "string",
  "recordType": "string",
  "primaryColumn": "string",
  "columnTransformations": {
    "property1": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    },
    "property2": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    }
  },
  "permissions": {}
}

Responses

Status Meaning Description Schema
200 OK Delete a mapping for data ingestion IngestionMapping

IngestionMappingsController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
const inputBody = '{
  "dataSourceName": "string",
  "recordType": "string",
  "primaryColumn": "string",
  "columnTransformations": {
    "property1": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    },
    "property2": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    }
  },
  "permissions": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/ingestion-mapping',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
const fetch = require('node-fetch');
const inputBody = {
  "dataSourceName": "string",
  "recordType": "string",
  "primaryColumn": "string",
  "columnTransformations": {
    "property1": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    },
    "property2": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    }
  },
  "permissions": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/ingestion-mapping',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /ingestion-mapping

Permissions
CreateIngestionMappings

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "dataSourceName": "string",
  "recordType": "string",
  "primaryColumn": "string",
  "columnTransformations": {
    "property1": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    },
    "property2": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    }
  },
  "permissions": {}
}

Parameters

Name In Type Required Description
body body IngestionMapping false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "dataSourceName": "string",
  "recordType": "string",
  "primaryColumn": "string",
  "columnTransformations": {
    "property1": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    },
    "property2": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    }
  },
  "permissions": {}
}

Responses

Status Meaning Description Schema
200 OK Create a new mapping for data ingestion IngestionMapping

IngestionMappingsController.getAll

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/ingestion-mapping',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/ingestion-mapping',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /ingestion-mapping

Permissions
ViewIngestionMappings

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "dataSourceName": "string",
  "recordType": "string",
  "primaryColumn": "string",
  "columnTransformations": {
    "property1": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    },
    "property2": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    }
  },
  "permissions": {}
}

Responses

Status Meaning Description Schema
200 OK Get a list of mapping for data ingestion IngestionMapping

StateTrackingController

StateTrackingController.findAllRecords

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/state-tracking/all/{recordType}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/state-tracking/all/{recordType}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /state-tracking/all/{recordType}

Permissions
DeleteIngestionMappings

Parameters

Name In Type Required Description
recordType path string true none
skip query number false none
limit query number false none
recordId query string false none

Example responses

200 Response

1
2
3
4
5
6
7
8
9
{
  "id": "string",
  "state": "string",
  "payload": "string",
  "recordType": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "error": "string",
  "recordId": "string"
}

Responses

Status Meaning Description Schema
200 OK Find all StateTracking by recordType StateTracking

StateTrackingController.countRecords

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/state-tracking/count/{recordType}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/state-tracking/count/{recordType}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /state-tracking/count/{recordType}

Permissions
DeleteIngestionMappings

Parameters

Name In Type Required Description
recordType path string true none
recordId query string false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Count StateTracking by recordType Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» count number false none none

StateTrackingController.findLatestRecord

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/state-tracking/latest/{recordType}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/state-tracking/latest/{recordType}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /state-tracking/latest/{recordType}

Permissions
DeleteIngestionMappings

Parameters

Name In Type Required Description
recordType path string true none
recordId query string false none

Example responses

200 Response

1
2
3
4
5
6
7
8
9
{
  "id": "string",
  "state": "string",
  "payload": "string",
  "recordType": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "error": "string",
  "recordId": "string"
}

Responses

Status Meaning Description Schema
200 OK Find latest StateTracking by recordType StateTracking

WidgetController

WidgetController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/widgets/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/widgets/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /widgets/count

Permissions
ViewWidgetList

Parameters

Name In Type Required Description
filter query widgets.Filter false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Count Widgets Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» count number false none none

WidgetController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const inputBody = '{}';
const headers = {
  'Content-Type':'application/json'
};

fetch('/widgets/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');
const inputBody = {};
const headers = {
  'Content-Type':'application/json'
};

fetch('/widgets/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /widgets/{id}

Permissions
UpdateWidget

Body parameter

1
{}

Parameters

Name In Type Required Description
id path string true none
body body object false none

Responses

Status Meaning Description Schema
204 No Content Widget PATCH success None

WidgetController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/widgets/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/widgets/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /widgets/{id}

Permissions
ViewWidget

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "datasetId": "string",
  "visualizationType": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Widget model instance Widget

WidgetController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
fetch('/widgets/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
const fetch = require('node-fetch');

fetch('/widgets/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /widgets/{id}

Permissions
DeleteWidget

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content Widget DELETE success None

WidgetController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "name": "string",
  "datasetId": "string",
  "visualizationType": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/widgets',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "name": "string",
  "datasetId": "string",
  "visualizationType": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/widgets',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /widgets

Permissions
CreateWidget

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "name": "string",
  "datasetId": "string",
  "visualizationType": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
body body new Widget false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "datasetId": "string",
  "visualizationType": "string",
  "extId": "string",
  "extMetadata": {}
}

Responses

Status Meaning Description Schema
200 OK Widget model instance Widget

WidgetController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/widgets',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/widgets',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /widgets

Permissions
ViewWidgetList

Parameters

Name In Type Required Description
filter query widgets.Filter false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "name": "string",
    "datasetId": "string",
    "visualizationType": "string",
    "extId": "string",
    "extMetadata": {}
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Widget model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Widget] false none [This model represents a widget]
» Widget Widget false none This model represents a widget
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none The unique identifier for a widget
»» name string false none The name of the widget
»» datasetId string true none The id of the dataset that is to be used for the widget
»» visualizationType string false none The type of visualization to be used for the widget
»» extId string false none The external id of the widget
»» extMetadata object false none The external metadata of the widget

Schemas

NewDataSet

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "name": "string",
  "dataSetQuery": {},
  "dataSetQueryHash": "string",
  "extId": "string",
  "extMetadata": {}
}

NewDataSet

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
name string true none The name of the data set
dataSetQuery object true none The query for the data set refer to StructuredQueryInterface
dataSetQueryHash string false none The hash of the query for the data set
extId string false none The external id of the data set
extMetadata object false none The external metadata of the data set

updateDataSet

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "dataSetQuery": {},
  "dataSetQueryHash": "string",
  "extId": "string",
  "extMetadata": {}
}

updateDataSet

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none The unique identifier for a data set
name string false none The name of the data set
dataSetQuery object false none The query for the data set refer to StructuredQueryInterface
dataSetQueryHash string false none The hash of the query for the data set
extId string false none The external id of the data set
extMetadata object false none The external metadata of the data set

DataSet

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "dataSetQuery": {},
  "dataSetQueryHash": "string",
  "extId": "string",
  "extMetadata": {}
}

DataSet

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none The unique identifier for a data set
name string true none The name of the data set
dataSetQuery object true none The query for the data set refer to StructuredQueryInterface
dataSetQueryHash string false none The hash of the query for the data set
extId string false none The external id of the data set
extMetadata object false none The external metadata of the data set

IngestionMapping

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "dataSourceName": "string",
  "recordType": "string",
  "primaryColumn": "string",
  "columnTransformations": {
    "property1": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    },
    "property2": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    }
  },
  "permissions": {}
}

IngestionMapping

Properties

Name Type Required Restrictions Description
dataSourceName string true none The datasource name for the ingestion mapping
recordType string true none The record type for the ingestion mapping
primaryColumn string true none The primary column for the ingestion mapping
columnTransformations object false none The column transformations for the ingestion mapping, refer to ColumnMappings interface
» additionalProperties object false none none
»» typeConversion object false none none
»»» expectedType string false none none
»»» dataStoreKey string false none none
»»» customHandler string false none none
»»» ConversionOptions object false none none
»» dataStoreKey string false none none
»» skip boolean false none none
permissions object false none The permissions for the ingestion mapping

IngestionMappingPartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "dataSourceName": "string",
  "recordType": "string",
  "primaryColumn": "string",
  "columnTransformations": {
    "property1": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    },
    "property2": {
      "typeConversion": {
        "expectedType": "string",
        "dataStoreKey": "string",
        "customHandler": "string",
        "ConversionOptions": {}
      },
      "dataStoreKey": "string",
      "skip": true
    }
  },
  "permissions": {}
}

IngestionMappingPartial

Properties

Name Type Required Restrictions Description
dataSourceName string false none The datasource name for the ingestion mapping
recordType string false none The record type for the ingestion mapping
primaryColumn string false none The primary column for the ingestion mapping
columnTransformations object false none The column transformations for the ingestion mapping, refer to ColumnMappings interface
» additionalProperties object false none none
»» typeConversion object false none none
»»» expectedType string false none none
»»» dataStoreKey string false none none
»»» customHandler string false none none
»»» ConversionOptions object false none none
»» dataStoreKey string false none none
»» skip boolean false none none
permissions object false none The permissions for the ingestion mapping

ColumnForDataSourceModel

1
2
3
4
5
6
7
{
  "columnName": "string",
  "dataSourceName": "string",
  "displayName": "string",
  "originalDataType": "string",
  "dataType": "String"
}

ColumnForDataSourceModel

Properties

Name Type Required Restrictions Description
columnName string false none The name of the column
dataSourceName string false none Name of the data source
displayName string false none Display name of the column
originalDataType string false none Original data type of the column
dataType string false none Data type of the column

Enumerated Values

Property Value
dataType String
dataType Number
dataType Boolean
dataType Array
dataType Object
dataType Json
dataType Date
dataType Unknown

StateTracking

1
2
3
4
5
6
7
8
9
{
  "id": "string",
  "state": "string",
  "payload": "string",
  "recordType": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "error": "string",
  "recordId": "string"
}

StateTracking

Properties

Name Type Required Restrictions Description
id string false none The unique identifier for a state tracking
state string true none The state of the ingested data
payload string false none The payload of the ingested data
recordType string true none The type of the ingested data
timestamp string(date-time) true none The timestamp of the ingested data
error string false none The error of the ingested data if any
recordId string true none The id of the ingested data

Widget

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "datasetId": "string",
  "visualizationType": "string",
  "extId": "string",
  "extMetadata": {}
}

Widget

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none The unique identifier for a widget
name string false none The name of the widget
datasetId string true none The id of the dataset that is to be used for the widget
visualizationType string false none The type of visualization to be used for the widget
extId string false none The external id of the widget
extMetadata object false none The external metadata of the widget

new Widget

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "name": "string",
  "datasetId": "string",
  "visualizationType": "string",
  "extId": "string",
  "extMetadata": {}
}

new Widget

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
name string false none The name of the widget
datasetId string true none The id of the dataset that is to be used for the widget
visualizationType string false none The type of visualization to be used for the widget
extId string false none The external id of the widget
extMetadata object false none The external metadata of the widget

Dashboard

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "description": "string",
  "layout": {},
  "extId": "string",
  "extMetadata": {}
}

Dashboard

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none The unique identifier for a dashboard
name string true none The name of the dashboard
description string false none The description of the dashboard
layout object false none The layout of the dashboard
extId string false none The external id of the dashboard
extMetadata object false none The external metadata of the dashboard

NewDashboard

1
2
3
4
5
6
7
8
{
  "name": "string",
  "description": "string",
  "layout": {},
  "widgetIds": [
    "string"
  ]
}

NewDashboard

Properties

Name Type Required Restrictions Description
name string true none The name of the dashboard
description string false none The description of the dashboard
layout object false none The layout of the dashboard
widgetIds [string] false none none

CreateDashboardDto

1
2
3
4
5
6
7
8
{
  "name": "string",
  "description": "string",
  "layout": {},
  "widgetIds": [
    "string"
  ]
}

CreateDashboardDto

Properties

Name Type Required Restrictions Description
name string true none The name of the dashboard
description string false none The description of the dashboard
layout object false none The layout of the dashboard
widgetIds [string] false none none

WidgetWithRelations

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "datasetId": "string",
  "visualizationType": "string",
  "extId": "string",
  "extMetadata": {}
}

WidgetWithRelations

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none The unique identifier for a widget
name string false none The name of the widget
datasetId string true none The id of the dataset that is to be used for the widget
visualizationType string false none The type of visualization to be used for the widget
extId string false none The external id of the widget
extMetadata object false none The external metadata of the widget

DashboardWithRelations

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "description": "string",
  "layout": {},
  "extId": "string",
  "extMetadata": {},
  "widgets": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "datasetId": "string",
      "visualizationType": "string",
      "extId": "string",
      "extMetadata": {}
    }
  ]
}

DashboardWithRelations

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none The unique identifier for a dashboard
name string true none The name of the dashboard
description string false none The description of the dashboard
layout object false none The layout of the dashboard
extId string false none The external id of the dashboard
extMetadata object false none The external metadata of the dashboard
widgets [WidgetWithRelations] false none [This model represents a widget (tsType: WidgetWithRelations, schemaOptions: { includeRelations: true })]

dashboards.ScopeFilter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {},
  "include": [
    {}
  ]
}

dashboards.ScopeFilter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [object] false none none

dashboards.IncludeFilter.Items

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "relation": "widgets",
  "scope": {
    "offset": 0,
    "limit": 100,
    "skip": 0,
    "order": "string",
    "where": {},
    "fields": {},
    "include": [
      {}
    ]
  }
}

dashboards.IncludeFilter.Items

Properties

Name Type Required Restrictions Description
relation string false none none
scope dashboards.ScopeFilter false none none

Enumerated Values

Property Value
relation widgets

dashboards.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "name": true,
    "description": true,
    "layout": true,
    "extId": true,
    "extMetadata": true
  },
  "include": [
    {
      "relation": "widgets",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

dashboards.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» name boolean false none none
»» description boolean false none none
»» layout boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous dashboards.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

loopback.Count

1
2
3
{
  "count": 0
}

loopback.Count

Properties

Name Type Required Restrictions Description
count number false none none

data_sets.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "name": true,
    "dataSetQuery": true,
    "dataSetQueryHash": true,
    "extId": true,
    "extMetadata": true
  }
}

data_sets.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» name boolean false none none
»» dataSetQuery boolean false none none
»» dataSetQueryHash boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

widgets.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "name": true,
    "datasetId": true,
    "visualizationType": true,
    "extId": true,
    "extMetadata": true
  }
}

widgets.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» name boolean false none none
»» datasetId boolean false none none
»» visualizationType boolean false none none
»» extId boolean false none none
»» extMetadata boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none