Integration
การเชื่อมต่อกับแพลตฟอร์มอื่น ๆ
What is Integration?
Integration: ฟังก์ชันที่มีหน้าที่ในการเชื่อมต่อกับแพลตฟอร์มอื่น ๆ ผ่าน RESTful API โดยสามารถดึงข้อมูลและทราบรายละเอียดต่าง ๆ ที่เกี่ยวข้องจากระบบภายนอกได้อย่างมีประสิทธิภาพ
Tag/ Tag Relation Provider
Publisher
Function
Provider
การจัดการและตั้งค่าการให้บริการข้อมูล
Provider : การเปิดปิด Tag/TagRelation ในระบบที่สามารถเรียกใช้งานผ่าน RESTful API เพื่อให้บริการข้อมูลกับผู้ใช้
Tag Provider
TagRelation Provider
Usage
การปรับ Toggle เพื่อเปิดปิด การใช้งานผ่าน RESTful API
Active : เปิดการใช้งานผ่าน RESTful API
Inactive : ปิดการใช้งานผ่าน RESTful API
Active / Inactive All : เปิดการใช้งานผ่าน RESTful API ทั้งหมดที่มีใน iCube Server 1. Click : กดปุ่ม Status 2. Select : เลือก Status ที่ต้องการตั้งค่า 3. Submit : กดปุ่ม Submit เพื่อบันทึกการตั้งค่า
[Integration Provider] API Document
API Document สำหรับ Provider ใช้ในการดึงข้อมูลจาก iCube Platform
GET
Fetches detailed information about a specific tag relationidentified by its name.
GET
Fetches the values of specified tag relations identified by their names
POST
Fetches the values of specified tags based on the provided criteria
POST
Fetches the values of specified tag relations based on the provided criteria
DELETE
Deletes the specified tag relation values for tag relation based on their timestamps
Get service list all
Retrieves the base URL information and provides links to additional resources or endpoint categories.
Get connection
Checks the connection status to confirm the API is accessible and operational.
Get Tag all
Fetches a list of tags, including their details and a link to access the latest tag values.
Example URL
Last Update: 1 NOV 2024
Retrieve Tag List
Method: GET
URL: {{base_url}}/tag
Response Example:
Response Details:
data
array
List of tag objects.
tagname
string
Name of the tag.
server
string
Server name where the tag originates.
description
string/null
Description of the tag.
subDescription
string/null
Additional description, if any.
tagType
string
Data type of the tag (e.g., "Double").
tagSource
string
Source type of the tag (e.g., "Normal tag").
tagMode
string
Mode of the tag (e.g., "Default").
unit
string
Unit of measurement (e.g., "L").
timeStamp
datetime
Timestamp of the tag's last recorded value.
value
string
URL link to access the latest value of the tag.
Get Tag Relation all
Fetches a list of tag relations, including details about each relation and its properties.
Example URL
Last Update: 7 NOV 2024
Retrieve Tag Relations
Method: GET
URL: {{base_url}}/tagrelation
Response Example:
Response Details:
result
array
List of tag relation objects.
tagRelationName
string
Name of the tag relation.
server
string
Server name associated with the tag relation.
description
string
Description of the tag relation.
createAt
datetime
Timestamp of when the tag relation was created.
updateAt
datetime/null
Timestamp of the last update, if applicable.
deleteAt
datetime/null
Timestamp of when the tag relation was deleted, if applicable.
enableHyperTable
bool
Indicates if the hyper table feature is enabled.
isView
bool
Indicates if the tag relation is viewable.
Get Tag by name
Fetches detailed information about a specific tag identified by its name.
Example URL
Last Update: 1 NOV 2024
Retrieve Tag Information
Method: GET
URL: {{base_url}}/tag/{tagname}
Response Example:
Response Details:
data
array
List of tag objects, containing details of the specified tag.
tagname
string
Name of the tag.
server
string
Server name associated with the tag.
description
string/null
Description of the tag.
subDescription
string/null
Sub-description of the tag, if available.
tagType
string
Data type of the tag (e.g., Integer, Double).
tagSource
string
Source of the tag data (e.g., Normal tag).
tagMode
string
Mode of the tag (e.g., Default).
unit
string
Unit of measurement for the tag, if applicable.
timeStamp
datetime
Last updated timestamp for the tag.
value
string
URL or current value of the tag.
Get Tag Relation by name
Fetches detailed information about a specific tag relation identified by its name.
Example URL
Last Update: 1 NOV 2024
Retrieve Tag Relation Information
Method: GET
URL: {{base_url}}/tagrelation/{tagrelationname}
Response Example:
Response Details:
data
array
Contains details of the specified tag relation.
tagRelationName
string
Name of the tag relation.
server
string
Server name associated with the tag relation.
description
string
Description of the tag relation.
enableHyperTable
string
Indicates if hyper table functionality is enabled.
isView
string
Indicates if the tag relation is a view.
sqlQueryScript
string/null
SQL script associated with the tag relation, if available.
createAt
datetime
Creation timestamp for the tag relation.
value
string
URL or current value of the tag relation.
tagRelationFieldMappings
array
List of field mappings associated with the tag relation.
fieldName
string
Name of the field in the mapping.
description
string/null
Description of the field, if available.
isIdentity
bool
Indicates if the field is an identity field.
Get single Tag value
Fetches the value of a specific tag identified by its name, along with optional filters for time range and conditions.
Example URL
Last Update: 1 NOV 2024
Retrieve Tag Value with Conditions
Method: GET
URL: {{base_url}}/tag/{tagname}/value?starttime={starttime}&endtime={endtime}&query={query}
Query Parameters:
starttime
Yes
Starting time for filtering the data (e.g., *-10y)
(Default: starttime=*-10m)
endtime
Yes
Ending time for filtering the data (e.g., *)
(Default: endtime=*)
query
No
A condition to filter the results, acting like a WHERE clause in PostgreSQL.
Time Expression:
sec
Second
m
Minute
h
Hour
d
Day
mo
Month
y
Year
*
Present
-
Go back (e.g., *-10y means go back 10 years)
+
Go forward (e.g., *+10mo means go forward 10 months)
Response Example:
Response Details:
data
array
Array of tag value objects returned from the API.
tagname
string
Name of the tag.
description
string/null
Description of the tag, if available.
subDescription
string/null
Sub-description of the tag, if available.
value
string
Current value of the tag.
quality
integer
Quality indicator of the tag value.
status
integer
Status code associated with the tag value.
timeStamp
datetime
Timestamp when the tag value was recorded.
Get single Tag Relation value
Fetches the values of a specific tag relation identified by its name, along with optional filters for time range and conditions.
Example URL
Last Update: 5 NOV 2024
Retrieve Tag Relation Value with Conditions
Method: GET
URL: {{base_url}}/tagrelation/{tagrelationname}/value?starttime={starttime}&endtime={endtime}&query={query}
Query Parameters:
starttime
Yes
Starting time for filtering the data (e.g., *-10y)
(Default: starttime=*-10m)
endtime
Yes
Ending time for filtering the data (e.g., *)
(Default: endtime=*)
query
No
A condition to filter the results, acting like a WHERE clause in PostgreSQL.
Time Expression:
sec
Second
m
Minute
h
Hour
d
Day
mo
Month
y
Year
*
Present
-
Go back (e.g., *-10d means go back 10 days)
+
Go forward (e.g., *+10mo means go forward 10 months)
Response Example:
Note: The fields Id, name, and tel are placeholders and will vary depending on the specific tag relation being represented in the request. Ensure you refer to the specific tag relation schema for exact field details.
Response Details:
data
array
Array of tag relation value objects returned from the API.
Id
string
Unique identifier for the tag relation.
name
string
Name associated with the tag relation.
tel
string
Telephone number associated with the tag relation.
quality
integer
Quality indicator of the tag relation value.
status
integer
Status code associated with the tag relation value.
timeStamp
datetime
Timestamp when the tag relation value was recorded.
Get multiple Tag values
Fetches the values of specified tags identified by their names, with optional filters for time range and status.
Example URL
Last Update: 5 NOV 2024
Retrieve Tag Values with Filters
Method: GET
URL: {{base_url}}/tag/value?name={tagname}&starttime={starttime}&endtime={endtime}&statusData={statusData}
Query Parameters:
name
Yes
Comma-separated list of tag names to retrieve values for (e.g., B15-Status,VT-01).
starttime
Yes
Starting time for filtering the data (e.g., *-10y)
(Default: starttime=*-10m)
endtime
Yes
Ending time for filtering the data (e.g., *)
(Default: endtime=*)
statusData
No
A filter for the status of the tag values, acting like a WHERE clause in PostgreSQL (only integer).
Time Expression:
sec
Second
m
Minute
h
Hour
d
Day
mo
Month
y
Year
*
Present
-
Go back (e.g., *-10d means go back 10 days)
+
Go forward (e.g., *+10mo means go forward 10 months)
Response Example:
Response Details:
data
array
Array of tag value objects returned from the API.
tagname
string
Name of the tag.
description
string/null
Description of the tag.
subDescription
string/null
Additional description of the tag (if available).
value
string
The value of the tag.
unit
string
Unit of measurement for the tag value.
quality
integer
Quality indicator of the tag value.
status
integer
Status code associated with the tag value.
timeStamp
datetime
Timestamp when the tag value was recorded.
Get multiple Tag Relation values
Fetches the values of specified tag relations identified by their names, with optional filters for time range and status.
Example URL
Last Update: 7 NOV 2024
Retrieve Tag Relation Values with Filters
Method: GET
URL: {{base_url}}/tagrelation/value?name={tagrelationname}&starttime={starttime}&endtime={endtime}&statusData={statusData}
Query Parameters:
name
Yes
Comma-separated list of tag relation names to retrieve values for (e.g., bronze_relation_raw,Testmultiple).
starttime
Yes
Starting time for filtering the data (e.g., *-10y)
(Default: starttime=*-10m)
endtime
Yes
Ending time for filtering the data (e.g., *)
(Default: endtime=*)
statusData
No
A filter for the status of the tag relation values, acting like a WHERE clause in PostgreSQL (only integer).
Time Expression:
sec
Second
m
Minute
h
Hour
d
Day
mo
Month
y
Year
*
Present
-
Go back (e.g., *-10d means go back 10 days)
+
Go forward (e.g., *+10mo means go forward 10 months)
Response Example:
Note: The fields Id, name, and tel are placeholders and will vary depending on the specific tag relation being represented in the request. Ensure you refer to the specific tag relation schema for exact field details.
Response Details:
data
array
Array of tag relation value objects returned from the API.
tagRelationName
string
Name of the tag relation.
Id
string
Unique identifier for the tag relation entry.
name
string
Name associated with the tag relation.
tel
string
Telephone number associated with the tag relation.
quality
integer
Quality indicator of the tag relation value.
status
integer
Status code associated with the tag relation value.
timeStamp
datetime
Timestamp when the tag relation value was recorded.
Get multiple Tag values (with Body)
Fetches the values of specified tags based on the provided criteria.
Example URL
Last Update: 7 NOV 2024
Retrieve Tag Values
Method: POST
URL: {{base_url}}/tag/value?mode=read
Query Parameters:
mode
string
Mode of the Request
read: Use this mode to retrieve data.write: Use this mode to insert data.
(Default: mode=read)
updateStatus
bool
Update Status of data
True: Use this when need to update the status of dataFalse: Use this when don't need to update the status of data
(Default: updateStatus=False)
clearAll
bool
Clear records of data
True: Use this when need to clear all records of data before insert the new oneFalse: Use this when don't need to clear all records of data before insert the new one
(Default: clearAll=False)
Request Body:
tagnames
string
Comma-separated list of tag names to retrieve values for (e.g., VT-01,B15-Status)
starttime
string
Starting time for filtering the data (e.g., *-10y)
(Default: starttime=*-10m)
endtime
string
Ending time for filtering the data (e.g., *)
(Default: endtime=*)
statusData
integer
Status filter for the tag values
Time Expression:
sec
Second
m
Minute
h
Hour
d
Day
mo
Month
y
Year
*
Present
-
Go back (e.g., *-10y means go back 10 years)
+
Go forward (e.g., *+10mo means go forward 10 months)
Example Request Body:
Response Example:
Response Details:
data
array
Array of tag value objects returned from the API.
tagname
string
Name of the tag.
description
string/null
Description of the tag.
subDescription
string/null
Additional description of the tag (if available).
value
string
Value associated with the tag.
unit
string
Unit of measurement for the tag value.
quality
integer
Quality indicator of the tag value.
status
integer
Status code associated with the tag value.
timeStamp
datetime
Timestamp when the tag value was recorded.
Get multiple Tag Relation values (with Body)
Fetches the values of specified tag relations based on the provided criteria.
Example URL
Last Update: 7 NOV 2024
Retrieve Tag Relation Values
Method: POST
URL: {{base_url}}/tagrelation/value?mode=read
Query Parameters:
mode
string
Mode of the Request
read: Use this mode to retrieve data.write: Use this mode to insert data.
(Default: mode=read)
updateStatus
bool
Update Status of data
True: Use this when need to update the status of dataFalse: Use this when don't need to update the status of data
(Default: updateStatus=False)
clearAll
bool
Clear records of data
True: Use this when need to clear all records of data before insert the new oneFalse: Use this when don't need to clear all records of data before insert the new one
(Default: clearAll=False)
Request Body:
tagrelations
string
Comma-separated list of tag relation names to retrieve values for (e.g., bronze_relation_raw,TagRelationManagementSystem)
starttime
string
Starting time for filtering the data (e.g., *-10y)
(Default: starttime=*-10m)
endtime
string
Ending time for filtering the data (e.g., *)
(Default: endtime=*)
statusData
integer
Status filter for the tag relation values
Time Expression:
sec
Second
m
Minute
h
Hour
d
Day
mo
Month
y
Year
-
Go back (e.g., *-10y means go back 10 years)
*
Present
+
Go forward (e.g., *+10mo means go forward 10 months)
Example Request Body:
Response Example:
Note: The fields Id, name, and tel are placeholders and will vary depending on the specific tag relation being represented in the request. Ensure you refer to the specific tag relation schema for exact field details.
Response Details:
data
array
Array of tag relation value objects returned from the API.
tagRelationName
string
Name of the tag relation.
Id
string
Unique identifier for the tag relation.
name
string
Name associated with the tag relation.
tel
string
Telephone number associated with the tag relation.
quality
integer
Quality indicator of the tag relation value.
status
integer
Status code associated with the tag relation value.
timeStamp
datetime
Timestamp when the tag relation value was recorded.
Insert multiple Tag values
Add the specified tag values with their timestamps.
Example URL
Last Update: 1 NOV 2024
Add Tag Values
Method: POST
URL: {{base_url}}/tag/value?mode=write
Query Parameters:
mode
string
Mode of the Request
read: Use this mode to retrieve data.write: Use this mode to insert data.
(Default: mode=read)
updateStatus
bool
Update Status of data
True: Use this when need to update the status of dataFalse: Use this when don't need to update the status of data
(Default: updateStatus=False)
clearAll
bool
Clear records of data
True: Use this when need to clear all records of data before insert the new oneFalse: Use this when don't need to clear all records of data before insert the new one
(Default: clearAll=False)
Request Body:
The request body must be an array of tag value objects, each containing the following parameters:
TagName
string
Name of the tag to which the value belongs.
timeStamp
datetime
Timestamp of the value being written.
value
variant
Value associated with the tag. It can be one of the following data types:
Value Data Types:
string
Represents text data.
int
Represents integer data.
double
Represents floating-point data.
bool
Represents boolean values (true/false).
Example Request Body:
Response Example:
Response Details:
message
string
Success message indicating the result of the write operation.
Insert multiple Tag Relation values
Add the specified tag relation values with their field mappings and timestamps.
Example URL
Last Update: 1 NOV 2024
Add Tag Relation Values
Method: POST
URL: {{base_url}}/tagrelation/value?mode=write
Query Parameters:
mode
string
Mode of the Request
read: Use this mode to retrieve data.write: Use this mode to insert data.
(Default: mode=read)
updateStatus
bool
Update Status of data
True: Use this when need to update the status of dataFalse: Use this when don't need to update the status of data
(Default: updateStatus=False)
clearAll
bool
Clear records of data
True: Use this when need to clear all records of data before insert the new oneFalse: Use this when don't need to clear all records of data before insert the new one
(Default: clearAll=False)
Request Body:
The request body must be an array of tag relation value objects, each containing the following parameters:
tagRelationName
string
Name of the tag relation to which the values belong.
fieldMappings
array
An array of field mapping objects for the tag relation.
timeStamp
datetime
Timestamp of the value being written.
Field Mappings:
Each object in the fieldMappings array must contain the following parameters:
field_Name
string
Name of the field being mapped.
value
variant
Value associated with the field. It can be one of the following data types:
Value Data Types:
string
Represents text data.
int
Represents integer data.
big int
Represents large integer data.
boolean
Represents boolean values (true/false).
double
Represents floating-point data.
Example Request Body:
Response Example:
Response Details:
message
string
Success message indicating the result of the write operation.
Update multiple Tag value
Updates the specified values for the tag with GUID
Example URL
Last Update: 1 NOV 2024
Update Tag Value
Method: PUT
URL: {{base_url}}/tag/{tagname}/value
Request Body:
The request body must be an array of tag value objects, each containing the following parameters:
tagValueId
GUID
Unique identifier for the tag value.
value
variant
The value associated with the tag. It can be one of the following data types:
timeStamp
datetime
Timestamp of when the value is recorded.
Value Data Types:
string
Represents text data.
int
Represents integer data.
boolean
Represents boolean values (true/false).
double
Represents floating-point data.
Example Request Body:
Response Example:
Response Details:
message
string
Success message indicating the result of the write operation.
Update multiple Tag Relation value
Updates the specified values for the tag relation
Example URL
Last Update: 1 NOV 2024
Update Tag Relation Value
Method: PUT
URL: {{base_url}}/tagrelation/{tagrelationname}/value
Request Body:
The request body must be an array of tag relation value objects, each containing the following parameters:
tagRelationValueId
int
Unique identifier for the tag relation value.
timeStamp
datetime
Timestamp of when the values are recorded.
fieldValues
array
An array of field value objects, each containing:
Field Value Object:
field_Id
int
Unique identifier for the field.
value
variant
The value associated with the field, which can be one of the following data types:
Value Data Types:
string
Represents text data.
int
Represents integer data.
big int
Represents large integer data.
boolean
Represents boolean values (true/false).
double
Represents floating-point data.
Example Request Body:
Response Example:
Response Details:
message
string
Success message indicating the result of the write operation.
Delete multiple Tag values
Deletes the specified tag values for tag based on their timestamps.
Example URL
Last Update: 1 NOV 2024
Delete Tag Values
Method: DELETE
URL: {{base_url}}/tag/{tagname}/value
Request Body:
The request body must be an array of objects, each containing the following parameter:
timeStamp
datetime
The timestamp of the tag value to be deleted.
Example Request Body:
Response Example:
Response Details:
message
string
Success message indicating the result of the delete operation.
Delete multiple Tag Relation values
Delete the specified tag relation values for tag relation based on their timestamps.
Example URL
Last Update: 1 NOV 2024
Delete Tag Relation Values
Method: DELETE
URL: {{base_url}}/tagrelation/{tagrelationname}/value
Request Body:
The request body must be an array of objects, each containing the following parameter:
timeStamp
datetime
The timestamp of the tag relation value to be deleted.
Example Request Body:
Response Example:
Response Details:
message
string
Success message indicating the result of the delete operation.
APIs Document
API Document สำหรับ Provider ใช้ในการดึงข้อมูลจาก iCube Platform
GET
Fetches detailed information about a specific tag relationidentified by its name.
GET
Fetches the values of specified tagrelations identified by their names
POST
Fetches the values of specified tags based on the provided criteria
POST
Fetches the values of specified tagrelations based on the provided criteria
Get service lists
Retrieves the base URL information and provides links to additional resources or endpoint categories.
Get connection
Checks the connection status to confirm the API is accessible and operational.
Get tags
Fetches a list of tags, including their details and a link to access the latest tag values.
Last Update: 11 NOV 2024
Example URL
Retrieve Tag List
Method: GET
URL: {{base_url}}/tag
Response Example:
Response Details:
data
array
List of tag objects.
tagname
string
Name of the tag.
description
string/null
Description of the tag.
subDescription
string/null
Additional description, if any.
tagType
string
Data type of the tag (e.g., "Double").
tagSource
string
Source type of the tag (e.g., "Normal tag").
tagMode
string
Mode of the tag (e.g., "Default").
unit
string
Unit of measurement (e.g., "L").
value
string
URL link to access the latest value of the tag.
Get tagrelations
Fetches a list of tagrelations, including details about each relation and its properties.
Last Update: 11 NOV 2024
Example URL
Retrieve Tagrelations
Method: GET
URL: {{base_url}}/tagrelation
Response Example:
Response Details:
result
array
List of tag relation objects.
tagRelationName
string
Name of the tag relation.
description
string
Description of the tag relation.
enableHyperTable
bool
Indicates if the hyper table feature is enabled.
isView
bool
Indicates if the tag relation is viewable.
Get tag by tagname
Fetches detailed information about a specific tag identified by its name.
Last Update: 11 NOV 2024
Example URL
Note: This endpoint demonstrates querying data for a specific tag (B15-Status). In this example, B15-Status is the tag name being queried.
Retrieve Tag Information
Method: GET
URL: {{base_url}}/tag/{tagname}
Response Example:
Response Details:
data
array
List of tag objects, containing details of the specified tag.
tagname
string
Name of the tag.
description
string/null
Description of the tag.
subDescription
string/null
Sub-description of the tag, if available.
tagType
string
Data type of the tag (e.g., Integer, Double).
tagSource
string
Source of the tag data (e.g., Normal tag).
tagMode
string
Mode of the tag (e.g., Default).
unit
string
Unit of measurement for the tag, if applicable.
value
string
URL or current value of the tag.
Get tagrelation by tagrelation name
Fetches detailed information about a specific tag relation identified by its name.
Last Update: 11 NOV 2024
Example URL
Note: This endpoint demonstrates querying data for a specific tag relation (bronze_relation_raw). In this example, bronze_relation_raw is the tag relation name being queried.
Retrieve Tagrelation Information
Method: GET
URL: {{base_url}}/tagrelation/{tagrelationname}
Response Example:
Response Details:
data
array
Contains details of the specified tag relation.
tagRelationName
string
Name of the tag relation.
description
string
Description of the tag relation.
enableHyperTable
string
Indicates if hyper table functionality is enabled.
isView
string
Indicates if the tag relation is a view.
sqlQueryScript
string/null
SQL script associated with the tag relation, if available.
value
string
URL or current value of the tag relation.
tagRelationFieldMappings
array
List of field mappings associated with the tag relation.
fieldName
string
Name of the field in the mapping.
description
string/null
Description of the field, if available.
isIdentity
bool
Indicates if the field is an identity field.
Get single tag value
Fetches the value of a specific tag identified by its name, along with optional filters for time range and conditions.
Last Update: 7 NOV 2024
Example URL
Note: This endpoint demonstrates querying the value of a specific tag (B15-Status) with additional query parameters. In this example:
starttime=*-10dspecifies the start time as 10 days ago.endtime=*indicates no specific end time (or the most recent data).query=value > 50filters the results to include only those where the value is greater than 50.
Retrieve Tag Value with Conditions
Method: GET
URL: {{base_url}}/tag/{tagname}/value?starttime={starttime}&endtime={endtime}&query={query}
Query Parameters:
starttime
Yes
Starting time for filtering the data (e.g., *-10y)
(Default: starttime=*-10m)
endtime
Yes
Ending time for filtering the data (e.g., *)
(Default: endtime=*)
query
No
A condition to filter the results, acting like a WHERE clause in PostgreSQL.
Time Expression:
sec
Second
m
Minute
h
Hour
d
Day
mo
Month
y
Year
*
Present
-
Go back (e.g., *-10y means go back 10 years)
+
Go forward (e.g., *+10mo means go forward 10 months)
Response Example:
Response Details:
data
array
Array of tag value objects returned from the API.
tagname
string
Name of the tag.
description
string/null
Description of the tag, if available.
subDescription
string/null
Sub-description of the tag, if available.
value
string
Current value of the tag.
quality
integer
Quality indicator of the tag value.
status
integer
Status code associated with the tag value.
timeStamp
datetime
Timestamp when the tag value was recorded.
Get single tagrelation value
Fetches the values of a specific tagrelation identified by its name, along with optional filters for time range and conditions.
Last Update: 7 NOV 2024
Example URL
Note: This endpoint demonstrates querying the value of a specific tag relation (bronze_relation_raw) with additional query parameters. In this example:
starttime=*-10dspecifies the start time as 10 days ago.endtime=*indicates no specific end time (or the most recent data).query=name like 'K%'filters the results to include only those where the name starts with the letter "K."
Retrieve Tagrelation Value with Conditions
Method: GET
URL: {{base_url}}/tagrelation/{tagrelationname}/value?starttime={starttime}&endtime={endtime}&query={query}
Query Parameters:
starttime
Yes
Starting time for filtering the data (e.g., *-10y)
(Default: starttime=*-10m)
endtime
Yes
Ending time for filtering the data (e.g., *)
(Default: endtime=*)
query
No
A condition to filter the results, acting like a WHERE clause in PostgreSQL.
Time Expression:
sec
Second
m
Minute
h
Hour
d
Day
mo
Month
y
Year
*
Present
-
Go back (e.g., *-10d means go back 10 days)
+
Go forward (e.g., *+10mo means go forward 10 months)
Response Example:
Note: The fields Id, name, and tel are placeholders and will vary depending on the specific tag relation being represented in the request. Ensure you refer to the specific tag relation schema for exact field details.
Response Details:
data
array
Array of tag relation value objects returned from the API.
Id
string
Unique identifier for the tag relation.
name
string
Name associated with the tag relation.
tel
string
Telephone number associated with the tag relation.
quality
integer
Quality indicator of the tag relation value.
status
integer
Status code associated with the tag relation value.
timeStamp
datetime
Timestamp when the tag relation value was recorded.
Get multiple tags values
Fetches the values of specified tags identified by their names, with optional filters for time range and status.
Last Update: 7 NOV 2024
Example URL
Note: This endpoint demonstrates querying the value of specific tags (B15-Status, VT-01) with additional query parameters. In this example:
name=B15-Status,VT-01specifies the tag names being queried.starttime=*-10ysets the start time as 10 years ago.endtime=*indicates no specific end time (or the most recent data).statusData=18filters the results to include only those with a status data value of 18.
Retrieve Tag Values with Filters
Method: GET
URL: {{base_url}}/tag/value?name={tagname}&starttime={starttime}&endtime={endtime}&statusData={statusData}
Query Parameters:
name
Yes
Comma-separated list of tag names to retrieve values for (e.g., B15-Status,VT-01).
starttime
Yes
Starting time for filtering the data (e.g., *-10y)
(Default: starttime=*-10m)
endtime
Yes
Ending time for filtering the data (e.g., *)
(Default: endtime=*)
statusData
No
A filter for the status of the tag values, acting like a WHERE clause in PostgreSQL (only integer).
Time Expression:
sec
Second
m
Minute
h
Hour
d
Day
mo
Month
y
Year
*
Present
-
Go back (e.g., *-10d means go back 10 days)
+
Go forward (e.g., *+10mo means go forward 10 months)
Response Example:
Response Details:
data
array
Array of tag value objects returned from the API.
tagname
string
Name of the tag.
description
string/null
Description of the tag.
subDescription
string/null
Additional description of the tag (if available).
value
string
The value of the tag.
unit
string
Unit of measurement for the tag value.
quality
integer
Quality indicator of the tag value.
status
integer
Status code associated with the tag value.
timeStamp
datetime
Timestamp when the tag value was recorded.
Get multiple tagrelations values
Fetches the values of specified tag relations identified by their names, with optional filters for time range and status.
Last Update: 7 NOV 2024
Example URL
Note: This endpoint demonstrates querying the value for specific tag relations (bronze_relation_raw, Testmultiple) with additional query parameters. In this example:
name=bronze_relation_raw,Testmultiplespecifies the tag relations being queried.starttime=*-5mosets the start time as 5 months ago.endtime=*indicates no specific end time (or the most recent data).statusData=9filters the results to include only those with a status data value of 9.
Retrieve Tagrelation Values with Filters
Method: GET
URL: {{base_url}}/tagrelation/value?name={tagrelationname}&starttime={starttime}&endtime={endtime}&statusData={statusData}
Query Parameters:
name
Yes
Comma-separated list of tag relation names to retrieve values for (e.g., bronze_relation_raw,Testmultiple).
starttime
Yes
Starting time for filtering the data (e.g., *-10y)
(Default: starttime=*-10m)
endtime
Yes
Ending time for filtering the data (e.g., *)
(Default: endtime=*)
statusData
No
A filter for the status of the tag relation values, acting like a WHERE clause in PostgreSQL (only integer).
Time Expression:
sec
Second
m
Minute
h
Hour
d
Day
mo
Month
y
Year
*
Present
-
Go back (e.g., *-10d means go back 10 days)
+
Go forward (e.g., *+10mo means go forward 10 months)
Response Example:
Note: The fields Id, name, and tel are placeholders and will vary depending on the specific tag relation being represented in the request. Ensure you refer to the specific tag relation schema for exact field details.
Response Details:
data
array
Array of tag relation value objects returned from the API.
tagRelationName
string
Name of the tag relation.
Id
string
Unique identifier for the tag relation entry.
name
string
Name associated with the tag relation.
tel
string
Telephone number associated with the tag relation.
quality
integer
Quality indicator of the tag relation value.
status
integer
Status code associated with the tag relation value.
timeStamp
datetime
Timestamp when the tag relation value was recorded.
Get multiple tags values (with Body)
Fetches the values of specified tags based on the provided criteria.
Last Update: 7 NOV 2024
Example URL
Note: This endpoint demonstrates querying the value for a specific tag with the mode=read query parameter. In this example, the query specifies that the data should be retrieved in read mode.
Retrieve Tag Values
Method: POST
URL: {{base_url}}/tag/value?mode=read
Query Parameters:
mode
string
Mode of the Request
read: Use this mode to retrieve data.write: Use this mode to insert data.
(Default: mode=read)
updateStatus
bool
Update Status of data
true: Use this when need to update the status of datafalse: Use this when don't need to update the status of data
(Default: updateStatus=false)
clearAll
bool
Clear records of data
true: Use this when need to clear all records of data before insert the new onefalse: Use this when don't need to clear all records of data before insert the new one
(Default: clearAll=false)
Request Body:
tagnames
string
Comma-separated list of tag names to retrieve values for (e.g., VT-01,B15-Status)
starttime
string
Starting time for filtering the data (e.g., *-10y)
(Default: starttime=*-10m)
endtime
string
Ending time for filtering the data (e.g., *)
(Default: endtime=*)
statusData
integer
Status filter for the tag values
Time Expression:
sec
Second
m
Minute
h
Hour
d
Day
mo
Month
y
Year
*
Present
-
Go back (e.g., *-10y means go back 10 years)
+
Go forward (e.g., *+10mo means go forward 10 months)
Example Request Body:
Response Example:
Response Details:
data
array
Array of tag value objects returned from the API.
tagname
string
Name of the tag.
description
string/null
Description of the tag.
subDescription
string/null
Additional description of the tag (if available).
value
string
Value associated with the tag.
unit
string
Unit of measurement for the tag value.
quality
integer
Quality indicator of the tag value.
status
integer
Status code associated with the tag value.
timeStamp
datetime
Timestamp when the tag value was recorded.
Get multiple tagrelations values (with Body)
Fetches the values of specified tag relations based on the provided criteria.
Last Update: 7 NOV 2024
Example URL
Note: This endpoint demonstrates querying the value for a specific tag relation with the mode=read query parameter. In this example, the query specifies that the data should be retrieved in read mode.
Retrieve Tagrelation Values
Method: POST
URL: {{base_url}}/tagrelation/value?mode=read
Query Parameters:
mode
string
Mode of the Request
read: Use this mode to retrieve data.write: Use this mode to insert data.
(Default: mode=read)
updateStatus
bool
Update Status of data
true: Use this when need to update the status of datafalse: Use this when don't need to update the status of data
(Default: updateStatus=false)
clearAll
bool
Clear records of data
true: Use this when need to clear all records of data before insert the new onefalse: Use this when don't need to clear all records of data before insert the new one
(Default: clearAll=false)
Request Body:
tagrelations
string
Comma-separated list of tag relation names to retrieve values for (e.g., bronze_relation_raw,TagRelationManagementSystem)
starttime
string
Starting time for filtering the data (e.g., *-10y)
(Default: starttime=*-10m)
endtime
string
Ending time for filtering the data (e.g., *)
(Default: endtime=*)
statusData
integer
Status filter for the tag relation values
Time Expression:
sec
Second
m
Minute
h
Hour
d
Day
mo
Month
y
Year
-
Go back (e.g., *-10y means go back 10 years)
*
Present
+
Go forward (e.g., *+10mo means go forward 10 months)
Example Request Body:
Response Example:
Note: The fields Id, name, and tel are placeholders and will vary depending on the specific tag relation being represented in the request. Ensure you refer to the specific tag relation schema for exact field details.
Response Details:
data
array
Array of tag relation value objects returned from the API.
tagRelationName
string
Name of the tag relation.
Id
string
Unique identifier for the tag relation.
name
string
Name associated with the tag relation.
tel
string
Telephone number associated with the tag relation.
quality
integer
Quality indicator of the tag relation value.
status
integer
Status code associated with the tag relation value.
timeStamp
datetime
Timestamp when the tag relation value was recorded.
Insert multiple tag values
Add the specified tag values with their timestamps.
Last Update: 7 NOV 2024
Example URL
Note: This endpoint demonstrates querying the value for a specific tag with the mode=write query parameter. In this example, the query specifies that the data should be in write mode, indicating the insertion of new values.
Add Tag Values
Method: POST
URL: {{base_url}}/tag/value?mode=write
Query Parameters:
mode
string
Mode of the Request
read: Use this mode to retrieve data.write: Use this mode to insert data.
(Default: mode=read)
updateStatus
bool
Update Status of data
true: Use this when need to update the status of datafalse: Use this when don't need to update the status of data
(Default: updateStatus=false)
clearAll
bool
Clear records of data
true: Use this when need to clear all records of data before insert the new onefalse: Use this when don't need to clear all records of data before insert the new one
(Default: clearAll=false)
Request Body:
The request body must be an array of tag value objects, each containing the following parameters:
tagname
string
Name of the tag to which the value belongs.
timeStamp
datetime
Timestamp of the value being written.
value
variant
Value associated with the tag. It can be one of the following data types:
Value Data Types:
string
Represents text data.
int
Represents integer data.
double
Represents floating-point data.
bool
Represents boolean values (true/false).
Example Request Body:
Response Example:
Response Details:
message
string
Success message indicating the result of the write operation.
Insert multiple tagrelation values
Add the specified tag relation values with their field mappings and timestamps.
Last Update: 7 NOV 2024
Example URL
Note: This endpoint demonstrates querying the value for a specific tag relation with the mode=write query parameter. In this example, the query specifies that the data should be in write mode, indicating the insertion of new values.
Add Tagrelation Values
Method: POST
URL: {{base_url}}/tagrelation/value?mode=write
Query Parameters:
mode
string
Mode of the Request
read: Use this mode to retrieve data.write: Use this mode to insert data.
(Default: mode=read)
updateStatus
bool
Update Status of data
true: Use this when need to update the status of datafalse: Use this when don't need to update the status of data
(Default: updateStatus=false)
clearAll
bool
Clear records of data
true: Use this when need to clear all records of data before insert the new onefalse: Use this when don't need to clear all records of data before insert the new one
(Default: clearAll=false)
Request Body:
The request body must be an array of tag relation value objects, each containing the following parameters:
tagRelationName
string
Name of the tag relation to which the values belong.
fieldMappings
array
An array of field mapping objects for the tag relation.
timeStamp
datetime
Timestamp of the value being written.
Field Mappings:
Each object in the fieldMappings array must contain the following parameters:
field_Name
string
Name of the field being mapped.
value
variant
Value associated with the field. It can be one of the following data types:
Value Data Types:
string
Represents text data.
int
Represents integer data.
big int
Represents large integer data.
boolean
Represents boolean values (true/false).
double
Represents floating-point data.
Example Request Body:
Response Example:
Response Details:
message
string
Success message indicating the result of the write operation.
Update multiple tag values
Updates the specified values for the tag with GUID
Last Update: 7 NOV 2024
Example URL
Note: This endpoint demonstrates updating the value for a specific tag (B15-Status) using the PUT method. In this example, the PUT request is used to modify the value of the tag.
Update Tag Value
Method: PUT
URL: {{base_url}}/tag/{tagname}/value
Request Body:
The request body must be an array of tag value objects, each containing the following parameters:
tagValueId
GUID
Unique identifier for the tag value.
value
variant
The value associated with the tag. It can be one of the following data types:
timeStamp
datetime
Timestamp of when the value is recorded.
Value Data Types:
string
Represents text data.
int
Represents integer data.
boolean
Represents boolean values (true/false).
double
Represents floating-point data.
Example Request Body:
Response Example:
Response Details:
message
string
Success message indicating the result of the write operation.
Update multiple tagrelation values
Updates the specified values for the tag relation
Last Update: 7 NOV 2024
Example URL
Note: This endpoint demonstrates updating the value for a specific tag relation (TagRelationData3) using the PUT method. In this example, the PUT request is used to modify the value of the tag relation.
Update Tagrelation Value
Method: PUT
URL: {{base_url}}/tagrelation/{tagrelationname}/value
Request Body:
The request body must be an array of tag relation value objects, each containing the following parameters:
tagRelationValueId
int
Unique identifier for the tag relation value.
timeStamp
datetime
Timestamp of when the values are recorded.
fieldValues
array
An array of field value objects, each containing:
Field Value Object:
field_Id
int
Unique identifier for the field.
value
variant
The value associated with the field, which can be one of the following data types:
Value Data Types:
string
Represents text data.
int
Represents integer data.
big int
Represents large integer data.
boolean
Represents boolean values (true/false).
double
Represents floating-point data.
Example Request Body:
Response Example:
Response Details:
message
string
Success message indicating the result of the write operation.
Publisher
การกำหนด Publisher
Publisher : ฟังก์ชันที่ใช้ในการส่งข้อมูลไปยังแหล่งข้อมูลภายนอก ช่วยให้สามารถเผยแพร่หรือส่งต่อข้อมูลไปยังระบบหรือแพลตฟอร์มอื่น ๆ
Function
การสร้าง Publisher เพื่อโอนย้านข้อมูล
การอัพเดต Publisher ที่ได้สร้างขึ้น
การลบ Publisher ที่ได้สร้างขึ้น
Create Publisher
การสร้าง Publisher
Click : กดปุ่มเพิ่ม Publisher ( + Publisher )
Publisher name : กรอกชื่อ Publisher name
Select : เลือก Interface ที่ต้องการโอนย้ายข้อมูล
Click : กดปุ่ม Check connect
Mapping Mode
Tag : เลือก Mapping กับ alias name
TagRelation : เลือก TagRelation กับ Table และ Field กับ Column
Add Column : กดไอคอน (+) เพื่อเพิ่ม Column
Static value : เพิ่ม Column สำหรับพิมพ์ข้อมูลแบบกำหนดเอง
Merge Type : รูปแบบการเพิ่มข้อมูล Replace Duplicate: ฟังก์ชันที่ใช้ในการเพิ่มข้อมูลใหม่ หากพบข้อมูลซ้ำจะทำการอัปเดตข้อมูลเดิมตาม Identity ที่ระบุไว้ Clear all & Insert: ฟังก์ชันที่ทำการล้างข้อมูลทั้งหมดจากแหล่งข้อมูลก่อน แล้วทำการเพิ่มข้อมูลใหม่เข้าไปในระบบตามที่ระบุ
Scheduler : กำหนดรอบเวลาในการโอนย้ายข้อมูล
Status filter : คัดเลือก Status ของข้อมูลก่อนโอนย้าย
Validate Execution : ทดสอบการการโอนย้ายข้อมูล
Save : กด Save เพื่อบันทึกการตั้งค่า
Update Publisher
การแก้ไข Publisher
การแก้ไข Publisher มี 4 ขั้นตอน ดังนี้
Select : เลือก Publisher ที่ต้องการแก้ไข
Information : ทำการแก้ไข Publisher
Validate Execution : กดปุ่ม Validate Execution เพื่อตรวจสอบการเชื่อมต่อ
Save : กดปุ่ม Save เพื่อบันทึกการแก้ไข
Delete Publisher
การลบ Publisher
การลบ Publisher มี 3 ขั้นตอน
Select : เลือก Publisher ที่ต้องการลบ
Information : เมื่อกดเลือก จะมีการแสดงรายละเอียดของ Publisher และกดปุ่ม Delete
Confirm : กดปุ่ม Delete อีกครั้งเพื่อยืนยันการลบ Publisher ที่เลือก
