Views

Node SDK CRUD View files

CRUD on view files.

All examples assume a properly authenticated SDK instance

Get all views

Returns an array of view objects

try {
  const res = await sdk.instance.getViews();
} catch (err) {
  console.error(err);
}

Get a view by ZUID

try {
  const viewZUID = "11=..."; // View ZUIDS begin with 11
  const res = await sdk.instance.getView(viewZUID);
} catch (err) {
  console.error(err);
}

Create a view (snippet)

const type = "snippet";
const fileName = "navigation";
const code = "my view content";
const payload = {
  type: type,
  fileName: fileName,
  code: code
};

try {
  const res = await sdk.instance.createView(payload);
} catch (err) {
  console.error(err);
}

Create a view (endpoint)

const type = "ajax-json";
const fileName = "/special-endpoint.json";
const code = JSON.stringify({ foo: "bar" });
const payload = {
  type: type,
  fileName: fileName,
  code: code
};

try {
  const res = await sdk.instance.createView(payload);
} catch (err) {
  console.error(err);
}

Update a view

This will only updated view and will not publish it.

const viewZUID = "11-...";
const code = "my view content";
const payload = {
  code: code
};

try {
  const res = await sdk.instance.updateView(viewZUID, payload);
} catch (err) {
  console.error(err);
}

Publish a view

const viewZUID = "11-...";
const version = 1

try {
  const res = await sdk.instance.publishView(viewZUID, version);
} catch (err) {
  console.error(err);
}

Updated 8 months ago