Version:

Version:

Version:

Version:


Table of Contents

Online Help

Get Document Activity

Description

Get activities of the document in the cloud service account.

URL

/api/v1/profile/document/activity

Method: POST

Request Headers

Key

Required

Value

Type

Description

companyId

Required

<12345> String Company ID in FortiCWP, can be obtained through Get Resource Map

roleId

Required

<12345>

Long

Login user identity, can be obtained through Get Resource Map

Authorization

Required

Bearer <Authorization Token> String Authorization credential generated by FortiCWP
Content-Type

Required

application/json String  

fileId

Required

<1234567>

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.

service

Optional

<Azure>

String

Cloud service

Request Body Parameters

Name Priority Type Description
startTime Required long

Starting time of filtered open alerts in Unix Epoch timestamp. To convert date and time to Unix Epoch timestamp, refer to https://www.epochconverter.com/.

endTime Required long Ending time of filtered open alerts in Unix Epoch timestamp. To convert date and time to Unix Epoch timestamp, refer to https://www.epochconverter.com/.
skip Required Integer Indexes in result set, used to exclude a response from the first N items of a resource collection.
limit Required Integer Maximum number of return file activities in a page
operationList Optional Array Array list of operation as filter to get file activities

Sample Request

Request URL

POST https://www.forticwp.com/api/v1/profile/document/activity

Request Header

Authorization: Bearer <Authorization_Token>

companyId: 2

Content-Type: application/json

roleId: 36241

fileId: ulD3N2ohkHdbSo2PDLiCSrP2FEo-LZMVCx-YKC9cXE

Request Body

{

"skip":0,

"limit":10,

"operation_list":[

],

"startTime":1576020971494,

"endTime":1583793371494

}

Response Variables

Name

Type

Description

totalPages integer Total page of searched file activities
limit integer Maximum number of return file activities in a page
skip integer Indexes in a result set, used to exclude a response from the first N items of a resource collection.
data.eventId String ID of file activity
data.type String Type of file activity, it can be activity or update
data.fileId String File ID
data.fileName String File name
data.userName String User name of the one who triggered the activity
data.user String Iser account of activity
data.date String yyyy-MM-dd'T'HH:mm:ssZ, time of operation executed
data.operation String Operation of the activity
data.displayOperation String Operation name
data.alertIdList Array Alert ID list of the file activity triggered
totalCount integer Total number of activities of the file

Sample Response

{

"data":[

{

"eventId":"20360DD399I4SgiidnRUG1vEl6xH5PIA",

"type":"ACCESS",

"fileId":"VulD3N2ohkHdbSo2PDLiCSrP2FEo-LZMVCx-YKC9cXE",

"fileName":"305_v2.0-all-policies-31.ppt",

"user":"c7d04081-b84b-474b-850d-3d926e75344d",

"date":"2020-03-06T00:13:13.399Z",

"operation":"AZURE_DOWNLOAD_FILE",

"displayOperation":"download file",

"alertIdList":[

"20360xJ2042ATDVSgzQBOG94SzTbkx_A",

"20360xJ199PytNa-f_SkyGrJhN0hkLMg",

"20360xJ1956Nm2z58LS4CHJ606nMzWew",

"20360xJ191Z7kqEGepSrmzinEMg4MOSQ",

"20360xJ1867lSblDBpTmWeO0fhILqyKA",

"20360xJ182FKmiElIzQ7WDgtgezuww5Q",

"20360xJ178CTTVBgYJSSOAHQ6JfdzUqQ",

"20360xJ174u-JXrsMuTWySBl_z-Zo6Fg",

"20360xJ169NU_GrhElQR-gRQ-xYWtGGg",

"20360xJ1651mM1xnhJTw6CN6KW3w2Rnw",

"20360xJ160HyfDjXmkQQWDRh0IZiSMHQ",

"20360xJ156yNa6SraYSpWq6X-Z_-mNKg",

"20360xJ1526nobLXfPSSGCKnEXmVg0mg",

"20360xJ1470O6s6YKNSpyixcyLP9ornQ",

"20360xJ142MdS6hBa9RpSUaS02tZ1zmw",

"20360xJ136LlS3A4bxTOuppTX5yAWkRw",

"20360xJ12945H1Ts5sRE28x1sslvEf7g",

"20360xJ125J1B_BhswSiG1K5LIT6DHvA",

"20360xJ1200U67HIMiSPK_besWATwqew",

"20360xJ114N3xc-IecRcegpZl-2MXiZA",

"20360xJ109j_b5gcrzTdKYZtotFxIsXQ",

"20360xJ105zsG0t-cDQ8iXBYj1EP-sFA",

"20360xJ100gPKUq4PNSuu0XE94LrPhnA",

"20360xJ096EGzG3uqNT3mmcmim2tKcLA",

"20360xJ0919DPpsxStShWXunsAEVPlKw",

"20360xJ087Hnb7zSHSTFqMP50_cE4AEQ",

"20360xJ082RYgxMsjIRBS9bLOYhM0_HA",

"20360xJ078UypyiUwXT7m_DiNK_wqZ_A",

"20360xJ076K_o3dhUIRqWkwW-iMGfHTg",

"20360xJ071VFw78eGgR_2u8D929L6NUw",

"20360xJ064H4GQnXsxQdOdJVoV2lxZNw",

"20360xI791uJOGKtynSNyiBD6EnlwQDA"

]

},

{

"eventId":"2035NjZ662x6mvDJsSR7GmdEPQ4kizbA",

"type":"CREATE",

"fileId":"VulD3N2ohkHdbSo2PDLiCSrP2FEo-LZMVCx-YKC9cXE",

"fileName":"305_v2.0-all-policies-31.ppt",

"user":"c7d04081-b84b-474b-850d-3d926e75344d",

"date":"2020-03-05T23:45:35.662Z",

"operation":"AZURE_UPLOAD_FILE",

"displayOperation":"upload file",

"alertIdList":[

"203609s365r0TXXadlTLi_KoYYJMrq0g",

"203609s365rpO7uWrkRTGm5_aiA7ppJQ",

"203609s3227mmghe8ERIeKDVW-iZLjag",

"203609s300e6vuqjUsQTKc2-rycFArlA",

"203609s29124B9RTi8QgOvD65OPK-Afw",

"203609s282vXvkniVqQZWV5ldbETAzIw",

"203609s273CFRQIYgcQMOQd2kI1h1uZg",

"203609s242hDdL3HCOSOWAI3usEnn4jA",

"203609s229WVbigwPQRQqkcieP84AvsQ",

"203609s221WHdX4_6IRnqFKLo_n7cgMQ",

"203609s207dt6ugMLEQiiluLe9XT5wpw",

"203609s181OWQVxeZqQYiQtZMd74dGOg",

"203609s161DkHBI3nkQgqCRqUrd1Jqkw",

"203609s147nlthph5MSC6t7PGrMf5HMg",

"203609s133r_bZagMWTJ-eOhjQ2Tn3xg",

"203609s118YH3blWAURV-OSQD4rPrptQ",

"203609s095IAbzj-93QW-uEWwzP7hslA",

"203609s0733GiGHsNmQvaAqaqOBT5fSg",

"203609s051cF1WiqTIQpaBVlek5EBDnw",

"203609s032NGxKu4G7Q0GWsoeyRCw-vQ",

"203609s011EOu22dCURgiMFx7IQop-xA",

"203609r9937HwKI63sSb-fE-wYrTe4vg",

"203609r975Mlknj5mjQ0CruCWdzXUGgQ",

"203609r955CICfRcpzSiC8FmyAMrMi6A",

"203609r935ixP6_3FVT3u_6QrgT5amMA",

"203609r916JTtWWcs1RUqcIB-EuqMWtw",

"203609r889elOSaVoqSiO_ElQd_kWg9A",

"203609r863uy46ZEXeTGCVuUQg1VbeAA",

"203609r839epeyMEnIR923K_66fFCZjA",

"203609r814brSGybC3SBauBbcZz-DbJQ",

"203609r790eB59hfUaR1OM7hJ9-FoWEQ",

"203609r755megjlQZpTiWcrSD8NmdF1Q",

"203609O84613GSs1jiTxWE20DUWKgCGQ"

]

}

],

"totalPage":0,

"limit":10,

"skip":0,

"totalCount":2

}

 

 

 

 

 

 

Get Document Activity

Description

Get activities of the document in the cloud service account.

URL

/api/v1/profile/document/activity

Method: POST

Request Headers

Key

Required

Value

Type

Description

companyId

Required

<12345> String Company ID in FortiCWP, can be obtained through Get Resource Map

roleId

Required

<12345>

Long

Login user identity, can be obtained through Get Resource Map

Authorization

Required

Bearer <Authorization Token> String Authorization credential generated by FortiCWP
Content-Type

Required

application/json String  

fileId

Required

<1234567>

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.

service

Optional

<Azure>

String

Cloud service

Request Body Parameters

Name Priority Type Description
startTime Required long

Starting time of filtered open alerts in Unix Epoch timestamp. To convert date and time to Unix Epoch timestamp, refer to https://www.epochconverter.com/.

endTime Required long Ending time of filtered open alerts in Unix Epoch timestamp. To convert date and time to Unix Epoch timestamp, refer to https://www.epochconverter.com/.
skip Required Integer Indexes in result set, used to exclude a response from the first N items of a resource collection.
limit Required Integer Maximum number of return file activities in a page
operationList Optional Array Array list of operation as filter to get file activities

Sample Request

Request URL

POST https://www.forticwp.com/api/v1/profile/document/activity

Request Header

Authorization: Bearer <Authorization_Token>

companyId: 2

Content-Type: application/json

roleId: 36241

fileId: ulD3N2ohkHdbSo2PDLiCSrP2FEo-LZMVCx-YKC9cXE

Request Body

{

"skip":0,

"limit":10,

"operation_list":[

],

"startTime":1576020971494,

"endTime":1583793371494

}

Response Variables

Name

Type

Description

totalPages integer Total page of searched file activities
limit integer Maximum number of return file activities in a page
skip integer Indexes in a result set, used to exclude a response from the first N items of a resource collection.
data.eventId String ID of file activity
data.type String Type of file activity, it can be activity or update
data.fileId String File ID
data.fileName String File name
data.userName String User name of the one who triggered the activity
data.user String Iser account of activity
data.date String yyyy-MM-dd'T'HH:mm:ssZ, time of operation executed
data.operation String Operation of the activity
data.displayOperation String Operation name
data.alertIdList Array Alert ID list of the file activity triggered
totalCount integer Total number of activities of the file

Sample Response

{

"data":[

{

"eventId":"20360DD399I4SgiidnRUG1vEl6xH5PIA",

"type":"ACCESS",

"fileId":"VulD3N2ohkHdbSo2PDLiCSrP2FEo-LZMVCx-YKC9cXE",

"fileName":"305_v2.0-all-policies-31.ppt",

"user":"c7d04081-b84b-474b-850d-3d926e75344d",

"date":"2020-03-06T00:13:13.399Z",

"operation":"AZURE_DOWNLOAD_FILE",

"displayOperation":"download file",

"alertIdList":[

"20360xJ2042ATDVSgzQBOG94SzTbkx_A",

"20360xJ199PytNa-f_SkyGrJhN0hkLMg",

"20360xJ1956Nm2z58LS4CHJ606nMzWew",

"20360xJ191Z7kqEGepSrmzinEMg4MOSQ",

"20360xJ1867lSblDBpTmWeO0fhILqyKA",

"20360xJ182FKmiElIzQ7WDgtgezuww5Q",

"20360xJ178CTTVBgYJSSOAHQ6JfdzUqQ",

"20360xJ174u-JXrsMuTWySBl_z-Zo6Fg",

"20360xJ169NU_GrhElQR-gRQ-xYWtGGg",

"20360xJ1651mM1xnhJTw6CN6KW3w2Rnw",

"20360xJ160HyfDjXmkQQWDRh0IZiSMHQ",

"20360xJ156yNa6SraYSpWq6X-Z_-mNKg",

"20360xJ1526nobLXfPSSGCKnEXmVg0mg",

"20360xJ1470O6s6YKNSpyixcyLP9ornQ",

"20360xJ142MdS6hBa9RpSUaS02tZ1zmw",

"20360xJ136LlS3A4bxTOuppTX5yAWkRw",

"20360xJ12945H1Ts5sRE28x1sslvEf7g",

"20360xJ125J1B_BhswSiG1K5LIT6DHvA",

"20360xJ1200U67HIMiSPK_besWATwqew",

"20360xJ114N3xc-IecRcegpZl-2MXiZA",

"20360xJ109j_b5gcrzTdKYZtotFxIsXQ",

"20360xJ105zsG0t-cDQ8iXBYj1EP-sFA",

"20360xJ100gPKUq4PNSuu0XE94LrPhnA",

"20360xJ096EGzG3uqNT3mmcmim2tKcLA",

"20360xJ0919DPpsxStShWXunsAEVPlKw",

"20360xJ087Hnb7zSHSTFqMP50_cE4AEQ",

"20360xJ082RYgxMsjIRBS9bLOYhM0_HA",

"20360xJ078UypyiUwXT7m_DiNK_wqZ_A",

"20360xJ076K_o3dhUIRqWkwW-iMGfHTg",

"20360xJ071VFw78eGgR_2u8D929L6NUw",

"20360xJ064H4GQnXsxQdOdJVoV2lxZNw",

"20360xI791uJOGKtynSNyiBD6EnlwQDA"

]

},

{

"eventId":"2035NjZ662x6mvDJsSR7GmdEPQ4kizbA",

"type":"CREATE",

"fileId":"VulD3N2ohkHdbSo2PDLiCSrP2FEo-LZMVCx-YKC9cXE",

"fileName":"305_v2.0-all-policies-31.ppt",

"user":"c7d04081-b84b-474b-850d-3d926e75344d",

"date":"2020-03-05T23:45:35.662Z",

"operation":"AZURE_UPLOAD_FILE",

"displayOperation":"upload file",

"alertIdList":[

"203609s365r0TXXadlTLi_KoYYJMrq0g",

"203609s365rpO7uWrkRTGm5_aiA7ppJQ",

"203609s3227mmghe8ERIeKDVW-iZLjag",

"203609s300e6vuqjUsQTKc2-rycFArlA",

"203609s29124B9RTi8QgOvD65OPK-Afw",

"203609s282vXvkniVqQZWV5ldbETAzIw",

"203609s273CFRQIYgcQMOQd2kI1h1uZg",

"203609s242hDdL3HCOSOWAI3usEnn4jA",

"203609s229WVbigwPQRQqkcieP84AvsQ",

"203609s221WHdX4_6IRnqFKLo_n7cgMQ",

"203609s207dt6ugMLEQiiluLe9XT5wpw",

"203609s181OWQVxeZqQYiQtZMd74dGOg",

"203609s161DkHBI3nkQgqCRqUrd1Jqkw",

"203609s147nlthph5MSC6t7PGrMf5HMg",

"203609s133r_bZagMWTJ-eOhjQ2Tn3xg",

"203609s118YH3blWAURV-OSQD4rPrptQ",

"203609s095IAbzj-93QW-uEWwzP7hslA",

"203609s0733GiGHsNmQvaAqaqOBT5fSg",

"203609s051cF1WiqTIQpaBVlek5EBDnw",

"203609s032NGxKu4G7Q0GWsoeyRCw-vQ",

"203609s011EOu22dCURgiMFx7IQop-xA",

"203609r9937HwKI63sSb-fE-wYrTe4vg",

"203609r975Mlknj5mjQ0CruCWdzXUGgQ",

"203609r955CICfRcpzSiC8FmyAMrMi6A",

"203609r935ixP6_3FVT3u_6QrgT5amMA",

"203609r916JTtWWcs1RUqcIB-EuqMWtw",

"203609r889elOSaVoqSiO_ElQd_kWg9A",

"203609r863uy46ZEXeTGCVuUQg1VbeAA",

"203609r839epeyMEnIR923K_66fFCZjA",

"203609r814brSGybC3SBauBbcZz-DbJQ",

"203609r790eB59hfUaR1OM7hJ9-FoWEQ",

"203609r755megjlQZpTiWcrSD8NmdF1Q",

"203609O84613GSs1jiTxWE20DUWKgCGQ"

]

}

],

"totalPage":0,

"limit":10,

"skip":0,

"totalCount":2

}