Skip to content

Latest commit

 

History

History
116 lines (87 loc) · 4.18 KB

experience.md

File metadata and controls

116 lines (87 loc) · 4.18 KB

Experience Actions

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

Contents

Bootstrap

Bootstraps the experience for this application with standard endpoints and views

var params = {
  applicationId: myApplicationId,
  options: myOptions
};

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

// with promises
client.experience.bootstrap(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.cli, all.Organization, all.User, all.User.cli, experience.*, or experience.bootstrap.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
options Experience Bootstrap Options Y Bootstrap options Experience Bootstrap Options Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Experience Bootstrap Result If bootstrap was successful

Error Responses

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

Delete

Deletes multiple parts of an experience including users, groups, slugs, domains, versions, endpoints, views, and workflows

var params = {
  applicationId: myApplicationId
};

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

// with promises
client.experience.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, experience.*, or experience.delete.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
keepUsers string N If this is set, Experience Users will not be removed. true
keepGroups string N If this is set, Experience Groups will not be removed. true
keepSlugs string N If this is set, Experience Slugs will not be removed. true
keepDomains string N If this is set, Experience Domains will not be removed. true
removeVersions string N If this is set, all Experience Versions and their contents will be removed (except for develop). true
keepViews string N If this is set, Experience Views (in the develop version) will not be removed. true
keepEndpoints string N If this is set, Experience Endpoints (in the develop version) will not be removed. true
removeWorkflows string N If this is set, all Experience Workflows (in the develop version) will ve removed. true
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Success If deletion was successful

Error Responses

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