Health endpoints schema
- Last UpdatedOct 27, 2025
- 3 minute read
- PI System
- Adapter for OPC UA 1.6
- Adapters
The full schema definition for the Health endpoints configuration is in the OPC UA_HealthEndpoints_schema.json file located in one of the following folders:
-
Windows: %ProgramFiles%\OSIsoft\Adapters\OPC UA\Schemas
-
Linux: /opt/OSIsoft/Adapters/OPC UA/Schemas
The following is an example of a complete Health endpoints configuration:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "OmfHealthEndpointConfiguration",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"endpoint",
"id"
],
"properties": {
"id": {
"type": [
"null",
"string"
],
"isIndex": true
},
"endpoint": {
"type": "string",
"format": "uri",
"minLength": 1
},
"userName": {
"type": [
"null",
"string"
],
"minLength": 1
},
"password": {
"type": [
"null",
"string"
],
"minLength": 1,
"isEncrypted": true
},
"clientId": {
"type": [
"null",
"string"
],
"minLength": 1
},
"clientSecret": {
"type": [
"null",
"string"
],
"minLength": 1,
"isEncrypted": true
},
"debugExpiration": {
"type": [
"null",
"string"
],
"description": "UTC time 2023-01-29T12:43:00Z",
"format": "date-time"
},
"tokenEndpoint": {
"type": [
"null",
"string"
],
"format": "uri"
},
"validateEndpointCertificate": {
"type": "boolean"
}
},
"allOf": [
{
"if": {
"oneOf": [
{
"properties": {
"userName": {
"type": "string"
},
"clientId": {
"type": "null"
}
}
},
{
"properties": {
"userName": {
"type": "null"
},
"clientId": {
"type": "string"
}
}
},
{
"properties": {
"userName": {
"type": "null"
},
"clientId": {
"type": "null"
}
}
}
]
},
"then": {
"properties": {
"userName": {
"type": [
"null",
"string"
]
},
"clientId": {
"type": [
"null",
"string"
]
}
}
},
"else": {
"properties": {
"userName": {
"type": "null",
"description": "Specify userName or clientId, but not both"
},
"clientId": {
"type": "null",
"description": "Specify userName or clientId, but not both"
}
}
}
},
{
"if": {
"oneOf": [
{
"properties": {
"userName": {
"type": "string"
},
"clientSecret": {
"type": "null"
}
}
},
{
"properties": {
"userName": {
"type": "null"
},
"clientSecret": {
"type": "string"
}
}
},
{
"properties": {
"userName": {
"type": "null"
},
"clientSecret": {
"type": "null"
}
}
}
]
},
"then": {
"properties": {
"userName": {
"type": [
"null",
"string"
]
},
"clientSecret": {
"type": [
"null",
"string"
]
}
}
},
"else": {
"properties": {
"userName": {
"type": "null",
"description": "Specify userName or clientSecret, but not both"
},
"clientSecret": {
"type": "null",
"description": "Specify userName or clientSecret, but not both"
}
}
}
},
{
"if": {
"oneOf": [
{
"properties": {
"password": {
"type": "string"
},
"clientSecret": {
"type": "null"
}
}
},
{
"properties": {
"password": {
"type": "null"
},
"clientSecret": {
"type": "string"
}
}
},
{
"properties": {
"password": {
"type": "null"
},
"clientSecret": {
"type": "null"
}
}
}
]
},
"then": {
"properties": {
"password": {
"type": [
"null",
"string"
]
},
"clientSecret": {
"type": [
"null",
"string"
]
}
}
},
"else": {
"properties": {
"password": {
"type": "null",
"description": "Specify password or clientSecret, but not both"
},
"clientSecret": {
"type": "null",
"description": "Specify password or clientSecret, but not both"
}
}
}
},
{
"if": {
"oneOf": [
{
"properties": {
"clientId": {
"type": "string"
},
"password": {
"type": "null"
}
}
},
{
"properties": {
"clientId": {
"type": "null"
},
"password": {
"type": "string"
}
}
},
{
"properties": {
"clientId": {
"type": "null"
},
"password": {
"type": "null"
}
}
}
]
},
"then": {
"properties": {
"clientId": {
"type": [
"null",
"string"
]
},
"password": {
"type": [
"null",
"string"
]
}
}
},
"else": {
"properties": {
"clientId": {
"type": "null",
"description": "Specify clientId or password, but not both"
},
"password": {
"type": "null",
"description": "Specify clientId or password, but not both"
}
}
}
}
]
},
"childrenUniqueKey": "/id"
}