Skip to main content

OSIsoft PI System™

The OIBus agent can receive the following HTTP calls. The agent run a local PI module through an inter-process communication.

HTTP API​

Status​

curl --location 'http://localhost:2224/api/pi/id/status'

Connection​

curl --location --request PUT 'http://localhost:2224/api/pi/id/connect' \
--header 'Content-Type: application/json' \
--data '{}'

Read​

curl --location --request PUT 'http://localhost:2224/api/pi/id/read' \
--header 'Content-Type: application/json' \
--data '{
    "startTime": "2023-11-02T15:00:00.000Z",
    "endTime": "2023-11-02T16:00:00.000Z",
    "items": [
        {
            "name": "PUMP01.Bearing Temperature",
            "type": "pointId",
            "piPoint": "OSIDemo_Pump01.Bearing Temperature.7918cae4-e10a-5af6-340b-5b8d9da3f5b2",
        },
        {
            "name": "PUMP02",
            "type": "pointQuery",
            "piQuery": "OSIDemo_Pump02*",
        }
    ]
}'

Disconnection​

curl --location --request DELETE 'http://localhost:2224/api/pi/id/disconnect'