Skip to content

Auditor 10.7 tables fix #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 20 commits into from
Jul 24, 2025
Merged

Auditor 10.7 tables fix #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
ffb9d10
Fixed tables for /requirements/deploymentscenarios topic
Jul 16, 2025
e49d4b5
Fixed tables with bullets issues (via script):
Jul 16, 2025
fa35b4f
Fixed table in the
Jul 16, 2025
93bf151
Fixed issue with failed build (changes some symbols)
Jul 16, 2025
be6480e
Fixed table for
Jul 16, 2025
17a8e53
Fixed tables in the /windows overview topic
Jul 16, 2025
a7d9d74
Fixed /admin/monitoringplans/fileservers/overview
Jul 17, 2025
2f33fef
Fixed doubles table in the
Jul 17, 2025
effd7ea
Fixed tables in the /admin/alertsettings/create/
Jul 17, 2025
3083a32
Ran Stuart script for /API/ section to fix tables
Jul 18, 2025
01caa21
Fixed XML and JSON table
Jul 18, 2025
4ad0c50
Fixed \api\filterreference table
Jul 18, 2025
0ed2dce
Fixed XML and JSON in the api/postdata
Jul 18, 2025
4f0d66a
Fixed api/postdata/activityrecords
Jul 18, 2025
f06e295
Fixed remained issues with JSON and XML
Jul 18, 2025
636dd87
Fixed 2 issues as Stuart asked
Jul 18, 2025
94812eb
Fixed filters.md topic
Jul 21, 2025
5f5adce
Fixed compatibility.md topic
Jul 21, 2025
2e8e75e
Fixed errordetails topic
Jul 21, 2025
0006f9e
Fixed filterreference.md topic
Jul 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions docs/auditor/10.7/admin/alertsettings/create/create.md
View file
Open in desktop

Large diffs are not rendered by default.

90 changes: 70 additions & 20 deletions docs/auditor/10.7/admin/monitoringplans/fileservers/overview.md
View file
Open in desktop

Large diffs are not rendered by default.

26 changes: 13 additions & 13 deletions docs/auditor/10.7/admin/search/filteradvanced.md
View file
Open in desktop

Large diffs are not rendered by default.

43 changes: 22 additions & 21 deletions docs/auditor/10.7/api/activityrecordreference.md
View file
Open in desktop

Large diffs are not rendered by default.

13 changes: 6 additions & 7 deletions docs/auditor/10.7/api/compatibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,10 @@ sidebar_position: 130
Make sure to check your product version, and then review and update your add-ons and scripts
leveraging Netwrix Auditor Integration API. Download the latest add-on version in the Add-on Store.

| Property in 8.0 – 8.5 | New property in 9.0 and above |
| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| - XML: `<AuditedSystem></AuditedSystem>` - JSON: `"AuditedSystem"` | - XML: `<DataSource></DataSource>` - JSON: `"DataSource"` |
| - XML: `<ManagedObject></ManagedObject>` - JSON: `"ManagedObject"` | - XML: `<MonitoringPlan> `````` <Name>Name</Name> `````` <ID>Unique ID</ID> `````` </MonitoringPlan>` - JSON: `"MonitoringPlan" : { `````` "ID": "{Unique ID}", `````` "Name": "Name" `````` }` Now the MonitoringPlan contains two sub-entries: ID and Name. The ID property is optional and is assigned automatically by the product. |
| — | - XML: `<Item> `````` <Name>Item name</Name> `````` </Item>` - JSON: `"Item": {"Name": "Item name"}` |
| Property in 8.0 – 8.5 | New property in 9.0 and above |
|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| XML: `<AuditedSystem></AuditedSystem>`, JSON: `"AuditedSystem"` | XML: `<DataSource></DataSource>`, JSON: `"DataSource"` |
| XML: `<ManagedObject></ManagedObject>`, JSON: `"ManagedObject"` | XML: `<MonitoringPlan> <Name>Name</Name> <ID>Unique ID</ID> </MonitoringPlan>`, JSON: `"MonitoringPlan" : { "ID": "{Unique ID}", "Name": "Name" }` Now the MonitoringPlan contains two sub-entries: ID and Name. The ID property is optional and is assigned automatically by the product. |
| — | XML: `<Item> <Name>Item name</Name> </Item>`, JSON: `"Item": {"Name": "Item name"` |

To learn more about input and output Activity Record structure, refer to
[Activity Records](/docs/auditor/10.7/api/postdata/activityrecords.md).
To learn more about input and output Activity Record structure, refer to [Activity Records](/docs/auditor/10.7/api/postdata/activityrecords.md).
38 changes: 29 additions & 9 deletions docs/auditor/10.7/api/errordetails.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,35 @@ The error details include:

The error details have the format similar to the following:

| Format | Example |
| ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| XML | `<?xml version="1.0" encoding="UTF-8" ?> `````` <ErrorList xmlns="http://schemas.netwrix.com/api/v1/"> `````` <Error> `````` <Category>Category</Category> `````` <Description>Error Description</Description> `````` <Location>Error Location</Location> `````` </Error> `````` </ErrorList>` |
| JSON | `{ `````` "ErrorList": [ `````` { `````` "Category": "Category", `````` "Description": "Error Description", `````` "Location": "Error Location" `````` } `````` ] `````` }` |
**XML:**
```xml
<?xml version="1.0" encoding="UTF-8" ?>
<ErrorList xmlns="http://schemas.netwrix.com/api/v1/">
<Error>
<Category>Category</Category>
<Description>Error Description</Description>
<Location>Error Location</Location>
</Error>
</ErrorList>
```

**JSON:**
```json
{
"ErrorList": [
{
"Category": "Category",
"Description": "Error Description",
"Location": "Error Location"
}
]
}
```

Review examples below to see how error details correspond to invalid requests.

| Request | Error details returned |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Invalid request: XML: `curl -H "Content-Type: application/xml; Charset=UTF-8" https://WKSWin12R2:9699/ netwrix/api/v1/activity_records/search -u Enterprise\ NetwrixUser:NetwrixIsCool --data-binary @C:\APIdocs\Search.xml` `<?xml version="1.0" encoding="utf-8"?> `````` <ActivityRecordSearch xmlns="http://schemas. netwrix.com/api/v1/activity_records/"> `````` <FilterList> `````` <Who>Administrator</Who> `````` <DataSource>Active Directory `````` <Action>Modified</Action> `````` </FilterList> `````` </ActivityRecordSearch>` - JSON: `curl -H "Content-Type: application/json; Charset=UTF-8" https://WKSWin12R2:9699/ netwrix/api/v1/activity_records/search?format=json -u Enterprise\NetwrixUser: NetwrixIsCool --data-binary @C:\APIdocs\Search.json` `{ `````` "FilterList": { `````` "Who": "Administrator", `````` "DataSource": "Active Directory `````` "Action": "Added" `````` } `````` }` | 400 Bad Request - XML: `<?xml version="1.0" encoding="UTF-8" ?> `````` <ErrorList xmlns="http://schemas.netwrix.com/api/v1/"> `````` <Error> `````` <Category>XMLError</Category> `````` <Description>0xC00CE56D End tag 'FilterList' does not match the start tag 'DataSource' `````` </Description> `````` </Error> `````` </ErrorList>` - JSON: If JSON is corrupted, server returns 500 Internal Server Error with empty body. |
| Invalid request: - XML: `curl https://WKSWin12R2:9699/ netwrix/api/v1/activity_records/ enum?count=FIVE -u Enterprise\ NetwrixUser:NetwrixIsCool` - JSON: `curl https://WKSWin12R2:9699/ netwrix/api/v1/activity_records/ enum?format=json&count=FIVE -u Enterprise\NetwrixUser: NetwrixIsCool` | 400 Bad Request - XML: `<?xml version="1.0" encoding="UTF-8" ?> `````` <ErrorList xmlns="http://schemas.netwrix.com/api/v1/"> `````` <Error> `````` <Category>InputError</Category> `````` <Description>Invalid count parameter specified. Error details: 0x80040204 Cannot convert the attribute data type `````` </Description> `````` </Error> `````` </ErrorList>` - JSON: `{ `````` "ErrorList": [ `````` { `````` "Category": "InputError", `````` "Description": "Invalid count parameter specified. Error details: 0x80040204 Cannot convert the attribute data type" `````` } `````` ] `````` }` |
| Valid request, but the Audit Database is unreachable: - XML: `curl https://WKSWin12R2:9699/ netwrix/api/v1/activity_records/enum -u Enterprise\ NetwrixUser:NetwrixIsCool` - JSON: `curl https://WKSWin12R2:9699/ netwrix/api/v1/activity_records/enum?format=json -u Enterprise\NetwrixUser: NetwrixIsCool` | 500 Internal Server Error - XML: `<?xml version="1.0" encoding="UTF-8" ?> `````` <ErrorList xmlns="http://schemas.netwrix.com/api/v1/"> `````` <Error> `````` <Category>ServerError</Category> `````` <Description>0x80040C0A SQL Server cannot be contacted, connection is lost (0x80040C0A SQL Server cannot be contacted, connection is lost (0x80004005 [DBNETLIB][ConnectionOpen (Connect()). ]SQL Server does not exist or access denied.)) [0x00007FFDCC06BBC8,0x00007FFDB99EF4BA; 0x00007FFDB99BEEEF,0x00007FFDB99EF4DC] `````` </Description> `````` </Error> `````` </ErrorList>` - JSON: `{ `````` "ErrorList": [ `````` { `````` "Category": "ServerError", `````` "Description": "0x80040C0A SQL Server cannot be contacted, connection is lost (0x80040C0A SQL Server cannot be contacted, connection is lost (0x80004005 [DBNETLIB][ConnectionOpen (Connect()). ]SQL Server does not exist or access denied.)) [0x00007FFDCC06BBC8,0x00007FFDB99EF4BA; 0x00007FFDB99BEEEF,0x00007FFDB99EF4DC]" `````` } `````` ] `````` }` |
| Request | Error details returned |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Invalid request: **XML:** `curl -H "Content-Type: application/xml; Charset=UTF-8" https://WKSWin12R2:9699/netwrix/api/v1/activity_records/search -u Enterprise\NetwrixUser:NetwrixIsCool --data-binary @C:\APIdocs\Search.xml`; ```xml <ActivityRecordSearch xmlns="http://schemas.netwrix.com/api/v1/activity_records/"> <FilterList> <Who>Administrator</Who> <DataSource>Active Directory</DataSource> <Action>Modified</Action> </FilterList> </ActivityRecordSearch> ```; **JSON:** `curl -H "Content-Type: application/json; Charset=UTF-8" https://WKSWin12R2:9699/netwrix/api/v1/activity_records/search?format=json -u Enterprise\NetwrixUser:NetwrixIsCool --data-binary @C:\APIdocs\Search.json`; ```json { "FilterList": { "Who": "Administrator", "DataSource": "Active Directory", "Action": "Added" } } ``` | 400 Bad Request; **XML:** ```xml <ErrorList xmlns="http://schemas.netwrix.com/api/v1/"> <Error> <Category>XMLError</Category> <Description>0xC00CE56D End tag 'FilterList' does not match the start tag 'DataSource'</Description> </Error> </ErrorList> ```; **JSON:** If JSON is corrupted, server returns 500 Internal Server Error with empty body. |
| Invalid request: **XML:** `curl https://WKSWin12R2:9699/netwrix/api/v1/activity_records/enum?count=FIVE -u Enterprise\NetwrixUser:NetwrixIsCool`; **JSON:** `curl https://WKSWin12R2:9699/netwrix/api/v1/activity_records/enum?format=json&count=FIVE -u Enterprise\NetwrixUser:NetwrixIsCool` | 400 Bad Request; **XML:** ```xml <ErrorList xmlns="http://schemas.netwrix.com/api/v1/"> <Error> <Category>InputError</Category> <Description>Invalid count parameter specified. Error details: 0x80040204 Cannot convert the attribute data type</Description> </Error> </ErrorList> ```; **JSON:** ```json { "ErrorList": [ { "Category": "InputError", "Description": "Invalid count parameter specified. Error details: 0x80040204 Cannot convert the attribute data type" } ] } ``` |
| Valid request, but the Audit Database is unreachable: **XML:** `curl https://WKSWin12R2:9699/netwrix/api/v1/activity_records/enum -u Enterprise\NetwrixUser:NetwrixIsCool`; **JSON:** `curl https://WKSWin12R2:9699/netwrix/api/v1/activity_records/enum?format=json -u Enterprise\NetwrixUser:NetwrixIsCool` | 500 Internal Server Error; **XML:** ```xml <ErrorList xmlns="http://schemas.netwrix.com/api/v1/"> <Error> <Category>ServerError</Category> <Description>0x80040C0A SQL Server cannot be contacted, connection is lost (0x80004005 [DBNETLIB][ConnectionOpen (Connect())] SQL Server does not exist or access denied.) [0x00007FFDCC06BBC8,0x00007FFDB99EF4BA; 0x00007FFDB99BEEEF,0x00007FFDB99EF4DC]</Description> </Error> </ErrorList> ```; **JSON:** ```json { "ErrorList": [ { "Category": "ServerError", "Description": "0x80040C0A SQL Server cannot be contacted, connection is lost (0x80004005 [DBNETLIB][ConnectionOpen (Connect())] SQL Server does not exist or access denied.) [0x00007FFDCC06BBC8,0x00007FFDB99EF4BA; 0x00007FFDB99BEEEF,0x00007FFDB99EF4DC]" } ] } ``` |
Loading
Loading