Checks one statement expression against the current saved catalog without modifying configuration.

POST

/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/authoring-validate

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/security/authoring-validate"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"ExpectedDescriptorFingerprint\": \"example\", \"Source\": \"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/security/authoring-validate';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"ExpectedDescriptorFingerprint":"example","Source":"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/security/authoring-validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ExpectedDescriptorFingerprint": "example", "Source": "example" }'

Authorizations

WorkspaceBearer

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^required

Checks raw editor text against the current saved subject and its empty-source description.

object

ExpectedDescriptorFingerprint

string

nullable

Source

string

nullable

Example^generated

{
  "ExpectedDescriptorFingerprint": "example",
  "Source": "example"
}

Checks raw editor text against the current saved subject and its empty-source description.

object

ExpectedDescriptorFingerprint

string

nullable

Source

string

nullable

Example^generated

{
  "ExpectedDescriptorFingerprint": "example",
  "Source": "example"
}

Checks raw editor text against the current saved subject and its empty-source description.

object

ExpectedDescriptorFingerprint

string

nullable

Source

string

nullable

Example^generated

{
  "ExpectedDescriptorFingerprint": "example",
  "Source": "example"
}

Responses

200

application/json

object

Data

A completed expression check; catalog and authorization failures use the API error envelope.

object

BaseDescriptorFingerprint

string

nullable

Valid

boolean

Diagnostics

Array<object>

nullable

An error in the submitted text, with optional zero-based UTF-16 offsets and exclusive End.

object

Code

string

nullable

Message

string

nullable

Start

integer format: int32

nullable

End

integer format: int32

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

A completed expression check; catalog and authorization failures use the API error envelope.

object

BaseDescriptorFingerprint

string

nullable

Valid

boolean

Diagnostics

Array<object>

nullable

An error in the submitted text, with optional zero-based UTF-16 offsets and exclusive End.

object

Code

string

nullable

Message

string

nullable

Start

integer format: int32

nullable

End

integer format: int32

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
    }
  ]
}

401

Unauthorized

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

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

A completed expression check; catalog and authorization failures use the API error envelope.

object

BaseDescriptorFingerprint

string

nullable

Valid

boolean

Diagnostics

Array<object>

nullable

An error in the submitted text, with optional zero-based UTF-16 offsets and exclusive End.

object

Code

string

nullable

Message

string

nullable

Start

integer format: int32

nullable

End

integer format: int32

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
    }
  ]
}

Checks one statement expression against the current saved catalog without modifying configuration.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Bodyrequired

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

401

Examplegenerated

403

Examplegenerated

404

Example

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated