list_dataflows_by_datasource_id

DatasourcesApi.list_dataflows_by_datasource_id(datasource_id, role_id, projection_expression=None, filter_expression=None, limit=None, offset=None, sortorder=None, sortby=None, action=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get datasource flows: replication tasks, consumers, flows..

Returns paginated dataflows for a datasource (view access required). Supported types: jdbc bulkdataload, jdbc advanceddataload, saas, streams, and arcgis. For jdbc bulkdataload, action=get-presigned-url returns a presigned PUT URL string for uploading a large create payload. MetadataUpdateStatus and MetadataUpdateMessage are defaulted when absent.

Parameters:

  • datasource_id (str) – (required)

  • role_id (str) – (required)

  • projection_expression (str) – Comma-separated attributes to include on each dataflow item.

  • filter_expression (str) – Optional filter expression (applied for types that support it, e.g. arcgis against DataflowName).

  • limit (str) – Page size. Maximum 1000. Default is 100 for jdbc bulkdataload, jdbc advanceddataload, and saas; 500 for streams and arcgis.

  • offset (str) – 1-based page offset. Defaults to first page when omitted.

  • sortorder (str) – Sort order. Defaults to desc.

  • sortby (str) – Attribute to sort by. Defaults to LastModifiedTime.

  • action (str) – For jdbc bulkdataload, set to get-presigned-url to return a presigned PUT URL string for large dataflow create payloads.

  • _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:

ListDataflowsByDatasourceId200Response

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /datasources/{datasource_id}/dataflows

Success (HTTP 200)

Successfully returns datasource flows list, or a presigned URL string when action=get-presigned-url (bulkdataload).

Errors

HTTP 400

Invalid input parameters

HTTP 500

Something went wrong at backend