get_datasource_details

DatasourcesApi.get_datasource_details(datasource_id, role_id, projection_expression=None, request_type=None, entity_type=None, api_version=None, action=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get datasource details

Returns a single datasource’s details (view access required). Use action=get-ca-upload-url for a DMS CA certificate upload presigned URL. Use request_type=get_dependent_resources, get_entity_info, or get_rules_config for alternate payloads. For saas datasources, request_type may also be mappings, list_connector_entities, or describe_connector_entity (entity_type required for describe_connector_entity; api_version required when IngestionType is customconnector).

Parameters:

  • datasource_id (str) – (required)

  • role_id (str) – (required)

  • projection_expression (str) – Comma-separated attributes to include in the default details response.

  • request_type (str) – Alternate response type such as get_dependent_resources, get_entity_info, get_rules_config, or saas values mappings, list_connector_entities, describe_connector_entity. When omitted, returns datasource details.

  • entity_type (str) – Required when request_type=describe_connector_entity for saas datasources. Optional entitiesPath for list_connector_entities.

  • api_version (str) – AppFlow API version for saas connector entity requests. Required when the saas datasource IngestionType is customconnector.

  • action (str) – Optional action. Use get-ca-upload-url to return a CA upload presigned URL and DatasourceId.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

GetDatasourceDetails200Response

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /datasources/{datasource_id}

Success (HTTP 200)

Successfully returns datasource details or an alternate payload based on action/request_type.

Errors

HTTP 400

Invalid input parameters

HTTP 500

Something went wrong at backend