Create one validation rule for an entity definition.

POST

/api/workspace/admin/entity-definitions/{entityDefinitionId}/validation-rules

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/entity-definitions/example/validation-rules"),
    Content = new StringContent("{ \"Name\": \"example\", \"DisplayName\": \"example\", \"Expression\": \"example\", \"Message\": \"example\", \"Enabled\": true, \"MessageTranslations\": { \"additionalProperty\": \"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/entity-definitions/example/validation-rules';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"Name":"example","DisplayName":"example","Expression":"example","Message":"example","Enabled":true,"MessageTranslations":{"additionalProperty":"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/entity-definitions/example/validation-rules \
  --header 'Content-Type: application/json' \
  --data '{ "Name": "example", "DisplayName": "example", "Expression": "example", "Message": "example", "Enabled": true, "MessageTranslations": { "additionalProperty": "example" } }'

Authorizations

None

Parameters

Path Parameters

entityDefinitionId

required

string

Query Parameters

access_token

string

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

Request Body

Create one entity validation rule.

object

Name

required

Stable technical validation rule key.

string

DisplayName

required

User-facing validation rule label.

string

Expression

required

Boolean validation expression.

string

Message

required

User-facing validation failure message.

string

Enabled

Whether this validation rule is active.

boolean

MessageTranslations

Optional localized validation failure message templates keyed by locale.

object

key

additional properties

string

Example^generated

{
  "Name": "example",
  "DisplayName": "example",
  "Expression": "example",
  "Message": "example",
  "Enabled": true,
  "MessageTranslations": {
    "additionalProperty": "example"
  }
}

Create one entity validation rule.

object

Name

required

Stable technical validation rule key.

string

DisplayName

required

User-facing validation rule label.

string

Expression

required

Boolean validation expression.

string

Message

required

User-facing validation failure message.

string

Enabled

Whether this validation rule is active.

boolean

MessageTranslations

Optional localized validation failure message templates keyed by locale.

object

key

additional properties

string

Example^generated

{
  "Name": "example",
  "DisplayName": "example",
  "Expression": "example",
  "Message": "example",
  "Enabled": true,
  "MessageTranslations": {
    "additionalProperty": "example"
  }
}

Create one entity validation rule.

object

Name

required

Stable technical validation rule key.

string

DisplayName

required

User-facing validation rule label.

string

Expression

required

Boolean validation expression.

string

Message

required

User-facing validation failure message.

string

Enabled

Whether this validation rule is active.

boolean

MessageTranslations

Optional localized validation failure message templates keyed by locale.

object

key

additional properties

string

Example^generated

{
  "Name": "example",
  "DisplayName": "example",
  "Expression": "example",
  "Message": "example",
  "Enabled": true,
  "MessageTranslations": {
    "additionalProperty": "example"
  }
}

Responses

200

application/json

object

Data

Administrative entity validation rule definition.

object

Validation rule identifier.

string

nullable

EntityDefinitionId

Owning entity definition identifier.

string

nullable

Name

Stable technical validation rule key.

string

nullable

DisplayName

User-facing validation rule label.

string

nullable

Expression

Validation expression.

string

nullable

Message

User-facing validation failure message.

string

nullable

MessageTranslations

Optional localized validation failure message templates keyed by locale.

object

key

additional properties

string

Enabled

Whether this validation rule is active.

boolean

SortOrder

Validation rule ordering inside the entity definition.

integer format: int32

IsDeleted

Whether the validation rule is soft-deleted.

boolean

DeletedAt

Soft-delete timestamp when deleted.

string format: date-time

nullable

RowVersion

Concurrency token.

string format: uuid

SchemaSource

integer format: int32

Allowed values: 0 1

SourceNetPackageId

Stable NET package root id when package-owned.

string

nullable

SourcePackageId

NET package artifact id when package-owned.

string

nullable

SourceStableId

Stable Moltaro id when package-owned.

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": {
    "SchemaSource": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Administrative entity validation rule definition.

object

Validation rule identifier.

string

nullable

EntityDefinitionId

Owning entity definition identifier.

string

nullable

Name

Stable technical validation rule key.

string

nullable

DisplayName

User-facing validation rule label.

string

nullable

Expression

Validation expression.

string

nullable

Message

User-facing validation failure message.

string

nullable

MessageTranslations

Optional localized validation failure message templates keyed by locale.

object

key

additional properties

string

Enabled

Whether this validation rule is active.

boolean

SortOrder

Validation rule ordering inside the entity definition.

integer format: int32

IsDeleted

Whether the validation rule is soft-deleted.

boolean

DeletedAt

Soft-delete timestamp when deleted.

string format: date-time

nullable

RowVersion

Concurrency token.

string format: uuid

SchemaSource

integer format: int32

Allowed values: 0 1

SourceNetPackageId

Stable NET package root id when package-owned.

string

nullable

SourcePackageId

NET package artifact id when package-owned.

string

nullable

SourceStableId

Stable Moltaro id when package-owned.

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

404

Not Found

application/json

object

Data

Administrative entity validation rule definition.

object

Validation rule identifier.

string

nullable

EntityDefinitionId

Owning entity definition identifier.

string

nullable

Name

Stable technical validation rule key.

string

nullable

DisplayName

User-facing validation rule label.

string

nullable

Expression

Validation expression.

string

nullable

Message

User-facing validation failure message.

string

nullable

MessageTranslations

Optional localized validation failure message templates keyed by locale.

object

key

additional properties

string

Enabled

Whether this validation rule is active.

boolean

SortOrder

Validation rule ordering inside the entity definition.

integer format: int32

IsDeleted

Whether the validation rule is soft-deleted.

boolean

DeletedAt

Soft-delete timestamp when deleted.

string format: date-time

nullable

RowVersion

Concurrency token.

string format: uuid

SchemaSource

integer format: int32

Allowed values: 0 1

SourceNetPackageId

Stable NET package root id when package-owned.

string

nullable

SourcePackageId

NET package artifact id when package-owned.

string

nullable

SourceStableId

Stable Moltaro id when package-owned.

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": {
    "SchemaSource": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

Administrative entity validation rule definition.

object

Validation rule identifier.

string

nullable

EntityDefinitionId

Owning entity definition identifier.

string

nullable

Name

Stable technical validation rule key.

string

nullable

DisplayName

User-facing validation rule label.

string

nullable

Expression

Validation expression.

string

nullable

Message

User-facing validation failure message.

string

nullable

MessageTranslations

Optional localized validation failure message templates keyed by locale.

object

key

additional properties

string

Enabled

Whether this validation rule is active.

boolean

SortOrder

Validation rule ordering inside the entity definition.

integer format: int32

IsDeleted

Whether the validation rule is soft-deleted.

boolean

DeletedAt

Soft-delete timestamp when deleted.

string format: date-time

nullable

RowVersion

Concurrency token.

string format: uuid

SchemaSource

integer format: int32

Allowed values: 0 1

SourceNetPackageId

Stable NET package root id when package-owned.

string

nullable

SourcePackageId

NET package artifact id when package-owned.

string

nullable

SourceStableId

Stable Moltaro id when package-owned.

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": {
    "SchemaSource": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Create one validation rule for an entity definition.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated

Example^generated

Example^generated

Example^generated