Skip to content

Latest commit

 

History

History
executable file
·
554 lines (375 loc) · 13.7 KB

IntegrationApi.md

File metadata and controls

executable file
·
554 lines (375 loc) · 13.7 KB
Raw

LookerApi31Reference.IntegrationApi

All URIs are relative to /api/3.1

Method HTTP request Description
acceptIntegrationHubLegalAgreement POST /integration_hubs/{integration_hub_id}/accept_legal_agreement Accept Integration Hub Legal Agreement
allIntegrationHubs GET /integration_hubs Get All Integration Hubs
allIntegrations GET /integrations Get All Integrations
createIntegrationHub POST /integration_hubs Create Integration Hub
deleteIntegrationHub DELETE /integration_hubs/{integration_hub_id} Delete Integration Hub
fetchIntegrationForm POST /integrations/{integration_id}/form Fetch Remote Integration Form
integration GET /integrations/{integration_id} Get Integration
integrationHub GET /integration_hubs/{integration_hub_id} Get Integration Hub
testIntegration POST /integrations/{integration_id}/test Test integration
updateIntegration PATCH /integrations/{integration_id} Update Integration
updateIntegrationHub PATCH /integration_hubs/{integration_hub_id} Update Integration Hub

acceptIntegrationHubLegalAgreement

IntegrationHub acceptIntegrationHubLegalAgreement(integrationHubId)

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

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.IntegrationApi();

var integrationHubId = 789; // Number | Id of integration_hub


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.acceptIntegrationHubLegalAgreement(integrationHubId, callback);

Parameters

Name Type Description Notes
integrationHubId Number Id of integration_hub

Return type

IntegrationHub

Authorization

No authorization required

HTTP request headers

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

allIntegrationHubs

[IntegrationHub] allIntegrationHubs(opts)

Get All Integration Hubs

Get information about all Integration Hubs.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.IntegrationApi();

var opts = {
  'fields': "fields_example" // String | Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.allIntegrationHubs(opts, callback);

Parameters

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

Return type

[IntegrationHub]

Authorization

No authorization required

HTTP request headers

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

allIntegrations

[Integration] allIntegrations(opts)

Get All Integrations

Get information about all Integrations.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.IntegrationApi();

var opts = {
  'fields': "fields_example", // String | Requested fields.
  'integrationHubId': "integrationHubId_example" // String | Filter to a specific provider
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.allIntegrations(opts, callback);

Parameters

Name Type Description Notes
fields String Requested fields. [optional]
integrationHubId String Filter to a specific provider [optional]

Return type

[Integration]

Authorization

No authorization required

HTTP request headers

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

createIntegrationHub

IntegrationHub createIntegrationHub(opts)

Create Integration Hub

Create a new Integration Hub.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.IntegrationApi();

var opts = {
  'body': new LookerApi31Reference.IntegrationHub(), // IntegrationHub | Integration Hub
  'fields': "fields_example" // String | Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createIntegrationHub(opts, callback);

Parameters

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

Return type

IntegrationHub

Authorization

No authorization required

HTTP request headers

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

deleteIntegrationHub

'String' deleteIntegrationHub(integrationHubId)

Delete Integration Hub

Delete a Integration Hub.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.IntegrationApi();

var integrationHubId = 789; // Number | Id of integration_hub


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.deleteIntegrationHub(integrationHubId, callback);

Parameters

Name Type Description Notes
integrationHubId Number Id of integration_hub

Return type

'String'

Authorization

No authorization required

HTTP request headers

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

fetchIntegrationForm

DataActionForm fetchIntegrationForm(integrationId)

Fetch Remote Integration Form

Returns the Integration form for presentation to the user.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.IntegrationApi();

var integrationId = 789; // Number | Id of Integration


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.fetchIntegrationForm(integrationId, callback);

Parameters

Name Type Description Notes
integrationId Number Id of Integration

Return type

DataActionForm

Authorization

No authorization required

HTTP request headers

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

integration

Integration integration(integrationId, opts)

Get Integration

Get information about a Integration.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.IntegrationApi();

var integrationId = 789; // Number | Id of Integration

var opts = {
  'fields': "fields_example" // String | Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.integration(integrationId, opts, callback);

Parameters

Name Type Description Notes
integrationId Number Id of Integration
fields String Requested fields. [optional]

Return type

Integration

Authorization

No authorization required

HTTP request headers

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

integrationHub

IntegrationHub integrationHub(integrationHubId, opts)

Get Integration Hub

Get information about a Integration Hub.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.IntegrationApi();

var integrationHubId = 789; // Number | Id of Integration Hub

var opts = {
  'fields': "fields_example" // String | Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.integrationHub(integrationHubId, opts, callback);

Parameters

Name Type Description Notes
integrationHubId Number Id of Integration Hub
fields String Requested fields. [optional]

Return type

IntegrationHub

Authorization

No authorization required

HTTP request headers

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

testIntegration

IntegrationTestResult testIntegration(integrationId)

Test integration

Tests the integration to make sure all the settings are working.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.IntegrationApi();

var integrationId = 789; // Number | Id of Integration


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.testIntegration(integrationId, callback);

Parameters

Name Type Description Notes
integrationId Number Id of Integration

Return type

IntegrationTestResult

Authorization

No authorization required

HTTP request headers

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

updateIntegration

Integration updateIntegration(integrationId, body, opts)

Update Integration

Update parameters on a Integration.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.IntegrationApi();

var integrationId = 789; // Number | Id of Integration

var body = new LookerApi31Reference.Integration(); // Integration | Integration

var opts = {
  'fields': "fields_example" // String | Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateIntegration(integrationId, body, opts, callback);

Parameters

Name Type Description Notes
integrationId Number Id of Integration
body Integration Integration
fields String Requested fields. [optional]

Return type

Integration

Authorization

No authorization required

HTTP request headers

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

updateIntegrationHub

IntegrationHub updateIntegrationHub(integrationHubId, body, opts)

Update Integration Hub

Update a Integration Hub definition.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.IntegrationApi();

var integrationHubId = 789; // Number | Id of Integration Hub

var body = new LookerApi31Reference.IntegrationHub(); // IntegrationHub | Integration Hub

var opts = {
  'fields': "fields_example" // String | Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateIntegrationHub(integrationHubId, body, opts, callback);

Parameters

Name Type Description Notes
integrationHubId Number Id of Integration Hub
body IntegrationHub Integration Hub
fields String Requested fields. [optional]

Return type

IntegrationHub

Authorization

No authorization required

HTTP request headers

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