Event information response
- Last UpdatedSep 04, 2025
- 1 minute read
Event information is provided in a response to provide additional information about events that occurred during processing of OMF requests.
|
Field |
Description |
|---|---|
|
Message |
A short description of the event. |
|
Reason |
Provides more information about why the event occurred. In most cases, this is null because the Message describes the problem. |
|
Suggestions |
Provides possible solutions to the problem. May include multiple solutions. Solutions may be incompatible with each other. |
|
EventCode |
The event code for the event. For lists of event codes and their meanings, see Event codes. |
|
Parameters |
Provides additional context for values included in the message. Parameters are only included when PI Web API is in debug mode. |
The following is an example of event information in a response.
{
"Message": "A parameter in the request is not valid.",
"Reason": "The tenant was not found.",
"Suggestions":
"Specify the 'tenantId' of an existing tenant, and try the operation
"Create a tenant with the specified 'tenantId' before using it.'
],
"EventCode": 5309,
"Parameters": [
{
"Name": "TenantID",
"Value": "osiosft1"
}
]
}
Note: Parameter names may not be unique.