Health endpoints parameters

id

Optional

string

Uniquely identifies the endpoint. This can be any alphanumeric string. If left blank, a unique value is generated automatically.

Allowed value: any string identifier
Default value: new GUID (Globally Unique Identifier)

endpoint

Required

string

The URL (Uniform Resource Locator) of the OMF (Open Message Format) endpoint to receive this health data.

Allowed value: well-formed http or https endpoint string
Default: null

username

Required for PI Web API endpoints

string

The username used to authenticate with a PI Web API OMF (Open Message Format) endpoint.

AVEVA PI Server:

Allowed value: any string
Default: null

password

Required for PI Web API endpoints

string

The password used to authenticate with a PI Web API OMF (Open Message Format) endpoint.

AVEVA PI Server:

Allowed value: any string
Default: null

clientId

Required for CONNECT data services endpoints

string

The client ID used for authentication with a CONNECT data services OMF (Open Message Format) endpoint.

Allowed value: any string
Default: null

clientSecret

Required for CONNECT data services endpoints

string

The client secret used for authentication with a CONNECT data services OMF (Open Message Format) endpoint.

Allowed value: any string
Default: null

tokenEndpoint

Optional for CONNECT data services endpoints

string

Retrieves a CONNECT data services token from an alternative endpoint.

Allowed value: well-formed http or https endpoint string
Default value: null

validateEndpointCertificate

Optional

boolean

Disables verification of destination security certificate. Use for testing only with self-signed certificates; AVEVA recommends keeping this set to the default (true) in production environments.

Allowed value: true or false
Default value: true