Preview the active children an Archive policy of a hidden section would archive.

POST

/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/hidden-policy/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/entity/example/ui/form/example/items/example/hidden-policy/preview"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
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/entity/example/ui/form/example/items/example/hidden-policy/preview';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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/entity/example/ui/form/example/items/example/hidden-policy/preview \
  --header 'Authorization: Bearer <token>'

For a stored parent only. Answers Ready with the count and the token the submission confirms when the actor can see and archive every active child of the relation, otherwise Unavailable without a count. Nothing is written.

Authorizations

WorkspaceBearer

Parameters

Path Parameters

entityIdOrKey

required

string

Parent Entity definition identifier or key.

formSurfaceId

required

string

The Form surface.

formItemId

required

string

The WithParent related-table item.

Query Parameters

instanceId

string

The stored parent record.

access_token

string

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

Responses

200

application/json

object

Data

The active relation set an Archive policy of a hidden section would archive.

object

State

Hidden-policy preview state.

integer format: int32

Allowed values: 0 1

AffectedCount

Number of active child records when Ready; null otherwise.

integer format: int32

nullable

AffectedSetToken

Token of the set the submission confirms when Ready; null otherwise.

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

400

Bad Request

application/json

object

Data

The active relation set an Archive policy of a hidden section would archive.

object

State

Hidden-policy preview state.

integer format: int32

Allowed values: 0 1

AffectedCount

Number of active child records when Ready; null otherwise.

integer format: int32

nullable

AffectedSetToken

Token of the set the submission confirms when Ready; null otherwise.

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

404

Not Found

application/json

object

Data

The active relation set an Archive policy of a hidden section would archive.

object

State

Hidden-policy preview state.

integer format: int32

Allowed values: 0 1

AffectedCount

Number of active child records when Ready; null otherwise.

integer format: int32

nullable

AffectedSetToken

Token of the set the submission confirms when Ready; null otherwise.

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