Preview all deterministic source changes and optional root-leaf menu placement for one page.

POST

/api/workspace/admin/ui-project/page-generators/preview

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/admin/ui-project/page-generators/preview"),
    Content = new StringContent("{ \"Kind\": 0, \"BaseRevisionId\": \"example\", \"BaseSourceChecksum\": \"example\", \"Key\": \"example\", \"Title\": \"example\", \"Icon\": \"example\", \"Layout\": 0, \"RoutePath\": \"example\", \"EntityList\": { \"EntityDefinitionId\": \"example\", \"ColumnFieldIds\": [ \"example\" ], \"InitialSort\": { \"FieldId\": \"example\", \"Direction\": 0 }, \"PageSize\": 1, \"QuickFilterFieldIds\": [ \"example\" ], \"RowTarget\": 0, \"WorkspaceUiDetailsPageKey\": \"example\" }, \"EntityDetails\": { \"EntityDefinitionId\": \"example\", \"ParameterName\": \"example\", \"Groups\": [ { \"Key\": \"example\", \"Title\": \"example\", \"FieldIds\": [ \"example\" ] } ] }, \"ExternalApiExample\": { \"Preset\": 0, \"BaseCurrency\": \"example\", \"QuoteCurrencies\": [ \"example\" ] }, \"MenuPlacement\": { \"Enabled\": true, \"RuntimeMenuId\": \"example\" } }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/admin/ui-project/page-generators/preview';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"Kind":0,"BaseRevisionId":"example","BaseSourceChecksum":"example","Key":"example","Title":"example","Icon":"example","Layout":0,"RoutePath":"example","EntityList":{"EntityDefinitionId":"example","ColumnFieldIds":["example"],"InitialSort":{"FieldId":"example","Direction":0},"PageSize":1,"QuickFilterFieldIds":["example"],"RowTarget":0,"WorkspaceUiDetailsPageKey":"example"},"EntityDetails":{"EntityDefinitionId":"example","ParameterName":"example","Groups":[{"Key":"example","Title":"example","FieldIds":["example"]}]},"ExternalApiExample":{"Preset":0,"BaseCurrency":"example","QuoteCurrencies":["example"]},"MenuPlacement":{"Enabled":true,"RuntimeMenuId":"example"}}'
};

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/workspace/admin/ui-project/page-generators/preview \
  --header 'Content-Type: application/json' \
  --data '{ "Kind": 0, "BaseRevisionId": "example", "BaseSourceChecksum": "example", "Key": "example", "Title": "example", "Icon": "example", "Layout": 0, "RoutePath": "example", "EntityList": { "EntityDefinitionId": "example", "ColumnFieldIds": [ "example" ], "InitialSort": { "FieldId": "example", "Direction": 0 }, "PageSize": 1, "QuickFilterFieldIds": [ "example" ], "RowTarget": 0, "WorkspaceUiDetailsPageKey": "example" }, "EntityDetails": { "EntityDefinitionId": "example", "ParameterName": "example", "Groups": [ { "Key": "example", "Title": "example", "FieldIds": [ "example" ] } ] }, "ExternalApiExample": { "Preset": 0, "BaseCurrency": "example", "QuoteCurrencies": [ "example" ] }, "MenuPlacement": { "Enabled": true, "RuntimeMenuId": "example" } }'

Authorizations

None

Parameters

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Preview one deterministic generated page against an immutable source revision.

object

Kind

integer format: int32

Allowed values: 0 1 2 3

BaseRevisionId

string

nullable

BaseSourceChecksum

string

nullable

Key

string

nullable

Title

string

nullable

Icon

string

nullable

Layout

integer format: int32

Allowed values: 0 1

RoutePath

string

nullable

EntityList

Entity-list generator settings.

object

EntityDefinitionId

string

nullable

ColumnFieldIds

Array<string>

nullable

InitialSort

Initial sort for a generated entity list.

object

FieldId

string

nullable

Direction

integer format: int32

Allowed values: 0 1

PageSize

integer format: int32

nullable

QuickFilterFieldIds

Array<string>

nullable

RowTarget

integer format: int32

Allowed values: 0 1 2

WorkspaceUiDetailsPageKey

string

nullable

EntityDetails

Entity-details generator settings.

object

EntityDefinitionId

string

nullable

ParameterName

string

nullable

Groups

Array<object>

nullable

One named read-only field group on a generated details page.

object

Key

string

nullable

Title

string

nullable

FieldIds

Array<string>

nullable

ExternalApiExample

External API example generator settings.

object

Preset

integer format: int32

Allowed values: 0

BaseCurrency

string

nullable

QuoteCurrencies

Array<string>

nullable

MenuPlacement

Optional root-leaf runtime-menu placement.

object

Enabled

boolean

RuntimeMenuId

string

nullable

Responses

200

application/json

object

Data

Deterministic preview of one generated page.

object

Kind

integer format: int32

Allowed values: 0 1 2 3

BaseRevisionId

string

nullable

BaseSourceChecksum

string

nullable

PageKey

string

nullable

MainFilePath

string

nullable

Changes

Array<object>

nullable

One generated source-file change in a template preview.

object

Operation

integer format: int32

Allowed values: 0 1 2

Path

Canonical source path.

string

nullable

ContentUtf8

Deterministically generated UTF-8 content.

string

nullable

ExpectedContentHash

Expected current hash for an updated file.

string

nullable

CreatesFile

Whether the change creates a new file.

boolean

MenuPlan

Optional runtime-menu change shown independently from source changes.

object

Requested

boolean

Eligible

boolean

RuntimeMenuId

string

nullable

Label

string

nullable

Icon

string

nullable

PageKey

string

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Kind": 0,
    "Changes": [
      {
        "Operation": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Deterministic preview of one generated page.

object

Kind

integer format: int32

Allowed values: 0 1 2 3

BaseRevisionId

string

nullable

BaseSourceChecksum

string

nullable

PageKey

string

nullable

MainFilePath

string

nullable

Changes

Array<object>

nullable

One generated source-file change in a template preview.

object

Operation

integer format: int32

Allowed values: 0 1 2

Path

Canonical source path.

string

nullable

ContentUtf8

Deterministically generated UTF-8 content.

string

nullable

ExpectedContentHash

Expected current hash for an updated file.

string

nullable

CreatesFile

Whether the change creates a new file.

boolean

MenuPlan

Optional runtime-menu change shown independently from source changes.

object

Requested

boolean

Eligible

boolean

RuntimeMenuId

string

nullable

Label

string

nullable

Icon

string

nullable

PageKey

string

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Kind": 0,
    "Changes": [
      {
        "Operation": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Conflict

application/json

object

Data

Deterministic preview of one generated page.

object

Kind

integer format: int32

Allowed values: 0 1 2 3

BaseRevisionId

string

nullable

BaseSourceChecksum

string

nullable

PageKey

string

nullable

MainFilePath

string

nullable

Changes

Array<object>

nullable

One generated source-file change in a template preview.

object

Operation

integer format: int32

Allowed values: 0 1 2

Path

Canonical source path.

string

nullable

ContentUtf8

Deterministically generated UTF-8 content.

string

nullable

ExpectedContentHash

Expected current hash for an updated file.

string

nullable

CreatesFile

Whether the change creates a new file.

boolean

MenuPlan

Optional runtime-menu change shown independently from source changes.

object

Requested

boolean

Eligible

boolean

RuntimeMenuId

string

nullable

Label

string

nullable

Icon

string

nullable

PageKey

string

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Kind": 0,
    "Changes": [
      {
        "Operation": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Preview all deterministic source changes and optional root-leaf menu placement for one page.

Authorizations

Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

409

Example

Example^generated