Get Document Violation

Description

Get the document violation details against data pattern.

URL

/api/v1/profile/document/violation

Request Method: POST

Request Headers

Key	Value	Type	Description
companyId	<12345>	String	Company ID in FortiCWP, can be obtained through Get Resource Map
roleId	<12345>	Long	Login user identity, can be obtained through Get Resource Map
Authorization	Bearer <Authorization Token>	String	Authorization credential generated by FortiCWP
filedId	<yCNgf>	String	File ID of the document under monitoring in FortiCWP - File ID can be obtained through the response variable objectId from Get Alert by Filter. When the response variable objectType in the "Get Alert by Filter" API response is of type "Document", the objectId is also the file ID. Other types of objectType cannot use objectId as the file ID.
Content-Type	application/json	String

Sample Request

Request URL	POST https://www.forticwp.com/api/v1/profile/document/violation
Request Header	Authorization: Bearer <Authorization_Token> companyId: 1 fileId: RI6AZSxyCNgfjdJDT7F2OgJNzHgCFmVH2Kz_NxYROxM Content-Type: application/json roleId: 36241

Response Variables

Name	Type	Description
data	Array	Profile document data pattern violation list
limit	Integer	Maximum number of return data violation pattern in a page
skip	Integer	Indexes in a result set, used to exclude response from the first N items of a resource collection
totalCount	Integer	Total number of data violation pattern
totalPage	Integer	Total page of data violation pattern
data.dataPatternId	Integer	Serialized ID number
data.dataPatternCategory	String	Data pattern category
data.dataPatternName	String	Display name of violation data pattern
data.violationDetail	String	Detail of violation data pattern

Sample Response

{

"totalPage": 0,

"limit": 0,

"skip": 0,

"totalCount": 0

}