DatagroupApi.md

LookerApi31Reference.DatagroupApi

All URIs are relative to /api/3.1

Method	HTTP request	Description
allDatagroups	GET /datagroups	Get All Datagroups
datagroup	GET /datagroups/{datagroup_id}	Get Datagroup
updateDatagroup	PATCH /datagroups/{datagroup_id}	Update Datagroup

allDatagroups

[Datagroup] allDatagroups()

Get All Datagroups

Get information about all datagroups.

Example

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

var apiInstance = new LookerApi31Reference.DatagroupApi();

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

Parameters

This endpoint does not need any parameter.

Return type

[Datagroup]

Authorization

No authorization required

HTTP request headers

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

datagroup

Datagroup datagroup(datagroupId)

Get Datagroup

Get information about a datagroup.

Example

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

var apiInstance = new LookerApi31Reference.DatagroupApi();

var datagroupId = "datagroupId_example"; // String | ID of datagroup.


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

Parameters

Name	Type	Description	Notes
datagroupId	String	ID of datagroup.

Return type

Datagroup

Authorization

No authorization required

HTTP request headers

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

updateDatagroup

Datagroup updateDatagroup(datagroupId, body)

Update Datagroup

Update a datagroup using the specified params.

Example

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

var apiInstance = new LookerApi31Reference.DatagroupApi();

var datagroupId = "datagroupId_example"; // String | ID of datagroup.

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


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

Parameters

Name	Type	Description	Notes
datagroupId	String	ID of datagroup.
body	Datagroup	Datagroup

Return type

Datagroup

Authorization

No authorization required

HTTP request headers

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