Previews the Agent's calendar and current recipients without writing data.

POST

/api/workspace/file-protection/agents/{id}/signal-policies/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/file-protection/agents/example/signal-policies/preview"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"Policies\": [ { \"Kind\": 0, \"Enabled\": true, \"EventSeverity\": 1, \"WarningAfterMinutes\": 1, \"ErrorAfterMinutes\": 1, \"Calendar\": [ { \"DayOfWeek\": 1, \"StartMinute\": 1, \"EndMinute\": 1 } ] } ] }")
    {
        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/file-protection/agents/example/signal-policies/preview';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","Policies":[{"Kind":0,"Enabled":true,"EventSeverity":1,"WarningAfterMinutes":1,"ErrorAfterMinutes":1,"Calendar":[{"DayOfWeek":1,"StartMinute":1,"EndMinute":1}]}]}'
};

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/file-protection/agents/example/signal-policies/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "Policies": [ { "Kind": 0, "Enabled": true, "EventSeverity": 1, "WarningAfterMinutes": 1, "ErrorAfterMinutes": 1, "Calendar": [ { "DayOfWeek": 1, "StartMinute": 1, "EndMinute": 1 } ] } ] }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

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

Atomically replaces one object’s policy set.

object

RowVersion

string format: uuid

Policies

Array<object>

nullable

Object-owned rule. Null thresholds disable the corresponding escalation level.

object

Kind

integer format: int32

Allowed values: 0 1 2 3 4 5

Enabled

boolean

EventSeverity

integer format: int32

Allowed values: 1 2

WarningAfterMinutes

integer format: int32

nullable

ErrorAfterMinutes

integer format: int32

nullable

Calendar

Array<object>

nullable

One weekly local interval; day is ISO Monday=1 through Sunday=7. End less than start crosses midnight.

object

DayOfWeek

integer format: int32

StartMinute

integer format: int32

EndMinute

integer format: int32

Responses

200

application/json

object

Data

Dry-run result; no configuration is persisted.

object

TimeZoneId

string

nullable

CalculatedAtUtc

string format: date-time

Policies

Array<object>

nullable

Server-calculated calendar deadlines for one proposed rule.

object

Kind

integer format: int32

Allowed values: 0 1 2 3 4 5

WarningAtUtc

string format: date-time

nullable

ErrorAtUtc

string format: date-time

nullable

WarningRecipientCount

integer format: int32

ErrorRecipientCount

integer format: int32

ReferenceAtUtc

string format: date-time

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