oda.RestAPI

Материал из ODANT Wiki
(перенаправлено с «oda.API»)
Перейти к: навигация, поиск

Спецификации

Спецификация REST API ODANT

Rest Command

[10]     Command      ::=   URL '/api' (ItemContext)? ('?' Method ('?' Parameters)?)?

Contexts

[20]     Context           ::=   HostContext | BaseContext | ModuleContext | SolutionContext | ClassContext | ObjectContext
[21]     HostCotext        ::=   '/' HostStep
[22]     BaseContext       ::=   (HostContext)? '/' BaseStep
[23]     ModuleContext     ::=   BaseContext '/' ModuleStep
[24]     SolutionContext   ::=   BaseContext '/' SolutionStep
[25]     ClassContext      ::=   (BaseContext | ModuleContext) '/' ClassStep
[26]     ObjectContext     ::=   ClassContext '/' ObjectStep

Steps

[30]     HostStep          ::=   ('H' | 'h') ItemPath
[31]     BaseStep          ::=   'root' | 'system' | (('B' | 'b') ItemPath)
[33]     ModuleStep        ::=   ('M' | 'm') ItemPath
[34]     SolutionStep      ::=   ('S' | 's') ItemPath
[35]     ClassStep         ::=   ('C' | 'c') ItemPath
[36]     ObjectStep        ::=   ('O' | 'o') ItemPath

ItemPaths

[40]     ItemPath          ::=   (AnyItemPath | ConcreteItemPath)
[41]     AnyItemPath       ::=   '+'
[42]     ConcreteItemPath  ::=   '-' (ItemId | ItemMask)
[43]     ItemId            ::=   (Digit)15

Commands

[30]     Command     ::=   file | info | find | select | create | read | update | delete
[31]     info        ::=   'info' ('?' SelectParameter)
[32]     find        ::=   'find' '?' 'path=' oda.Path

Parameters

[40]     Parameters     ::=   Parameter ('&' Parameter)*
[41]     Parameter      ::=   ParamName '=' ParamValue
[42]     ParamName      ::=   'id' | 'path' | 'type' | 'source' | 'pack' | 'name' | 'size'

ПРИМЕРЫ

(Для проверки жми на ссылки)

find

www.odant.ru:8080/oda/this.work.test.с-peoples/
Установить контекст на класс peoples, находящийся в хранилище test из раздела work текущего this хоста.

Результат:

<find context="this.work.test.с-peoples" t="1">
  <class fid="H-000000000000000.P-work.S-723649384737463.C-736452637463647" n="peoples" l="Люди" i="736452637463647" a="0"/>
</context>


a
s
в
а

info

find

select

create

read

update

delete

Устаревшие
Получить пакет A индекса Grid из класса clients в базе данных work на сервере www.odant.ru:8080
www.odant.ru:8080/oda/get_config 
Создание индекса на сервере www.odant.ru:8080
http://www.odant.ru:8080/oda/xquery_index?id=D:WORK/D:1CE3F3C24EFFABC/C:396435080141174/I:Grid

Новые
Получить пакет A индекса Grid из класса clients в базе данных work на сервере www.odant.ru:8080
www.odant.ru:8080/oda/read?id=work/clients/I:Grid&pack=A