Skip to content

Accepts this unchanged-file episode until that file next updates.

POST
/api/workspace/file-protection/signals/{id}/dismiss
curl --request POST \
--url https://example.com/api/workspace/file-protection/signals/example/dismiss \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "Comment": "example" }'
id
required
string
access_token
string

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

Dismisses this freshness episode until that same file is observed updated.

object
RowVersion
string format: uuid
Comment
string
nullable
Examplegenerated
{
"RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"Comment": "example"
}

OK

Media typeapplication/json
object
Data

Episode diagnostics and its immutable transition history.

object
Signal

Authorized, path-safe diagnostics for a single episode.

object
Id
string
nullable
SourceId
string
nullable
AgentId
string
nullable
FileId
string
nullable
ObjectDisplayName
string
nullable
FileName
string
nullable
PolicyKind
integer format: int32
Allowed values: 0 1 2 3 4 5
Severity
integer format: int32
Allowed values: 1 2
State
integer format: int32
Allowed values: 0 1 2
RaisedAtUtc
string format: date-time
UpdatedAtUtc
string format: date-time
ResolvedAtUtc
string format: date-time
nullable
DiagnosticCode
string
nullable
ResolutionCode
string
nullable
ReferenceAtUtc
string format: date-time
nullable
LastObservedAtUtc
string format: date-time
nullable
CountedMinutes
number format: double
nullable
ThresholdMinutes
integer format: int32
nullable
RunId
string
nullable
OccurrenceId
string
nullable
RecoveryPointId
string
nullable
TimeZoneId
string
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
RowVersion
string format: uuid
AllowedActions
Array<string>
nullable
SafeErrorCode
string
nullable
NextThresholdAtUtc
string format: date-time
nullable
History
Array<object>
nullable

One immutable episode transition.

object
Id
string
nullable
Event
string
nullable
OccurredAtUtc
string format: date-time
Severity
integer format: int32
Allowed values: 1 2
ActorUserId
string
nullable
Reason
string
nullable
Comment
string
nullable
SourceId
string
nullable
AgentId
string
nullable
SignalId
string
nullable
PolicyKind
integer format: int32
Allowed values: 0 1 2 3 4 5
FileId
string
nullable
FileName
string
nullable
DiagnosticSnapshot

Only recorded, safe diagnostic facts; null means the historical event did not record that value.

object
PolicyKind
integer format: int32
Allowed values: 0 1 2 3 4 5
State
integer format: int32
Allowed values: 0 1 2
FileId
string
nullable
FileName
string
nullable
DiagnosticCode
string
nullable
SafeErrorCode
string
nullable
ResolutionCode
string
nullable
RunId
string
nullable
OccurrenceId
string
nullable
RecoveryPointId
string
nullable
RaisedAtUtc
string format: date-time
nullable
UpdatedAtUtc
string format: date-time
nullable
ResolvedAtUtc
string format: date-time
nullable
ReferenceAtUtc
string format: date-time
nullable
LastObservedAtUtc
string format: date-time
nullable
CountedMinutes
number format: double
nullable
ThresholdMinutes
integer format: int32
nullable
TimeZoneId
string
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
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
Recipients
Array<object>
nullable

Recipient selections for one type and level, with current workspace eligible audience count.

object
PolicyKind
integer format: int32
Allowed values: 0 1 2 3 4 5
Severity
integer format: int32
Allowed values: 1 2
Recipients
Array<object>
nullable

An explicit role or responsibility-group recipient selection.

object
Kind
integer format: int32
Allowed values: 0 1
Id
string
nullable
DisplayName
string
nullable
EligibleRecipientCount
integer format: int32
TimeZoneId
string
nullable
ActorDisplayName
string
nullable
ObjectDisplayName
string
nullable
TotalHistoryCount

Authorized transition count; History contains the latest 100 in chronological order.

integer format: int32
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": {
"Signal": {
"PolicyKind": 0,
"Severity": 1,
"State": 0
},
"History": [
{
"Severity": 1,
"PolicyKind": 0,
"DiagnosticSnapshot": {
"PolicyKind": 0,
"State": 0
},
"Policies": [
{
"Kind": 0,
"EventSeverity": 1
}
],
"Recipients": [
{
"PolicyKind": 0,
"Severity": 1,
"Recipients": [
{
"Kind": 0
}
]
}
]
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}