Skip to content

Latest commit

 

History

History
165 lines (123 loc) · 5.39 KB

experienceGroup.md

File metadata and controls

165 lines (123 loc) · 5.39 KB

Experience Group Actions

Details on the various actions that can be performed on the Experience Group resource, including the expected parameters and the potential responses.

Contents

Delete

Deletes an experience group

var params = {
  applicationId: myApplicationId,
  experienceGroupId: myExperienceGroupId
};

// with callbacks
client.experienceGroup.delete(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.experienceGroup.delete(params)
  .then(console.log)
  .catch(console.error);

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, experienceGroup.*, or experienceGroup.delete.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
experienceGroupId string Y ID associated with the experience group 575ed78e7ae143cd83dc4aab
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Success If experience group was successfully deleted

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if experience group was not found

Get

Retrieves information on an experience group

var params = {
  applicationId: myApplicationId,
  experienceGroupId: myExperienceGroupId
};

// with callbacks
client.experienceGroup.get(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.experienceGroup.get(params)
  .then(console.log)
  .catch(console.error);

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceGroup.*, or experienceGroup.get.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
experienceGroupId string Y ID associated with the experience group 575ed78e7ae143cd83dc4aab
includeDirectDeviceCount string N Whether or not to return count of devices associated directly with this group false true
includeTotalDeviceCount string N Whether or not to return count of devices associated with this group or any of its descendents false true
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Experience Group Experience group information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if experience group was not found

Patch

Updates information about an experience group

var params = {
  applicationId: myApplicationId,
  experienceGroupId: myExperienceGroupId,
  experienceGroup: myExperienceGroup
};

// with callbacks
client.experienceGroup.patch(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.experienceGroup.patch(params)
  .then(console.log)
  .catch(console.error);

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, experienceGroup.*, or experienceGroup.patch.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
experienceGroupId string Y ID associated with the experience group 575ed78e7ae143cd83dc4aab
experienceGroup Experience Group Patch Y Object containing new properties of the experience group Experience Group Patch Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Experience Group Updated experience group information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if experience group was not found