create_datasource_dataflow

DatasourcesApi.create_datasource_dataflow(datasource_id, role_id, datasource_flows_details, content_type=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create dataflows

Creates a dataflow for the datasource (edit access required). Supported types: jdbc bulkdataload, jdbc advanceddataload (not GovCloud), saas, streams, and arcgis. Request body shape varies by datasource type (DatasourceFlowsDetails). For jdbc bulkdataload, required fields include DataflowName, ProcessType, TargetLocation, DataflowConfig, and CreateDataset. Saas flows require DataflowName plus CreateDataset/DatasetDetails. Response includes Message and DataflowId.

Parameters:

  • datasource_id (str) – (required)

  • role_id (str) – (required)

  • datasource_flows_details (DatasourceFlowsDetails) – (required)

  • content_type (str)

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

DataflowCreateResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: POST /datasources/{datasource_id}/dataflows

Success (HTTP 200)

Successfully created the dataflow (or creation triggered in background)

Errors

HTTP 400

Missing required request parameters

HTTP 500

Something went wrong at backend