Skip to content

hcc1084404/PiWeb-Api

 
 

Repository files navigation

PiWeb-Api

Build status Build status

The PiWeb-API is a communication interface for the quality data management system ZEISS PiWeb. The interface is based on an HTTP/S web service architecture.

What's the PiWeb-API?

The PiWeb-API provides an extensive set of web service endpoints for reading and writing measurement and quality data from and to the PiWeb server. With these HTTP/S endpoints it is very easy to read and write the inspection plan structure as well as measurements and measurement values.

Additional to the HTTP/S based REST API there is also a .NET client library, which is available on NuGet.org: Zeiss.PiWeb.Api.Rest.

API .NET SDK v6.0.0 introduced major architectural changes. Updating to version 6.0.0? Please follow our migration guide to adapt your application to recent changes!

Learn more

Questions, bugs or improvement ideas?

Feel free to create an issue in this repositroy and we will try to help you as fast as possible.

Examples

Detailed examples for both REST API and .NET SDK can be found in the documentation.

Fetching the attribute configuration:
http://your-piweb-server/dataServiceRest/configuration
{
    "partAttributes":
    [
        {
            "key": 1001,
            "description": "part number",
            "length": 30,
            "type": "AlphaNumeric",
            "definitionType": "AttributeDefinition"
        }, "..."
    ],
    "characteristicAttributes":
    [
        {
            "key": 2101,
            "description": "Nominal",
            "length": 0,
            "type": "Float",
            "definitionType": "AttributeDefinition"
        },
        {
            "key": 2110,
            "description": "Lower tolerance",
            "length": 0,
            "type": "Float",
            "definitionType": "AttributeDefinition"
        },
        {
            "key": 2111,
            "description": "Upper tolerance",
            "length": 0,
            "type": "Float",
            "definitionType": "AttributeDefinition"
        }, "..."
    ],
    "measurementAttributes": [ "..." ],
    "valueAttributes":
    [
        {
            "key": 1,
            "description": "measured value",
            "length": 0,
            "type": "Float",
            "definitionType": "AttributeDefinition"
        }
    ],
    "catalogAttributes": [ "..." ]
}
Fetching all parts
http://your-piweb-server/dataServiceRest/parts?depth=10000
[
    {
        "path": "/",
        "charChangeDate": "2015-03-26T08:56:51.487Z",
        "attributes": { },
        "uuid": "00000000-0000-0000-0000-000000000000",
        "version": 0,
        "timestamp": "2014-10-07T13:39:34.74Z",
        "current": true
    },  "..."
]
Fetching the 10 most recent measurements
http://your-piweb-server/dataServiceRest/measurements?limitResult=10
[
   {
        "uuid": "64a47361-9b5b-43e3-9774-45e2862e65ab",
        "partUuid": "4ce9ba9a-794f-4e57-beb2-c84612065179",
        "lastModified": "2015-03-26T08:51:29.343Z",
        "attributes":
        {
            "4": "2014-12-05T14:25:55Z"
        }
    },
    {
        "uuid": "c0b784f1-d85b-4c46-8f39-7824567004aa",
        "partUuid": "4ce9ba9a-794f-4e57-beb2-c84612065179",
        "lastModified": "2015-03-26T08:48:35.14Z",
        "attributes":
        {
            "4": "2014-12-05T13:25:55Z"
        }
    }, "..."
]

About

An API to communicate with the ZEISS PiWeb quality data management system

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 98.7%
  • PowerShell 1.2%
  • Batchfile 0.1%