Команда onehook

Метод XML-RPC

Требуемые разрешения

update

one.hook.update

HOOK:MANAGE

create

one.hook.allocate

HOOK:CREATE

delete

one.hook.delete

HOOK:MANAGE

show

one.hook.info

HOOK:USE

rename

one.hook.rename

HOOK:MANAGE

list

top

one.hook.info

HOOK:USE

lock

one.hook.lock

HOOK:MANAGE

unlock

one.hook.unlock

HOOK:MANAGE

retry

one.hook.retry

HOOK:MANAGE

log

one.hooklog.info

HOOK:-

one.hook.allocate

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

String

Содержание шаблона нового хука.

Синтаксис может быть стандартным  attribute=value или в формате XML

OUT

Boolean

В зависимости от результата выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор выделяемого ресурса / Строка с ошибкой 

OUT

Int

Код ошибки

one.hook.delete

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

OUT

Boolean

В зависимости от результата выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор ресурса / Строка с ошибкой 

OUT

Int

Код ошибки

OUT

Int

Идентификатор объекта, вызвавшего ошибку

one.hook.update

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

IN

String

Содержание шаблона нового хука.

Синтаксис может быть стандартным  attribute=value или в формате XML

IN

Int

Типы обновления шаблона: 

  • 0 — перезаписать весь шаблон хука; 
  • 1 — объединить новый шаблон хука с существующим

OUT

Boolean

В зависимости от результата выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор ресурса / Строка с ошибкой 

OUT

Int

Код ошибки

one.hook.rename

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

IN

String

Новое имя хука

OUT

Boolean

В зависимости от результата выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор ресурса / Строка с ошибкой 

OUT

Int

Код ошибки

OUT

Int

Идентификатор объекта, вызвавшего ошибку

one.hook.info

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

IN

Boolean

Необязательный флаг для расшифровки скрытой информации, доступен только для администратора

OUT

Boolean

В зависимости от результата выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

String

Строка с информацией / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор объекта, вызвавшего ошибку

one.hook.lock

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

IN

Int

Уровни блокирования хука: 

  • 1 — use; 
  • 2 — manage;
  • 3 — admin;
  • 4 — all

IN

Boolean

test: проверка блокировки объекта, для возвращения сообщения об ошибке

OUT

Boolean

В зависимости от результата выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int

Идентификатор ресурса

OUT

Int

Код ошибки

OUT

Int

Идентификатор объекта, вызвавшего ошибку

OUT

String

Время блокировки объекта при возникновении ошибки, в случае, если test = true

one.hook.unlock

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

OUT

Boolean

В зависимости от результата выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int

Идентификатор ресурса

OUT

Int

Код ошибки

OUT

Int

Идентификатор объекта, вызвавшего ошибку

one.hook.retry

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Идентификатор объекта

IN

Int

Идентификатор запускаемого процесса

OUT

Boolean

В зависимости от результата выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int

Идентификатор ресурса

OUT

Int

Код ошибки

OUT

Int

Идентификатор объекта, вызвавшего ошибку

one.hookpool.info

Можно вывести диапазон из всего списка идентификаторов от первого до последнего. Для того чтобы вывести весь диапазон необходимо задать (-1, -1), для извлечения диапазона от заданного идентификатора до конца списка задать (<id>, 1), для извлечения диапазона от начала списка до заданного идентификатора, необходимо задать (0, <id>), где <id> — заданный идентификатор.

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Фильтр:

  • -4 — ресурсы, принадлежащие к основной группе пользователя; 

  • -3 — ресурсы, принадлежащие пользователю; 

  • -2 — все ресурсы;

  • -1 — ресурсы, принадлежащие пользователю и любой его группе; 

  • больше или равно 0 — ресурсы, принадлежащие пользователю, идентифицированному по заданному UID

IN

Int

Если следующий параметр больше или равен -1, это начало диапазона. Значения меньше -1, используются для определения с какой записи будет выводиться информация

IN

Int

Для значений больше или равных -1, это последний идентификатор диапазона. Значения меньше -1, используются для определения сколько записей будет выводиться на странице

OUT

Boolean

В зависимости от результата выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

String

Строка с информацией / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор объекта, вызвавшего ошибку

one.hooklog.info

Тип

Тип данных

Описание

IN

String

Строка сессии

IN

Int

Дата начала фильтрации записей журнала выполнения хука в формате epoch

IN

Int

Дата окончания фильтрации записей журнала выполнения хука в формате epoch

IN

Int

Идентификатор объекта для фильтрации записей журнала выполнения хука

IN

Int

Код возврата при выполнении:

  • -1 — вывод информации об ошибке;
  • 0 — вывод всей информации;
  • 1 — вывод информации об успехе


OUT

Boolean

В зависимости от результата выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

String

Строка с информацией / Строка с ошибкой

OUT

Int

Код ошибки

OUT

Int

Идентификатор объекта, вызвавшего ошибку