Request

Response

    Quick Reference

    Documents

    OperationMethod + Endpoint
    Get a Document GET /documents/{documentID}
    Add a Document POST /documents
    Delete a Document DELETE /documents/{documentID}

    Groups

    OperationMethod + Endpoint
    Get Groups for user GET /groups
    Get a Group definition GET /groups/{groupID}
    Get history for a given group POST /groups/{groupID}/history
    Add user to Group PUT /groups/{groupID}/users/{userID}

    Modeldata

    OperationMethod + Endpoint
    Create an Element POST /create
    Read from database POST /scan
    Get model history POST /modeldata/{modelID}/history
    Write to database POST /mutate
    Get database schema GET /schema

    Streams

    OperationMethod + Endpoint
    Get Streams secrets POST /models/{modelID}/getstreamssecrets
    Reset Streams secrets POST /models/{modelID}/resetstreamssecrets
    Delete Stream data POST /timeseries/models/{modelID}/deletestreamsdata
    Get Latest Stream data POST /timeseries/models/{modelID}/streams
    Get Stream data GET /timeseries/models/{modelID}/streams/{elementID}
    Save Stream data POST /timeseries/models/{modelID}/streams/{elementID}
    Streams webhook POST /timeseries/models/{modelID}/webhooks/generic

    Stream Configs

    OperationMethod + Endpoint
    List Stream Configurations GET /models/{modelID}/stream-configs
    Update Streams Configurations PATCH /models/{modelID}/stream-configs
    Get Stream Configuration GET /models/{modelID}/stream-configs/{elementID}
    Save Stream Configuration PUT /models/{modelID}/stream-configs/{elementID}

    Templates

    OperationMethod + Endpoint
    Get template for twin GET /inlinetemplate

    Twins

    OperationMethod + Endpoint
    Get Twins for a group GET /groups/{groupID}/twins
    Create Twin POST /groups/{groupID}/twins
    Get Twin definition GET /twins/{twinID}
    Check access permission to Twin HEAD /twins{twinID}
    Create default model POST /defaultmodel
    Get twin history POST /twins/{twinID}/history
    Get users of Twin GET /users

    Views

    OperationMethod + Endpoint
    Get saved Views GET /views