previewFormView

POST

/api/v1/data-sources/{id}/views/preview

const url = 'https://example.com/api/v1/data-sources/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/views/preview';
const options = {method: 'POST'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/data-sources/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/views/preview

Projects an unsaved, proposed saved view and returns the resulting typed dataset without persisting anything or altering the cached projection. Only output-eligible records in the view’s included states are returned, so a preview never exposes unapproved records. Requires the manage capability.

Parameters

Path Parameters

required

string format: uuid

Responses

200

The projected typed dataset for the proposed view

403

Manage capability required

422

Proposed view rejected