V3 Message Violations

Gets violations as a result of policy enforcement on messages. The message part of this violation is the same as documented in Create Message v4

Get violations as a result of policy enforcement on messages.

Retrieves DLP v3 message related violations for a given time range

GETyouragentURL.symphony.com/agent/v3/dlp/violations/message

Query parameters

Header parameters

Response

200204400401403500

OK

Body

application/json

violations*array of V3DLPViolationMessage (object)

A representation of list of violations due to messages sent by a user of Symphony

nextOffsetstring

Offset for the next chunk of violations to be submitted in the next request. Value is null if there are no further violations.

Request

JavaScriptCurl

const response = await fetch('youragentURL.symphony.com/agent/v3/dlp/violations/message', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "violations": [
    {
      "violation": {
        "enforcementEventID": "text",
        "entityID": "text",
        "details": [],
        "action": "text",
        "outcome": {
          "type": "text"
        },
        "version": "text",
        "ignoreDLPwarning": false
      },
      "message": {
        "messageId": "text",
        "parentMessageId": "text",
        "message": "text",
        "data": "text",
        "attachments": [
          {
            "id": "text",
            "name": "text",
            "images": [
              {
                "id": "text",
                "dimension": "text"
              }
            ]
          }
        ],
        "user": {
          "firstName": "text",
          "lastName": "text",
          "displayName": "text",
          "email": "text",
          "username": "text"
        },
        "stream": {
          "streamId": "text",
          "streamType": "text",
          "roomName": "text",
          "members": [
            {
              "firstName": "text",
              "lastName": "text",
              "displayName": "text",
              "email": "text",
              "username": "text"
            }
          ],
          "external": false,
          "crossPod": false
        },
        "externalRecipients": false,
        "diagnostic": "text",
        "userAgent": "text",
        "originalFormat": "text",
        "disclaimer": "text",
        "sid": "fa691cd3-484a-4109-aeb2-57c05b78c95b",
        "replacing": "text",
        "replacedBy": "text",
        "initialMessageId": "text",
        "silent": false
      },
      "sharedMessage": {
        "messageId": "text",
        "parentMessageId": "text",
        "message": "text",
        "data": "text",
        "attachments": [
          {
            "id": "text",
            "name": "text",
            "images": [
              {
                "id": "text",
                "dimension": "text"
              }
            ]
          }
        ],
        "user": {
          "firstName": "text",
          "lastName": "text",
          "displayName": "text",
          "email": "text",
          "username": "text"
        },
        "stream": {
          "streamId": "text",
          "streamType": "text",
          "roomName": "text",
          "members": [
            {
              "firstName": "text",
              "lastName": "text",
              "displayName": "text",
              "email": "text",
              "username": "text"
            }
          ],
          "external": false,
          "crossPod": false
        },
        "externalRecipients": false,
        "diagnostic": "text",
        "userAgent": "text",
        "originalFormat": "text",
        "disclaimer": "text",
        "sid": "fa691cd3-484a-4109-aeb2-57c05b78c95b",
        "replacing": "text",
        "replacedBy": "text",
        "initialMessageId": "text",
        "silent": false
      },
      "diagnostic": "text"
    }
  ],
  "nextOffset": "text"
}

📘 sharedMessage

Note that the sharedMessage attribute is only returned when the message represented by this class is a wall post sharing another message. Please note the payload example with sharedMessage object included.

🚧 Required Permissions

Calling this endpoint requires the Expression Filter Policy Management role. See Bot Permissions for a list of roles and associated privileges.