0% found this document useful (0 votes)
9 views28 pages

DATA Access Read (RESTful API) YTH

The document outlines the structure and functionality of a RESTful API server, detailing various endpoints for accessing data related to tags, including their descriptions and current values. It provides examples of GET requests and the expected JSON responses containing metadata and current measurements. The document emphasizes the integration of different services and layers within the system architecture.

Uploaded by

Min35Q1 tongsang
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
9 views28 pages

DATA Access Read (RESTful API) YTH

The document outlines the structure and functionality of a RESTful API server, detailing various endpoints for accessing data related to tags, including their descriptions and current values. It provides examples of GET requests and the expected JSON responses containing metadata and current measurements. The document emphasizes the integration of different services and layers within the system architecture.

Uploaded by

Min35Q1 tongsang
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

!

" # $ % &
&

% % '' % ( $ ) * % + % % $
* ( % ' %) %( % , % % %-
' ( . * * /$ * / % 0 12 )3 %
1 %( ( ' + % %
$% $ ' % %$ % + % % %(
, * % ( % ' ( * $

+ %

$ % "

HTTPS Server

Request router
Alarm history Item History Item run-time

OData handler

BUS Service
Integration layer Dataset Service (DSS)
Dataset Access Process

Yokogawa RESTful API Server

CI Core

!" # # #

!" # $ % &
$% $ ' % %$ % + % % %(
, * % ( % ' ( * $ 4 %
5 4 64 * '' % ) $ % %( / + %
% % ' % ' (

$ % "

HTTPS Server

Request router
Alarm history Item History Item run-time

OData handler

BUS Service
Integration layer Dataset Service (DSS)
Dataset Access Process

RESTful API Server

CI Portal CI Core

& !" # # # #'

!" # $ % &
7

& # "
% % $ " # $ * $
• , ' + % % " # $ *
o , 8 % 9 ' %
o , 8 % 9 ' $ : % 5
o , 8 %-
• % '" # $ * + % %

!" # $ % &
;

& ( ! ) # " #

, % + % % %( " # $ *
$% % +

(HTTP method) [Link] number)/jrest/v1/(entity type)?(query option)

• $ ! * ' %( % % ( , ( '
" # $ * / - <. = ' ( ) (
.
• * # ! %( % ' * (
• % # !+ %( % ') % ') " # $
* , -./
• # % ( % $% ) $ % % ( '
%

• ( % # % % , : % ' /
<> ? % %= ) ( ( % $% ) $ %
% ( ' %
>
%( % % %) ( <> ? % %=
• * 0 # % 6
4 % ' : @
$ ( : @

: ' % ' % ) 1 %* % %/ 88$$$ ( 8( ' % %8

!" # $ % &
& ( 1 # 2 ! 3 4 # 5
%( ) ( (% 9 ' ( '" # $ *

• ( # )

GET [Link]

• ( ) !%

GET [Link]

) * + ' , ( 9 ' ( % '


< 1A 2; : B5@@ A =
6 ' % ' %) %( ' ( % % % < % ' =
( ( % ' ) ( 9 ' ( %) ( , % +) $
1 % <7 %( +=
• #7 ) !%
{
"@[Link]": "$metadata#Tags/$entity",
"TagName": "SO_SRN5.SFC.PQM001_P",
"Description": "Export Measurement Watt",
"CurrentValue": {
"Value": "0",
"Quality": 0,
"Timestamp": "2025-10-17T09:06:00Z"
},
"EngineeringHigh": 0.0,
"EngineeringLow": 0.0,
"SourceID": "Not used.",
"Deadband": 0.0,
"ScanRate": "Not used.",
"ID": "Not used.",
"Units": "MW",
"InAlarm": false,
"Offline": false
}

!" # $ % &
C

$% ) $ % $ * % (
+ #
# 4 # 5 3 " % # 3 %
2 ' % ' ' % ' 5 + ' ' &;; %
% 4 :9D (

% % %
%E • * E %
• B ( (' % &
• 4 ( ' (' ' 1 1
D @
% % % - 4 ' )
% % % F $ F $ ' )
() %( () %( )
4% % % % % %
% ' % % ' 6 %
1 % % 6 %
F $F ' F $ ' )
F $F $F ' F $9 $ ' )
- F' - ' )
- - F' - 9 ' )
#% $ ( ( ' #% $ ( ( 6 %
' %
% % % 4% % % % % %

!" # $ % &
D

& & ( 1 # 2 ! 3 * # 48 % 5
%( ) ( (% 9 ' ( $ % * ' ) '
" # $ * % % ( %( % )
%( % 6 $ , + ' % , ' % G5 G 5
%

• ( # )

GET [Link]

• ( ) !%

GET
[Link]
SFC.WMS01')

) * + ' , ( 9 ' ( $ % % '


% % < 1A 2; : G5 @ =

6 ' % ' $ ( %) ( $
1A 2; : G5 @ G 5 % 1A 2; %
& 1A 2; : G5 @& &%( G 5 % 1A 2; %
(
1A 2; : G5 @ G 5 % 1A 2; %

+ ) * $ % $ * % (

• #7 ) !%
{
"@[Link]": "$metadata#Tags",
"value": [
{
"TagName": "SO_SRN5.SFC.WMS01_GHI",
"Description": "Solar Irradiance (GHI)",
"CurrentValue": {
"Value": "185.66",
"Quality": 0,
"Timestamp": "2025-10-17T09:07:00Z"
},
"EngineeringHigh": 0.0,
"EngineeringLow": 0.0,
"SourceID": "Not used.",
"Deadband": 0.0,
"ScanRate": "Not used.",
"ID": "Not used.",
"Units": "",
"InAlarm": false,
"Offline": false
},
{
"TagName": "SO_SRN5.SFC.WMS01_HR",
"Description": "Site Humidity",
"CurrentValue": {
"Value": "60",
"Quality": 0,

!" # $ % &
H

"Timestamp": "2025-10-17T09:07:30Z"
},
"EngineeringHigh": 0.0,
"EngineeringLow": 0.0,
"SourceID": "Not used.",
"Deadband": 0.0,
"ScanRate": "Not used.",
"ID": "Not used.",
"Units": "",
"InAlarm": false,
"Offline": false
},
{
"TagName": "SO_SRN5.SFC.WMS01_PIR",
"Description": "Pairs of Irradiance (Albedometer)",
"CurrentValue": {
"Value": "0",
"Quality": 0,
"Timestamp": "2025-10-17T09:06:00Z"
},
"EngineeringHigh": 0.0,
"EngineeringLow": 0.0,
"SourceID": "Not used.",
"Deadband": 0.0,
"ScanRate": "Not used.",
"ID": "Not used.",
"Units": "",
"InAlarm": false,
"Offline": false
},
{
"TagName": "SO_SRN5.SFC.WMS01_POA",
"Description": "Plane of Array Irradiance (POA)",
"CurrentValue": {
"Value": "0",
"Quality": 0,
"Timestamp": "2025-10-17T09:06:00Z"
},
"EngineeringHigh": 0.0,
"EngineeringLow": 0.0,
"SourceID": "Not used.",
"Deadband": 0.0,
"ScanRate": "Not used.",
"ID": "Not used.",
"Units": "W/m²",
"InAlarm": false,
"Offline": false
},
{
"TagName": "SO_SRN5.SFC.WMS01_PVT01",
"Description": "PV Module Temperature",
"CurrentValue": {
"Value": "22.55",
"Quality": 0,
"Timestamp": "2025-10-17T09:08:00Z"
},
"EngineeringHigh": 0.0,
"EngineeringLow": 0.0,
"SourceID": "Not used.",
"Deadband": 0.0,
"ScanRate": "Not used.",
"ID": "Not used.",
"Units": "°C",
"InAlarm": false,
"Offline": false
},
{
"TagName": "SO_SRN5.SFC.WMS01_PVT02",

!" # $ % &
@

"Description": "PV Module Temperature",


"CurrentValue": {
"Value": "22.55",
"Quality": 0,
"Timestamp": "2025-10-17T09:08:00Z"
},
"EngineeringHigh": 0.0,
"EngineeringLow": 0.0,
"SourceID": "Not used.",
"Deadband": 0.0,
"ScanRate": "Not used.",
"ID": "Not used.",
"Units": "°C",
"InAlarm": false,
"Offline": false
},
{
"TagName": "SO_SRN5.SFC.WMS01_PVT03",
"Description": "PV Module Temperature",
"CurrentValue": {
"Value": "22.55",
"Quality": 0,
"Timestamp": "2025-10-17T09:08:00Z"
},
"EngineeringHigh": 0.0,
"EngineeringLow": 0.0,
"SourceID": "Not used.",
"Deadband": 0.0,
"ScanRate": "Not used.",
"ID": "Not used.",
"Units": "°C",
"InAlarm": false,
"Offline": false
},
{
"TagName": "SO_SRN5.SFC.WMS01_RI",
"Description": "Rainfall",
"CurrentValue": {
"Value": "100",
"Quality": 0,
"Timestamp": "2025-10-17T09:09:30Z"
},
"EngineeringHigh": 0.0,
"EngineeringLow": 0.0,
"SourceID": "Not used.",
"Deadband": 0.0,
"ScanRate": "Not used.",
"ID": "Not used.",
"Units": "",
"InAlarm": false,
"Offline": false
},
{
"TagName": "SO_SRN5.SFC.WMS01_RPOA01",
"Description": "Rear-side Plane of Array Irradiance (Rear POA)",
"CurrentValue": {
"Value": "0",
"Quality": 0,
"Timestamp": "2025-10-17T09:06:00Z"
},
"EngineeringHigh": 0.0,
"EngineeringLow": 0.0,
"SourceID": "Not used.",
"Deadband": 0.0,
"ScanRate": "Not used.",
"ID": "Not used.",
"Units": "W/m²",
"InAlarm": false,

!" # $ % &
"Offline": false
},
{
"TagName": "SO_SRN5.SFC.WMS01_RPOA02",
"Description": "Rear-side Plane of Array Irradiance (Rear POA)",
"CurrentValue": {
"Value": "0",
"Quality": 0,
"Timestamp": "2025-10-17T09:06:00Z"
},
"EngineeringHigh": 0.0,
"EngineeringLow": 0.0,
"SourceID": "Not used.",
"Deadband": 0.0,
"ScanRate": "Not used.",
"ID": "Not used.",
"Units": "W/m²",
"InAlarm": false,
"Offline": false
},
{
"TagName": "SO_SRN5.SFC.WMS01_RPOA03",
"Description": "Rear-side Plane of Array Irradiance (Rear POA)",
"CurrentValue": {
"Value": "0",
"Quality": 0,
"Timestamp": "2025-10-17T09:06:00Z"
},
"EngineeringHigh": 0.0,
"EngineeringLow": 0.0,
"SourceID": "Not used.",
"Deadband": 0.0,
"ScanRate": "Not used.",
"ID": "Not used.",
"Units": "W/m²",
"InAlarm": false,
"Offline": false
},
{
"TagName": "SO_SRN5.SFC.WMS01_SR",
"Description": "Soiling Ratio (SR)",
"CurrentValue": {
"Value": "0",
"Quality": 0,
"Timestamp": "2025-10-17T09:06:00Z"
},
"EngineeringHigh": 0.0,
"EngineeringLow": 0.0,
"SourceID": "Not used.",
"Deadband": 0.0,
"ScanRate": "Not used.",
"ID": "Not used.",
"Units": "",
"InAlarm": false,
"Offline": false
},
{
"TagName": "SO_SRN5.SFC.WMS01_TI",
"Description": "Ambient Temperature",
"CurrentValue": {
"Value": "30.6",
"Quality": 0,
"Timestamp": "2025-10-17T09:10:30Z"
},
"EngineeringHigh": 0.0,
"EngineeringLow": 0.0,
"SourceID": "Not used.",
"Deadband": 0.0,

!" # $ % &
&

"ScanRate": "Not used.",


"ID": "Not used.",
"Units": "°C",
"InAlarm": false,
"Offline": false
},
{
"TagName": "SO_SRN5.SFC.WMS01_WDIR",
"Description": "Wind Direction",
"CurrentValue": {
"Value": "0",
"Quality": 0,
"Timestamp": "2025-10-17T09:06:00Z"
},
"EngineeringHigh": 0.0,
"EngineeringLow": 0.0,
"SourceID": "Not used.",
"Deadband": 0.0,
"ScanRate": "Not used.",
"ID": "Not used.",
"Units": "",
"InAlarm": false,
"Offline": false
},
{
"TagName": "SO_SRN5.SFC.WMS01_WSPD",
"Description": "Wind Speed",
"CurrentValue": {
"Value": "0",
"Quality": 0,
"Timestamp": "2025-10-17T09:06:00Z"
},
"EngineeringHigh": 0.0,
"EngineeringLow": 0.0,
"SourceID": "Not used.",
"Deadband": 0.0,
"ScanRate": "Not used.",
"ID": "Not used.",
"Units": "",
"InAlarm": false,
"Offline": false
}
]
}

!" # $ % &
& , ( 1 #$ " 3
%( ) ( (% 9 ' ( '" # $ *

• ( # )

GET
[Link]
ry(StartTime='2025-10-17T09:00:00z',EndTime='2025-10-
17T09:30:00z',SampleInterval=900)

• ( ) !%

GET
[Link]
[Link](StartTime='2025-10-
17T09:00:00z',EndTime='2025-10-17T09:30:00z',SampleInterval=900)

) * + ' , ( - ( % '
< 1A 2; : G5 @ A- =
6 '
9 , ' % ' ! %( #' ! '
%) ( +
9 - * ) ' +' '&( % ( (%
9 ' % * ;'%

• #7 ) !%
{
"@[Link]": "$metadata#TagHistory",
"value": [
{
"Value": 0.0,
"Quality": 0,
"Timestamp": "2025-10-17T09:00:00Z"
},
{
"Value": 185.66,
"Quality": 0,
"Timestamp": "2025-10-17T09:15:00Z"
},
{
"Value": 185.66,
"Quality": 0,
"Timestamp": "2025-10-17T09:30:00Z"
}
]
}

!" # $ % &
7

&& % # !
" # $ * %( $ ( ,

+ & $ " '


" ' #
&@@ 1I , ' (
&@7 2 % % , ' ( $ % ( % (
7@@ 6 ( , 4 F % , % ) % % / %
( % (( ( %
7@ 4% J ( ( % * % ' %/
% ' 8 $ ( %
7@7 2 : %( ( , % ) % % * )
7@; 5 (2 $ ( - ' ( % ) % % (
;@@ % % * % ($ * $ % ,
;@ * 4% * ) 4% ) *

!" # $ % &
;

, # ! ' # #
% '( ) / ( % () %, ') % % % ( %( ) ( %(
9% ' ( ( ( ( % ' <% %= %8 % ' % + <4% =
% ' . %( $) < = ( * % ' /$ % * % % ' / % '
) $ % ) (

# # 9#
• # # % %K % ' ( % () ( % % 3 :
% K 3 / )) * % % 2 ' ) ( <% %=
• 9# % K % ' ( % () ( % % % %) ' % ( #
)9 ( % ( <% %= ( ' % $ % 4% % ' $
( ( ( : ? :
• K % ' ( % () ( % ( * $ $ ) ( % ( <4% =

!" # $ % &
+ , F <% %= %8 % '%

6 :# #; < " #
4 #1 5
6A 6& %6
& 6A 6&& %6
6A -27 %
7 1A 6 %6
; 6A 6D %6
. 1A 6 %6
C 6A "1
D 1AF . F ' %
H 6A 6 7 ) %
@ 1A4 7 4 (
1A I @ #
& 6A D
1A &
7 6A2IG 2 # %
$ %
; 6A2IGH 2 # %
$ %
6A 6H ) %
C 1A 6C ) %
D . 1A4 4( % %
H . 1A I2 # %2 # %
&@ 1A4 &@ 4( % %
& 1A4 7@ 4( % %
&& . 6A4 & 4( % %
& 1A6 & 6 '
&7 1A6 7 6 '
&; 1A 2; %
& . 1A 2 %
&C . 1A 2 %
&D . 1A I & % #
&H . 6A I % #
@ . 1A I % #
. 1A 2 %
& . 1A2G 2 $
. 6A2G 2 $
7 . 1A2G 7 2 $
; . 1A2G & 2 $
6AI 6 @ I % % )
C 1AI 6 @ I % % )
D 1A 6 @ )
H 1A 6 )
7@ 6A 6 D )

!" # $ % &
C

+ F % '
3 # ! 4 %" 5 3 " % #
3
+++++ : B5@@ A + 5 ' % G
= * 8 #
+++++ : G5 @ A ') % '
+++++ : G5 @ A- - '(
+++++ : G5 @ A %
+++++ : G5 @ AG G %( (
+++++ : G5 @ AG G %( %
+++++ : G5 @ A.- ( % .-
+++++ : G5 @ A E @ E5 ( '
+++++ : G5 @ A E @& E5 ( '
+++++ : G5 @ A E @ E5 ( '
+++++ : G5 @ A ( % ) ( '
+++++ : G5 @ A 1 % ( % 1
+++++ : G5 @ A 1 @ 9 ( % ( % 6 # 1
+++++ : G5 @ A 1 @& 9 ( % ( % 6 # 1
+++++ : G5 @ A 1 @ 9 ( % ( % 6 # 1
+++++ : G5 @ A %
&#' = * 8 #
+++++ : G5 @&A ') % '
+++++ : G5 @&A- - '(
+++++ : G5 @&A %
+++++ : G5 @&AG G %( (
+++++ : G5 @&AG G %( %
+++++ : G5 @&A.- ( % .-
+++++ : G5 @&A E @ E5 ( '
+++++ : G5 @&A E @& E5 ( '
+++++ : G5 @&A E @ E5 ( '
+++++ : G5 @&A ( % ) ( '
+++++ : G5 @&A 1 % ( % 1
+++++ : G5 @&A 1 @ 9 ( % ( % 6 # 1
+++++ : G5 @&A 1 @& 9 ( % ( % 6 # 1
+++++ : G5 @&A 1 @ 9 ( % ( % 6 # 1
+++++ : G5 @&A %
,'= * 8 #
+++++ : G5 @ A ') % '
+++++ : G5 @ A- - '(
+++++ : G5 @ A %
+++++ : G5 @ AG G %( (
+++++ : G5 @ AG G %( %
+++++ : G5 @ A.- ( % .-
+++++ : G5 @ A E @ E5 ( '
+++++ : G5 @ A E @& E5 ( '
+++++ : G5 @ A E @ E5 ( '
+++++ : G5 @ A ( % ) ( '
+++++ : G5 @ A 1 % ( % 1

!" # $ % &
D

3 # ! 4 %" 5 3 " % #
+++++ :G5 @ A 1 @ 9 ( % ( % 6 # 1
+++++ :G5 @ A 1 @& 9 ( % ( % 6 # 1
+++++ :G5 @ A 1 @ 9 ( % ( % 6 # 1
+++++ :G5 @ A %
*
= * 8 #
+++++ : G5 @7A ') % '
+++++ : G5 @7A- - '(
+++++ : G5 @7A %
+++++ : G5 @7AG G %( (
+++++ : G5 @7AG G %( %
+++++ : G5 @7A.- ( % .-
+++++ : G5 @7A E @ E5 ( '
+++++ : G5 @7A E @& E5 ( '
+++++ : G5 @7A E @ E5 ( '
+++++ : G5 @7A ( % ) ( '
+++++ : G5 @7A 1 % ( % 1
+++++ : G5 @7A 1 @ 9 ( % ( % 6 # 1
+++++ : G5 @7A 1 @& 9 ( % ( % 6 # 1
+++++ : G5 @7A 1 @ 9 ( % ( % 6 # 1
+++++ : G5 @7A %

6 ' % ') G 5 %( %( % ( % %8

• +++++ : B5@@ A
+++++ ? <% %= / %) ($ < %8 =% ' $ () + ,
: ? : %
B5@@ A ? + 5 ' % G ' B5@@

) !% # ! 1A4 7 B5 B5@@ A
+ 5 ' % G ' B5@@ 1A4 7 %

• +++++ : G5 @ A.-
+++++ ? % % / %) ($ < %8 =% ' $ () + ,
: ? : %
G5 @ A.- ? ( % .- ' G5 @

) !% # ! 1A4 7 : G5 @ A.-
( % .- ' G5 @ 1A4 7 %

) !% # ! 1A6 & : G5 @&A.-


( % .- ' G5 @& 1A6 & %

) !% # ! 1A6 7 : G5 @ A
') % ' ' G5 @ 1A6 7 %

!" # $ % &
H

%% #' )
%% #' ) %E '
%% #' ) & 1 6A 6 7
%% #' ) , 1 6A "1
%% #' ) 1 1A6 &
%% #' ) - 1 1A6 7
%% #' ) > 1 1A I @
%% #' ) / 1 1A 2;
%% #' ) ? 1 1A4 7

!" # $ % &
&@

%% #' ) #7 !
+ ' , / % %( % ' * ) ( " % ' %
, / % %( % % % * % *
G
% % <6 = % (
4 : @
$ ( : @

• %E 1A 2; : B5@@ A

!" # $ % &
&

• %E 1A 2; : G5 @ A

• %E 1A 2; : G5 @ A-

!" # $ % &
&&

• %E 1A 2; : G5 @ A

• %E 1A 2; : G5 @ AG

!" # $ % &
&

• %E 1A 2; : G5 @ AG

• %E 1A 2; : G5 @ A.-

!" # $ % &
&7

• %E 1A 2; : G5 @ A E @

• %E 1A 2; : G5 @ A E @&

!" # $ % &
&;

• %E 1A 2; : G5 @ A E @

• %E 1A 2; : G5 @ A

!" # $ % &
&

• %E 1A 2; : G5 @ A 1

• %E 1A 2; : G5 @ A 1 @

!" # $ % &
&C

• %E 1A 2; : G5 @ A 1 @&

• %E 1A 2; : G5 @ A 1 @

!" # $ % &
&D

• %E 1A 2; : G5 @ A

!" # $ % &

You might also like