{
  "opencollection": "1.0.0",
  "info": {
    "name": "OSIsoft PI Web API",
    "version": "2023.2.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "DataServers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List PI Data Archive servers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{piwebapi_host}/piwebapi/dataservers",
            "params": [
              {
                "name": "selectedFields",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to return"
              }
            ]
          },
          "docs": "Returns all registered PI Data Archive servers accessible via this PI Web API instance."
        }
      ]
    },
    {
      "info": {
        "name": "PIPoints",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List PI points on a server",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{piwebapi_host}/piwebapi/dataservers/:webId/points",
            "params": [
              {
                "name": "webId",
                "value": "",
                "type": "path",
                "description": "PI Web API WebId (unique opaque identifier for PI System objects)"
              },
              {
                "name": "nameFilter",
                "value": "",
                "type": "query",
                "description": "Wildcard filter for tag names (e.g. *.FLOW)"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Filter by point type"
              },
              {
                "name": "maxCount",
                "value": "",
                "type": "query"
              },
              {
                "name": "startIndex",
                "value": "",
                "type": "query"
              },
              {
                "name": "selectedFields",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns PI points (tags) on the specified PI Data Archive server with optional name filtering."
        },
        {
          "info": {
            "name": "Get a PI point",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{piwebapi_host}/piwebapi/points/:webId",
            "params": [
              {
                "name": "webId",
                "value": "",
                "type": "path",
                "description": "PI Web API WebId (unique opaque identifier for PI System objects)"
              },
              {
                "name": "selectedFields",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns PI point configuration and metadata."
        }
      ]
    },
    {
      "info": {
        "name": "Streams",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get current stream value",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{piwebapi_host}/piwebapi/streams/:webId/value",
            "params": [
              {
                "name": "webId",
                "value": "",
                "type": "path",
                "description": "PI Web API WebId (unique opaque identifier for PI System objects)"
              },
              {
                "name": "desiredUnits",
                "value": "",
                "type": "query",
                "description": "Unit of measure for the returned value"
              },
              {
                "name": "selectedFields",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns the current (snapshot) value for a PI point or AF attribute stream."
        },
        {
          "info": {
            "name": "Get recorded stream values",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{piwebapi_host}/piwebapi/streams/:webId/recorded",
            "params": [
              {
                "name": "webId",
                "value": "",
                "type": "path",
                "description": "PI Web API WebId (unique opaque identifier for PI System objects)"
              },
              {
                "name": "startTime",
                "value": "",
                "type": "query",
                "description": "Start time (absolute or relative, e.g. \"*-1d\" or \"2026-03-01T00:00:00Z\")"
              },
              {
                "name": "endTime",
                "value": "",
                "type": "query",
                "description": "End time"
              },
              {
                "name": "boundaryType",
                "value": "",
                "type": "query"
              },
              {
                "name": "maxCount",
                "value": "",
                "type": "query"
              },
              {
                "name": "desiredUnits",
                "value": "",
                "type": "query"
              },
              {
                "name": "selectedFields",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns archive (recorded) values for a PI point or AF attribute within a time range."
        },
        {
          "info": {
            "name": "Get interpolated stream values",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{piwebapi_host}/piwebapi/streams/:webId/interpolated",
            "params": [
              {
                "name": "webId",
                "value": "",
                "type": "path",
                "description": "PI Web API WebId (unique opaque identifier for PI System objects)"
              },
              {
                "name": "startTime",
                "value": "",
                "type": "query"
              },
              {
                "name": "endTime",
                "value": "",
                "type": "query"
              },
              {
                "name": "interval",
                "value": "",
                "type": "query",
                "description": "Interval between values (e.g. \"1h\", \"5m\")"
              },
              {
                "name": "desiredUnits",
                "value": "",
                "type": "query"
              },
              {
                "name": "maxCount",
                "value": "",
                "type": "query"
              },
              {
                "name": "selectedFields",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns interpolated values at a fixed time interval within a time range."
        },
        {
          "info": {
            "name": "Get stream summary statistics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{piwebapi_host}/piwebapi/streams/:webId/summary",
            "params": [
              {
                "name": "webId",
                "value": "",
                "type": "path",
                "description": "PI Web API WebId (unique opaque identifier for PI System objects)"
              },
              {
                "name": "startTime",
                "value": "",
                "type": "query"
              },
              {
                "name": "endTime",
                "value": "",
                "type": "query"
              },
              {
                "name": "summaryType",
                "value": "",
                "type": "query",
                "description": "Comma-separated summary types"
              },
              {
                "name": "calculationBasis",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns statistical summaries (min, max, average, count, etc.) for a stream over a time range."
        }
      ]
    },
    {
      "info": {
        "name": "AssetServers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Asset Framework servers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{piwebapi_host}/piwebapi/assetservers"
          },
          "docs": "Returns all registered PI Asset Framework (AF) servers."
        }
      ]
    },
    {
      "info": {
        "name": "Elements",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List AF elements",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{piwebapi_host}/piwebapi/assetdatabases/:webId/elements",
            "params": [
              {
                "name": "webId",
                "value": "",
                "type": "path",
                "description": "PI Web API WebId (unique opaque identifier for PI System objects)"
              },
              {
                "name": "nameFilter",
                "value": "",
                "type": "query"
              },
              {
                "name": "templateName",
                "value": "",
                "type": "query"
              },
              {
                "name": "maxCount",
                "value": "",
                "type": "query"
              },
              {
                "name": "selectedFields",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns top-level AF elements in an asset database."
        }
      ]
    },
    {
      "info": {
        "name": "Attributes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List element attributes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{piwebapi_host}/piwebapi/elements/:webId/attributes",
            "params": [
              {
                "name": "webId",
                "value": "",
                "type": "path",
                "description": "PI Web API WebId (unique opaque identifier for PI System objects)"
              },
              {
                "name": "nameFilter",
                "value": "",
                "type": "query"
              },
              {
                "name": "selectedFields",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns attributes of an AF element."
        }
      ]
    },
    {
      "info": {
        "name": "EventFrames",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Query event frames",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{piwebapi_host}/piwebapi/eventframes",
            "params": [
              {
                "name": "databaseWebId",
                "value": "",
                "type": "query",
                "description": "AF database WebId to search"
              },
              {
                "name": "startTime",
                "value": "",
                "type": "query"
              },
              {
                "name": "endTime",
                "value": "",
                "type": "query"
              },
              {
                "name": "nameFilter",
                "value": "",
                "type": "query"
              },
              {
                "name": "templateName",
                "value": "",
                "type": "query"
              },
              {
                "name": "maxCount",
                "value": "",
                "type": "query"
              },
              {
                "name": "selectedFields",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns event frames matching specified criteria within a time range."
        }
      ]
    },
    {
      "info": {
        "name": "BatchRequests",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Execute a batch request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{piwebapi_host}/piwebapi/batch",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Executes multiple PI Web API requests in a single HTTP call. Supports sequential and parallel execution with parameter substitution between requests."
        }
      ]
    }
  ],
  "bundled": true
}