GET Gestalt/api/data/datasources?filter={filter}

Gets the available data sources.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
filter

A comma-separated set of filters to apply to the search.

DataSourceSearchFilters

Default value is None

Body Parameters

None.

Response Information

Resource Description

The content of a successful response will be a list of data sources that the caller is authorised to access.

Collection of DataSourceConfiguration
NameDescriptionTypeAdditional information
Host

Gets or sets the remote host that the data source definition was downloaded from.

URI

None.

SupportedFeatures

Gets the features supported by the data source.

SupportedDriverFeatures

None.

Name

Gets or sets the component name.

ComponentName

Required

TypeName

Gets or sets the component type name.

string

Required

Description

Gets or sets the component description.

string

Max length: 100

Status

Gets the current component status.

ComponentStatus

None.

Settings

Gets or sets the component settings.

Collection of DataCoreConfigurationSetting

None.

Properties

Gets or sets the properties for the component.

Dictionary of string [key] and string [value]

None.

AuthorizationRules

Gets or sets the authorisation rules for the component.

Collection of AuthorizationRule

None.

Response Formats

application/json

Sample:
[
  {
    "Host": "http://webapihelppage1.com",
    "SupportedFeatures": 0,
    "Name": {
      "Name": "sample string 1",
      "Namespace": "sample string 2",
      "QualifiedName": "sample string 2.sample string 1",
      "DisplayName": "sample string 3",
      "Aliases": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "TypeName": "sample string 2",
    "Description": "sample string 3",
    "Status": {
      "RunningStatus": 0,
      "HealthStatus": {
        "IsHealthy": true,
        "Properties": []
      },
      "IsInitialised": false,
      "IsDisabled": false,
      "DebugMode": true,
      "UtcStartupTime": "2021-07-24T10:37:36.1967304+00:00",
      "UtcLastModified": "2021-07-24T10:37:36.1967304Z",
      "Uptime": "00:00:00.0312536",
      "Messages": [],
      "Properties": []
    },
    "Settings": [
      {
        "Category": "sample string 1",
        "Name": "sample string 2",
        "DisplayName": "sample string 3",
        "Description": "sample string 4",
        "HelpLink": "http://webapihelppage5.com",
        "RequiresEncryption": true,
        "TypeName": "sample string 7",
        "FriendlyTypeName": 0,
        "IsRequired": true,
        "DefaultValue": "sample string 9",
        "Value": "sample string 10",
        "IsValid": true,
        "ValidationMessages": [
          "sample string 1",
          "sample string 2"
        ],
        "PossibleValues": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "ValueSetOptions": 0,
        "DisplayIndex": 12
      },
      {
        "Category": "sample string 1",
        "Name": "sample string 2",
        "DisplayName": "sample string 3",
        "Description": "sample string 4",
        "HelpLink": "http://webapihelppage5.com",
        "RequiresEncryption": true,
        "TypeName": "sample string 7",
        "FriendlyTypeName": 0,
        "IsRequired": true,
        "DefaultValue": "sample string 9",
        "Value": "sample string 10",
        "IsValid": true,
        "ValidationMessages": [
          "sample string 1",
          "sample string 2"
        ],
        "PossibleValues": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "ValueSetOptions": 0,
        "DisplayIndex": 12
      }
    ],
    "Properties": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "AuthorizationRules": [
      {
        "AccessType": 0,
        "RoleName": "sample string 1",
        "Identity": "sample string 2",
        "Properties": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        }
      },
      {
        "AccessType": 0,
        "RoleName": "sample string 1",
        "Identity": "sample string 2",
        "Properties": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        }
      }
    ]
  },
  {
    "Host": "http://webapihelppage1.com",
    "SupportedFeatures": 0,
    "Name": {
      "Name": "sample string 1",
      "Namespace": "sample string 2",
      "QualifiedName": "sample string 2.sample string 1",
      "DisplayName": "sample string 3",
      "Aliases": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "TypeName": "sample string 2",
    "Description": "sample string 3",
    "Status": {
      "RunningStatus": 0,
      "HealthStatus": {
        "IsHealthy": true,
        "Properties": []
      },
      "IsInitialised": false,
      "IsDisabled": false,
      "DebugMode": true,
      "UtcStartupTime": "2021-07-24T10:37:36.1967304+00:00",
      "UtcLastModified": "2021-07-24T10:37:36.1967304Z",
      "Uptime": "00:00:00.0468639",
      "Messages": [],
      "Properties": []
    },
    "Settings": [
      {
        "Category": "sample string 1",
        "Name": "sample string 2",
        "DisplayName": "sample string 3",
        "Description": "sample string 4",
        "HelpLink": "http://webapihelppage5.com",
        "RequiresEncryption": true,
        "TypeName": "sample string 7",
        "FriendlyTypeName": 0,
        "IsRequired": true,
        "DefaultValue": "sample string 9",
        "Value": "sample string 10",
        "IsValid": true,
        "ValidationMessages": [
          "sample string 1",
          "sample string 2"
        ],
        "PossibleValues": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "ValueSetOptions": 0,
        "DisplayIndex": 12
      },
      {
        "Category": "sample string 1",
        "Name": "sample string 2",
        "DisplayName": "sample string 3",
        "Description": "sample string 4",
        "HelpLink": "http://webapihelppage5.com",
        "RequiresEncryption": true,
        "TypeName": "sample string 7",
        "FriendlyTypeName": 0,
        "IsRequired": true,
        "DefaultValue": "sample string 9",
        "Value": "sample string 10",
        "IsValid": true,
        "ValidationMessages": [
          "sample string 1",
          "sample string 2"
        ],
        "PossibleValues": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "ValueSetOptions": 0,
        "DisplayIndex": 12
      }
    ],
    "Properties": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "AuthorizationRules": [
      {
        "AccessType": 0,
        "RoleName": "sample string 1",
        "Identity": "sample string 2",
        "Properties": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        }
      },
      {
        "AccessType": 0,
        "RoleName": "sample string 1",
        "Identity": "sample string 2",
        "Properties": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        }
      }
    ]
  }
]

text/json

Sample:
[
  {
    "Host": "http://webapihelppage1.com",
    "SupportedFeatures": 0,
    "Name": {
      "Name": "sample string 1",
      "Namespace": "sample string 2",
      "QualifiedName": "sample string 2.sample string 1",
      "DisplayName": "sample string 3",
      "Aliases": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "TypeName": "sample string 2",
    "Description": "sample string 3",
    "Status": {
      "RunningStatus": 0,
      "HealthStatus": {
        "IsHealthy": true,
        "Properties": []
      },
      "IsInitialised": false,
      "IsDisabled": false,
      "DebugMode": true,
      "UtcStartupTime": "2021-07-24T10:37:36.1967304+00:00",
      "UtcLastModified": "2021-07-24T10:37:36.1967304Z",
      "Uptime": "00:00:00.0468639",
      "Messages": [],
      "Properties": []
    },
    "Settings": [
      {
        "Category": "sample string 1",
        "Name": "sample string 2",
        "DisplayName": "sample string 3",
        "Description": "sample string 4",
        "HelpLink": "http://webapihelppage5.com",
        "RequiresEncryption": true,
        "TypeName": "sample string 7",
        "FriendlyTypeName": 0,
        "IsRequired": true,
        "DefaultValue": "sample string 9",
        "Value": "sample string 10",
        "IsValid": true,
        "ValidationMessages": [
          "sample string 1",
          "sample string 2"
        ],
        "PossibleValues": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "ValueSetOptions": 0,
        "DisplayIndex": 12
      },
      {
        "Category": "sample string 1",
        "Name": "sample string 2",
        "DisplayName": "sample string 3",
        "Description": "sample string 4",
        "HelpLink": "http://webapihelppage5.com",
        "RequiresEncryption": true,
        "TypeName": "sample string 7",
        "FriendlyTypeName": 0,
        "IsRequired": true,
        "DefaultValue": "sample string 9",
        "Value": "sample string 10",
        "IsValid": true,
        "ValidationMessages": [
          "sample string 1",
          "sample string 2"
        ],
        "PossibleValues": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "ValueSetOptions": 0,
        "DisplayIndex": 12
      }
    ],
    "Properties": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "AuthorizationRules": [
      {
        "AccessType": 0,
        "RoleName": "sample string 1",
        "Identity": "sample string 2",
        "Properties": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        }
      },
      {
        "AccessType": 0,
        "RoleName": "sample string 1",
        "Identity": "sample string 2",
        "Properties": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        }
      }
    ]
  },
  {
    "Host": "http://webapihelppage1.com",
    "SupportedFeatures": 0,
    "Name": {
      "Name": "sample string 1",
      "Namespace": "sample string 2",
      "QualifiedName": "sample string 2.sample string 1",
      "DisplayName": "sample string 3",
      "Aliases": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "TypeName": "sample string 2",
    "Description": "sample string 3",
    "Status": {
      "RunningStatus": 0,
      "HealthStatus": {
        "IsHealthy": true,
        "Properties": []
      },
      "IsInitialised": false,
      "IsDisabled": false,
      "DebugMode": true,
      "UtcStartupTime": "2021-07-24T10:37:36.1967304+00:00",
      "UtcLastModified": "2021-07-24T10:37:36.1967304Z",
      "Uptime": "00:00:00.0468639",
      "Messages": [],
      "Properties": []
    },
    "Settings": [
      {
        "Category": "sample string 1",
        "Name": "sample string 2",
        "DisplayName": "sample string 3",
        "Description": "sample string 4",
        "HelpLink": "http://webapihelppage5.com",
        "RequiresEncryption": true,
        "TypeName": "sample string 7",
        "FriendlyTypeName": 0,
        "IsRequired": true,
        "DefaultValue": "sample string 9",
        "Value": "sample string 10",
        "IsValid": true,
        "ValidationMessages": [
          "sample string 1",
          "sample string 2"
        ],
        "PossibleValues": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "ValueSetOptions": 0,
        "DisplayIndex": 12
      },
      {
        "Category": "sample string 1",
        "Name": "sample string 2",
        "DisplayName": "sample string 3",
        "Description": "sample string 4",
        "HelpLink": "http://webapihelppage5.com",
        "RequiresEncryption": true,
        "TypeName": "sample string 7",
        "FriendlyTypeName": 0,
        "IsRequired": true,
        "DefaultValue": "sample string 9",
        "Value": "sample string 10",
        "IsValid": true,
        "ValidationMessages": [
          "sample string 1",
          "sample string 2"
        ],
        "PossibleValues": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "ValueSetOptions": 0,
        "DisplayIndex": 12
      }
    ],
    "Properties": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "AuthorizationRules": [
      {
        "AccessType": 0,
        "RoleName": "sample string 1",
        "Identity": "sample string 2",
        "Properties": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        }
      },
      {
        "AccessType": 0,
        "RoleName": "sample string 1",
        "Identity": "sample string 2",
        "Properties": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        }
      }
    ]
  }
]