Get Document Detail
Description
Get the document file detail information
URL
/api/v1/profile/document/detail
Request Method: POST
Request Header
|
Key |
Value |
Type |
Description |
|---|---|---|---|
| companyId | <12345> | String | Company ID - Company ID can be obtained through Get Resource Map |
| Authorization | Bearer <Authorization Token> | String | Authorization credential generated by FortiCWP |
|
fileId |
<NgfjdJDT7F2Og> |
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/detail |
| Request Header |
Authorization: Bearer <Authorization_Token> companyId: 2 fileId: RI6AZSxyCNgfjdJDT7F2OgJNzHgCFmVH2Kz_NxYROxM Content-Type: application |
Response Variable
|
Name |
Required |
Type |
Description |
|---|---|---|---|
| data | Required | JSON Object | Profile document detail data |
| limit | Required | Integer | Maximum number of return file details in a page |
| skip | Required | Integer | Indexes in a result set, used to exclude response from the first N items of a resource collection. |
| totalCount | Required | Integer | Total number of file details |
| totalPage | Required | Integer | Total pages of document file detail |
| data.fileId | Required | String | Document file ID in FortiCWP |
| data.fileName | Required | String | Document file name |
| data.buId | Required | Integer | Business ID, one service ID per one Business ID |
| data.serviceId | Required | String | Service ID to distinguish different account of the cloud service in FortiCWP |
| data.storageAccount | Optional | String | Azure storage account which the document file uploaded |
| data.storageAccountId | Optional | String | Azure storage account serial number |
| data.companyId | Required | String | Company id |
| data.service | Required | String | Service cloud account of the profile document |
| data.path | Required | String | Original profile document file path in the cloud account |
| data.ownerId | Optional | String | Profile document owner ID |
| data.owner | Optional | String | profile document owner |
| data.ownerName | Optional | String | Profile document owner name |
| data.createdDate | Required | long | Timestamp, document created date in the cloud account |
| data.lastModifiedDate | Required | long | Timestamp, document last modified date in the cloud account |
| data.link | Required | String | Download link of the document in Forticwp |
| data.lastScannedDate | Required | long | Timestamp, last scan date of the document |
| data.size | Required | Integer | Document size (Byte) |
| data.dlp | Required | Boolean | Check whether the profile document is a DLP file |
| data.exposure | Required | Boolean | Check whether the profile document is exposed |
| data.sharing | Required | Boolean | Check whether the profile document is shared |
| data.sensitive | Required | Boolean | Check whether the profile document is sensitive |
| data.malware | Required | Boolean | Check whether the profile document is malware |
| data.isLink | Required | Boolean | Check whether the profile document shared link exist |
| data.region | Required | String | Region of the cloud storage server |
| data.bucket | Required | String | Bucket name where the profile document uploaded |
| data.isDelete | Required | Boolean | Check whether the profile document is deleted on the cloud server |
| data.parentId | Required | String | ID of the folder where the document is uploaded, a root folder is set to null or 0 |
| data.folder | Required | Boolean | Check whether the profile document is a folder |
| data.location | Required | Boolean | |
| data.root | Required | Boolean | Check whether the profile document is a root folder |
| data.account | Required | JSON Object | Cloud account information of the profile document |
Sample Response
{
"data": [
{
"fileId": "RI6AZSxyCNgfjdJDT7F2OgJNzHgCFmVH2Kz_NxYROxM",
"fileName": "214_v2.0-all-policies-31.xls",
"buId": 21076,
"serviceId": "828026382104",
"companyId": "2",
"service": "AWS",
"path": "214_v2.0-all-policies-31.xls",
"ownerId": "2e2a055db84e307a9a8521ed88558fcfe43f99a5f4f6cc03029c5f7cbb92d8c8",
"owner": "zhangyue_1981",
"ownerName": "zhangyue_1981",
"createdDate": "",
"lastModifiedDate": "2020-03-04T02:53:58.000Z",
"link": "/download/AWS/files/file/RI6AZSxyCNgfjdJDT7F2OgJNzHgCFmVH2Kz_NxYROxM",
"lastScannedDate": "2020-03-04T03:10:44.391Z",
"size": 29696,
"dlp": true,
"exposure": false,
"sharing": false,
"sensitive": true,
"malware": false,
"isLink": false,
"region": "us-west-2",
"bucket": "license-on-8280",
"isDelete": false,
"parentId": "R2G4Ehcc4iGkNCRGFtmJ94uOSLAj32UgDF3tKpQgEbc",
"folder": false,
"location": false,
"root": false
}
],
"totalPage": 0,
"limit": 0,
"skip": 0,
"totalCount": 0
}