Skip to content

IntegrationApi.md

Latest commit

 

History

History
514 lines (360 loc) · 15.1 KB

IntegrationApi.md

File metadata and controls

514 lines (360 loc) · 15.1 KB

lookerapi.IntegrationApi

All URIs are relative to https://demo.looker.com:19999/api/3.0

Method HTTP request Description
accept_integration_hub_legal_agreement POST /integration_hubs/{integration_hub_id}/accept_legal_agreement Accept Integration Hub Legal Agreement
all_integration_hubs GET /integration_hubs Get All Integration Hubs
all_integrations GET /integrations Get All Integrations
create_integration_hub POST /integration_hubs Create Integration Hub
delete_integration_hub DELETE /integration_hubs/{integration_hub_id} Delete Integration Hub
fetch_integration_form POST /integrations/{integration_id}/form Fetch Remote Integration Form
integration GET /integrations/{integration_id} Get Integration
integration_hub GET /integration_hubs/{integration_hub_id} Get Integration Hub
update_integration PATCH /integrations/{integration_id} Update Integration
update_integration_hub PATCH /integration_hubs/{integration_hub_id} Update Integration Hub

accept_integration_hub_legal_agreement

IntegrationHub accept_integration_hub_legal_agreement(integration_hub_id)

Accept Integration Hub Legal Agreement

Accepts the legal agreement for a given integration hub. This only works for integration hubs that have legal_agreement_required set to true and legal_agreement_signed set to false.

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.IntegrationApi()
integration_hub_id = 789 # int | Id of integration_hub

try: 
    # Accept Integration Hub Legal Agreement
    api_response = api_instance.accept_integration_hub_legal_agreement(integration_hub_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->accept_integration_hub_legal_agreement: %s\n" % e)

Parameters

Name Type Description Notes
integration_hub_id int Id of integration_hub

Return type

IntegrationHub

Authorization

No authorization required

HTTP request headers

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

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

all_integration_hubs

list[IntegrationHub] all_integration_hubs(fields=fields)

Get All Integration Hubs

Get information about all Integration Hubs.

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.IntegrationApi()
fields = 'fields_example' # str | Requested fields. (optional)

try: 
    # Get All Integration Hubs
    api_response = api_instance.all_integration_hubs(fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->all_integration_hubs: %s\n" % e)

Parameters

Name Type Description Notes
fields str Requested fields. [optional]

Return type

list[IntegrationHub]

Authorization

No authorization required

HTTP request headers

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

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

all_integrations

list[Integration] all_integrations(fields=fields, integration_hub_id=integration_hub_id)

Get All Integrations

Get information about all Integrations.

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.IntegrationApi()
fields = 'fields_example' # str | Requested fields. (optional)
integration_hub_id = 'integration_hub_id_example' # str | Filter to a specific provider (optional)

try: 
    # Get All Integrations
    api_response = api_instance.all_integrations(fields=fields, integration_hub_id=integration_hub_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->all_integrations: %s\n" % e)

Parameters

Name Type Description Notes
fields str Requested fields. [optional]
integration_hub_id str Filter to a specific provider [optional]

Return type

list[Integration]

Authorization

No authorization required

HTTP request headers

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

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

create_integration_hub

IntegrationHub create_integration_hub(body=body, fields=fields)

Create Integration Hub

Create a new Integration Hub.

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.IntegrationApi()
body = lookerapi.IntegrationHub() # IntegrationHub | Integration Hub (optional)
fields = 'fields_example' # str | Requested fields. (optional)

try: 
    # Create Integration Hub
    api_response = api_instance.create_integration_hub(body=body, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->create_integration_hub: %s\n" % e)

Parameters

Name Type Description Notes
body IntegrationHub Integration Hub [optional]
fields str Requested fields. [optional]

Return type

IntegrationHub

Authorization

No authorization required

HTTP request headers

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

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

delete_integration_hub

str delete_integration_hub(integration_hub_id)

Delete Integration Hub

Delete a Integration Hub.

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.IntegrationApi()
integration_hub_id = 789 # int | Id of integration_hub

try: 
    # Delete Integration Hub
    api_response = api_instance.delete_integration_hub(integration_hub_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->delete_integration_hub: %s\n" % e)

Parameters

Name Type Description Notes
integration_hub_id int Id of integration_hub

Return type

str

Authorization

No authorization required

HTTP request headers

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

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

fetch_integration_form

DataActionForm fetch_integration_form(integration_id)

Fetch Remote Integration Form

Returns the Integration form for presentation to the user.

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.IntegrationApi()
integration_id = 789 # int | Id of Integration

try: 
    # Fetch Remote Integration Form
    api_response = api_instance.fetch_integration_form(integration_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->fetch_integration_form: %s\n" % e)

Parameters

Name Type Description Notes
integration_id int Id of Integration

Return type

DataActionForm

Authorization

No authorization required

HTTP request headers

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

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

integration

Integration integration(integration_id, fields=fields)

Get Integration

Get information about a Integration.

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.IntegrationApi()
integration_id = 789 # int | Id of Integration
fields = 'fields_example' # str | Requested fields. (optional)

try: 
    # Get Integration
    api_response = api_instance.integration(integration_id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->integration: %s\n" % e)

Parameters

Name Type Description Notes
integration_id int Id of Integration
fields str Requested fields. [optional]

Return type

Integration

Authorization

No authorization required

HTTP request headers

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

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

integration_hub

IntegrationHub integration_hub(integration_hub_id, fields=fields)

Get Integration Hub

Get information about a Integration Hub.

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.IntegrationApi()
integration_hub_id = 789 # int | Id of Integration Hub
fields = 'fields_example' # str | Requested fields. (optional)

try: 
    # Get Integration Hub
    api_response = api_instance.integration_hub(integration_hub_id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->integration_hub: %s\n" % e)

Parameters

Name Type Description Notes
integration_hub_id int Id of Integration Hub
fields str Requested fields. [optional]

Return type

IntegrationHub

Authorization

No authorization required

HTTP request headers

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

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

update_integration

Integration update_integration(integration_id, body, fields=fields)

Update Integration

Update parameters on a Integration.

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.IntegrationApi()
integration_id = 789 # int | Id of Integration
body = lookerapi.Integration() # Integration | Integration
fields = 'fields_example' # str | Requested fields. (optional)

try: 
    # Update Integration
    api_response = api_instance.update_integration(integration_id, body, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->update_integration: %s\n" % e)

Parameters

Name Type Description Notes
integration_id int Id of Integration
body Integration Integration
fields str Requested fields. [optional]

Return type

Integration

Authorization

No authorization required

HTTP request headers

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

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

update_integration_hub

IntegrationHub update_integration_hub(integration_hub_id, body, fields=fields)

Update Integration Hub

Update a Integration Hub definition.

Example

from __future__ import print_statement
import time
import lookerapi
from lookerapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = lookerapi.IntegrationApi()
integration_hub_id = 789 # int | Id of Integration Hub
body = lookerapi.IntegrationHub() # IntegrationHub | Integration Hub
fields = 'fields_example' # str | Requested fields. (optional)

try: 
    # Update Integration Hub
    api_response = api_instance.update_integration_hub(integration_hub_id, body, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->update_integration_hub: %s\n" % e)

Parameters

Name Type Description Notes
integration_hub_id int Id of Integration Hub
body IntegrationHub Integration Hub
fields str Requested fields. [optional]

Return type

IntegrationHub

Authorization

No authorization required

HTTP request headers

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

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