Skip to content

Commit e54a3c5

Browse files
jtvioletjtviolet
authored
Merge pull request #121 from netwrix/aleks/auditor-10.7-tables_fix
Auditor 10.7 tables fix
2 parents 14a5d92 + 0006f9e commit e54a3c5

File tree

28 files changed

+1119
-520
lines changed

28 files changed

+1119
-520
lines changed

‎docs/auditor/10.7/admin/alertsettings/create/create.md‎

Lines changed: 9 additions & 8 deletions
Large diffs are not rendered by default.

‎docs/auditor/10.7/admin/monitoringplans/fileservers/overview.md‎

Lines changed: 70 additions & 20 deletions
Large diffs are not rendered by default.

‎docs/auditor/10.7/admin/search/filteradvanced.md‎

Lines changed: 13 additions & 13 deletions
Large diffs are not rendered by default.

‎docs/auditor/10.7/api/activityrecordreference.md‎

Lines changed: 22 additions & 21 deletions
Large diffs are not rendered by default.

‎docs/auditor/10.7/api/compatibility.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,10 @@ sidebar_position: 130
99
Make sure to check your product version, and then review and update your add-ons and scripts
1010
leveraging Netwrix Auditor Integration API. Download the latest add-on version in the Add-on Store.
1111

12-
| Property in 8.0 – 8.5 | New property in 9.0 and above |
13-
| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
14-
| - XML: `<AuditedSystem></AuditedSystem>` - JSON: `"AuditedSystem"` | - XML: `<DataSource></DataSource>` - JSON: `"DataSource"` |
15-
| - 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. |
16-
| — | - XML: `<Item> `````` <Name>Item name</Name> `````` </Item>` - JSON: `"Item": {"Name": "Item name"}` |
12+
| Property in 8.0 – 8.5 | New property in 9.0 and above |
13+
|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
14+
| XML: `<AuditedSystem></AuditedSystem>`, JSON: `"AuditedSystem"` | XML: `<DataSource></DataSource>`, JSON: `"DataSource"` |
15+
| 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. |
16+
| — | XML: `<Item> <Name>Item name</Name> </Item>`, JSON: `"Item": {"Name": "Item name"` |
1717

18-
To learn more about input and output Activity Record structure, refer to
19-
[Activity Records](/docs/auditor/10.7/api/postdata/activityrecords.md).
18+
To learn more about input and output Activity Record structure, refer to [Activity Records](/docs/auditor/10.7/api/postdata/activityrecords.md).

‎docs/auditor/10.7/api/errordetails.md‎

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,35 @@ The error details include:
1919

2020
The error details have the format similar to the following:
2121

22-
| Format | Example |
23-
| ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
24-
| 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>` |
25-
| JSON | `{ `````` "ErrorList": [ `````` { `````` "Category": "Category", `````` "Description": "Error Description", `````` "Location": "Error Location" `````` } `````` ] `````` }` |
22+
**XML:**
23+
```xml
24+
<?xml version="1.0" encoding="UTF-8" ?>
25+
<ErrorList xmlns="http://schemas.netwrix.com/api/v1/">
26+
<Error>
27+
<Category>Category</Category>
28+
<Description>Error Description</Description>
29+
<Location>Error Location</Location>
30+
</Error>
31+
</ErrorList>
32+
```
33+
34+
**JSON:**
35+
```json
36+
{
37+
"ErrorList": [
38+
{
39+
"Category": "Category",
40+
"Description": "Error Description",
41+
"Location": "Error Location"
42+
}
43+
]
44+
}
45+
```
2646

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

29-
| Request | Error details returned |
30-
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
31-
| 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. |
32-
| 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" `````` } `````` ] `````` }` |
33-
| 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]" `````` } `````` ] `````` }` |
49+
| Request | Error details returned |
50+
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
51+
| 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. |
52+
| 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" } ] } ``` |
53+
| 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]" } ] } ``` |

0 commit comments

Comments
 (0)