WEB REST API — различия между версиями

Материал из TekonWiki
Перейти к: навигация, поиск
Строка 35: Строка 35:
 
<pre>{"SessionExpired": "Срок действия указанного сеанса истек из-за бездействия или был недопустимым"}
 
<pre>{"SessionExpired": "Срок действия указанного сеанса истек из-за бездействия или был недопустимым"}
 
{"error": "Неожиданная ошибка"}</pre>
 
{"error": "Неожиданная ошибка"}</pre>
 +
  
  
Строка 40: Строка 41:
  
 
Общий вид запрос для доступа к данным системы учета ресурсов выглядит следующим образом
 
Общий вид запрос для доступа к данным системы учета ресурсов выглядит следующим образом
<pre>'''http://host:port/rest/api/ASKUE'''/[MethodName]/[ParamValue]</pre>
+
<pre>http://host:port/rest/api/ASKUE/[MethodName]/[ParamValue]</pre>
 +
 
 +
=== Данные сервера ===
 +
<pre>http://host:port/rest/api/ASKUE/ServerInformation</pre>
 +
 
 +
Ответ:
 +
<pre>&nbsp; {
 +
&nbsp; &nbsp; &nbsp; "startime":"2020-10-31T18:20:36.623+03:00",
 +
&nbsp; &nbsp; &nbsp; "currenttime":"2020-10-31T18:21:54.713+03:00",
 +
&nbsp; &nbsp; &nbsp; "version":"1.0"
 +
&nbsp; }</pre>
 +
 
 +
starttime - время старта WEB-сервера<br/> currenttime - текущее время&nbsp;WEB-сервера<br/> version - номер версии ПО&nbsp;WEB-сервера
 +
 
 +
Данные справочников базы данных
 +
 
 +
&nbsp;
  
 
[[Category:ДокументацияСКАДА]]
 
[[Category:ДокументацияСКАДА]]

Версия 15:37, 31 октября 2020

Введение 

Данное API позволяет получить доступ к данными циркулирующим в ПО АСУД.SCADA посредством выполнения запросов по HTTP(S) протоколу к специализированному WEB-сервису.

WEB-сервис поставляется отдельно или может входить в дистрибутив ПО АСУД.SCADA

Для работы WEB-сервиса требуется отдельная лицензия записанная на USB-ключ защиты


Общие сведения

Самый простой способ вызвать серверный метод - выполнить GET-запрос со следующим URL-адресом, без содержимого в теле сообщения:

http://host:port/rest/api/[ClassName]/[MethodName]/[ParamValue]

следующие параметры не являются обязательными:

  • port
  • ParamValue

ParamValue - представляет собой список значений параметров, разделенных косой чертой (/), которые соответствуют входным параметрам, необходимым для вызываемого метода сервера.

Если серверный метод не имеет входных параметров, ничего не должно следовать за именем метода в URL-адресе.

Две косые черты (//) в части URL-адреса, представляющей значения параметров, устанавливают значение параметра в этом индексе, как пустую строку.

Значения, передаваемые таким образом, должны быть закодированы, по правилам представления URL-адреса.

Значения являющиеся объектами JSON или массивами JSON должны быть переданы в теле HTTP(S)-запроса.  А тип запроса должен быть POST или PUT. 

Ответ, возвращаемый на запроса, будет содержать в тексте ответа строковое представление JSON-объекта :

{"result":["123456"]}

Если во время вызова на сервере возникает ошибка, такая как истекший сеанс, неавторизованный пользователь или недопустимые входные значения, то вместо свойства result возвращаемый объект JSON будет содержать свойство error или SessionExpired, например:

{"SessionExpired": "Срок действия указанного сеанса истек из-за бездействия или был недопустимым"}
{"error": "Неожиданная ошибка"}


Доступ к данным учета ресурсов

Общий вид запрос для доступа к данным системы учета ресурсов выглядит следующим образом

http://host:port/rest/api/ASKUE/[MethodName]/[ParamValue]

Данные сервера

http://host:port/rest/api/ASKUE/ServerInformation

Ответ:

  {
      "startime":"2020-10-31T18:20:36.623+03:00",
      "currenttime":"2020-10-31T18:21:54.713+03:00",
      "version":"1.0"
  }

starttime - время старта WEB-сервера
currenttime - текущее время WEB-сервера
version - номер версии ПО WEB-сервера

Данные справочников базы данных