Giter Club home page Giter Club logo

piweb-api's Introduction

PiWeb-Api

ZEISS PiWeb

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.

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"
        }
    }, "..."
]

Additional to the HTTP/S based REST API there is also a .NET client library.

Learn more

piweb-api's People

Contributors

daniel-lahmann avatar daniel-flemming avatar czfechner avatar schnjan avatar czthiele avatar kevinschienercz avatar i3ck avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.