API Trace
Reads trace entries. Trace entries comprise records of all attempts at accessing an API. Some APIs may have tracing disabled. Authentication Type constants are defined in the API Constants file. You may get a list of current values by using the Read Type API (see below).
The StartDate and EndDate parameters should use the Sortable Date format, i.e. "yyyy-MM-ddTHH:mm:ss".
Authentication: Windows
Privilege : Administrator , Power User
Method: PxStat.Security.Trace_API.Read
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
StartDate |
DateTime | Start of Date/Time range for this read. | |
EndDate |
DateTime | End of Date/Time range for this read | |
AuthenticationType |
String | Type of access | |
TrcUsername |
String | Trace User Name | |
TrcIp |
String | Trace Ip |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
TrcCcnUsername |
String | AD User Name of the account that logged in |
TrcPrvValue |
String | Privilege of the account that logged in |
TrcIp |
String | IP address of the client |
TrcMethod |
String | Fully qualified name of the API that was called |
TrcParams |
String | Parameters supplied when calling the API |
TrcUserAgent |
String | User Agent string from the HTTP request object |
TrcDateTime |
String | Date/Time of API Request |
Gets a list of the different Trace types.
Authentication: Windows
Privilege : Administrator , Power User
Method: PxStat.Security.Trace_API.ReadType
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
| No Parameters defined |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
AuthenticationType |
String | The defined authentication type |
