Preview a server-generated Net Operation Project source template without creating a revision.

POST

/api/workspace/admin/net-operation-project/source-templates/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/net-operation-project/source-templates/preview"),
    Content = new StringContent("{ \"TemplateId\": \"example\", \"ClassName\": \"example\", \"DisplayName\": \"example\", \"StableKey\": \"example\", \"TargetEntityDefinitionId\": \"example\", \"Folder\": \"example\", \"Path\": \"example\", \"RevisionId\": \"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/net-operation-project/source-templates/preview';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"TemplateId":"example","ClassName":"example","DisplayName":"example","StableKey":"example","TargetEntityDefinitionId":"example","Folder":"example","Path":"example","RevisionId":"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/net-operation-project/source-templates/preview \
  --header 'Content-Type: application/json' \
  --data '{ "TemplateId": "example", "ClassName": "example", "DisplayName": "example", "StableKey": "example", "TargetEntityDefinitionId": "example", "Folder": "example", "Path": "example", "RevisionId": "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

Request a generated Net Operation Project source template preview.

object

TemplateId

Template identifier.

string

nullable

ClassName

Requested C# class name.

string

nullable

DisplayName

Optional user-facing function or data-source display name.

string

nullable

StableKey

Optional stable function or data-source key.

string

nullable

TargetEntityDefinitionId

Optional target Entity Definition id for entity-scoped templates.

string

nullable

Folder

Optional source folder used when Path is omitted.

string

nullable

Path

Optional explicit source path.

string

nullable

RevisionId

Optional source revision id used for collision warnings.

string

nullable

Example^generated

{
  "TemplateId": "example",
  "ClassName": "example",
  "DisplayName": "example",
  "StableKey": "example",
  "TargetEntityDefinitionId": "example",
  "Folder": "example",
  "Path": "example",
  "RevisionId": "example"
}

Request a generated Net Operation Project source template preview.

object

TemplateId

Template identifier.

string

nullable

ClassName

Requested C# class name.

string

nullable

DisplayName

Optional user-facing function or data-source display name.

string

nullable

StableKey

Optional stable function or data-source key.

string

nullable

TargetEntityDefinitionId

Optional target Entity Definition id for entity-scoped templates.

string

nullable

Folder

Optional source folder used when Path is omitted.

string

nullable

Path

Optional explicit source path.

string

nullable

RevisionId

Optional source revision id used for collision warnings.

string

nullable

Example^generated

{
  "TemplateId": "example",
  "ClassName": "example",
  "DisplayName": "example",
  "StableKey": "example",
  "TargetEntityDefinitionId": "example",
  "Folder": "example",
  "Path": "example",
  "RevisionId": "example"
}

Request a generated Net Operation Project source template preview.

object

TemplateId

Template identifier.

string

nullable

ClassName

Requested C# class name.

string

nullable

DisplayName

Optional user-facing function or data-source display name.

string

nullable

StableKey

Optional stable function or data-source key.

string

nullable

TargetEntityDefinitionId

Optional target Entity Definition id for entity-scoped templates.

string

nullable

Folder

Optional source folder used when Path is omitted.

string

nullable

Path

Optional explicit source path.

string

nullable

RevisionId

Optional source revision id used for collision warnings.

string

nullable

Example^generated

{
  "TemplateId": "example",
  "ClassName": "example",
  "DisplayName": "example",
  "StableKey": "example",
  "TargetEntityDefinitionId": "example",
  "Folder": "example",
  "Path": "example",
  "RevisionId": "example"
}

Responses

200

application/json

object

Data

Generated Net Operation Project source template preview.

object

TemplateId

Template identifier.

string

nullable

ProposedPath

Normalized source path for the generated file.

string

nullable

Content

Generated C# source content.

string

nullable

ResolvedClassName

Sanitized C# class name.

string

nullable

ResolvedDisplayName

Resolved display name used by the template.

string

nullable

ResolvedStableKey

Resolved stable key used by the template.

string

nullable

TargetEntityDefinitionId

Resolved target Entity Definition id, when applicable.

string

nullable

TargetEntityClrType

Generated workspace contract CLR type for the target entity, when applicable.

string

nullable

Warnings

Non-blocking preview warnings.

Array<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

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Generated Net Operation Project source template preview.

object

TemplateId

Template identifier.

string

nullable

ProposedPath

Normalized source path for the generated file.

string

nullable

Content

Generated C# source content.

string

nullable

ResolvedClassName

Sanitized C# class name.

string

nullable

ResolvedDisplayName

Resolved display name used by the template.

string

nullable

ResolvedStableKey

Resolved stable key used by the template.

string

nullable

TargetEntityDefinitionId

Resolved target Entity Definition id, when applicable.

string

nullable

TargetEntityClrType

Generated workspace contract CLR type for the target entity, when applicable.

string

nullable

Warnings

Non-blocking preview warnings.

Array<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

{
  "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"
}

404

Not Found

application/json

object

Data

Generated Net Operation Project source template preview.

object

TemplateId

Template identifier.

string

nullable

ProposedPath

Normalized source path for the generated file.

string

nullable

Content

Generated C# source content.

string

nullable

ResolvedClassName

Sanitized C# class name.

string

nullable

ResolvedDisplayName

Resolved display name used by the template.

string

nullable

ResolvedStableKey

Resolved stable key used by the template.

string

nullable

TargetEntityDefinitionId

Resolved target Entity Definition id, when applicable.

string

nullable

TargetEntityClrType

Generated workspace contract CLR type for the target entity, when applicable.

string

nullable

Warnings

Non-blocking preview warnings.

Array<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

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Preview a server-generated Net Operation Project source template without creating a revision.

Authorizations

Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

Example^generated

Example^generated

Example^generated

Example^generated