External DocumentationTo learn more, visit the Egnyte Secure Govern documentation.
Parameters
| Parameter | Description |
|---|---|
| File ID | ID of the file, as listed by the source. |
| Include Text Context | Number of characters before and after the match to include in the context. Context is only returned if this parameter is set. Otherwise context field is missing from response. |
| Source ID | ID of the source. |
Example Output
{
"id": "ID of the file, as listed by the source",
"lastUpdated": 0,
"latestVersionId": "from latestEntryId or from versionId in CLFS sources",
"locationId": "uuid",
"matches": [
{
"pattern": "ID of the pattern that matched content, various formats possible",
"patternName": "Human readable name for the pattern matched",
"position": {
"cellRange": "Cell range in Excel file the matches were found in. Example: C3:C10",
"context": {
"after": "Content after the match",
"before": "Content before the match"
},
"matchingFragments": [
"string"
],
"page": 0,
"sheet": "Sheet name in Excel file the matches were found in. Example: Summary"
},
"sample": "Sample text that occurred and matched a pattern. It can be the single matched string or an example one of multiple matches.",
"type": "What kind of a match is this - sensitive content found in text or the entire document is of sensitive type (eg. an invoice), or metadata of the document matches (author field in a .docx etc.)"
}
],
"name": "FROM: filename in Secure and Govern",
"path": "example: /Shared/Documents/GoldenDataset longNames/Bank info",
"policies": [
"ID of the policy (not tag)"
],
"risk": 0,
"sourceId": "TODO: seems redundant",
"url": "string"
}