GET api/v1/dataSources

List data source

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Filter

Filter records

ListDataSourceV1Filter

None.

Select

Select columns

Collection of ListDataSourceV1Select

Default value: All

Example value: Name, Description

Unique items

Sort

Sort records Sort by the first column, then by the second column, and so on

Collection of ListDataSourceV1Sort

Default value: Name

Example value: Name

Max items: 3

Unique items

PageNumber

Page number

integer (32 bits)

Default value: 1

Example value: 1

Range: inclusive between 1 and 2147483647

PageSize

Number of records per page

integer (32 bits)

Default value: 10

Example value: 10

Range: inclusive between 0 and 100

Body Parameters

None.

Response Information

Resource Description

Retrieve a list of data sources

ListDataSourceV1Response
NameDescriptionTypeAdditional information
DataSources

List of data sources

Collection of ListDataSourceV1ResponseDataSource

None.

Total

Total number of records matching the request

integer (32 bits)

Required

Example value: 42

Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample:
{
  "DataSources": [
    {
      "DataSourceId": "1223fbbb-4fa1-4361-afaf-14234fcf59c5",
      "Name": "Projects",
      "Description": "Data source for active customer projects",
      "Kind": "File",
      "BusinessGroupId": "23078dcd-a5ba-4cef-9af2-250758e395c2",
      "CanBeUploaded": true,
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
    },
    {
      "DataSourceId": "1223fbbb-4fa1-4361-afaf-14234fcf59c5",
      "Name": "Projects",
      "Description": "Data source for active customer projects",
      "Kind": "File",
      "BusinessGroupId": "23078dcd-a5ba-4cef-9af2-250758e395c2",
      "CanBeUploaded": true,
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
    }
  ],
  "Total": 42
}