Data endpoints REST URLs
- Last UpdatedNov 11, 2025
- 3 minute read
- PI System
- Adapter for OPC UA 1.6
- Adapters
The following is a list of available REST URLs:
|
HTTP verb |
Relative URL |
Action |
|---|---|---|
|
|
api/v1/configuration/omfegress/DataEndpoints |
Gets all configured Egress endpoints |
|
|
api/v1/configuration/omfegress/DataEndpoints |
Deletes all configured Egress endpoints |
|
|
api/v1/configuration/omfegress/DataEndpoints |
Adds an array of Egress endpoints or a single endpoint. Fails if any endpoint already exists |
|
|
api/v1/configuration/omfegress/DataEndpoints |
Replaces all Egress endpoints |
|
|
api/v1/configuration/omfegress/DataEndpoints |
Allows partial updating of configured endpoints. Note: The request must be an array containing one or more endpoints. Each endpoint in the array must include its Id. |
|
|
api/v1/configuration/omfegress/DataEndpoints/{Id} |
Gets configured endpoint by Id |
|
|
api/v1/configuration/omfegress/DataEndpoints/{Id} |
Deletes configured endpoint by Id |
|
|
api/v1/configuration/omfegress/DataEndpoints/{Id} |
Updates or creates a new endpoint with the specified Id |
|
|
api/v1/configuration/omfegress/DataEndpoints/{Id} |
Allows partial updating of configured endpoint by Id |
Egress execution details
-
After configuring an Egress endpoint, egress is immediately run for that endpoint. Egress is handled individually per configured endpoint. When data is egressed for the first time, types and containers are egressed to the configured endpoint. After that only new or changed types or containers are egressed. Type creation must be successful in order to create containers. Container creation must be successful in order to egress data.
-
If you delete an Egress endpoint, data flow immediately stops for that endpoint. Buffered data in a deleted endpoint is permanently lost.
-
Type, container, and data items are batched into one or more messages when egressing. As per the requirements defined in , a single message payload will not exceed 192KB in size. Compression is automatically applied to outbound egress messages. On the egress destination, failure to add a single item results in the message failing. Types, containers, and data are egressed as long as the destination continues to respond to requests.