```
@Path("/")
public interface ViolationsApi
```
Agent API
This document refers to Symphony API calls to send and receive messages and content. They need the on-premise Agent installed to perform decryption/encryption of content. - sessionToken and keyManagerToken can be obtained by calling the authenticationAPI on the symphony back end and the key manager respectively. Refer to the methods described in authenticatorAPI.yaml. - Actions are defined to be atomic, ie will succeed in their entirety or fail and have changed nothing. - If it returns a 40X status then it will have sent no message to any stream even if a request to aome subset of the requested streams would have succeeded. - If this contract cannot be met for any reason then this is an error and the response code will be 50X. - MessageML is a markup language for messages. See reference here: https://rest-api.symphony.com/docs/messagemlv2

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`V1DLPViolationMessageResponse`	`v1DlpViolationsMessageGet(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit)`	Get violations as a result of policy enforcement on messages.
`V1DLPViolationSignalResponse`	`v1DlpViolationsSignalGet(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit)`	Get violations as a result of policy enforcement on signals.
`V1DLPViolationStreamResponse`	`v1DlpViolationsStreamGet(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit)`	Get violations as a result of policy enforcement on streams.
`String`	`v3DlpViolationAttachmentGet(String fileId, String violationId, String sessionToken, String keyManagerToken)`	Get attachments that were sent as part of messages that were flagged by the DLP System.
`V3DLPViolationMessageResponse`	`v3DlpViolationsMessageGet(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit)`	Get violations as a result of policy enforcement on messages.
`V3DLPViolationSignalResponse`	`v3DlpViolationsSignalGet(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit)`	Get violations as a result of policy enforcement on signals.
`V3DLPViolationStreamResponse`	`v3DlpViolationsStreamGet(Long startTime, String sessionToken, String keyManagerToken, Long endTime, String next, Integer limit)`	Get violations as a result of policy enforcement on streams.

Method Detail

v1DlpViolationsMessageGet

@GET
@Path("/v1/dlp/violations/message")
@Produces("application/json")
V1DLPViolationMessageResponse v1DlpViolationsMessageGet(@QueryParam("startTime")
                                                        Long startTime,
                                                        @HeaderParam("sessionToken")
                                                        String sessionToken,
                                                        @HeaderParam("keyManagerToken")
                                                        String keyManagerToken,
                                                        @QueryParam("endTime")
                                                        Long endTime,
                                                        @QueryParam("next")
                                                        String next,
                                                        @QueryParam("limit")
                                                        Integer limit)

Get violations as a result of policy enforcement on messages. TBD

v1DlpViolationsSignalGet

@GET
@Path("/v1/dlp/violations/signal")
@Produces("application/json")
V1DLPViolationSignalResponse v1DlpViolationsSignalGet(@QueryParam("startTime")
                                                      Long startTime,
                                                      @HeaderParam("sessionToken")
                                                      String sessionToken,
                                                      @HeaderParam("keyManagerToken")
                                                      String keyManagerToken,
                                                      @QueryParam("endTime")
                                                      Long endTime,
                                                      @QueryParam("next")
                                                      String next,
                                                      @QueryParam("limit")
                                                      Integer limit)

Get violations as a result of policy enforcement on signals. TBD

v1DlpViolationsStreamGet

@GET
@Path("/v1/dlp/violations/stream")
@Produces("application/json")
V1DLPViolationStreamResponse v1DlpViolationsStreamGet(@QueryParam("startTime")
                                                      Long startTime,
                                                      @HeaderParam("sessionToken")
                                                      String sessionToken,
                                                      @HeaderParam("keyManagerToken")
                                                      String keyManagerToken,
                                                      @QueryParam("endTime")
                                                      Long endTime,
                                                      @QueryParam("next")
                                                      String next,
                                                      @QueryParam("limit")
                                                      Integer limit)

Get violations as a result of policy enforcement on streams. TBD

v3DlpViolationAttachmentGet

@GET
@Path("/v3/dlp/violation/attachment")
@Produces("application/octet-stream")
String v3DlpViolationAttachmentGet(@QueryParam("fileId")
                                   String fileId,
                                   @QueryParam("violationId")
                                   String violationId,
                                   @HeaderParam("sessionToken")
                                   String sessionToken,
                                   @HeaderParam("keyManagerToken")
                                   String keyManagerToken)

Get attachments that were sent as part of messages that were flagged by the DLP System. Retrieves attachments from related message violations as a base64 encoded String.

v3DlpViolationsMessageGet

@GET
@Path("/v3/dlp/violations/message")
@Produces("application/json")
V3DLPViolationMessageResponse v3DlpViolationsMessageGet(@QueryParam("startTime")
                                                        Long startTime,
                                                        @HeaderParam("sessionToken")
                                                        String sessionToken,
                                                        @HeaderParam("keyManagerToken")
                                                        String keyManagerToken,
                                                        @QueryParam("endTime")
                                                        Long endTime,
                                                        @QueryParam("next")
                                                        String next,
                                                        @QueryParam("limit")
                                                        Integer limit)

Get violations as a result of policy enforcement on messages. Retrieves DLP v3 message related violations for a given time range

v3DlpViolationsSignalGet

@GET
@Path("/v3/dlp/violations/signal")
@Produces("application/json")
V3DLPViolationSignalResponse v3DlpViolationsSignalGet(@QueryParam("startTime")
                                                      Long startTime,
                                                      @HeaderParam("sessionToken")
                                                      String sessionToken,
                                                      @HeaderParam("keyManagerToken")
                                                      String keyManagerToken,
                                                      @QueryParam("endTime")
                                                      Long endTime,
                                                      @QueryParam("next")
                                                      String next,
                                                      @QueryParam("limit")
                                                      Integer limit)

Get violations as a result of policy enforcement on signals. Retrieves DLP v3 signal related violations for a given time range

v3DlpViolationsStreamGet

@GET
@Path("/v3/dlp/violations/stream")
@Produces("application/json")
V3DLPViolationStreamResponse v3DlpViolationsStreamGet(@QueryParam("startTime")
                                                      Long startTime,
                                                      @HeaderParam("sessionToken")
                                                      String sessionToken,
                                                      @HeaderParam("keyManagerToken")
                                                      String keyManagerToken,
                                                      @QueryParam("endTime")
                                                      Long endTime,
                                                      @QueryParam("next")
                                                      String next,
                                                      @QueryParam("limit")
                                                      Integer limit)

Get violations as a result of policy enforcement on streams. Retrieves DLP v3 signal related violations for a given time range

Interface ViolationsApi