Once Open-Plant (Full Version) is installed, Open-Plant provides Web API endpoints which return JSON data about tags, users, and most importantly data values from the connected devices. There are no special licenses for this. Web APIs are accessible even on the free version. The base Web API Address is 'https://127.0.0.1:33170/api' for secure https and 'http://127.0.0.1:33171/api' for unsecure http endpoints. If windows authentication is used '/wa' must be followed before api, such as 'https//127.0.0.1:33170/wa/api' and 'http://127.0.0.1:33171/wa/api'.

All request must use the appropriate HTTP Method. Open-Plant limits this to GET, PUT, PATCH, POST and DELETE.

GENERAL APIS

GET

Server Info

This API returns the current server information. This API is typically used as the first call to the Open-Plant server, acting as a simple server 'PING'.

Examples:

https://127.0.0.1:33170/api/serverinfo
https://127.0.0.1:33170/wa/api/serverinfo

*Add '/wa' before '/api' when the calling user is authenticated with his windows id

Returns (JSON):

{
  "data": {
    "Version": "1.0.0.0",
    "MachineName": "MYSERVER",
    "ServerTimeUTC": "2020-08-01T23:30:24.0414514Z",
    "TagCount": 7,
    "IsLicensed": false,
    "TagCountLicensedLimit": 3000,
    "License": null
  }
}

Security Restrictions

This API can be called by any users with Access Level 1 (L1User) or higher

POST

Authenticate User

This API is used to check the authenticity of a user based on it's 'username' and 'password' or current 'WindowsId', supplied at the request header. The user must exist in the Open-Plant User database.

To authenticate via username and password, see the example below (jsfiddle)

var xhttp = new XMLHttpRequest();
xhttp.open("POST", "https://127.0.0.1:33170/api/authenticate", true);
xhttp.setRequestHeader('Authorization', 'Basic ' + window.btoa('USERNAME:PASSWORD'));
xhttp.send();
xhttp.onreadystatechange = function(){
  if (xhttp.readyState === XMLHttpRequest.DONE) {
    if (xhttp.status === 200) document.write("SUCCESS!"); else document.write("FAILED!");
  }
};

To authenticate via windows Id, see the example below (jsfiddle)

var xhttp = new XMLHttpRequest();
xhttp.open("POST", "https://127.0.0.1:33170/wa/api/authenticate", true);
xhttp.withCredentials = true;
xhttp.send();
xhttp.onreadystatechange = function(){
  if (xhttp.readyState === XMLHttpRequest.DONE) {
    if (xhttp.status === 200) document.write("SUCCESS!");
    else document.write("FAILED!");
  }
};

An optional 'twofactorkey' can also be provided for users with Two Factor Authentication enabled. If the user is not authentic, the API will return a '401 Unauthorized' response.

This API is NOT a pre-requisite for other API calls. In fact, every WebAPI call authenticates the caller. This API is just a simple check. However...

For users with two factor authentication enabled, this API is the only API that allows the User to set 'verified' status on the 'twofactorkey' challenge. Without the 'verified' status, users that have two factor authentication enabled will not be able to perform any other API calls. The 'verified' status lasts as long as the user is active. if the user is inactive for more than 1 hour, the two factor key 'verified' status will expire. The user will have to call this API again with a new 'twofactorkey' specified. This API is thus usually implemented on a login screen.

This API will return the user object and a 'AuthenticationResult' variable, which will return 'true' if the provided password (and two factor key is correct).

Examples:

https://127.0.0.1:33170/api/authenticate
https://127.0.0.1:33170/api/authenticate?twofactorkey=312345
https://127.0.0.1:33170/wa/api/authenticate

*Add '/wa' before '/api' when the calling user is authenticated with his windows id

Returns (JSON):

{
    "AuthenticationResult": true,
    "data": {
        "Username": "Administrator",
        "UserRole": 10,
        "AccessLevel": 10,
        "FullName": "aaa",
        "Email": "aaa",
        "AccountType": 0,
        "Google2FactAuthEnable": false,
        "API": true,
        "Custom1": "",
        "Custom2": "",
        "Custom3": "",
        "Custom4": "",
        "Custom5": "",
        "Custom6": "",
        "Custom7": "",
        "Custom8": "",
        "Custom9": ""
    }
}

Security Restrictions

This API can be accessed by anyone as long as they provide a valid Username/Password or Windows Id

USER APIS

GET

Single User

This API gets the requested user and it's details in a JSON object.

Examples:

https://127.0.0.1:33170/api/users/?username=azrinsani
https://127.0.0.1:33170/api/users/?username=administrator
https://127.0.0.1:33170/api/users/?username=AZRINLAPTOP2\azrin

https://127.0.0.1:33170/wa/api/users/?username=AZRINLAPTOP2\azrin

*Add '/wa' before '/api' if the calling user is authenticating with windows id (Integrated Logins)

Returns (JSON):

{
  "data": {
    "Username": "AZRINLAPTOP2\azrin",
    "UserRole": "Administrator",
    "AccessLevel": 10,
    "FullName": "",
    "Email": "",
    "AccountType": 1,
    "AccountTypeName": "WindowsUser",
    "Google2FactAuthEnable": false,
    "API": true,
    "Custom1": "",
    "Custom2": "",
    "Custom3": "",
    "Custom4": "",
    "Custom5": "",
    "Custom6": "",
    "Custom7": "",
    "Custom8": "",
    "Custom9": ""
  }
}

Security Restrictions

Apart from Administrators, this API can only view the caller or users lower than the caller's access level

GET

Multiple User(s)

This API lists users and it's details in a JSON object. A search 'wildcard' parameter can be passed as a parameter. The wildcard search is NOT case sensitive.

Examples:

https://127.0.0.1:33170/api/users
https://127.0.0.1:33170/api/users?wildcard=*administ*

https://127.0.0.1:33170/wa/api/users

*Add '/wa' before '/api' if the calling user is authenticating with his windows id (Integrated Logins)

Returns (JSON):

{
  "data": [
    {
      "Username": "Administrator",
      "UserRole": "Administrator",
      "AccessLevel": 10,
      "FullName": "",
      "Email": "",
      "AccountType": 0,
      "AccountTypeName": "Standard",
      "Google2FactAuthEnable": false,
      "API": true,
      "Custom1": "",
      "Custom2": "",
      "Custom3": "",
      "Custom4": "",
      "Custom5": "",
      "Custom6": "",
      "Custom7": "",
      "Custom8": "",
      "Custom9": ""
    },
    {
      "Username": "AZRINLAPTOP2\azrin",
      "UserRole": "Administrator",
      "AccessLevel": 10,
      "FullName": "",
      "Email": "",
      "AccountType": 1,
      "AccountTypeName": "WindowsUser",
      "Google2FactAuthEnable": false,
      "API": true,
      "Custom1": "",
      "Custom2": "",
      "Custom3": "",
      "Custom4": "",
      "Custom5": "",
      "Custom6": "",
      "Custom7": "",
      "Custom8": "",
      "Custom9": ""
    }
  ]
}

{
  "data": [
    {
      "Username": "Administrator",
      "UserRole": "Administrator",
      "AccessLevel": 10,
      "FullName": "",
      "Email": "",
      "AccountType": 0,
      "AccountTypeName": "Standard",
      "Google2FactAuthEnable": false,
      "API": true,
      "Custom1": "",
      "Custom2": "",
      "Custom3": "",
      "Custom4": "",
      "Custom5": "",
      "Custom6": "",
      "Custom7": "",
      "Custom8": "",
      "Custom9": ""
    }
  ]
}

Security Restrictions

Apart from Administrators, this API will only return the caller user himself or users lower than the caller's access level

PUT

Create User

This API creates a new user inside Open-Plant. If the user creation was successful, the API will return the current user object. If the user to be created already exists, the API will return a '409 Conflict' reponse.

The following parameters can be added such as:
- 'username' is the user's login name. It must be specified and must be unqiue. It is NOT case sensitive.
- 'password' is the user's new password. It must be specified for 'Standard' account type (Account type 0)
- 'accounttype' can either be '0','Standard' or '1','WindowsUser' or '2','WindowsGroup'. If not specified, the default will be '1'(WindowsUser)
- 'accesslevel' can either be '1' (L1User),'2','3',....'10'(Administrator). If not specified, the default will be '1'(L1User)
- 'tfaenable' indicates whether Two Factor Authentication is enabled for this user. Can be either 'true' or 'false'. Default is 'false'.
NOTE: Two Factor Authentication can only be enabled for Account Type 'Standard'. When Two Factor Authentication is enabled, the API will return a user object which includes the QR Code URL and Manual Entry Key.

- 'fullname' is the full name of the user, for record purpose only.
- 'email' is the user's email address, for record purpose only.
- 'custom1'..'custom9' are custom fields which can be used to provide additional data for the user.

Examples:

https://localhost:33170/api/users/?username=Jack&password=Cr@zy\Pa55w0Rd/\*.
https://localhost:33170/api/users/?username=Jack&password=Cr@zy\Pa55w0Rd/\*.&accounttype=1
https://localhost:33170/api/users/?username=Jack&password=Cr@zy\Pa55w0Rd/\*.&accounttype=0&accesslevel=10
https://localhost:33170/api/users/?username=Jack&password=Cr@zy\Pa55w0Rd/\*.&accounttype=0&accesslevel=9&tfaenable=true&custom1=CUSTOM PARAMETER FOR USER&custom7=CUSTOME PARAMETER FOR USE2
https://localhost:33170/api/users/?username=MYDOMAIN\Jack&accounttype=2

https://localhost:33170/wa/api/users/?username=Jack&password=Cr@zy\Pa55w0Rd/\*.

*Add '/wa' before '/api' if the calling user is authenticating with his windows id (Integrated Logins)

Returns (JSON):

{
  "data": {
    "Username": "MYDOMAIN\Jack",
    "UserRole": "Manager",
    "AccessLevel": 9,
    "FullName": null,
    "Email": null,
    "AccountType": 1,
    "AccountTypeName": "WindowsUser",
    "TwoFactorAuthEnable": false,
    "API": true,
    "Custom1": "CUSTOM PARAMETER FOR USER",
    "Custom2": null,
    "Custom3": null,
    "Custom4": null,
    "Custom5": null,
    "Custom6": null,
    "Custom7": "CUSTOME PARAMETER FOR USE2",
    "Custom8": null,
    "Custom9": null
  }
}

{
  "data": {
    "Username": "Jack",
    "UserRole": "Manager",
    "AccessLevel": 9,
    "FullName": null,
    "Email": null,
    "AccountType": 0,
    "AccountTypeName": "Standard",
    "TwoFactorAuthEnable": true,
    "API": true,
    "Custom1": "CUSTOM PARAMETER FOR USER",
    "Custom2": null,
    "Custom3": null,
    "Custom4": null,
    "Custom5": null,
    "Custom6": null,
    "Custom7": "CUSTOME PARAMETER FOR USE2",
    "Custom8": null,
    "Custom9": null,
    "TwoFactorAuthQRCodeURL": "http://chart.googleapis.com/chart?cht=qr&chs=300x300&chl=otpauth%3A%2F%2Ftotp%2FLogin%3Fsecret%3DMQ2WMNTBGI4WIMRSGIZA%26issuer%3DOpen-Plant",
    "TwoFactorAuthManualEntry": "MQ2WMNTBGI4WIMRSGIZA"
  }
}

*When Two Factor Authentication is enabled, the API will return a user object which includes the QR Code URL and Manual Entry Key.

Security Restrictions

Apart from Administrators, this API can only be used to create users lower than the caller's access level

PATCH

Update User

This API updates a user in Open-Plant. If the user update was successful, the API will return the updated user object. If the user to be updated does not exist, the API will return a '404 Not Found' reponse.
The 'username' parameter must be specified as it denotes the user to be updated.

The following parameters can be added/updated.
- 'newusername' is the new username of the user. If specified, the user's current username will be changed.
- 'password' is the user's new password. If specified, the new pasword will replace the old password.
- 'accounttype' can either be '0','Standard' or '1','WindowsUser' or '2','WindowsGroup'.
- 'accesslevel' can either be '1' (L1User),'2','3',....'10'(Administrator).
- 'tfaenable' indicates whether Two Factor Authentication is enabled for this user. Can be either 'true' or 'false'. Default is 'false'.
- 'resettfa' if set 'true' will reset the current Two Factor Authentication code. A new QR Code URL and Manual Entry Key will be returned in the updated user object.
- 'fullname' is the full name of the user, for record purpose only.
- 'email' is the user's email address, for record purpose only.
- 'custom1'..'custom9' are custom fields which can be used to provide additional data for the user.

Examples:

https://localhost:33170/api/users/?username=jack&newusername=jack2
https://localhost:33170/api/users/?username=Jack&password=Cr@zy\Pa55w0Rd/\*.
https://localhost:33170/api/users/?username=Jack&resettfa=true
https://localhost:33170/api/users/?username=Jack&accounttype=0&accesslevel=9&tfaenable=true&custom1=CUSTOM PARAMETER FOR USER&custom7=CUSTOME PARAMETER FOR USE2
https://localhost:33170/api/users/?username=jack&newusername=MYDOMAIN\Jack&accounttype=2
https://localhost:33170/wa/api/users/?username=jack&newusername=jack2

*Add '/wa' before '/api' if the calling user is authenticating with his windows id (Integrated Logins)

Returns (JSON):

{
  "data": {
    "Username": "jack2",
    "UserRole": "Manager",
    "AccessLevel": 9,
    "FullName": "",
    "Email": "",
    "AccountType": 0,
    "AccountTypeName": "Standard",
    "TwoFactorAuthEnable": true,
    "API": true,
    "Custom1": "CUSTOM PARAMETER FOR USER",
    "Custom2": "this is a custom property",
    "Custom3": "",
    "Custom4": "",
    "Custom5": "",
    "Custom6": "",
    "Custom7": "CUSTOME PARAMETER FOR USE2",
    "Custom8": "",
    "Custom9": ""
  }
}

{
  "data": {
    "Username": "jack2",
    "UserRole": "Manager",
    "AccessLevel": 9,
    "FullName": "",
    "Email": "",
    "AccountType": 0,
    "AccountTypeName": "Standard",
    "TwoFactorAuthEnable": true,
    "API": true,
    "Custom1": "CUSTOM PARAMETER FOR USER",
    "Custom2": "this is a custom property",
    "Custom3": "",
    "Custom4": "",
    "Custom5": "",
    "Custom6": "",
    "Custom7": "CUSTOME PARAMETER FOR USE2",
    "Custom8": "",
    "Custom9": "",
    "TwoFactorAuthQRCodeURL": "http://chart.googleapis.com/chart?cht=qr&chs=300x300&chl=otpauth%3A%2F%2Ftotp%2FLogin%3Fsecret%3DGU2TMOBWGEYDMMBTG5SQ%26issuer%3DOpen-Plant",
    "TwoFactorAuthManualEntry": "GU2TMOBWGEYDMMBTG5SQ"
  }
}

*When 'resettfa' is set true, the API will return a user object which includes the QR Code URL and Manual Entry Key.

Security Restrictions

Apart from Administrators, the caller can only update himself and users lower than the caller's access level

DELETE

Delete User

This API deletes a user from Open-Plant. If the user to be deleted does not exist, the API will return a '404 Not Found' reponse. The 'username' parameter must be specified as it denotes the user to be deleted. The API will return the deleted user object.

Examples:

https://localhost:33170/api/users/?username=jack
https://localhost:33170/api/users/?username=MYDOMAIN\domainuser

https://localhost:33170/wa/api/users/?username=jack

*Add '/wa' before '/api' if the calling user is authenticating with his windows id (Integrated Logins)

Returns (JSON):

{
  "data": {
    "Username": "jack2",
    "UserRole": "Manager",
    "AccessLevel": 9,
    "FullName": "",
    "Email": "",
    "AccountType": 0,
    "AccountTypeName": "Standard",
    "TwoFactorAuthEnable": true,
    "API": true,
    "Custom1": "CUSTOM PARAMETER FOR USER",
    "Custom2": "this is a custom property",
    "Custom3": "",
    "Custom4": "",
    "Custom5": "",
    "Custom6": "",
    "Custom7": "CUSTOME PARAMETER FOR USE2",
    "Custom8": "",
    "Custom9": ""
  }
}

Security Restrictions

Apart from Administrators, the caller can only delete users lower than the caller's access level

TAG APIS

GET

Tag List

This API gets a simple list of tags into a JSON object. A search 'wildcard' parameter can be passed as parameter. Both the 'wildcard' and 'TagIds' parameter are NOT case sensitive.

Examples:

https://127.0.0.1:33170/api/taglist
https://127.0.0.1:33170/api/taglist?wildcard=*.pv

https://127.0.0.1:33170/wa/api/taglist?wildcard=*.pv

*Add '/wa' before '/api' if the calling user is authenticating with his windows id (Integrated Logins)

Returns (JSON):

{
  "data": [
    "random1.value",
    "myplant\tag.value",
    "random2.value"
  ]
}

{
    "data": []
}

Security Restrictions

This API can be called by any users with Access Level 1 (L1User) or higher

GET

Single Tag

This API returns a single tag with it's details in a JSON object. In Open-Plant, Tag Ids are not case sensitive. 'LiveValue' is a sub-object which denotes data the most recent and fresh data. Data is considered fresh when it is not older than the Tag's 'SampleTimeOutInS'. If Data is not fresh, it will return null. 'LastValue' also returns the most recent data but it does not care if the data is fresh or not. These objects return the sample time as 'TSUTC' in ISO8601 format with Time Zone always in UTC.

Example:

https://127.0.0.1:33170/api/tags/?tagid=FIC101.Value
https://127.0.0.1:33170/api/tags/?tagid=fic101.value   //This is same as above. Tag Ids are not case sensitive.

https://127.0.0.1:33170/wa/api/tags?tagid=FIC101.Value

*Add '/wa' before '/api' if the calling user is authenticating with his windows id (Integrated Logins)

Returns (JSON):

{
  "data": {
    "Id": "Random1.Value",
    "TagName": "Random1",
    "Parameter": "Value",
    "UnitOfMeasure": "",
    "Description": "",
    "Corporate": "",
    "Plant": "",
    "Area": "",
    "Unit": "",
    "Param1": "",
    "Param2": "",
    "Param3": "",
    "Param4": "",
    "Param5": "",
    "Param6": "",
    "Param7": "",
    "Param8": "",
    "Param9": "",
    "DataType": 0,
    "InterpType": 1,
    "SampleTimeoutInS": 180,
    "CacheSizeInNumberOfItems": 3600,
    "DuplicateThresholdInMS": 250,
    "DatabaseLocation": "pv_random1.value",
    "DatabaseLocationId": null,
    "LiveValue": null,
    "LastValue": {
      "TSUTC": "2020-07-28T03:28:01Z",
      "Value": -46.873633974173,
      "IsError": false
    },
    "Historize": true
  }
}

Security Restrictions

This API can be called by any users with Access Level 1 (L1User) or higher

GET

Multiple Tag(s)

This API gets a list of tags with it's details in a JSON object. In Open-Plant Tag Ids are not case sensitive. A search 'wildcard' parameter can be added. This wildcard search too is NOT case sensitive.

'LiveValue' is a sub-object which denotes data the most recent and fresh data. Data is considered fresh when it is not older than the Tag's 'SampleTimeOutInS'. If Data is not fresh, it will return null. 'LastValue' also returns the most recent data but it does not care if the data is fresh or not. These objects return the sample time as 'TSUTC' in ISO8601 format with Time Zone always in UTC.

Examples:

https://127.0.0.1:33170/api/tags
https://127.0.0.1:33170/api/tags?wildcard=random.real4
https://127.0.0.1:33170/api/tags?wildcard=random*

https://127.0.0.1:33170/wa/api/tags?wildcard=random*

*Add '/wa' before '/api' if the calling user is authenticating with his windows id (Integrated Logins)

Returns (JSON):

{
  "data": [
    {
      "Id": "Random1.Value",
      "TagName": "Random1",
      "Parameter": "Value",
      "UnitOfMeasure": "",
      "Description": "",
      "Corporate": "",
      "Plant": "",
      "Area": "",
      "Unit": "",
      "Param1": "",
      "Param2": "",
      "Param3": "",
      "Param4": "",
      "Param5": "",
      "Param6": "",
      "Param7": "",
      "Param8": "",
      "Param9": "",
      "DataType": 0,
      "InterpType": 1,
      "SampleTimeoutInS": 180,
      "CacheSizeInNumberOfItems": 3600,
      "DuplicateThresholdInMS": 250,
      "DatabaseLocation": "pv_random1.value",
      "DatabaseLocationId": null,
      "LiveValue": null,
      "LastValue": {
        "TSUTC": "2020-07-28T03:28:01.000Z",
        "Value": -46.873633974173,
        "IsError": false
      },
      "Historize": true
    },
    {
      "Id": "Random2.Value",
      "TagName": "Random2",
      "Parameter": "Value",
      "UnitOfMeasure": "",
      "Description": "",
      "Corporate": "",
      "Plant": "",
      "Area": "",
      "Unit": "",
      "Param1": "",
      "Param2": "",
      "Param3": "",
      "Param4": "",
      "Param5": "",
      "Param6": "",
      "Param7": "",
      "Param8": "",
      "Param9": "",
      "DataType": 0,
      "InterpType": 1,
      "SampleTimeoutInS": 180,
      "CacheSizeInNumberOfItems": 3600,
      "DuplicateThresholdInMS": 250,
      "DatabaseLocation": "pv_random2.value",
      "DatabaseLocationId": null,
      "LiveValue": null,
      "LastValue": {
        "TSUTC": "2020-07-28T03:28:01.000Z",
        "Value": 57.1790787196621,
        "IsError": false
      },
      "Historize": true
    }
  ]
}

{
  "data": [
    {
      "Id": "Random1.Value",
      "TagName": "Random1",
      "Parameter": "Value",
      "UnitOfMeasure": "m3hr",
      "Description": "This is a description",
      "Corporate": "Open-Plant",
      "Plant": "Refinery",
      "Area": "P1",
      "Unit": "CDU",
      "Param1": "",
      "Param2": "",
      "Param3": "",
      "Param4": "",
      "Param5": "",
      "Param6": "",
      "Param7": "",
      "Param8": "",
      "Param9": "",
      "DataType": 0,
      "InterpType": 1,
      "SampleTimeoutInS": 180,
      "CacheSizeInNumberOfItems": 3600,
      "DuplicateThresholdInMS": 250,
      "DatabaseLocation": "pv_random1.value",
      "DatabaseLocationId": null,
      "LiveValue": null,
      "LastValue": {
        "TSUTC": "2020-07-28T03:28:01.000Z",
        "Value": -46.873633974173,
        "IsError": false
      },
      "Historize": true
    }
  ]
}

Security Restrictions

This API can be called by any users with Access Level 1 (L1User) or higher

PUT

Create New Tag

This API allows the creation of a new Open-Plant Tag. In Open-Plant, the primary identifier for a tag is the 'TagId'. The TagId is a combination of two parameters, which is 'TagName' dot('.') 'Parameter'. For example, TagName 'FIC101' and Parameter 'PV', will result in Tag Id 'FIC101.PV'. The API allows one to specify 'TagId' or 'TagName' and 'Parameter'. In Open-Plant ,'TagId', 'TagName' and 'Parameter' are not case sensitive. If a Tag already exists it will return a '409 Conflict' response

Other parameters below are optional.
- 'unitofmeasure' is the engineering unit of the tag's value such as 'KG', 'DegC', 'N', 'M3HR'. This is important for display in charts.
- 'datatype' is the Data Type of the tag's value which can either be 'Real'(0),'Int'(1) or 'Bool'(2). Note: If datatype is not specified, the default is 'Real'
- 'interpolation' can either be 'Linear'(1) or 'Digital'(2). In 'Linear' interpolation, value is linear interpolated between two nearby raw samples. In 'Digital' interpolation, the last raw sample is taken. If interpolation is not specified, the default is 'Linear'
- 'description' is the Tag's description. This is important for display in GUI.
- 'corporate', 'plant', 'area', 'unit' are the physical locations of the tag in a typical plant hierarchy.
- 'p1','p2','p3'....'p9' are optional custom parameters.

The api will return the tag created in JSON if successful.

Examples:

https://127.0.0.1:33170/api/tags/?tagid=MyNewTag.pv
https://127.0.0.1:33170/api/tags/?tagname=MyNewTag&parameter=pv				//this will create the same Tag as above
https://127.0.0.1:33170/api/tags/?tagid=TIC1.pv&unitofmeasure=DegC&datatype=real&interpolation=linear
https://127.0.0.1:33170/api/tags/?tagid=TIC1.pv&unitofmeasure=DegC			//this will create the same Tag as above. Default 'datatype' is real and default 'interpolation' is linear
https://127.0.0.1:33170/api/tags/?tagid=FIC1.pv&unitofmeasure=M3HR&corporate=Open-Plant&plant=Refinery&area=Process&Unit=CDU
https://127.0.0.1:33170/api/tags/?tagid=FIC2.pv&unitofmeasure=M3HR&corporate=Open-Plant&plant=Refinery&area=Process&Unit=CDU&p1=First Custom Stuff&p2=Custom Stuff&p3=Custom Stuff&p4=Custom Stuff&p5=Custom Stuff&p6=Custom Stuff&p7=Custom Stuff&p8=Custom Stuff&p9=Last Custom Stuff

https://127.0.0.1:33170/wa/api/tags/?tagid=MyNewTag.pv

*Add '/wa' before '/api' if the calling user is authenticating with his windows id (Integrated Logins)

Returns (JSON):

{
  "data": {
    "Id": "FIC102.value",
    "TagName": "FIC102",
    "Parameter": "value",
    "UnitOfMeasure": null,
    "Description": null,
    "Corporate": null,
    "Plant": null,
    "Area": null,
    "Unit": null,
    "Param1": null,
    "Param2": null,
    "Param3": null,
    "Param4": null,
    "Param5": null,
    "Param6": null,
    "Param7": null,
    "Param8": null,
    "Param9": null,
    "DataType": 0,
    "InterpType": 1,
    "SampleTimeoutInS": 180,
    "CacheSizeInNumberOfItems": 3600,
    "DuplicateThresholdInMS": 250,
    "DatabaseLocation": "pv_fic102.value",
    "DatabaseLocationId": null,
    "LiveValue": null,
    "LastValue": null,
    "Historize": false
  }
}

{
    "data": {
        "Id": "FIC2.pv",
        "TagName": "FIC2",
        "Parameter": "pv",
        "UnitOfMeasure": "M3HR",
        "Description": null,
        "Corporate": "Open-Plant",
        "Plant": "Refinery",
        "Area": "Process",
        "Unit": "CDU",
        "Param1": "First Custom Stuff",
        "Param2": "Custom Stuff",
        "Param3": "Custom Stuff",
        "Param4": "Custom Stuff",
        "Param5": "Custom Stuff",
        "Param6": "Custom Stuff",
        "Param7": "Custom Stuff",
        "Param8": "Custom Stuff",
        "Param9": "Last Custom Stuff",
        "DataType": 0,
        "InterpType": 1,
        "SampleTimeoutInS": 180,
        "CacheSizeInNumberOfItems": 3600,
        "DuplicateThresholdInMS": 250,
        "DatabaseLocation": "pv_FIC2.pv",
    	"DatabaseLocationId": null,
        "LiveValue": null,
        "LastValue": null
    }
}

Security Restrictions

This API can only be called by users with Access Level 4 (Connector) or higher

PATCH

Update Tag

This API allows the update of an existing Open-Plant Tag, identified by a 'tagid'. In Open-Plant ,TagId's are not case sensitive. The 'tagid' must be specified. if the tag does not exist, an error '404-Not Found' will be thrown.

The parameters that can be updated are as below.
- 'unitofmeasure' is the engineering unit of the tag's value such as 'KG', 'DegC', 'N', 'M3HR'. This is important for display in charts.
- 'datatype' is the Data Type of the tag's value which can either be 'Real'(0),'Int'(1) or 'Bool'(2).
- 'interpolation' can either be 'Linear'(1) or 'Digital'(2). In 'Linear' interpolation, value is linear interpolated between two nearby raw samples. In 'Digital' interpolation, the last raw sample is taken.
- 'description' is the Tag's description. This is important for display in GUI.
- 'corporate', 'plant', 'area', 'unit' are the physical locations of the tag in a typical plant hierarchy.
- 'p1','p2','p3'....'p9' are optional custom parameters.

The api will return the updated tag as a JSON object if the update was successful.

Examples:

https://127.0.0.1:33170/api/tags/?tagid=TIC1.pv&unitofmeasure=DegF
https://127.0.0.1:33170/api/tags/?tagid=FIC101.value&unitofmeasure=kg/hr&interpolation=digital
https://127.0.0.1:33170/api/tags/?tagid=FIC101.value&corporate=Open-Plant&plant=Refinery&area=Process&Unit=CDU
https://127.0.0.1:33170/api/tags/?tagid=FIC101.Value&unitofmeasure=M3HR&corporate=Open-Plant&plant=Refinery&area=Process&Unit=CDU&p1=First Custom Stuff&p2=Custom Stuff&p3=Custom Stuff&p4=Custom Stuff&p5=Custom Stuff&p6=Custom Stuff&p7=Custom Stuff&p8=Custom Stuff&p9=Last Custom Stuff

https://127.0.0.1:33170/wa/api/tags/?tagid=TIC1.pv&unitofmeasure=DegF

*Add '/wa' before '/api' if the calling user is authenticating with his windows id (Integrated Logins)

Returns (JSON):

{
  "data": {
    "Id": "FIC101.value",
    "TagName": "FIC101",
    "Parameter": "value",
    "UnitOfMeasure": "M3HR",
    "Description": "",
    "Corporate": "Open-Plant",
    "Plant": "Refinery",
    "Area": "Process",
    "Unit": "CDU",
    "Param1": "First Custom Stuff",
    "Param2": "Custom Stuff",
    "Param3": "Custom Stuff",
    "Param4": "Custom Stuff",
    "Param5": "Custom Stuff",
    "Param6": "Custom Stuff",
    "Param7": "Custom Stuff",
    "Param8": "Custom Stuff",
    "Param9": "Last Custom Stuff\n\n",
    "DataType": 0,
    "InterpType": 2,
    "SampleTimeoutInS": 180,
    "CacheSizeInNumberOfItems": 3600,
    "DuplicateThresholdInMS": 250,
    "DatabaseLocation": "pv_fic101.value",
    "DatabaseLocationId": null,
    "LiveValue": null,
    "LastValue": null,
    "Historize": false
  }
}

Security Restrictions

This API can only be called by users with Access Level 4 (Connector) or higher

DELETE

Delete Tag

This API allows the deletion of an Open-Plant Tag. if the tag does not exist, an error '404-Not Found' response will be given. In Open-Plant, the primary identifier for a tag is the 'TagId', which is not case sensitive.

An optional parameter 'deletedata' when passed with 'true' or '1', will not only delete the tag, but also delete the tag data values as well. It makes sense to set this as 'true' since the tag has been deleted, there is no need to keep it's data values as well. However, if done by mistake, years of accumulated data will simple dissapear fom the database. As a safety measure, by default, this 'deletedata' parameter is set to 'false'.

The api will return the tag deleted in JSON if successful.

Examples:

https://127.0.0.1:33170/api/tags/?tagid=fic1.pv
https://127.0.0.1:33170/api/tags/?tagid=fic1.pv&deletedata=true
https://127.0.0.1:33170/api/tags/?tagid=fic1.pv&deletedata=false

https://127.0.0.1:33170/wa/api/tags/?tagid=fic1.pv&deletedata=false

*Add '/wa' before '/api' if the calling user is authenticating with his windows id (Integrated Logins)

Returns (JSON):

{
    "tagdeleted": true,
    "datadeleted": false
}

Security Restrictions

This API can only be called by users with Access Level 5 (Technician) or higher

To delete data (deletedatabase=true), Access Level 9 (Manager) or higher is required

VALUE APIS

GET

Single Value

This API gets a single 'Value' of a Tag identified by it's TagId. In Open-Plant, Tag Ids are not case sensitive. When 'Value' is requested without any timestamp parameter, Open-Plant will take the most fresh and live value. This value needs to honor the set Sample Timeout, a property of each tag (see SampleTimeoutInS in 'Returns (JSON)' GET Tag section). If the value obtained is older than the set Sample Timeout, a null value is returned.

'Value' can also requested with a 'timestamp', where Open-Plant returns the spot value at that time. The time stampd needs to be specified in theECMA ISO1806 format (yyyy-MM-ddThh:mm:ss.tttZ). Alternatively, any variants of the format 'YYYY-MM-dd hh:mm:ss' can also be specified but all time stamps must be in UTC. The timestamp input also accepts semantics such as 'now', 'now-1d' and etc as shown in the examples below.

When 'LastValue' is requested, Open-Plant will return the last known value reported by the tag. In this case, the sample timeout parameter is ignored. The 'timestamp' parameter is also not valid for lastvalue request.

Examples:

https://127.0.0.1:33170/api/value?tagid=Random.Real4
https://127.0.0.1:33170/api/value?tagid=Random.Real4&timestamp=now		//Get current data. Same as above.
https://127.0.0.1:33170/api/value?tagid=Random.Real4&timestamp=now-1d		//Get data 1 day ago
https://127.0.0.1:33170/api/value?tagid=Random.Real4&timestamp=now-10m		//Get data 10 minues ago
https://127.0.0.1:33170/api/value?tagid=Random.Real4&timestamp=now-3h		//Get data 3 hours ago
https://127.0.0.1:33170/api/value?tagid=Random.Real4&timestamp=now-5s		//Get data 5 seconds ago
https://127.0.0.1:33170/api/value?tagid=Random.Real4&timestamp=2019-08-16 13:43:10
https://127.0.0.1:33170/api/value?tagid=Random.Real4&timestamp=2019-08-16 03:43:12.432
https://127.0.0.1:33170/api/value?tagid=Random.Real4&timestamp=2019-08-16T03:43:12.432Z
https://127.0.0.1:33170/api/lastvalue?tagid=Random.Real4

https://127.0.0.1:33170/wa/api/lastvalue?tagid=Random.Real4

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
    "data": null
}

{
    "data": 18379.64
}

Security Restrictions

This API can be called by any users with Access Level 1 (L1User) or higher

GET

Multiple Value(s)

This API returns an array of 'Values' for a specified set of 'TagIds'. Multiple 'TagIds' can be specified with commas(,) separating them. In Open-Plant Tag Ids are not case sensitive. When 'Values' is called without any timestamp parameter, Open-Plant will take the most fresh and live values for the specified tags. These values need to honor the set Sample Timeout, a property of each tag (see SampleTimeoutInS in 'Returns (JSON)' GET Tag section). If the values obtained are older than the set Sample Timeout, a null value is returned.

When a timestamp parameter is specified, Open-Plant returns the value at that time. The timestamp needs to be specified in ECMA ISO1806 format (yyyy-MM-ddThh:mm:ss.tttZ). Alternatively, any variants of the format 'YYYY-MM-dd hh:mm:ss' can also be specified but all time stamps must be in UTC. The timestamp input also accepts semantics such as 'now', 'now-1d', and etc as shown in the examples below.

When 'LastValues' is requested, the sample timeout parameter is ignored. 'timestamp' parameter is not valid for this request.
If any of the requested TagIds does not exist, a null value is returned.

Examples:

https://127.0.0.1:33170/api/values?tagids=Random.Real4,Random.Int1
https://127.0.0.1:33170/api/values?tagids=Random.Real4,Random.Int1&timestamp=now		//Get current. Same as above.
https://127.0.0.1:33170/api/values?tagids=Random.Real4,Random.Int1&timestamp=now-1d		//Get data 1 day ago.
https://127.0.0.1:33170/api/values?tagids=Random.Real4,Random.Int1&timestamp=now-10m		//Get data 10 minues ago.
https://127.0.0.1:33170/api/values?tagids=Random.Real4,Random.Int1&timestamp=now-3h		//Get data 3 hours ago.
https://127.0.0.1:33170/api/values?tagids=Random.Real4,Random.Int1&timestamp=now-5s		//Get data 5 seconds ago.
https://127.0.0.1:33170/api/values?tagids=Random.Real4,Random.Int1&timestamp=2019-08-16 13:43:10
https://127.0.0.1:33170/api/values?tagids=Random.Real4,Random.Int1&timestamp=2019-08-16T03:43:12.432Z
https://127.0.0.1:33170/api/lastvalues?tagids=Random.Real4,Random.Int1

https://127.0.0.1:33170/wa/api/lastvalues?tagids=Random.Real4,Random.Int1

*Add '/wa' before '/api' if the calling user is authenticating with his windows id (Integrated Logins)

Returns (JSON):

{
    "data": [
        null,	//A null is returned when: 
        null,	// - the TagId specified does not exist OR
        null    // - if the value has expired (older than sample timeout) for 'values' call
    ]
}

{
    "data": [
        14095.179039999999,
        41.968
    ]
}

Security Restrictions

This API can be called by any users with Access Level 1 (L1User) or higher

GET

Data Table

This API gets a table of values. Imagine a table, which has 'timestamps' aranged in the left hand side column and 'TagIds' aranged in the top row, as shown below:

The parameter 'TagIds' can be specified with one or more Tag Id, with commas(,) separating them. In Open-Plant, Tag Ids are not case sensitive. Parameters 'from' and 'to' needs to be specified with a timestamp.

The timestamp needs to be specified in ECMA ISO1806 format (yyyy-MM-ddThh:mm:ss.tttZ). Alternatively, any variants of the format 'YYYY-MM-dd hh:mm:ss' can also be specified but all time stamps must be in UTC. The timestamp input also accepts semantics such as 'now', 'now-1d', and etc as shown in the examples below.

If parameters 'from' and 'to' are not specified, a '400 Bad Request' error will be shown.

The table rows will contain timestamps every 1 second between 'from' and 'to'. This interval can be changed by specifying an optional 'interval' parameter which is a value in miliseconds. In the above table example, the 'interval' is 10000 (i.e. 10 seconds).

The table values will be output as a 'ValuesTable' object which contains an array 'Values', where each array can be thought as a row in the data table. The values will always honor the set Sample Timeout, a property of each tag (see SampleTimeoutInS in 'Returns (JSON)' GET Tag section). If the samples obtained are older than the set Sample Timeout, the sample will not be excluded from the series (i.e. a null will not be returned)

Examples:

https://127.0.0.1:33170/api/datatable?tagids=Random.Real4,Random.Int1&from=2019-08-16T03:43:05.432Z&to=2019-08-16T03:43:08.432Z 		//time stamps are at 1 seconds interval (default)
https://127.0.0.1:33170/api/datatable?tagids=Random.Real4,Random.Int1&from=2019-08-16T03:30:05.432Z&to=2019-08-16T03:43:08.432Z&interval=120000 //time stamps are at 120 seconds interval
https://127.0.0.1:33170/api/datatable?tagids=Random.Real4,Random.Int1&from=now-1m&to=now 							//time stamps are at 1 second interval (default)
https://127.0.0.1:33170/api/datatable?tagids=Random.Real4,Random.Int1&from=now-1m&to=now&interval=30000  					//time stamps are at 30 seconds interval

https://127.0.0.1:33170/wa/api/datatable?tagids=Random.Real4,Random.Int1&from=now-1m&to=now

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
    "data": {
    	"TagIds": [			// This is the TagId Table Columns
            "Random.Real4",
            "Random.Int1"
        ],
        "TSUTCs": [			// This is the second variation of TimeStamp (The Table Rows)
            "2020-07-29T01:33:22.871Z",
            "2020-07-29T01:33:23.871Z",
            "2020-07-29T01:33:24.871Z"
        ],                
        "ValuesRows": [			// This is the Data Table Rows, each element is a Table Row
            [
            	10448.72,		// Corresponds to "Random.Real4" @ "2019-08-16T03:30:05.432Z"
                27122			// Corresponds to "Random.Int1"  @ "2019-08-16T03:30:05.432Z"
            ],
            [
                10448.72,		// Corresponds to "Random.Real4" @ "2019-08-16T03:33:05.432Z"
                27122			// Corresponds to "Random.Int1"  @ "2019-08-16T03:33:05.432Z"
            ],
            [
                10448.72,		// Corresponds to "Random.Real4" @ "2019-08-16T03:36:05.432Z"
                27122			// Corresponds to "Random.Int1"  @ "2019-08-16T03:36:05.432Z"
            ]            
        ]
    }
}

Security Restrictions

This API can be called by any users with Access Level 1 (L1User) or higher

SAMPLE APIS

GET

Single Sample

This API gets the current 'Sample' of a Tag identified by a 'Tag Id'. In Open-Plant, Tag Ids are not case sensitive. A 'Sample' is a data point, which has 'time stamp', 'value' and an 'Error' flag. When a 'Sample' is requested without a timestamp parameter, Open-Plant will take the most fresh/live sample. A 'fresh/live' sample needs to honor the Sample Timeout, a property of each tag (see SampleTimeoutInS in 'Returns (JSON)' GET Tag section). If the sample obtained is older than the set Sample Timeout, a null value is returned (as shown below).

'Sample' can also requested with a 'timestamp', where Open-Plant returns a sample at that time. The timestamp needs to be specified in ECMA ISO1806 format (yyyy-MM-ddThh:mm:ss.tttZ). Alternatively, any variants of the format 'YYYY-MM-dd hh:mm:ss' can also be specified but all time stamps must be in UTC. The timestamp input also accepts semantics such as 'now', 'now-1d', and etc as shown in the examples below.

When 'LastSample' is requested, the sample timeout parameter is ignored. 'timestamp' parameter is not valid for this request.
If the requested TagId does not exist, a '404-NotFound' response will be returned.

Examples:

https://127.0.0.1:33170/api/sample?tagid=fic103.value
https://127.0.0.1:33170/api/sample?tagid=fic103.value&timestamp=now		//Get current data. Same as above.
https://127.0.0.1:33170/api/sample?tagid=fic103.value&timestamp=now-1d		//Get data 1 day ago.
https://127.0.0.1:33170/api/sample?tagid=fic103.value&timestamp=now-10m		//Get data 10 minues ago.
https://127.0.0.1:33170/api/sample?tagid=fic103.value&timestamp=now-3h		//Get data 3 hours ago.
https://127.0.0.1:33170/api/sample?tagid=fic103.value&timestamp=now-5s		//Get data 5 seconds ago.
https://127.0.0.1:33170/api/sample?tagid=fic103.value&timestamp=2019-08-16 13:43:10
https://127.0.0.1:33170/api/sample?tagid=fic103.value&timestamp=2019-08-16 03:43:12.432
https://127.0.0.1:33170/api/sample?tagid=fic103.value&timestamp=2019-08-16T03:43:12.432Z
https://127.0.0.1:33170/api/lastsample?tagid=fic103.value

https://127.0.0.1:33170/wa/api/lastsample?tagid=fic103.value

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
  "data": {
    "TSUTC": "2020-07-29T01:38:28.6285625Z",
    "Value": -13.977528720618018,
    "IsError": false
  }
}

{
  "data": {
    "TSUTC": "2020-07-29T01:39:30.8540427Z",
    "Value": null,
    "IsError": false
  }
}

Security Restrictions

This API can be called by any users with Access Level 1 (L1User) or higher

GET

Multiple Sample(s)

This API gets an array of 'Samples' or 'LastSamples' for a specified set of 'TagIds'. One or more 'TagIds' can be specified with commas(,) separating them. In Open-Plant, Tag Ids are not case sensitive. A 'Sample' is a data point, which has 'time stamp', 'value' and an 'Error' flag. When 'Samples' is called without any timestamp parameter, Open-Plant will take the most fresh and live samples from each specified tags. These 'fresh/live' samples need to honor the set Sample Timeout, a property of each tag (see SampleTimeoutInS in 'Returns (JSON)' GET Tag section). If the samples obtained are older than the set Sample Timeout, a null value is returned (as shown in 'Examples' below).

When a timestamp parameter is specified, Open-Plant returns the interpolated value at that time. The timestamp needs to be specified in ECMA ISO1806 format (yyyy-MM-ddThh:mm:ss.tttZ). Alternatively, any variants of the format 'YYYY-MM-dd hh:mm:ss' can also be specified but all time stamps must be in UTC. The timestamp input also accepts semantics such as 'now', 'now-1d', and etc as shown in the examples below.

When 'LastSamples' is requested, the sample timeout parameter is ignored. 'timestamp' parameter is not valid for this request.
If any of the requested TagIds do not exist, a null value will be returned.

Examples:

https://127.0.0.1:33170/api/samples?tagids=Random.Real4,Random.Int1
https://127.0.0.1:33170/api/samples?tagids=Random.Real4,Random.Int1&timestamp=now		//Get current. Same as above.
https://127.0.0.1:33170/api/samples?tagids=Random.Real4,Random.Int1&timestamp=now-1d		//Get data 1 day ago.
https://127.0.0.1:33170/api/samples?tagids=Random.Real4,Random.Int1&timestamp=now-10m		//Get data 10 minues ago.
https://127.0.0.1:33170/api/samples?tagids=Random.Real4,Random.Int1&timestamp=now-3h		//Get data 3 hours ago.
https://127.0.0.1:33170/api/samples?tagids=Random.Real4,Random.Int1&timestamp=now-5s		//Get data 5 seconds ago.
https://127.0.0.1:33170/api/samples?tagids=Random.Real4,Random.Int1&timestamp=2019-08-16 13:43:10
https://127.0.0.1:33170/api/samples?tagids=Random.Real4,Random.Int1&timestamp=2019-08-16T03:43:12.432Z
https://127.0.0.1:33170/api/lastsamples?tagids=Random.Real4,Random.Int1

https://127.0.0.1:33170/wa/api/lastsamples?tagids=Random.Real4,Random.Int1

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
  "data": [
    {
      "TSUTC": "2020-07-29T01:44:20.0968541Z",
      "Value": -14.222284921082812,
      "IsError": false
    },
    {
      "TSUTC": "2020-07-29T01:44:20.0968541Z",
      "Value": 24.559068368542512,
      "IsError": false
    }
  ]
}

{
    "data": [
        null,		//Null is returned when Tag Id Specified does not exist
        {
          "TSUTC": "2020-07-29T01:44:20.0968541Z",
          "Value": 24.559068368542512,
          "IsError": false
        }
    ]
}

Security Restrictions

This API can be called by any users with Access Level 1 (L1User) or higher

GET

Sample Series

This API gets a series/array of 'Samples' for a 'TagId'. In Open-Plant Tag Ids are not case sensitive. A 'Sample' is a data point, which has 'time stamp', 'value' and an 'Error' flag. Parameters 'from' and 'to' needs to be specified with a timestamp.

The timestamp needs to be specified in ECMA ISO1806 format (yyyy-MM-ddThh:mm:ss.tttZ). Alternatively, any variants of the format 'YYYY-MM-dd hh:mm:ss' can also be specified but all time stamps must be in UTC. The timestamp input also accepts semantics such as 'now', 'now-1d', and etc as shown in the examples below.

If parameters 'from' and 'to' are not specified, a '400 Bad Request' error will be shown.

The sample series will return samples every 1 second between 'from' and 'to'. This interval can be changed by specifying an 'interval' parameter which is a value in miliseconds.

The sample series output will always honor the set Sample Timeout, a property of each tag (see SampleTimeoutInS in 'Returns (JSON)' GET Tag section). If the samples obtained are older than the set Sample Timeout, the sample will not be excluded from the series (i.e. a null will not be returned)

When 'LastSamples' is requested, the sample timeout parameter is ignored. 'timestamp' parameter is not valid for this request.

Examples:

https://127.0.0.1:33170/api/series?tagid=Random.Real4&from=2019-08-16T03:43:05.432Z&to=2019-08-16T03:43:08.432Z 		//returns samples every 1 second (default)
https://127.0.0.1:33170/api/series?tagid=Random.Real4&from=2019-08-16T03:30:05.432Z&to=2019-08-16T03:43:08.432Z&interval=120000 //returns samples every 120 seconds
https://127.0.0.1:33170/api/series?tagid=Random.Real4&from=now-1m&to=now 							//returns samples every 1 second (default)
https://127.0.0.1:33170/api/series?tagid=Random.Real4&from=now-1m&to=now&interval=30000  					//returns samples every 30 seconds

https://127.0.0.1:33170/wa/api/series?tagid=Random.Real4&from=now-1m&to=now&interval=30000

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
  "data": [
    {
      "TSUTC": "2020-07-29T04:46:00.2097341Z",
      "Value": -9.5293384029201,
      "IsError": false
    },
    {
      "TSUTC": "2020-07-29T04:47:00.2097341Z",
      "Value": -9.5293384029201,
      "IsError": false
    },
    {
      "TSUTC": "2020-07-29T04:48:00.2097341Z",
      "Value": -9.5293384029201,
      "IsError": false
    }
  ]
}

Security Restrictions

This API can be called by any users with Access Level 1 (L1User) or higher

GET

Raw Sample Series

This API gets a series of raw sample points for a specified 'TagId'. In Open-Plant,Tag Ids are not case sensitive. A 'Sample' is a data point, which has 'time stamp', 'value' and an 'Error' flag. 'Raw Samples' are samples taken directly from database without any interpolation or time series interval adjustment. This is unlike the 'Sample(s) Series' API.

NOTE: This API Call has better speed and performance.

Parameters 'from' and 'to' needs to be specified with a timestamp. The timestamp needs to be specified in ECMA ISO1806 format (yyyy-MM-ddThh:mm:ss.tttZ). Alternatively, any variants of the format 'YYYY-MM-dd hh:mm:ss' can also be specified but all time stamps must be in UTC. The timestamp input also accepts semantics such as 'now', 'now-1d', and etc as shown in the examples below.

If parameters 'from' and 'to' are not specified, a '400 Bad Request' error will be shown. This API will return all raw samples from database between 'from' and 'to'. An 'interval' parameter can be set which limits the raw samples returned. This 'interval' parameter is a value in miliseconds. It ensure that the raw samples are only obtained every 'interval'. In another word, there will exist a minimum 'interval' space between the returned raw samples.

The raw series output will ignore the set Sample Timeout, a property of each tag (see SampleTimeoutInS in 'Returns (JSON)' GET Tag section).
If the requested TagId does not exist, a '404-NotFound' response will be returned.

Examples:

https://127.0.0.1:33170/api/rawseries?tagid=Random.Real4&from=2019-08-16T03:43:05.432Z&to=2019-08-16T03:43:08.432Z 			//All samples are returned
https://127.0.0.1:33170/api/rawseries?tagid=Random.Real4&from=2019-08-16T03:30:05.432Z&to=2019-08-16T03:43:08.432Z&interval=120000 	//returns samples every 120 seconds
https://127.0.0.1:33170/api/rawseries?tagid=Random.Real4&from=now-1m&to=now 								//All samples are returned
https://127.0.0.1:33170/api/rawseries?tagid=Random.Real4&from=now-1m&to=now&interval=30000  						//returns samples every 30 seconds

https://127.0.0.1:33170/wa/api/rawseries?tagid=Random.Real4&from=now-1m&to=now

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
  "data": [
    {
      "TSUTC": "2020-07-29T06:03:07.022Z",
      "Value": 1.06203595225794,
      "IsError": false
    },
    {
      "TSUTC": "2020-07-29T06:03:08.022Z",
      "Value": 1.68915390255356,
      "IsError": false
    },
    {
      "TSUTC": "2020-07-29T06:03:10.022Z",
      "Value": 1.48192795947284,
      "IsError": false
    }
  ]
}

Security Restrictions

This API can be called by any users with Access Level 1 (L1User) or higher

POST

Insert Sample(s)

This API inserts many samples into a single Tag, identified by a case insensitive 'TagId'. If the requested TagId does not exist, a '404-NotFound' response will be returned. In Open-Plant, a 'Sample' is Open-Plant's most basic data. It has a 'time stamp', 'value' and an 'IsError' flag. Other then TagId, this APIs needs to be specified with the following:

- 'values' is the set of data to be inserted. It must be numerical. Each value should be separated by a comma(,). Depending on the 'datatype' property of the tag, value will be converted to a 'Real'(0), 'Int'(1) or 'Bool'(2) accordingly. The 'values' parameter is compulsory and must be provided. If not, a '400-Bad Request' error will be thrown.

- 'timestamps' is the set of timestamps corresponding to the 'values' data. The timestamp needs to be specified in ECMA ISO1806 format (yyyy-MM-ddThh:mm:ss.tttZ). Alternatively, any variants of the format 'YYYY-MM-dd hh:mm:ss' can also be specified but all time stamps must be in UTC. The timestamp input also accepts semantics such as 'now', 'now-1d', and etc as shown in the examples below. Each timestamp should be separated by a comma(,) and the number of elements must be the same as 'values'. The 'timestamps' parameter is compulsory and must be provided. If not, a '400-Bad Request' error will be thrown.

- 'iserrors' is a set of flags which indicates the validity of the corresponding 'values' data is invalid. This parameter can be specified with either 'true','false','1' or '0'. Each iserror flag should be separated by a comma(,) and the number of elements must be the same as 'values'. When 'IsError' is set true, Open-Plant will ignore the corresponding 'value' and will typically not display the value in charts. 'IsError' is generally used to mark a point of device error which can be used for reliability and maintenance analytics. The API also accepts a single 'IsErrors' value supplied, which if this be the case will render the entire set of values iserror 'true' or 'false' accordingly.

The api will return the number of samples inserted and tags created.

Examples:

https://127.0.0.1:33170/api/samples/?tagid=Random.Real4&values=0.1,0.2,0.15&timestamps=now,now-1s,now-2s
https://127.0.0.1:33170/api/samples/?tagid=Random.Real4&values=1.23,1.24,1.30&timestamps=2019-08-16 13:03:02,2019-08-16 13:04:02,2019-08-16 13:05:02
https://127.0.0.1:33170/api/samples/?tagid=Random.Real4&values=1,2,3&timestamps=2019-08-16T03:43:20.212Z,2019-08-16T03:43:21.212Z,2019-08-16T03:43:22.212Z
https://127.0.0.1:33170/api/samples/?tagid=Random.Real4&values=0.1,0.2,0.15&timestamps=now,now-1s,now-2s&iserrors=0,1,0
https://127.0.0.1:33170/api/samples/?tagid=Random.Real4&values=0.1,0.2,0.15&timestamps=now,now-1s,now-2s&iserrors=0
https://127.0.0.1:33170/api/samples/?tagid=Random.Real4&values=0.1,0.2,0.15&timestamps=now,now-1s,now-2s&iserrors=false

https://127.0.0.1:33170/wa/api/samples/?tagid=Random.Real4&values=0.1,0.2,0.15&timestamps=now,now-1s,now-2s&iserrors=false

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
    "data": [
        {
            "IsError": false,
            "TSLocal_ISO": "2019-08-16T11:43:20.212",
            "TSUTC": "/Date(1565927000212)/",
            "TSUTC_ISO": "2019-08-16T03:43:20.212Z",
            "Value": 1
        },
        {
            "IsError": false,
            "TSLocal_ISO": "2019-08-16T11:43:21.212",
            "TSUTC": "/Date(1565927001212)/",
            "TSUTC_ISO": "2019-08-16T03:43:21.212Z",
            "Value": 2
        },
        {
            "IsError": false,
            "TSLocal_ISO": "2019-08-16T11:43:22.212",
            "TSUTC": "/Date(1565927002212)/",
            "TSUTC_ISO": "2019-08-16T03:43:22.212Z",
            "Value": 3
        }
    ]
}

Security Restrictions

This API can be called by any users with Access Level 4 (Connector) or higher

POST

Insert Bulk Samples(s)

This API inserts many samples into many Tags, unlike the previous API which inserts many samples into a single tag. In Open-Plant, a 'Sample' is the most basic data, which has a 'time stamp', 'value' and an 'IsError' flag. Thus APIs needs to be specified with the following:

- 'tagids' is the set of tags where the samples are to be inserted. Each value should be separated by a comma(,). While inserting, if a Tag does not exists, the tag will be created. This is unlike the previous API, where an error will be returned if the tag does not exist. The 'tagids' parameter is compulsory and must be provided. If not, a '400-Bad Request' error will be thrown. The API also accepts a single tagid value supplied, which if this be the case will render the entire set of samples to be inserted to the same tag.

- 'values' is the set of data to be inserted, which must be numerical values. Each value should be separated by a comma(,) and it's position in the comma separated string will correspond to the tagids. Depending on the 'datatype' property of the tag, value will be converted to 'Real'(0), 'Int'(1) or 'Bool'(2) accordingly. The 'values' parameter is compulsory and must be provided. If not, a '400-Bad Request' error will be thrown.

- 'timestamps' is the set of timestamps corresponding to the 'values' data. The timestamp needs to be specified in ECMA ISO1806 format (yyyy-MM-ddThh:mm:ss.tttZ). Alternatively, any variants of the format 'YYYY-MM-dd hh:mm:ss' can also be specified but all time stamps must be in UTC. The timestamp input also accepts semantics such as 'now', 'now-1d', and etc as shown in the examples below. Each timestamp should be separated by a comma(,) and the number of elements must be the same as 'values'. If the 'timestamps' parameter not provided, it will assume all timestamps as 'now' or current time. This API also accepts a single 'timestamps' value supplied, which if this be the case will render the entire set of values timestamps to be inserted the same.

- 'iserrors' is a set of flags which indicates the validity of the 'values' data. This parameter can be specified with either 'true','false','1' or '0'. Each iserror flag should be separated by a comma(,) and the number of elements must be the same as 'values'. When 'IsError' is set true, Open-Plant will ignore the corresponding 'value' and will typically not display the value in charts. 'IsError' is generally used to mark a point of device error which can be used for reliability and maintenance analytics. The API also accepts a single 'IsErrors' value supplied, which if this be the case will render the entire set of values iserror 'true' or 'false' accordingly.

- 'datatypes' is a set of DataType definition which corresponds to the 'values' data. This parameter is used only when a new tag is created during the insert process. DataType can either be 'Real'(0), 'Int'(1) or 'Bool'(2). Each value should be separated by a comma(,) and it's position in the comma separated string will correspond to the tagids. The 'datatypes' parameter is NOT required. If it is not provided, it will use the Tags data type, when inserting a new data, or assume the data type as 'Real' when creating a new tag.

The api will return the number of samples inserted and tags created.

Examples:

https://127.0.0.1:33170/api/samples/?tagids=random.real4,random.int1,fic1.pv&values=0.1,2,0.15&timestamps=2019-08-16T03:43:20.212Z,2019-08-16T03:43:21.212Z,2019-08-16T03:43:22.212Z
https://127.0.0.1:33170/api/samples/?tagids=random.real4,random.int1,fic1.pv&values=0.1,2,0.15&timestamps=now,now-1s,now-2s
https://127.0.0.1:33170/api/samples/?tagids=random.int1,fic1.pv&values=3,2&timestamps=now,now&datatypes=int,real
https://127.0.0.1:33170/api/samples/?tagids=random.int1,fic1.pv&values=3,2&datatypes=int,real&iserrors=true,false
https://127.0.0.1:33170/api/samples/?tagids=random.int1,fic1.pv&values=3,2&datatypes=int,real&iserrors=true				//this causes all samples inserted have iserror=true
https://127.0.0.1:33170/api/samples/?tagids=random.real4,random.int1,fic1.pv&values=0.1,2,0.15					//this inserts all 3 samples at current time
https://127.0.0.1:33170/api/samples/?tagids=fic1.pv&values=0.1,2,0.15&timestamps=now,now-1s,now-2s					//this inserts all 3 samples into 'fic1.pv'
https://127.0.0.1:33170/api/samples/?tagids=random.real4,random.int1,fic1.pv&values=0.1,2,0.15&timestamps=2019-08-16T03:43:20.212Z	//this inserts all 3 samples at '2019-08-16T03:43:20.212Z'

https://127.0.0.1:33170/wa/api/samples/insert?tagids=random.real4,random.int1,fic1.pv&values=0.1,2,0.15&timestamps=2019-08-16T03:43:20.212Z

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
    "totalsamplesinserted": 3,
    "totaltagscreated": 0
}

Security Restrictions

This API can be called by any users with Access Level 4 (Connector) or higher

OPSCRIPT APIS

GET

OPScript List

This API returns a simple list of script names available on the server. A search 'wildcard' parameter can be passed as parameter. This 'wildcard' parameter is NOT case sensitive.

Examples:

https://127.0.0.1:33170/api/opscriptlist
https://127.0.0.1:33170/api/opscriptlist?wildcard="admin_*"

https://127.0.0.1:33170/wa/api/opscriptlist?wildcard="admin_*"

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
  "data": [
    {
      "Id": "7e1da12b-ffa6-46dc-a512-9f07158f34a3",
      "Name": "New Analysis 1"
    },
    {
      "Id": "801ce86a-9868-49c5-8a04-f2cf24072e81",
      "Name": "New Analysis 2"
    }
  ]
}

{
  "data": []
}

Security Restrictions

This API will only list down scripts where the caller's access level is higher or equal to the script's MinExecuteAccessLevel or MinEditAccessLevel.

GET

Single OPScript

This API returns a script and it's details identified by the script's 'id' or 'name'. Script 'id' is the preferred way to select a script as more than one script may have the same 'name'. In such case, only the first script will be returned.

Examples:

https://localhost:33170/api/opscripts/?id=7e1da12b-ffa6-46dc-a512-9f07158f34a3
https://localhost:33170/api/opscripts/?name=New Analysis 1

https://localhost:33170/wa/api/opscripts/?name=New Analysis 1

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
  "data": {
    "Id": "7e1da12b-ffa6-46dc-a512-9f07158f34a3",
    "Name": "New Analysis 1",
    "Enabled": true,
    "ParentId": "623c2bcc-e589-4695-b04d-ccf84790de60",
    "RunAsAccessLevel": 6,
    "MinimumEditAccessLevel": 6,
    "Code": "using OpenPlant;\r\nusing System;\r\nusing System.Linq;\r\nusing System.Diagnostics;\r\nusing System.Data;\r\nusing System.IO;\r\nusing System.Collections.Generic;\r\nusing System.Xml;\r\nusing System.Xml.Serialization;\r\nusing System.Threading;\r\nusing System.ServiceModel;\r\nusing System.Threading.Tasks;\r\nusing System.Collections.Concurrent;\r\nusing System.Globalization;\r\n\r\npublic class OPScript\r\n{\r\n\r\npublic object Main()\r\n{\r\n//*********** ANALYTIC SCRIPT STARTS HERE (DO NOT REMOVE THIS LINE) ***********\r\rThread.Sleep(1000);\rreturn OP.ListTagIds(\"*\");\n//*********** ANALYTIC SCRIPT ENDS HERE (DO NOT REMOVE THIS LINE) *************\r\nreturn null;\r\n}\r\n\r\n}\r\n",
    "Schedule": {
      "ScheduleEnabled": false,
      "StartTime": null,
      "OPScriptId": "7e1da12b-ffa6-46dc-a512-9f07158f34a3",
      "ServerName": "AZRINLAPTOP2",
      "StartImmediately": true,
      "Frequency": 1,
      "FrequencyUnit": 1,
      "DaysSelected_ForWeeksFrequencyUnit": [],
      "MonthsSelected_ForMonthsFrequencyUnit": [],
      "DaysSelected_ForMonthsFrequencyUnit": [],
      "SpecialDayOfMonth_ForMonthsFrequencyUnit": [],
      "ExpiryTime": null,
      "FirstDayOfWeek": 1
    },
    "WebAPI": {
      "Enabled": true,
      "EnableTriggerURL": true,
      "TriggerURLRegexMatch": "/test/for/alternative",
      "TriggerURLMethod": "GET",
      "MatchWithRegex": true
    },
    "MethodName": "Main"
  }
}

Security Restrictions

This API will only list down scripts where the caller's access level is higher or equal to the script's MinExecuteAccessLevel or MinEditAccessLevel.

GET

Multiple OPScripts

This API returns a list of script details available on the server. A search 'wildcard' parameter can be passed as parameter to filter based on the script's 'name'. This 'wildcard' parameter is NOT case sensitive.

Examples:

https://127.0.0.1:33170/api/opscripts
https://127.0.0.1:33170/api/opscripts?wildcard="admin_*"

https://127.0.0.1:33170/wa/api/opscrips?wildcard="admin_*"

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
  "data": [
    {
      "Id": "7e1da12b-ffa6-46dc-a512-9f07158f34a3",
      "Name": "New Analysis 1",
      "Enabled": true,
      "ParentId": "623c2bcc-e589-4695-b04d-ccf84790de60",
      "RunAsAccessLevel": 6,
      "MinimumEditAccessLevel": 6,
      "Code": "using OpenPlant;\r\nusing System;\r\nusing System.Linq;\r\nusing System.Diagnostics;\r\nusing System.Data;\r\nusing System.IO;\r\nusing System.Collections.Generic;\r\nusing System.Xml;\r\nusing System.Xml.Serialization;\r\nusing System.Threading;\r\nusing System.ServiceModel;\r\nusing System.Threading.Tasks;\r\nusing System.Collections.Concurrent;\r\nusing System.Globalization;\r\n\r\npublic class OPScript\r\n{\r\n\r\npublic object Main()\r\n{\r\n//*********** ANALYTIC SCRIPT STARTS HERE (DO NOT REMOVE THIS LINE) ***********\r\rThread.Sleep(1000);\rreturn OP.ListTagIds(\"*\");\n//*********** ANALYTIC SCRIPT ENDS HERE (DO NOT REMOVE THIS LINE) *************\r\nreturn null;\r\n}\r\n\r\n}\r\n",
      "Schedule": {
        "ScheduleEnabled": false,
        "StartTime": null,
        "OPScriptId": "7e1da12b-ffa6-46dc-a512-9f07158f34a3",
        "ServerName": "AZRINLAPTOP2",
        "StartImmediately": true,
        "Frequency": 1,
        "FrequencyUnit": 1,
        "DaysSelected_ForWeeksFrequencyUnit": [],
        "MonthsSelected_ForMonthsFrequencyUnit": [],
        "DaysSelected_ForMonthsFrequencyUnit": [],
        "SpecialDayOfMonth_ForMonthsFrequencyUnit": [],
        "ExpiryTime": null,
        "FirstDayOfWeek": 1
      },
      "WebAPI": {
        "Enabled": true,
        "EnableTriggerURL": true,
        "TriggerURLRegexMatch": "/test/for/alternative",
        "TriggerURLMethod": "GET",
        "MatchWithRegex": true
      },
      "MethodName": "Main"
    },
    {
      "Id": "801ce86a-9868-49c5-8a04-f2cf24072e81",
      "Name": "New Analysis 2",
      "Enabled": true,
      "ParentId": "",
      "RunAsAccessLevel": 6,
      "MinimumEditAccessLevel": 6,
      "Code": "using OpenPlant;\r\nusing System;\r\nusing System.Linq;\r\nusing System.Diagnostics;\r\nusing System.Data;\r\nusing System.IO;\r\nusing System.Collections.Generic;\r\nusing System.Xml;\r\nusing System.Xml.Serialization;\r\nusing System.Threading;\r\nusing System.ServiceModel;\r\nusing System.Threading.Tasks;\r\nusing System.Collections.Concurrent;\r\nusing System.Globalization;\r\n\r\npublic class OPScript\r\n{\r\n\r\npublic object Main(string P1)\r\n{\r\n//*********** ANALYTIC SCRIPT STARTS HERE (DO NOT REMOVE THIS LINE) ***********\r\nOP.Log(P1);\rThread.Sleep(1000);\rreturn OP.ListTagIds(\"*\");\n//*********** ANALYTIC SCRIPT ENDS HERE (DO NOT REMOVE THIS LINE) *************\r\nreturn null;\r\n}\r\n\r\n}\r\n",
      "Schedule": {
        "ScheduleEnabled": false,
        "StartTime": null,
        "OPScriptId": "801ce86a-9868-49c5-8a04-f2cf24072e81",
        "ServerName": "AZRINLAPTOP2",
        "StartImmediately": true,
        "Frequency": 1,
        "FrequencyUnit": 1,
        "DaysSelected_ForWeeksFrequencyUnit": [],
        "MonthsSelected_ForMonthsFrequencyUnit": [],
        "DaysSelected_ForMonthsFrequencyUnit": [],
        "SpecialDayOfMonth_ForMonthsFrequencyUnit": [],
        "ExpiryTime": null,
        "FirstDayOfWeek": 0
      },
      "WebAPI": {
        "Enabled": true,
        "EnableTriggerURL": false,
        "TriggerURLRegexMatch": "",
        "TriggerURLMethod": "GET",
        "MatchWithRegex": false
      },
      "MethodName": "Main"
    }
  ]
}

Security Restrictions

This API will only list down scripts where the caller's access level is higher or equal to the script's MinExecuteAccessLevel or MinEditAccessLevel.

POST

New OPScript

This API creates a new script.

A JSON object of the new script may be included in the request body of the API Call. In this case, the API will generate the script based on the JSON object. The JSON property 'Id' is normally ommitted so that a new Id can be assigned to the script.

If no request body is specified, the API will generate a blank script with a standard name and a new Id.

Side Note: Calling this API without a body multiple times will create a new script for each call. Thus so, this API is not Idempotent and needs to use a POST method

API URL

https://localhost:33170/api/opscripts/
https://localhost:33170/wa/api/opscripts/

*Add '/wa' before '/api' when using windows authentication

The request may include a JSON of the script to be created as shown below. This JSON input is the same format as the return script format output, except that in the example below, the script 'id' is ommitted for the system generate a new 'id'. The 'ParentId' is the folder Id to which the script is to be created in.

JSON Input (In request body)

{
  "data": {
    "Name": "My Analysis",
    "Enabled": false,
    "ParentId": "",
    "RunAsAccessLevel": 6,
    "MinimumEditAccessLevel": 6,
    "Code": "using OpenPlant;\r\nusing System;\r\nusing System.Linq;\r\nusing System.Diagnostics;\r\nusing System.Data;\r\nusing System.IO;\r\nusing System.Collections.Generic;\r\nusing System.Xml;\r\nusing System.Xml.Serialization;\r\nusing System.Threading;\r\nusing System.ServiceModel;\r\nusing System.Threading.Tasks;\r\nusing System.Collections.Concurrent;\r\nusing System.Globalization;\r\n\r\npublic class OPScript\r\n{\r\n\r\npublic object Main()\r\n{\r\n//*********** ANALYTIC SCRIPT STARTS HERE (DO NOT REMOVE THIS LINE) ***********\r\nOP.Log(\"Hello World!\");\r\n//*********** ANALYTIC SCRIPT ENDS HERE (DO NOT REMOVE THIS LINE) *************\r\nreturn null;\r\n}\r\n\r\n}\r\n",
    "Schedule": {
      "ScheduleEnabled": false,
      "StartTime": null,
      "OPScriptId": "",
      "ServerName": "",
      "StartImmediately": true,
      "Frequency": 1,
      "FrequencyUnit": 1,
      "DaysSelected_ForWeeksFrequencyUnit": [],
      "MonthsSelected_ForMonthsFrequencyUnit": [],
      "DaysSelected_ForMonthsFrequencyUnit": [],
      "SpecialDayOfMonth_ForMonthsFrequencyUnit": [],
      "ExpiryTime": null,
      "FirstDayOfWeek": 0
    },
    "WebAPI": {
      "Enabled": false,
      "EnableTriggerURL": false,
      "TriggerURLRegexMatch": "",
      "TriggerURLMethod": "",
      "MatchWithRegex": false
    },
    "MethodName": "Main"
  }
}

The API Call will return a JSON Object of the script created. This object will now include the new script 'Id'.

Returns (JSON):

{
  "data": {
    "Id": "818dabc5-84b0-46fe-aaf9-35ea86c63b73",
    "Name": "My Analysis",
    "Enabled": false,
    "ParentId": "",
    "RunAsAccessLevel": 6,
    "MinimumEditAccessLevel": 6,
    "Code": "using OpenPlant;\r\nusing System;\r\nusing System.Linq;\r\nusing System.Diagnostics;\r\nusing System.Data;\r\nusing System.IO;\r\nusing System.Collections.Generic;\r\nusing System.Xml;\r\nusing System.Xml.Serialization;\r\nusing System.Threading;\r\nusing System.ServiceModel;\r\nusing System.Threading.Tasks;\r\nusing System.Collections.Concurrent;\r\nusing System.Globalization;\r\n\r\npublic class OPScript\r\n{\r\n\r\npublic object Main()\r\n{\r\n//*********** ANALYTIC SCRIPT STARTS HERE (DO NOT REMOVE THIS LINE) ***********\r\nOP.Log(\"Hello World!\");\r\n//*********** ANALYTIC SCRIPT ENDS HERE (DO NOT REMOVE THIS LINE) *************\r\nreturn null;\r\n}\r\n\r\n}\r\n",
    "Schedule": {
      "ScheduleEnabled": false,
      "StartTime": null,
      "OPScriptId": "",
      "ServerName": "",
      "StartImmediately": true,
      "Frequency": 1,
      "FrequencyUnit": 1,
      "DaysSelected_ForWeeksFrequencyUnit": [],
      "MonthsSelected_ForMonthsFrequencyUnit": [],
      "DaysSelected_ForMonthsFrequencyUnit": [],
      "SpecialDayOfMonth_ForMonthsFrequencyUnit": [],
      "ExpiryTime": null,
      "FirstDayOfWeek": 0
    },
    "WebAPI": {
      "Enabled": false,
      "EnableTriggerURL": false,
      "TriggerURLRegexMatch": "",
      "TriggerURLMethod": "",
      "MatchWithRegex": false
    },
    "MethodName": "Main"
  }
}

Security Restrictions

This API can only be accessed with Access Level 6 (L1Engineer) and above. Also, one may not create a script with higher 'RunAsAccessLevel' or higher 'MinimumEditAccessLevel' than one's own access level.

PATCH

Update OPScript

This API updates an existing script identified by the script 'Id'. If the 'Id' could not be found, a '404-Not Found' reponse will be given.

A JSON object of the updated script must be included in the request body of the API Call. The specified JSON of the updated object must be in the correct format. A single property ommitted will cause the call to fail with '400-Bad Request'. This format is the same as the GET Single OPScript return output API Call. Thus so, it is best that this API is first called and its out copied and modified for this API Call.

API URL

https://localhost:33170/api/opscripts/?id=818dabc5-84b0-46fe-aaf9-35ea86c63b73
https://localhost:33170/wa/api/opscripts/?id=818dabc5-84b0-46fe-aaf9-35ea86c63b73

*Add '/wa' before '/api' when using windows authentication

JSON Input (In request body)

{
  "data": {
  	"Id": "818dabc5-84b0-46fe-aaf9-35ea86c63b73"
    "Name": "My Analysis New Name",
    "Enabled": true,
    "ParentId": "",
    "RunAsAccessLevel": 6,
    "MinimumEditAccessLevel": 6,
    "Code": "using OpenPlant;\r\nusing System;\r\nusing System.Linq;\r\nusing System.Diagnostics;\r\nusing System.Data;\r\nusing System.IO;\r\nusing System.Collections.Generic;\r\nusing System.Xml;\r\nusing System.Xml.Serialization;\r\nusing System.Threading;\r\nusing System.ServiceModel;\r\nusing System.Threading.Tasks;\r\nusing System.Collections.Concurrent;\r\nusing System.Globalization;\r\n\r\npublic class OPScript\r\n{\r\n\r\npublic object Main()\r\n{\r\n//*********** ANALYTIC SCRIPT STARTS HERE (DO NOT REMOVE THIS LINE) ***********\r\nOP.Log(\"Hello World!\");\r\n//*********** ANALYTIC SCRIPT ENDS HERE (DO NOT REMOVE THIS LINE) *************\r\nreturn null;\r\n}\r\n\r\n}\r\n",
    "Schedule": {
      "ScheduleEnabled": false,
      "StartTime": null,
      "OPScriptId": "",
      "ServerName": "",
      "StartImmediately": true,
      "Frequency": 1,
      "FrequencyUnit": 1,
      "DaysSelected_ForWeeksFrequencyUnit": [],
      "MonthsSelected_ForMonthsFrequencyUnit": [],
      "DaysSelected_ForMonthsFrequencyUnit": [],
      "SpecialDayOfMonth_ForMonthsFrequencyUnit": [],
      "ExpiryTime": null,
      "FirstDayOfWeek": 0
    },
    "WebAPI": {
      "Enabled": false,
      "EnableTriggerURL": false,
      "TriggerURLRegexMatch": "",
      "TriggerURLMethod": "",
      "MatchWithRegex": false
    },
    "MethodName": "Main"
  }
}

The API Call will return a JSON Object of the updated script which should be the same as above. The only case when it is NOT the same is when the API Call script 'Enabled' is true. With this, the API will attempt to enable the script. If enabling fails (for example due to code syntax error), the API will disable the script back (setting 'Enabled' as false).

Security Restrictions

This API can only be accessed with Access Level 6 (L1Engineer) and above. Also, one may not update an existing script to a higher 'RunAsAccessLevel' or higher 'MinimumEditAccessLevel' than one's own access level.

DELETE

Delete OPScript

This API deletes a script based on a script's 'id'. The API Call will return a JSON Object of the deleted script if the deletion was successful.

Examples:

https://localhost:33170/api/opscripts/?id=7e1da12b-ffa6-46dc-a512-9f07158f34a3
https://localhost:33170/wa/api/opscripts/?id=7e1da12b-ffa6-46dc-a512-9f07158f34a3

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
  "data": {
    "Id": "7e1da12b-ffa6-46dc-a512-9f07158f34a3",
    "Name": "New Analysis 1",
    "Enabled": true,
    "ParentId": "623c2bcc-e589-4695-b04d-ccf84790de60",
    "RunAsAccessLevel": 6,
    "MinimumEditAccessLevel": 6,
    "Code": "using OpenPlant;\r\nusing System;\r\nusing System.Linq;\r\nusing System.Diagnostics;\r\nusing System.Data;\r\nusing System.IO;\r\nusing System.Collections.Generic;\r\nusing System.Xml;\r\nusing System.Xml.Serialization;\r\nusing System.Threading;\r\nusing System.ServiceModel;\r\nusing System.Threading.Tasks;\r\nusing System.Collections.Concurrent;\r\nusing System.Globalization;\r\n\r\npublic class OPScript\r\n{\r\n\r\npublic object Main()\r\n{\r\n//*********** ANALYTIC SCRIPT STARTS HERE (DO NOT REMOVE THIS LINE) ***********\r\rThread.Sleep(1000);\rreturn OP.ListTagIds(\"*\");\n//*********** ANALYTIC SCRIPT ENDS HERE (DO NOT REMOVE THIS LINE) *************\r\nreturn null;\r\n}\r\n\r\n}\r\n",
    "Schedule": {
      "ScheduleEnabled": false,
      "StartTime": null,
      "OPScriptId": "7e1da12b-ffa6-46dc-a512-9f07158f34a3",
      "ServerName": "AZRINLAPTOP2",
      "StartImmediately": true,
      "Frequency": 1,
      "FrequencyUnit": 1,
      "DaysSelected_ForWeeksFrequencyUnit": [],
      "MonthsSelected_ForMonthsFrequencyUnit": [],
      "DaysSelected_ForMonthsFrequencyUnit": [],
      "SpecialDayOfMonth_ForMonthsFrequencyUnit": [],
      "ExpiryTime": null,
      "FirstDayOfWeek": 1
    },
    "WebAPI": {
      "Enabled": true,
      "EnableTriggerURL": true,
      "TriggerURLRegexMatch": "/test/for/alternative",
      "TriggerURLMethod": "GET",
      "MatchWithRegex": true
    },
    "MethodName": "Main"
  }
}

Security Restrictions

This API will only allow deletion of scripts with MinimumEditAccessLevel lower or equal to the caller's access level

GET

View OPScript Tree / Directory

This API returns a JSON Object of the OPScript Tree / Directory. The OPScript Tree is the visual tree seen in the Open-Plant Client (Example below).

In Open-Plant, the OPScript directory structure can only have two levels of folders (i.e. a folder and a sub folder). Each folder will have a 'MinimumEditAccessLevel' property, which will prevent lower level users from seeing the contents of the folder. However, if the Script's 'MinimumEditAccessLevel' is lower than the folder's Access Level, users with lower levels can still view/update/delete the script from via Web APIs. The folder thus does not have much impact on the execution or accessibility of the script, other than script organization in the Open-Plant Client.

The API is simply called as follows (Example):

http://localhost:33171/api/opscripttree/
http://localhost:33171/api/opscripttree/?Flatlist=true
http://localhost:33171/wa/api/opscripttree/

*Add '/wa' before '/api' when using windows authentication

When "flatlist" is NOT specified
The API returns a JSON object with a nested structure like a tree as shown below. The 'IsGroup' and '$type' property determines whether the entity represents a script of a folder.

NOTE: Although the structure is a nested tree, the tree means nothing other than being a friendly JSON presentation. The real indicator that a folder or script belongs to another folder is the 'ParentId' property. The 'ParentId' denotes the actual folder a script/folder/subfolder belongs to. A null ParentId means that the folder is at the top level directory.

When "flatlist" is specified
The API returns a JSON object as a list. This list can be easier manipulated and submitted in the Save Tree/Directory API Call, as the hierarcy object means nothing to Open-Plant other that it's 'ParentId'.

Returns (JSON) - Hierarcy Tree - FlatList NOT Specified:

{
  "data": [
    {
      "Id": "623c2bcc-e589-4695-b04d-ccf84790de60",
      "ParentId": "",
      "Name": "Azrin's Folder",
      "IsGroup": true,
      "MinimumEditAccessLevel": 6
    },
    {
      "Id": "7c5e88de-8b5c-4062-98d7-366dd5b197f4",
      "ParentId": "",
      "Name": "Azrin's Subfolder",
      "IsGroup": true,
      "MinimumEditAccessLevel": 6
    },
    {
      "Id": "7c5e99de-8b5c-4062-98d7-366dd5b197f4",
      "ParentId": "623c2bcc-e589-4695-b04d-ccf84790de60",
      "Name": "New Subfolder",
      "IsGroup": true,
      "MinimumEditAccessLevel": 6
    },
    {
      "Id": "2180b647-cbe1-49f5-96bf-fbaf32a41588",
      "ParentId": "7c5e99de-8b5c-4062-98d7-366dd5b197f4",
      "Name": "New Analysis 132",
      "IsGroup": false,
      "MinimumEditAccessLevel": 6
    },
    {
      "Id": "0da577c7-616a-4ee2-bc5a-27106c2e430b",
      "ParentId": "623c2bac-e589-4695-b04d-ccf84790de60",
      "Name": "test222",
      "IsGroup": false,
      "MinimumEditAccessLevel": 6
    }
  ]
}

Returns (JSON) - FlatList Specified

{
  "data": [
    {
      "$type": "OpenPlant.ScriptGroupWebAPI, OPCoreLib",
      "Children": [
        {
          "$type": "OpenPlant.ScriptSubGroupWebAPI, OPCoreLib",
          "Scripts": [
            {
              "Id": "2180b647-cbe1-49f5-96bf-fbaf32a41588",
              "ParentId": "7c5e99de-8b5c-4062-98d7-366dd5b197f4",
              "Name": "New Analysis 132",
              "IsGroup": false,
              "MinimumEditAccessLevel": 6
            }
          ],
          "Id": "7c5e99de-8b5c-4062-98d7-366dd5b197f4",
          "ParentId": "623c2bcc-e589-4695-b04d-ccf84790de60",
          "Name": "New Subfolder",
          "IsGroup": true,
          "MinimumEditAccessLevel": 6
        }
      ],
      "Id": "623c2bcc-e589-4695-b04d-ccf84790de60",
      "ParentId": null,
      "Name": "Azrin's Folder",
      "IsGroup": true,
      "MinimumEditAccessLevel": 6
    },
    {
      "$type": "OpenPlant.ScriptGroupWebAPI, OPCoreLib",
      "Children": [],
      "Id": "7c5e88de-8b5c-4062-98d7-366dd5b197f4",
      "ParentId": null,
      "Name": "Azrin's Subfolder",
      "IsGroup": true,
      "MinimumEditAccessLevel": 6
    }
  ]
}

Security Restrictions

This API will only return a tree with elements (script, folders and subfolders) with MinimumEditAccessLevel lower or equal to the caller's access level

POST

Save OPScript Tree / Directory

This API updates the OPScript Tree / Directory. The OPScript Tree is the visual tree seen in the Open-Plant Client.

A JSON object of the updated script must be included in the request body of the API Call. The expected format has the same format as the View Tree/Drectory return output API Call. Thus so, it is best that the View Tree/Directory API is called first with it's ouput copied and modified for use with this API Call. Both 'FlatList' or 'Script Hierarchy' JSON object can be specified.

The API is simply called with a 'POST' as follows:

Example:

http://localhost:33171/api/opscripttree/
http://localhost:33171/wa/api/opscripttree/

*Add '/wa' before '/api' when using windows authentication

Some notes with regards to the JSON Tree/Directory Input
- The JSON object folder/script/subfolder must be in the correct format. Any missing property (except 'Id') will cause the call to return a '400-Bad Request'
- The 'Id' property may be ommitted signalling the creation of a new script, folder or subfolder. Open-Plant will assign a new Id for it.
- If an incorrect 'Id' format is specified, Open-Plant will a assign a new Id (and create a new script).
- This API call only creates/updates. It does not delete. Thus so, it is not necessarry for the entire OPScript Tree/List be included in the API call. Any folder/script/subfolders may be ommitted, in which case the API will do nothing to the ommitted record.
- The 'ParentId' denotes the actual folder a script/folder/subfolder belongs to, not the position in the JSON tree hierarchy. A null ParentId means that the folder is at the top level directory. It is thus easier to update with a flatlist JSON object.
- Open-Plant only supports 2 levels of folder hierarchy. If any extra hierarchies are added, this API will set that item's 'ParentId' null.

JSON Request Body Example:

{
  "data": [
    {
      "ParentId": "",
      "Name": "Azrin's NEW Folder",
      "IsGroup": true,
      "MinimumEditAccessLevel": 6
    },
    {
      "Id": "0da577c7-616a-4ee2-bc5a-27106c2e430b",
      "ParentId": "623c2bac-e589-4695-b04d-ccf84790de60",
      "Name": "NEW FOLDER NAME",
      "IsGroup": false,
      "MinimumEditAccessLevel": 6
    }
  ]
}

*Ommitting 'Id' in the example above creates a NEW FOLDER at the top of the Tree hierarchy

The Web API Call return the updated JSON object. If a new folder/script is created, it will return it's new 'Id'

Returns (JSON):

{
  "data": [
    {
      "Id": "1af81898-615b-4b94-a2bb-3b6ba41a7566",
      "ParentId": "",
      "Name": "Azrin's NEW Folder",
      "IsGroup": true,
      "MinimumEditAccessLevel": 6
    },
    {
      "Id": "0da577c7-616a-4ee2-bc5a-27106c2e430b",
      "ParentId": "623c2bac-e589-4695-b04d-ccf84790de60",
      "Name": "NEW FOLDER NAME",
      "IsGroup": false,
      "MinimumEditAccessLevel": 6
    }
  ]
}

Security Restrictions

This API will not allow the update or creation of elements (script, folders or subfolders) with MinimumEditAccessLevel lower or equal to the caller's access level

POST

Create a new OPScript Tree / Directory Folder

This API creates a new OPScript Tree / Directory Folder. The following parameters can be specified:
- 'name' is the name of the folder. If unspecified, it will give a default name 'New Folder'
- 'minimumedit' is the minimum access level a user needs to view the contents of the folder. If unspecified, this will be set to the calling user's access level.
- 'parentid' is the folder Id where the created folder is to reside in. 'parentid' can be obtained from the View OPScript Tree web API. If unspecified, the folder will be created at the top of the directory

This Web API Call returns the created item's JSON object.

Example:

http://localhost:33171/api/newfolder								
http://localhost:33171/api/newfolder?name=MyNewFolder       		//with Minimum Edit = Querying User access level
http://localhost:33171/api/newfolder?name=MyNewFolder&minimumedit=7	//This creates a Folder at the top of the directory
http://localhost:33171/api/newfolder?name=MyNewFolder&minimumedit=7&parentid=641f8453-6030-41e3-96c4-8cdbb1e5d876

http://localhost:33171/wa/api/newfolder

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
  "data": {
    "ScriptList": [],
    "Id": "a0469268-d9b7-43a4-bd5c-6796747b8406",
    "ParentId": "7e0093b0-52f6-4cdf-89b7-4db99fbca3a7",
    "Name": "testfolderL2",
    "IsGroup": true,
    "MinimumEditAccessLevel": 7
  }
}

Security Restrictions

This API will not allow the deletion of folders and elements (script, folders or subfolders) insid the folder that has MinimumEditAccessLevel lower or equal to the caller's access level

DELETE

Delete OPScript Tree / Directory Folder

This API deletes an OPScript Tree / Directory Folder. The 'Id' of the folder needs to be specified in the API Call. This script will also delete everything inside the folder including scripts, as long as the element to be deleted has a lower access level than the querying user's access level.

This Web API Call will return the deleted item's JSON object. If the 'Id' could not be found, a '404-Not Found' reponse will be given.

Example:

http://localhost:33171/api/deletefolder?id=641f8453-6030-41e3-96c4-8cdbb1e5d876
http://localhost:33171/wa/api/deletefolder?id=641f8453-6030-41e3-96c4-8cdbb1e5d876

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
  "data": {
    "Id": "a0469268-d9b7-43a4-bd5c-6796747b8406",
    "ParentId": "7e0093b0-52f6-4cdf-89b7-4db99fbca3a7",
    "Name": "testfolderL2",
    "IsGroup": true,
    "MinimumEditAccessLevel": 7
  }
}

Security Restrictions

This API will not allow the deletion of folders and elements (script, folders or subfolders) insid the folder that has MinimumEditAccessLevel lower or equal to the caller's access level

POST

Run OPScript

This API run's either an existing OPScript or a custom OPScript inserted in the body of the API Call request. To run an existing OPScript, the script's 'Id' needs to be specified. A list of OPScript Id's can be found by first running the 'Multiple OPScripts' query.

The API can also be specified with a 'Name' i.e. the script name instead of the Id. However, If there are more than one script that has the same name, only one of the scripts will be run.

To run a custom script inserted in the body, the 'Id' and 'Name' must be ommitted. The script it self must be include in plain text in the API Call request body. An optional 'isadvance' parameter can be also specified as 'true' for custom scripts. This informs Open-Plant to treat the script as an advance code and will be compiled accordingly.

Example

http://localhost:33171/api/runscript						//This runs a custom script inserted in the request body 
http://localhost:33171/api/runscript?id=7e1da12b-ffa6-46dc-a512-9f07158f34a3 	//This runs an exsiting script
http://localhost:33171/api/runscript?name=Analysis1 	//This runs an exsiting script

*Add '/wa' before '/api' when using windows authentication

To run a custom OPScript, the following example shows how to include a script in the API call's body via Javascript. The custom OPScript is the one line "return OP.ListTagIds("*");" code . (Plunkr - Example)

var xhttp = new XMLHttpRequest();
xhttp.open("POST", "http://localhost:33171/api/runscript", true);
xhttp.setRequestHeader('Authorization', 'Basic ' + window.btoa('USERNAME:PASSWORD'));
xhttp.send("return OP.ListTagIds("*");");
xhttp.onreadystatechange = function(){
  if (xhttp.readyState === XMLHttpRequest.DONE) {
    if (xhttp.status === 200) document.write(xhttp.responseText);
    else document.write("FAILED!");
  }
};

It is faster and more resource efficient to run an existing script as the script is already compiled upon enabling the script. To run an existing script, make sure the script is both 'enabled' and 'web api trigger enabled' in the Open-Plant client as follows:

For security reasons, Open-Plant limits the functions a script can do based on it's 'Run Script As Access Level'. To learn more about these restriction, click .
- When running a CUSTOM script, the script's 'Run Script As Access Level' will be the API Caller's Access Level.
- When running an EXISTING script, the script's 'Run Script As Access Level' will be the 'Run Script As' property set on the script. This property can be set in the Open-Plant Client (as shown above).

OPScript triggered via Web APIs can return custom JSON data, accept user input, read API Call bodies and etc. To learn more see OP Script Custom Web APIs

This API by default returns a json object of the script execution result. If the OPScript returns a custom object, this custom object's JSON will be return instead.

Returns (JSON):

{
  "runsuccess": true,
  "runduration_ms": 243,
  "error": null
}

Example custom object return:

[
  "Sensor008.Value",
  "Sensor001.Value",
  "Sensor009.Value",
  "Sensor006.Value",
  "Sensor010.Value",
  "Sensor007.Value",
  "Sensor002.Value",
  "Sensor004.Value",
  "Sensor003.Value",
  "Sensor005.Value"
]

Security Restrictions

Running existing scripts (by specifying script Id or name) requires Access Level higher than the script's 'Run As' Access Level

Running custom scripts (where the script is specified in the Web API Call body) requires Access Level 6 (L1-Engineer) or higher

KV (Key-Value) STORE APIS

Key Value Store (KVStore) functions as a convenient database to store any type of data from strings, integer, numbers, date, time and even objects. When an object is stored, it is stored as a JSON string. Each item stored in the KVStore must be assigned a 'Key' and a 'KVGroup'.

KVStore is almost similar to OP Parameters, except that it is not cached in server memory but stored directly in the Open-Plant Database. Accessing KVStore will result in a database operation, which may be slightly slower than accessing server memory. However, unlike OP Parameters, there is no limit to the size of a value.

GET

Single Key Value

This API retrieves a value for the KV Store identified by the 'KVGroup' and 'Key'.

Examples:

https://127.0.0.1:33170/api/sample?tagid=fic103.value
https://127.0.0.1:33170/api/sample?tagid=fic103.value&timestamp=now		//Get current data. Same as above.
https://127.0.0.1:33170/api/sample?tagid=fic103.value&timestamp=now-1d		//Get data 1 day ago.
https://127.0.0.1:33170/api/sample?tagid=fic103.value&timestamp=now-10m		//Get data 10 minues ago.
https://127.0.0.1:33170/api/sample?tagid=fic103.value&timestamp=now-3h		//Get data 3 hours ago.
https://127.0.0.1:33170/api/sample?tagid=fic103.value&timestamp=now-5s		//Get data 5 seconds ago.
https://127.0.0.1:33170/api/sample?tagid=fic103.value&timestamp=2019-08-16 13:43:10
https://127.0.0.1:33170/api/sample?tagid=fic103.value&timestamp=2019-08-16 03:43:12.432
https://127.0.0.1:33170/api/sample?tagid=fic103.value&timestamp=2019-08-16T03:43:12.432Z
https://127.0.0.1:33170/api/lastsample?tagid=fic103.value

https://127.0.0.1:33170/wa/api/lastsample?tagid=fic103.value

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
  "data": {
    "TSUTC": "2020-07-29T01:38:28.6285625Z",
    "Value": -13.977528720618018,
    "IsError": false
  }
}

{
  "data": {
    "TSUTC": "2020-07-29T01:39:30.8540427Z",
    "Value": null,
    "IsError": false
  }
}

Security Restrictions

This API can be called by any users with Access Level 1 (L1User) or higher

GET

Multiple Sample(s)

https://127.0.0.1:33170/api/samples?tagids=Random.Real4,Random.Int1
https://127.0.0.1:33170/api/samples?tagids=Random.Real4,Random.Int1&timestamp=now		//Get current. Same as above.
https://127.0.0.1:33170/api/samples?tagids=Random.Real4,Random.Int1&timestamp=now-1d		//Get data 1 day ago.
https://127.0.0.1:33170/api/samples?tagids=Random.Real4,Random.Int1&timestamp=now-10m		//Get data 10 minues ago.
https://127.0.0.1:33170/api/samples?tagids=Random.Real4,Random.Int1&timestamp=now-3h		//Get data 3 hours ago.
https://127.0.0.1:33170/api/samples?tagids=Random.Real4,Random.Int1&timestamp=now-5s		//Get data 5 seconds ago.
https://127.0.0.1:33170/api/samples?tagids=Random.Real4,Random.Int1&timestamp=2019-08-16 13:43:10
https://127.0.0.1:33170/api/samples?tagids=Random.Real4,Random.Int1&timestamp=2019-08-16T03:43:12.432Z
https://127.0.0.1:33170/api/lastsamples?tagids=Random.Real4,Random.Int1

https://127.0.0.1:33170/wa/api/lastsamples?tagids=Random.Real4,Random.Int1

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
  "data": [
    {
      "TSUTC": "2020-07-29T01:44:20.0968541Z",
      "Value": -14.222284921082812,
      "IsError": false
    },
    {
      "TSUTC": "2020-07-29T01:44:20.0968541Z",
      "Value": 24.559068368542512,
      "IsError": false
    }
  ]
}

{
    "data": [
        null,		//Null is returned when Tag Id Specified does not exist
        {
          "TSUTC": "2020-07-29T01:44:20.0968541Z",
          "Value": 24.559068368542512,
          "IsError": false
        }
    ]
}

Security Restrictions

This API can be called by any users with Access Level 1 (L1User) or higher

GET

Sample Series

https://127.0.0.1:33170/api/series?tagid=Random.Real4&from=2019-08-16T03:43:05.432Z&to=2019-08-16T03:43:08.432Z 		//returns samples every 1 second (default)
https://127.0.0.1:33170/api/series?tagid=Random.Real4&from=2019-08-16T03:30:05.432Z&to=2019-08-16T03:43:08.432Z&interval=120000 //returns samples every 120 seconds
https://127.0.0.1:33170/api/series?tagid=Random.Real4&from=now-1m&to=now 							//returns samples every 1 second (default)
https://127.0.0.1:33170/api/series?tagid=Random.Real4&from=now-1m&to=now&interval=30000  					//returns samples every 30 seconds

https://127.0.0.1:33170/wa/api/series?tagid=Random.Real4&from=now-1m&to=now&interval=30000

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
  "data": [
    {
      "TSUTC": "2020-07-29T04:46:00.2097341Z",
      "Value": -9.5293384029201,
      "IsError": false
    },
    {
      "TSUTC": "2020-07-29T04:47:00.2097341Z",
      "Value": -9.5293384029201,
      "IsError": false
    },
    {
      "TSUTC": "2020-07-29T04:48:00.2097341Z",
      "Value": -9.5293384029201,
      "IsError": false
    }
  ]
}

Security Restrictions

This API can be called by any users with Access Level 1 (L1User) or higher

GET

Raw Sample Series

https://127.0.0.1:33170/api/rawseries?tagid=Random.Real4&from=2019-08-16T03:43:05.432Z&to=2019-08-16T03:43:08.432Z 			//All samples are returned
https://127.0.0.1:33170/api/rawseries?tagid=Random.Real4&from=2019-08-16T03:30:05.432Z&to=2019-08-16T03:43:08.432Z&interval=120000 	//returns samples every 120 seconds
https://127.0.0.1:33170/api/rawseries?tagid=Random.Real4&from=now-1m&to=now 								//All samples are returned
https://127.0.0.1:33170/api/rawseries?tagid=Random.Real4&from=now-1m&to=now&interval=30000  						//returns samples every 30 seconds

https://127.0.0.1:33170/wa/api/rawseries?tagid=Random.Real4&from=now-1m&to=now

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
  "data": [
    {
      "TSUTC": "2020-07-29T06:03:07.022Z",
      "Value": 1.06203595225794,
      "IsError": false
    },
    {
      "TSUTC": "2020-07-29T06:03:08.022Z",
      "Value": 1.68915390255356,
      "IsError": false
    },
    {
      "TSUTC": "2020-07-29T06:03:10.022Z",
      "Value": 1.48192795947284,
      "IsError": false
    }
  ]
}

Security Restrictions

This API can be called by any users with Access Level 1 (L1User) or higher

POST

Insert Sample(s)

https://127.0.0.1:33170/api/samples/?tagid=Random.Real4&values=0.1,0.2,0.15&timestamps=now,now-1s,now-2s
https://127.0.0.1:33170/api/samples/?tagid=Random.Real4&values=1.23,1.24,1.30&timestamps=2019-08-16 13:03:02,2019-08-16 13:04:02,2019-08-16 13:05:02
https://127.0.0.1:33170/api/samples/?tagid=Random.Real4&values=1,2,3&timestamps=2019-08-16T03:43:20.212Z,2019-08-16T03:43:21.212Z,2019-08-16T03:43:22.212Z
https://127.0.0.1:33170/api/samples/?tagid=Random.Real4&values=0.1,0.2,0.15&timestamps=now,now-1s,now-2s&iserrors=0,1,0
https://127.0.0.1:33170/api/samples/?tagid=Random.Real4&values=0.1,0.2,0.15&timestamps=now,now-1s,now-2s&iserrors=0
https://127.0.0.1:33170/api/samples/?tagid=Random.Real4&values=0.1,0.2,0.15&timestamps=now,now-1s,now-2s&iserrors=false

https://127.0.0.1:33170/wa/api/samples/?tagid=Random.Real4&values=0.1,0.2,0.15&timestamps=now,now-1s,now-2s&iserrors=false

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
    "data": [
        {
            "IsError": false,
            "TSLocal_ISO": "2019-08-16T11:43:20.212",
            "TSUTC": "/Date(1565927000212)/",
            "TSUTC_ISO": "2019-08-16T03:43:20.212Z",
            "Value": 1
        },
        {
            "IsError": false,
            "TSLocal_ISO": "2019-08-16T11:43:21.212",
            "TSUTC": "/Date(1565927001212)/",
            "TSUTC_ISO": "2019-08-16T03:43:21.212Z",
            "Value": 2
        },
        {
            "IsError": false,
            "TSLocal_ISO": "2019-08-16T11:43:22.212",
            "TSUTC": "/Date(1565927002212)/",
            "TSUTC_ISO": "2019-08-16T03:43:22.212Z",
            "Value": 3
        }
    ]
}

Security Restrictions

This API can be called by any users with Access Level 4 (Connector) or higher

POST

Insert Bulk Samples(s)

https://127.0.0.1:33170/api/samples/?tagids=random.real4,random.int1,fic1.pv&values=0.1,2,0.15&timestamps=2019-08-16T03:43:20.212Z,2019-08-16T03:43:21.212Z,2019-08-16T03:43:22.212Z
https://127.0.0.1:33170/api/samples/?tagids=random.real4,random.int1,fic1.pv&values=0.1,2,0.15&timestamps=now,now-1s,now-2s
https://127.0.0.1:33170/api/samples/?tagids=random.int1,fic1.pv&values=3,2&timestamps=now,now&datatypes=int,real
https://127.0.0.1:33170/api/samples/?tagids=random.int1,fic1.pv&values=3,2&datatypes=int,real&iserrors=true,false
https://127.0.0.1:33170/api/samples/?tagids=random.int1,fic1.pv&values=3,2&datatypes=int,real&iserrors=true				//this causes all samples inserted have iserror=true
https://127.0.0.1:33170/api/samples/?tagids=random.real4,random.int1,fic1.pv&values=0.1,2,0.15					//this inserts all 3 samples at current time
https://127.0.0.1:33170/api/samples/?tagids=fic1.pv&values=0.1,2,0.15&timestamps=now,now-1s,now-2s					//this inserts all 3 samples into 'fic1.pv'
https://127.0.0.1:33170/api/samples/?tagids=random.real4,random.int1,fic1.pv&values=0.1,2,0.15&timestamps=2019-08-16T03:43:20.212Z	//this inserts all 3 samples at '2019-08-16T03:43:20.212Z'

https://127.0.0.1:33170/wa/api/samples/insert?tagids=random.real4,random.int1,fic1.pv&values=0.1,2,0.15&timestamps=2019-08-16T03:43:20.212Z

*Add '/wa' before '/api' when using windows authentication

Returns (JSON):

{
    "totalsamplesinserted": 3,
    "totaltagscreated": 0
}

Security Restrictions

This API can be called by any users with Access Level 4 (Connector) or higher

Open-Plant is a revolutionary Industrial IOT Platform software, used to create and deploy Industrial IT apps/solutions. It is an all-encompassing solution offering both back-end and front-end components i.e. the full stack. From our user's experience, creating and deploying Industrial IT apps became 10x faster and 10x less cost. We serve the mining, energy, oil & gas, construction and manufacturing industry.

Vlix

We are based in

Perth, Australia

ABN:

70882507862

EMAIL

Sales / General Enquiry:

info@vlix.me

Support:

support@vlix.me

An Industrial IOT Platform

Web API Documentation

GENERAL APIS

Server Info

Authenticate User

USER APIS

Single User

Multiple User(s)

Create User

Update User

Delete User

TAG APIS

Tag List

Single Tag

Multiple Tag(s)

Create New Tag

Update Tag

Delete Tag

VALUE APIS

Single Value

Multiple Value(s)

Data Table

SAMPLE APIS

Single Sample

Multiple Sample(s)

Sample Series

Raw Sample Series

Insert Sample(s)

Insert Bulk Samples(s)

OPSCRIPT APIS

OPScript List

Single OPScript

Multiple OPScripts

New OPScript

Update OPScript

Delete OPScript

View OPScript Tree / Directory

Save OPScript Tree / Directory

Create a new OPScript Tree / Directory Folder

Delete OPScript Tree / Directory Folder

Run OPScript

KV (Key-Value) STORE APIS

Single Key Value

Multiple Sample(s)

Sample Series

Raw Sample Series

Insert Sample(s)

Insert Bulk Samples(s)

Home

How it works

Applications

Pricing / Contact

Download

Vlix

EMAIL

Sales / General Enquiry:

Support: