Skip to content

DataProviderCollApi.md

Latest commit

 

History

History
247 lines (168 loc) · 7.84 KB

DataProviderCollApi.md

File metadata and controls

247 lines (168 loc) · 7.84 KB
Raw

gateway_api_sdk.DataProviderCollApi

All URIs are relative to http://localhost

Method HTTP request Description
fetch_data_provider_coll GET /api/v1/data_provider_colls/{id} DataProviderColl@show
fetch_data_provider_coll_summary GET /api/v1/data_provider_colls/{id}/summary DataProviderColl@showSummary
fetch_data_provider_colls GET /api/v1/data_provider_colls DataProviderColl@index

fetch_data_provider_coll

FetchDataProviderColl200Response fetch_data_provider_coll(id)

DataProviderColl@show

Return a single DataProviderColl

Example

  • Bearer (JWT) Authentication (bearerAuth):
import gateway_api_sdk
from gateway_api_sdk.models.fetch_data_provider_coll200_response import FetchDataProviderColl200Response
from gateway_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gateway_api_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = gateway_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with gateway_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = gateway_api_sdk.DataProviderCollApi(api_client)
    id = 1 # int | DataProviderColl ID

    try:
        # DataProviderColl@show
        api_response = api_instance.fetch_data_provider_coll(id)
        print("The response of DataProviderCollApi->fetch_data_provider_coll:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataProviderCollApi->fetch_data_provider_coll: %s\n" % e)

Parameters

Name Type Description Notes
id int DataProviderColl ID

Return type

FetchDataProviderColl200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
404 Not found response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch_data_provider_coll_summary

FetchDataProviderCollSummary200Response fetch_data_provider_coll_summary(id)

DataProviderColl@showSummary

Return a single DataProviderColl - summary

Example

  • Bearer (JWT) Authentication (bearerAuth):
import gateway_api_sdk
from gateway_api_sdk.models.fetch_data_provider_coll_summary200_response import FetchDataProviderCollSummary200Response
from gateway_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gateway_api_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = gateway_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with gateway_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = gateway_api_sdk.DataProviderCollApi(api_client)
    id = 1 # int | DataProviderColl ID - summary

    try:
        # DataProviderColl@showSummary
        api_response = api_instance.fetch_data_provider_coll_summary(id)
        print("The response of DataProviderCollApi->fetch_data_provider_coll_summary:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataProviderCollApi->fetch_data_provider_coll_summary: %s\n" % e)

Parameters

Name Type Description Notes
id int DataProviderColl ID - summary

Return type

FetchDataProviderCollSummary200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
404 Not found response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch_data_provider_colls

FetchDataProviderColls200Response fetch_data_provider_colls(per_page=per_page)

DataProviderColl@index

Returns a list of DataProviderColls enabled on the system

Example

  • Bearer (JWT) Authentication (bearerAuth):
import gateway_api_sdk
from gateway_api_sdk.models.fetch_data_provider_colls200_response import FetchDataProviderColls200Response
from gateway_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gateway_api_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = gateway_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with gateway_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = gateway_api_sdk.DataProviderCollApi(api_client)
    per_page = 1 # int | per page (optional)

    try:
        # DataProviderColl@index
        api_response = api_instance.fetch_data_provider_colls(per_page=per_page)
        print("The response of DataProviderCollApi->fetch_data_provider_colls:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DataProviderCollApi->fetch_data_provider_colls: %s\n" % e)

Parameters

Name Type Description Notes
per_page int per page [optional]

Return type

FetchDataProviderColls200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -

[Back to top] [Back to API list] [Back to Model list] [Back to README]