PI Web API 2018 SP1 Swagger Spec

osisoft · Company

Company No Auth Free & Open enterprise

Swagger Spec file that describes PI Web API

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Retrieve an Analysis by path.

This method returns an Analysis based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analyses?path=example&webIdType=example&selectedFields=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analyses?path=example&webIdType=example&selectedFields=example"

import requests
params = {
    "path": "example",
    "webIdType": "example",
    "selectedFields": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analyses",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analyses');
url.searchParams.set('path', 'example');
url.searchParams.set('webIdType', 'example');
url.searchParams.set('selectedFields', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analyses")
	q := baseURL.Query()
	q.Set("path", "example")
	q.Set("webIdType", "example")
	q.Set("selectedFields", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analyses")
uri.query = URI.encode_www_form({
  "path" => "example",
  "webIdType" => "example",
  "selectedFields" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analyses?" . http_build_query([
    "path" => "example",
    "webIdType" => "example",
    "selectedFields" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Retrieve an analysis category by path.

Retrieve an analysis category by path.

https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analysiscategories?path=example&webIdType=example&selectedFields=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analysiscategories?path=example&webIdType=example&selectedFields=example"

import requests
params = {
    "path": "example",
    "webIdType": "example",
    "selectedFields": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analysiscategories",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analysiscategories');
url.searchParams.set('path', 'example');
url.searchParams.set('webIdType', 'example');
url.searchParams.set('selectedFields', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analysiscategories")
	q := baseURL.Query()
	q.Set("path", "example")
	q.Set("webIdType", "example")
	q.Set("selectedFields", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analysiscategories")
uri.query = URI.encode_www_form({
  "path" => "example",
  "webIdType" => "example",
  "selectedFields" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analysiscategories?" . http_build_query([
    "path" => "example",
    "webIdType" => "example",
    "selectedFields" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Retrieve an Analysis Rule Plug-in by path.

This method returns an Analysis Rule Plug-in based on the hierarchical path associated with it, and should be used when a path has been received from a separate part of the PI System for use in the PI Web API. Users should primarily search with the WebID when available.

https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analysisruleplugins?path=example&webIdType=example&selectedFields=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analysisruleplugins?path=example&webIdType=example&selectedFields=example"

import requests
params = {
    "path": "example",
    "webIdType": "example",
    "selectedFields": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analysisruleplugins",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analysisruleplugins');
url.searchParams.set('path', 'example');
url.searchParams.set('webIdType', 'example');
url.searchParams.set('selectedFields', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analysisruleplugins")
	q := baseURL.Query()
	q.Set("path", "example")
	q.Set("webIdType", "example")
	q.Set("selectedFields", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analysisruleplugins")
uri.query = URI.encode_www_form({
  "path" => "example",
  "webIdType" => "example",
  "selectedFields" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/osisoft.com/1.11.1.5383/analysisruleplugins?" . http_build_query([
    "path" => "example",
    "webIdType" => "example",
    "selectedFields" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with PI Web API 2018 SP1 Swagger Spec?

PI Web API 2018 SP1 Swagger Spec is a Company API. Developers commonly use company APIs for:

enriching CRM records with company firmographics
building lead-generation and prospecting tools
verifying business identity and registration details
monitoring competitors and market intelligence
powering B2B data enrichment pipelines

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. PI Web API 2018 SP1 Swagger Spec is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide

Open documentation ↗