Constructor Detail

• DBService

  public DBService()

Method Detail

• getMaxVersion

  public java.lang.String getMaxVersion()

  Максимальная версия базы данных, на которую можно обновиться

  URL: rest/api/admin/db/max_version
  

  Type: GET
  

  Returns:

  json данные об статусе выполнения запроса и с версией базы данных
  Пример возвращаемых данных метода, при успешном выполнении
  {
  "errorCode": 0,
  "errorMessage": "Success",
  "data": "270",
  }
  
  
  Пример возвращаемых данных метода, в случае ошибки
  {
  "errorCode": 13,
  "errorMessage": "Ошибка исполнения",
  "data": null,
  }

• getDbVersion

  public java.lang.String getDbVersion()

  Текущая версия базы данных

  URL: rest/api/admin/db/current_version
  

  Type: GET
  

  Returns:

  json данные об статусе выполнения запроса и с текущей версией базы данных
  Пример возвращаемых данных метода, при успешном выполнении
  {
  "errorCode": 0,
  "errorMessage": "Success",
  "data": "263",
  }
  
  
  Пример возвращаемых данных метода, в случае ошибки
  {
  "errorCode": 13,
  "errorMessage": "Ошибка исполнения",
  "data": null,
  }

• startUpdate

  public java.lang.String startUpdate()

  Запуск обновления базы данных. Статус выполнения обновления можно проверить с помощью методов /rest/api/admin/db/messages или /rest/api/admin/db/updating_is_completed

  Процесс обновления базы данных:

  1. /rest/api/admin/db/current_version - получаем текущую версию базы
  2. /rest/api/admin/db/max_version - получаем доступную версию
  3. Сравниваем полученные версии, если текущая версия базы меньше чем доступное, то запускаем обновление /rest/api/admin/db/start_update
  4. Периодический проверяем статус обновления /rest/api/admin/db/updating_is_completed
  5. После завершения обновления выполняем метод /rest/api/admin/db/on_db_updated

  Returns:

  json данные об статусе выполнения запроса
  Пример возвращаемых данных метода, при успешном выполнении
  {
  "errorCode": 0,
  "errorMessage": "Success"
  }
  
  
  Пример возвращаемых данных метода, в случае ошибки
  {
  "errorCode": 13,
  "errorMessage": "Ошибка исполнения"
  }

  See Also:

  URL: rest/api/admin/db/start_update
  

  Type: GET
  

• getMessages

  public java.lang.String getMessages()

  Сообщении об выполнения обновления базы данных. Если в сообщениях присутствует сообщение с типом "-1" ("type": -1) то обновление завершено.

  URL: rest/api/admin/db/messages
  

  Type: GET
  

  Returns:

  json данные об статусе выполнения запроса и с версией базы данных
  Пример возвращаемых данных метода
  {
  "errorCode": 0,
  "errorMessage": "Success",
  "data": [{
  "message": "Creating indexes",
  "type": 0,
  "date": 1416196612376
  }, {
  "message": "reports indexes created",
  "type": 0,
  "date": 1416196612378
  }, {
  "message": "Обновление завершено",
  "type": -1,
  "date": 1416196612378
  }]
  }

• updatingIsCompleted

  public java.lang.String updatingIsCompleted()

  Проверка статуса выполнения обновление базы.

  URL: rest/api/admin/db/updating_is_completed
  

  Type: GET
  

  Returns:

  json данные об выполнении обновления базы
  Пример возвращаемых данных метода, если обновление уже завершено
  {
  "errorCode": 0,
  "errorMessage": "Success",
  "data": true
  }
  
  
  Пример возвращаемых данных метода, если обновление еще не завершено
  {
  "errorCode": 0,
  "errorMessage": "Success",
  "data": false
  }

• onDbUpdated

  public java.lang.String onDbUpdated()

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

  URL: rest/api/admin/db/on_db_updated
  

  Type: GET
  

  Returns:

  json данные об статусе выполнения запроса и с версией базы данных
  Пример возвращаемых данных метода, при успешном выполнении
  {
  "errorCode": 0,
  "errorMessage": "Success"
  }
  
  
  Пример возвращаемых данных метода, в случае ошибки
  {
  "errorCode": 13,
  "errorMessage": "Ошибка исполнения"
  }

Constructor Detail

• UsersService

  public UsersService()

Method Detail

• logout

  public Response logout(java.util.List<java.lang.String> users)

  Принудительное разлогинивание пользователей

  URL: /rest/api/admin/user/log_out

  Тип: POST

  Данный метод доступен только пользователям с правами суперадминистратора.

  Parameters:

  Метод - принимает на входе массив строк, которые являются идентификаторами пользователей, которых необходимо разлогинить(обяз.).

  Пример запроса:

  POST / HTTP/1.1 Host: localhost:8389 Cache-Control: no-cache Content-Type: application/json [ "4da20e1f-49a9-4965-8736-8548896462ea", "1168cdf5-02c5-4f45-8141-2921f1165b68", "8c065606-05f7-4ad9-b7dd-02be1be18e6b" ]

  Returns:

  Пример ответа при успешном выполнении метода:

  { "errorCode": 0, "errorMessage":"Сессии пользователей принудительно завершены" }

• listLoggedInUsers

  public Response listLoggedInUsers(java.lang.String showIdsStr)

  Получение залогиненных пользователей

  URL: /rest/api/admin/user/logged_in

  Тип: GET

  Parameters:

  Метод - принимает следующий входной параметр:

  • showLoggedIn - признак необходимости возврата списка пользователей (по умолчанию false). Принимает следующие значения:
    • true - возвращает список залогиненных пользователей
    • false - не возвращает список залогиненных пользователей

  Пример запроса:

  /rest/api/admin/user/logged_in?showLoggedIn=true

  Returns:

  В случае успешного выполнения метод возвращает объект JSON с полями:

  • number - количество залогиненных пользователей
  • users - массив, состоящий из идентификаторов пользователей. При showLoggedIn=false, возвращается пустой массив

  Пример ответа при успешном выполнении:

  { "number" : 5, "users": [ "8b86eb00-e062-11e5-8c91-525400bb7fc6", "088565c0-e025-11e5-8c91-525400bb7fc6", "9b3dd2d0-dec2-11e5-8c91-525400bb7fc6", "86865eb0-a3d6-11e5-9ae6-525400bb7fc6", "50acca20-c8c2-11e5-92a8-525400bb7fc6" ] }

Constructor Detail

• ProcessesService

  public ProcessesService()

Method Detail

• getAvailableProcesses

  public java.lang.String getAvailableProcesses()

  Информация о процессах

  URL: rest/api/admin/processes/available
  

  Type: GET
  

  Returns:

  json данные об процессах
  {
  "errorCode": 0,
  "errorMessage": "Success",
  "data": [{
  "processName": "acquaintance-single",
  "currentProcessID": "590001",
  "description": "Элемент ознакомления",
  "isActual": true
  }, {
  "processName": "action",
  "currentProcessID": "640001",
  "description": "Стандартное поручение",
  "isActual": false
  }, {
  ... ...
  }
  ]
  }
  
  Значения некоторых полей:
  isActual - если false то процесс надо обновить, иначе процесс уже обновлен
  processName - название (ID) процесса, используется в качестве id для метода /rest/api/admin/processes/update

• getNotActualProcesses

  public java.lang.String getNotActualProcesses()

  Возвращает id-шники только не обновленных процессов.

  URL: rest/api/admin/processes/not_actual
  

  Type: GET
  

  Returns:

  json данные об не обновленных процессах
  {
  "errorCode": 0,
  "errorMessage": "Success",
  "data": [
  "acquaintance-single",
  "action",
  ... ...
  ]
  }
  

• updateProcess

  public java.lang.String updateProcess(java.lang.String processID)

  Обновить процесс

  URL: rest/api/admin/processes/updateProcess
  

  Type: GET
  

  Parameters:

  processID - id процесса (обяз.)

  Returns:

  json данные об статусе выполнения запроса
  Пример возвращаемых данных метода, при успешном выполнении
  {
  "errorCode": 0,
  "errorMessage": "Success"
  }
  
  
  Пример возвращаемых данных метода, в случае ошибки
  {
  "errorCode": 13,
  "errorMessage": "Ошибка исполнения"
  }

Constructor Detail

• PersonService

  public PersonService()

Method Detail

• getUser

  public java.lang.String getUser(java.lang.String locale,
                         boolean getGroups)

  Авторизует пользователя и возвращает информацию о нем

  URL rest/api/person/auth
  Method GET

  Parameters:

  locale - локаль пользователя

  getGroups - если данный параметр true, то метод вернет так же список групп в которых состоит авторизованный пользователь

  Returns:

  
  Если методу не передано никаих параметров кроме локали, то возвращается только json с информацией о пользователе (PersonWrapper#getJsonObject)
  Если параметр getGroups=true, то возвращается объект вида

   
       {
   
          person: {},     //информация о пользователе, см PersonWrapper#getJsonObject
   
          groups:                         //список групп
   
               [
   
               {groupID: "",              //идентификатор группы
   
               name: ""}                  //название группы
   
               , ...]
   
      }
   

  See Also:

  PersonWrapper#getJsonObject(arta.synergy.web.common.client.data.filecabinet.Person)

• generateUserAuthToken

  public java.lang.String generateUserAuthToken(java.lang.String moduleID)

  генерирует ключ для авторизации пользователя вне сессии

  URL rest/api/person/generate_auth_key
  Method GET

  Parameters:

  moduleID - идентификатор модуля

  Returns:

  json объект с полями:
  errorCode код выполнения: 0- в случае успешного выпонения, иначе - в случае возниковения ошибки
  errorMessage сообщение об ошибке
  key сгенерированный ключ пользователя

• deleteUserAuthKey

  public Response deleteUserAuthKey(java.lang.String moduleID)

  удаляет ключ авторизации пользователя вне сессии

  URL rest/api/person/invalidate_auth_key
  Method GET

  Parameters:

  moduleID - идентификатор модуля

  Returns:

  json объект с полями:
  errorCode код выполнения: 0- в случае успешного выпонения, иначе - в случае возниковения ошибки
  errorMessage сообщение об ошибке

• updateUserAuthKey

  public Response updateUserAuthKey(java.lang.String moduleID)

  обновление аренды токена

  URL rest/api/person/update_auth_key_expire
  Method GET

  Parameters:

  moduleID - идентификатор модуля

  Returns:

  json объект с полями:
  errorCode код выполнения: 0- в случае успешного выпонения, иначе - в случае возниковения ошибки
  errorMessage сообщение об ошибке

• deleteUserPhoto

  public java.lang.String deleteUserPhoto(java.lang.String userID,
                                 java.lang.String locale)

  Метод удаляет фотографию пользователя

  URL /rest/api/person/photo/delete
  Method GET

  Parameters:

  userID - UUID пользователя

  locale - локаль пользователя, выполняющего действие

  Returns:

  json объект с полями - errorCode - код выполнения операции (0 успешно, иначе - ошибка), errorMessage - сообщение об ошибке/успешном выполнении

• getSSOHash

  public java.lang.String getSSOHash(java.lang.String clientParams)

  Метод возвращает SSOHash пользователя

  URL /rest/api/person/SSOHash
  Method GET

  Parameters:

  clientParams - параметр, содержащий user-agent и host пользователя

  Returns:

  json объект с полями - errorCode - код выполнения операции (0 успешно, иначе - ошибка), errorMessage - сообщение об ошибке/успешном выполнении

• getAccountFullName

  public java.lang.String getAccountFullName(java.lang.String userID)

Constructor Detail

• PersonLoad

  public PersonLoad()

Method Detail

• getWorkload

  public java.util.List<PersonLoad.ValueResult> getWorkload(PersonLoad.ReqParams params)

  Возвращает список значений нагрузки для пользователя в указанный диапазон дат.
  Если пользователь не указан, то в качестве пользователя берется пользователь который выполняет запрос.
  Если не указаны даты начала и даты завершения - возвращается нагрузка для текущей даты.
  
  URL: /rest/person/workload
  Метод: POST
  JSON запроса:

  • userID - String пользователь для которого происходит запрос
  • startDate - String дата начала периода в формате yyyy-MM-dd
  • finishDate - String дата завершения периода в формате yyyy-MM-dd

  Пример запроса:

    {
    "userID":"e5067b88-114b-4a04-6cc6-679655dc652e"
    "startDate": "2015-02-08",
    "finishDate": "2015-02-09"
    }
   

  Parameters:

  params - параметры запроса

  Returns:

  список значений
  JSON ответа:

  • date - String дата начала периода в формате yyyy-MM-dd
  • value - String значения

  Пример результата ответа JSON

   [
   {
   "date": "2015-02-08",
   "value": "72"
   },
   {
   "date": "2015-02-09",
   "value": "84"
   }
   ]
   

• getWorkload

  public java.util.Map<java.lang.String,java.util.List<PersonLoad.ValueResult>> getWorkload(java.util.ArrayList<PersonLoad.ReqParams> params)

  Возвращает карту списков значений нагрузки для пользователей в указанных диапазонах дат.
  Если пользователь не указан, то в качестве пользователя берется пользователь который выполняет запрос.
  Если не указаны даты начала и даты завершения - возвращается нагрузка для текущей даты.
  
  URL: /rest/person/workload/m
  Метод: POST
  
  JSON запроса:

  • userID - String пользователь для которого происходит запрос
  • startDate - String дата начала периода в формате yyyy-MM-dd
  • finishDate - String дата завершения периода в формате yyyy-MM-dd

  
  Пример запроса:
  

   [
   {
   "userID":"e5067b88-114b-4a04-6cc6-679655dc652e",
   "startDate": "2015-02-08",
   "finishDate": "2015-02-09"
   },
   {
   "userID":"e5067b88-114b-4a04-6cc6-679655dc6521",
   "startDate": "2015-02-08",
   "finishDate": "2015-02-09"
   }
   ]
   

  Parameters:

  params - параметры запроса

  Returns:

  список значений
  JSON ответа:

  • userID - String пользователь для которого происходит запрос
    • date - String дата начала периода в формате yyyy-MM-dd
    • value - String значения

  Пример результата ответа JSON

   [
   {
   "e5067b88-114b-4a04-6cc6-679655dc6521":[
   {
   "date": "2015-02-08",
   "value": "72"
   },
   {
   "date": "2015-02-09",
   "value": "84"
   }
   ],
   "e5067b88-114b-4a04-6cc6-679655dc652e":[
   {
   "date": "2015-02-08",
   "value": "82"
   },
   {
   "date": "2015-02-09",
   "value": "13"
   }
   ]
   }
   ]
   

• getEfficiency

  public java.util.List<PersonLoad.ValueResult> getEfficiency(PersonLoad.ReqParams params)

  Возвращает список значений эффективности для пользователя в указанный диапазон дат.
  Если пользователь не указан, то в качестве пользователя берется пользователь который выполняет запрос.
  Если не указаны даты начала и даты завершения - возвращается эффективность для текущей даты.
  
  URL: /rest/person/efficiency
  Метод: POST
  
  JSON запроса:

  • userID - String пользователь для которого происходит запрос
  • startDate - String дата начала периода в формате yyyy-MM-dd
  • finishDate - String дата завершения периода в формате yyyy-MM-dd

  
  Пример запроса:
  

    {
    "userID":"e5067b88-114b-4a04-6cc6-679655dc652e"
    "startDate": "2015-02-08",
    "finishDate": "2015-02-09"
    }
   

  Parameters:

  params - параметры запроса

  Returns:

  список значений
  JSON ответа:

  • date - String дата начала периода в формате yyyy-MM-dd
  • value - String значения

  Пример результата ответа JSON

   [
   {
   "date": "2015-02-08",
   "value": "72"
   },
   {
   "date": "2015-02-09",
   "value": "84"
   }
   ]
   

• getEfficiency

  public java.util.Map<java.lang.String,java.util.List<PersonLoad.ValueResult>> getEfficiency(java.util.ArrayList<PersonLoad.ReqParams> params)

  Возвращает карту списков значений эффективности для пользователей в указанные диапазоны дат.
  Если пользователь не указан, то в качестве пользователя берется пользователь который выполняет запрос.
  Если не указаны даты начала и даты завершения - возвращается эффективность для текущей даты.
  
  URL: /rest/person/efficiency/m
  Метод: POST
  
  JSON запроса:

  • userID - String пользователь для которого происходит запрос
  • startDate - String дата начала периода в формате yyyy-MM-dd
  • finishDate - String дата завершения периода в формате yyyy-MM-dd

  
  Пример запроса:
  

    [
    {
    "userID":"e5067b88-114b-4a04-6cc6-679655dc652e",
    "startDate": "2015-02-08",
    "finishDate": "2015-02-09"
    },
    {
    "userID":"e5067b88-114b-4a04-6cc6-679655dc6521",
    "startDate": "2015-02-08",
    "finishDate": "2015-02-09"
    }
    ]
   

  Parameters:

  params - параметры запроса

  Returns:

  список значений
  JSON ответа:

  userID - String пользователь для которого происходит запрос

  • date - String дата начала периода в формате yyyy-MM-dd
  • value - String значения

  
  Пример результата ответа JSON

   [
   {
   "e5067b88-114b-4a04-6cc6-679655dc6521":[
   {
   "date": "2015-02-08",
   "value": "72"
   },
   {
   "date": "2015-02-09",
   "value": "84"
   }
   ],
   "e5067b88-114b-4a04-6cc6-679655dc652e":[
   {
   "date": "2015-02-08",
   "value": "82"
   },
   {
   "date": "2015-02-09",
   "value": "13"
   }
   ]
   }
   ]
   

Constructor Detail

• UserPhotoServlet

  public UserPhotoServlet()

Method Detail

• doPost

  protected void doPost(HttpServletRequest request,
            HttpServletResponse response)
                 throws ServletException,
                        java.io.IOException

  Throws:

  ServletException

  java.io.IOException

• doGet

  protected void doGet(HttpServletRequest request,
           HttpServletResponse response)
                throws ServletException,
                       java.io.IOException

  Throws:

  ServletException

  java.io.IOException

Constructor Detail

• LoggerService

  public LoggerService()

Method Detail

• addLog

  public java.lang.String addLog(java.lang.String providerID,
                        int actionType,
                        java.lang.String log)

  Метод добавляет запись в журнал логов системы

  
  

  URL rest/api/logger/add
  Method POST
  
  Все параметры запроса должны быть параметрами формы
  
  

  Parameters:

  providerID - идентификатор источника логов

  actionType - код действия

  log - текст лога

  Returns:

  json объект:
  errorCode код выполнения, 0 - успешно, иначе - произошла ошибка
  errorMessage сообщение о результате выполнения (в случае не успешного выполнения)

• start

  public java.lang.String start(java.util.HashMap<java.lang.String,java.lang.Object> options)

• saveFullProcessLog

  public java.lang.String saveFullProcessLog(java.lang.String dtiId,
                                    java.util.List<java.util.HashMap<java.lang.String,java.lang.String>> itemList)

• log

  public java.lang.String log(java.lang.String providerId,
                     int eventId,
                     java.lang.String type,
                     java.lang.String host,
                     java.lang.String userId,
                     boolean isPublic,
                     java.lang.String objects)

• registerProvider

  public java.lang.String registerProvider(java.lang.String providerId,
                                  java.lang.String name,
                                  java.lang.String jndi)

• registerEvent

  public java.lang.String registerEvent(java.lang.String providerId,
                               int eventId,
                               java.lang.String jndi)

• getHost

  public java.lang.String getHost()

Constructor Detail

• SettingsService

  public SettingsService()

Method Detail

• getSettings

  public java.lang.String getSettings(java.lang.String locale)

  Метод возвращает настройки приложения, необходимые для работы приложения

  URL rest/api/settings/get
  Method GET

  
  
  day_start_time - время начала рабочего дня
  day_finish_time - время завершения рабочего дня
  work_completion_forms - список доступных форм завершения работы, для каждой формы завершения указываются
  id - идентификатор формы завершения
  name - название формы завершения
  docflow_demand_sign_before_assign - обязательно ли подписание документов перед отправкой;
  display_author_input - отображать ли поле "автор" при создании работы
  date_resolution_after_finish_document - разрешено ли ставить работы по резолюции, завершающиеся после документа
  allow_add_work_responsibles - разрешать добавлять к работе соисполнителей (не из числа подчниненных)
  set_work_from_responsible - ставить работы исполнителям от имени ответственного
  allow_resend_work - позволять передавать работу
  signed_off - лейбл "Отписано"
  current_priorities - текущие приоритеты в системе
  all_priorities - все доступные приоритеты в системе
  dialogs - все доступные диалоги в системе (name - имя, uuid - uuid, type - тип)
  work_items - доступные пункты меню (модуль "Потоки работ")
  document_items - доступные пункты меню (модуль "Документы")
  file_items - доступные пункты меню (модуль "Файлы")
  day_length - длительность рабочего дня (из календаря Системы)
  default_work_length - время на выполнение работы по умолчанию
  default_document_project_work_length - время на выполнение проекта документа (в т.ч. по шаблону) по умолчанию
  default_agreement_length - время на выполнение согласования по умолчанию
  default_approvement_length - время на выполнение утверждения по умолчанию
  default_acquaintance_length - время на выполнение ознакомления по умолчанию
  systemName - наименование системы
  resolution_work_types - доступные пункты типов работ по резолюции, для каждого пункта указываются
  needCert - требовать ключ и сертификат
  enableEDS - настроено ли ЭЦП

  • dict_id - UUID записи справочника;
  • item_number - порядковый номер пункта в выпадающем списке;
  • item_process - действие, которое осуществляет пункт;
  • item_name - название пункта типа работы.

  Parameters:

  locale - локаль пользователя

  Returns:

  настройки как объект json

  See Also:

  arta.synergy.web.common.client.data.actions.dialog.WorkDialogType#WORK, arta.synergy.web.common.client.data.actions.dialog.WorkDialogType#DOCUMENT_PROJECT, arta.synergy.web.common.client.data.actions.dialog.WorkDialogType#TEMPLATE_PROJECT

• setSettings

  public java.lang.String setSettings( settings)

  Изменение настроек системы. Можно изменить настройки для администратора и для методолога. Администратору и методологу доступны свои настройки, соответствующий разделением в интерфейсе.

  Если пользователь является и администратором и методологом, то ему будут доступны все настройки.

  
  

  URL: rest/api/settings/set
  Тип POST
  

  Все настройки надо передавать в форме. Название, параметра должна совпадать с id настройки. Если не будет найден ни одна настройка по такому id. Сервер вернет следующую ошибку:

  {"errorCode": 13, "errorMessage": ""Настройка с id {id} не найдена"}

  Returns:

  Объект json с полями
  errorCode код выполнения (0- успешно, иначе - ошибка)
  errorMessage сообщение, характеризующее успешное выполнение либо ошибку

  Настройки, доступные для администратора:

  • management_url- url приложения
  • pass_min_length- минимальная длина пароля
  • pass_digit_count- минимальное количество цифровых символов
  • pass_up_letter_count- минимальное количество букв верхнего регистра
  • pass_low_letter_count- минимальное количество букв нижнего регистра
  • pass_special_count- минимальное количество специальных символов
  • pass_equal_seq_count- минимальное количество последовательных одинаковых символов
  • pass_class_equal_seq_count- минимальное количество последовательных одинаковых символов одного класса
  • pass_equals_login- запрет совпадения пароля с логином
  • pass_equals_fam- запрет совпадения пароля с фамилией
  • pass_equals_name- запрет совпадения пароля с именем
  • pass_equals_patronymic- запрет совпадения пароля с отчеством
  • pass_unsuccess_try_count- количество неудачных попыток
  • pass_timeout- таймаут
  • pass_progress_timeout- прогрессивный таймаут
  • pass_timeout_reset- период сброса количества неудачных попыток(с времени последней неудачной авторизации)
  • help_url- дрес службы поддержки
  • email_download_interval- нтервал загрузки почтовых сообщений
  • email_download_messages_limit- оличество почтовых сообщений, загружаемых за один раз
  • email_redownload_attempts_count- аксимальное количество попыток загрузить письмо
  • email_max_body_size- аксимальный размер тела сообщения
  • email_max_message_size- аксимальный размер загружаемого письма
  • email_load_self_mails- олучать письма от собственного адреса
  • email_max_jms_msg_time_to_live - симальное время жизни сообщения в очереди jms

  
  
  

  Настройки, доступные для методолога:

  • docflow_sign_agreement - подписывать согласования
  • docflow_sign_approvement - подписывать утверждения
  • docflow_sign_acq - подписывать ознакомления
  • docflow_demand_certificate - требовать ключ и сертификат
  • docflow_demand_sign_before_assign -требовать подпись перед отправкой документа
  • protocol_demand_aggreement -требовать согласование протокола
  • protocol_demand_approvement -требовать утверждение протокола,
  • protocol_demand_registration -требовать регистрацию протокола
  • allow_create_additional_resolutions - разрешить накладывать дополнительные резолюции
  • docflow_resolution_template -шаблон пункта резолюции
  • document_close_agreement -закрывать окно просмотра работы после согласования
  • document_close_approvement -закрывать окно просмотра работы после утверждения
  • document_close_acq - закрывать окно просмотра работы после ознакомления
  • document_close_assignment -закрывать окно просмотра работы после завершения работы
  • use_create_child_doc_btn -отображать кнопку для создания дочернего документа в окне документа
  • user_name_default_type - отображать полное фио пользователя в компоненте выбора пользователя
  • docs_default_display_period - показывать документы, созданные за последние (месяцев)
  • show_in_field_on_execution - отображать в поле "на исполнении"
  • check_in_reg_inc_documents - осуществлять проверку на совпадения при регистрации входящих документов
  • resolution_create_levels - количество уровней оргструктуры с правом на создание резолюции
  • completion_date_for_resolution - подставлять дату завершения документа в пункты резолюции
  • date_resolution_after_finish_document -разрешить ставить работы по резолюции, завершающиеся позже документа
  • use_action_progress_book -использовать справочник значений прогресса для поручений
  • set_work_from_responsible - ставить работы исполнителям от имени ответственного
  • allow_resend_work -разрешить передавать работы другим исполнителям
  • allow_add_work_responsibles -разрешить добавлять соисполнителей к работам, не являющихся подчиненными
  • show_future_works -отображать будущие работы
  • show_future_route_steps -отображать в ходе исполнения будущие этапы
  • demand_positive_comment -требовать ввода комментария при согласовании/утверждении
  • demand_negative_comment -требовать ввода комментария при отказе в согласовании/утверждении
  • allow_create_work_longer_parent -разрешать создавать дочерние работы, завершающиеся позже родительской
  • allow_delegation_to_all -разрешать делегирование прав всем сотрудникам
  • max_user_send_level -максимальный уровень иерархии вверх, которому можно отправить документ (0 - все уровни структуры)
  • works_completion_form_by_default -формат отображения поля автора в ходе выполнения
  • default_work_length -создание и перепоручение работы (в том числе по маршруту) // время на выполнение работ по-умолчанию
  • default_document_project_work_length -работа по проекту документа (в том числе по шаблону)
  • default_agreement_length -огласование
  • default_approvement_length -утверждение
  • default_acquaintance_length -ознакомление
  • plan_calc_type - расчет мероприятий проекта
  • plan_dates_type - тип ввода дат мероприятий проекта
  • plan_hide_completed - скрывать завершенные проекты и портфели в навигаторе
  • project_cost_pointer_measure - единица измерения стоимости проектов
  • system_name_kz - наименование системы на казахском языке
  • system_name_ru - наименование системы на русском языке
  • system_name_en - именование системы на английском языке

• getProcesses

  public java.lang.String getProcesses(java.lang.String locale)

  Метод возвращает список основных процессов, которые используется в системе
  
  URL: rest/api/settings/get_processes
  Тип GET
  

  Parameters:

  locale - локаль пользователя

       В случае успешного выполнения возвращает json c полями:
       name - название процесса на языке локали, переданной в параметре locale
       number - порядковый номер следования в списке
       type - тип операции, один из следующих вариантов:
          ASSIGNMENT_ITEM - работа
          AGREEMENT_ITEM - согласование
          APPROVAL_ITEM - утверждение
          ACQUAINTANCE_ITEM - ознакомление
          RESOLUTION_ACTION - резолюция
          SEND_DOCUMENT - отправка документа
          BLOCKING_PROCESS - блокирующий процесс
          REGISTRATION_ITEM - регистрация
          ROUTE_ITEM - маршрут
          SEND_DOCUMENT_BY_FORM - отправка документа по форме
          POSITION_APPOINMENT_ITEM - назначение на должность
          POSITION_TRANSFER_ITEM - перевод
          POSITION_DISCHARGE_ITEM - увольнение
          COPY_TO_PR_FOLDER_ITEM - копирование в личную папку
          CALENDAR_APPOINTEMENT_ITEM - назначение календаря
          REGISTER_EVENT_ITEM - событие реестра
          QUERY_RESULT - результат запроса
          COMMON_PROCESS_BY_FORM - работа по форме
          POINTERS_INPUT - ввод значения показателя
          TIMER - таймер
          ROUTE_TEMPLATE - запуск маршрута по шаблону
          CONDITION - условный переход
          COPY_TO_CARD - копирование в карточку
          REASSIGN_WORK - переназначение работ
   

• getWorkDays

  public Response getWorkDays(java.lang.String date_start,
                     java.lang.String date_finish,
                     java.lang.String type)

  Метод возвращает периоды рабочего времени с типами для каждого дня в запрашиваемом интервале
  
  URL: rest/api/settings/calendar
  Тип GET
  

  Parameters:

  date_start - дата начала интервала в формате yyyy-MM-dd (обязат.)

  date_finish - дата завершения интервала в формате yyyy-MM-dd (обязат.)

  type - тип дня, может быть стандартный "standard", нестандартный "custom", выходной "holiday" (не обязат.)

  Returns:

   Пример запроса без указания параметра type:
    `rest/api/settings/calendar?date_start=2016-05-01&date_finish=2016-05-04`
   Пример ответа на запрос без указания параметра type:
  {
    "2015-05-01": [
    {
        "type": "holiday"
    }
                  ],
    "2015-05-02": [
    {
        "start": "09:00",
        "finish": "13:00",
        "type": "custom"
    }
                  ],
        "2015-05-03": [
    {
        "type" : "holiday"
    }
                  ],
    "2015-05-04": [
    {
        "start": "09:00",
        "finish": "13:00",
        "type" : "standard"
    },
    {
        "start": "14:00",
        "finish": "18:00",
        "type" : "standard"
    }
                  ]
    }
   Где ключами являются даты интервала в формате yyyy-MM-dd,
   а значениями - список объектов с полями start, finish и type
   в которых указано время начала и завершения промежутка
   рабочего времени в формате HH:mm и тип дня этого промежутка
   Пример запроса с указанием параметра type:
    `rest/api/settings/calendar?date_start=2016-05-01&date_finish=2016-05-04&type=standard`
   Пример ответа на запрос с указанием параметра type:
  {
    "2015-05-03": [
    {
        "start": "09:00",
        "finish": "13:00",
        "type" : "standard"
    },
    {
        "start": "14:00",
        "finish": "18:00",
        "type" : "standard"
    }
                  ],
    "2015-05-04": [
    {
        "start": "09:00",
        "finish": "13:00",
        "type" : "standard"
    },
    {
        "start": "14:00",
        "finish": "18:00",
        "type" : "standard"
    }
                  ]
    }
  

Constructor Detail

• MobileUtilsService

  public MobileUtilsService()

Method Detail

• addDeviceToken

  public java.lang.String addDeviceToken(java.lang.String token,
                                java.lang.String type)

  Метод добавляет в систему token устройства для авторизовавшегося пользователя

  
  

  URL rest/api/mobile/utils/add_token
  Method GET
  
  Параметры метода:
  token идентификатор устройства
  type тип устройства
  locale локаль пользователя

  Returns:

  json c полями:
  

  errorCode

  результат выполнения метода (0 - успешно, иначе - ошибка)
  

  errorMessage

  сообщение об ошибке

• removeDeviceToken

  public java.lang.String removeDeviceToken(java.lang.String token)

  Метод добавляет в систему token устройства для авторизовавшегося пользователя

  
  

  URL rest/api/mobile/utils/remove_token
  Method GET
  
  Параметры метода:
  token идентифкатор устройства
  locale локаль пользователя

  Returns:

  json c полями:
  

  errorCode

  результат выполнения метода (0 - успешно, иначе - ошибка)
  

  errorMessage

  сообщение об ошибке

• getLocale

  public java.lang.String getLocale()

Field Detail

• WWW_AUTHENTICATE

  public static final java.lang.String WWW_AUTHENTICATE

  наименование хедера мы меняем этот хедер чтобы браузер не показывал свое окошко с вводом логина и пароля

  See Also:

  Constant Field Values

• WWW_AUTHENTICATE_VALUE

  public static final java.lang.String WWW_AUTHENTICATE_VALUE

  See Also:

  Constant Field Values

Constructor Detail

• AccessForbiddenServlet

  public AccessForbiddenServlet()

Method Detail

• service

  protected void service(HttpServletRequest httpServletRequest,
             HttpServletResponse httpServletResponse)
                  throws ServletException,
                         java.io.IOException

  Throws:

  ServletException

  java.io.IOException

Constructor Detail

• UserChooserService

  public UserChooserService()

Method Detail

• getUsers

  public java.lang.String getUsers(int startRecord,
                          int recordsCount,
                          java.lang.String locale,
                          boolean showAll,
                          int levelsCount,
                          int groupID,
                          java.lang.String search,
                          java.lang.Integer operationType,
                          java.lang.Integer ownerOperationType,
                          java.lang.String departmentID,
                          java.lang.String userID)

  Метод выполняет поиск пользователей

  URL rest/api/userchooser/search
  Method GET
  
  Для каждого пользователя возвращаются следующие данные
  userID - идентификатор пользователя
  name - имя пользователя в формате Фамилия И.О.
  position - название должности
  
  Примеры:
  Получение списка подчиненных пользователей

  rest/api/userchooser/search?showAll=false

  
  Получение списка всех пользователей (подчиненных и не подчиненных)

  rest/api/userchooser/search?showAll=true

  
  Получение списка всех пользователей, подчиненных user1

  rest/api/userchooser/search?showAll=true&userID=user1

  
  Получение списка всех пользователей (подчиненных и не подчиненных) в имени/фамилии которых содержится строка "абв"

  rest/api/userchooser/search?showAll=true&search=абв

  
  Получение списка всех пользователей (подчиненных и не подчиненных) в имени/фамилии которых содержится строка "абв" из департамента с идентификатором department1

  rest/api/userchooser/search?showAll=true&search=абв&departmentID=department1

  
  Получение списка всех пользователей, которым есть право ставить работу

  rest/api/userchooser/search?showAll=false&operationType=101

  
  Получение списка всех пользователей, которые делегировали право на создание работы

  rest/api/userchooser/search?showAll=true&ownerOperationType=101

  
  startRecord первая запись списка
  recordsCount количество записей в списке
  locale локаль пользователя
  showAll true - показывать всех пользователей, иначе - только подчиненных
  search строка поиска, вырождается в условие "содержит ли имя или фамилия пользователя эту строку".
  operationType идентификатор действия. Нужно использовать, если для получения списка пользователей необходимо учесть делегированные права на это действие. Например, для получения списка пользователей, которым можно ставить работу
  ownerOperationType - идентификатор действия для получения списка пользователей, которые делегировали данное действие текущему пользователю. Например, для получения списка пользователей, от имени которых можно создавать работы
  departmentID идентификатор департамента внутри которого необходимо осуществить поиск. По-умолчанию null - это означает, что поиск осуществляется по всей орг. структуре
  groupID id группы пользователя
  levelsCount параметр для будущего использования

  Returns:

  список пользователей как список json

• getUsersExt

  public Response getUsersExt(int startRecord,
                     int recordsCount,
                     java.lang.String locale,
                     boolean showAll,
                     int levelsCount,
                     int groupID,
                     java.lang.String search,
                     java.lang.Integer operationType,
                     java.lang.Integer ownerOperationType,
                     java.lang.String departmentID,
                     java.lang.String userID,
                     java.lang.String showNoPosition,
                     java.lang.String filterPositionID,
                     java.lang.String filterDepartmentID,
                     java.lang.String positionType,
                     java.util.List<java.lang.String> customFields,
                     java.lang.String userNameDisplayType,
                     boolean showEmailContacts,
                     boolean showGroups)

  получение списка пользователей
  url: /rest/api/userchooser/search_ext
  method : GET
  startRecord C какой записи поднимать пользователей
  recordsCount Какое кол-во записей поднимать
  locale локаль пользователя
  showAll Если значение переменной стоит true, то должны быть отображены не только подчиненные но и все пользователи
  levelsCount Количество уровней "вниз" по оргструктуре от данного пользователя
  groupID идентификатор группы. Если параметр задан в чузер подтягиваются пользователи, входящие в данную группу
  search Строка поиска
  operationType Тип действия Если данный параметр задан, то список пользователей будет подгружаться не только от имени userID, но и от имени тех пользователей, которые делегировали ему право на operationType
  ownerOperationType Если данный параметр задан, то список пользователей в выборке ограничивается теми пользователями, которые делегировали userID право на ownerOperationType и самим userID
  departmentID Идентификатор подразделения. Если он задан должен отображаться список пользователей только этого подразделения
  userID Идентификатор пользователя от имени которого выполняется поиск пользователей
  showNoPosition Отображать пользователей, не назначенных на должность
  filterPositionID UUID должности - фильтра. В чузере отображаются только пользователи, занимающие данную должность
  filterDepartmentID UUID подразделения - фильра. В чузере отображаются только пользователи, занимающие должность в данном подразделении (рекурсивно)
  positionType Тип должности Если данный параметр задан, то в чузере отображаются только те пользователи, которые относятся к подразделению, в котором userID занимает должность с типом positionType

  
  customFields перечень дополнительных полей, которые можно подгрузить для данного пользователя (передаются параметрами с названием customField=) может принимать одно значение is_inferior
  userNameDisplayType тип отображения имени пользователя (full, short)
  showEmailContacts подтягивать контакты
  showGroups подтягивать группы о_О

  Returns:

  список пользователей с полями
  personName имя (полное в формате)
  personID идентификатор
  departmentName наименование департамента
  positionName должность
  customFields доп поля (которые запрашивались)
  lastname фамилия
  firstname имя
  patronymic отчество

• getUsers

  public Response getUsers(java.util.List<java.lang.String> userIDs,
                  java.lang.String locale)

  получение информации о пользователях (группах, контактах)
  url: /rest/api/userchooser/getUserInfo
  method : GET

  Parameters:

  userIDs - идентификаторы пользователей передаются как userID=identifier1&userID=identifier2&userID=identifier3 (смотрите пункт про определение типа сущности по идентификатору)

  locale - локаль

  Returns:

  массив объектов с информацией о пользователях
  departmentName наименование департамента
  firstname имя
  lastname фамилия
  patronymic отчество
  personID идентификатор пользователя
  personName имя пользователя
  positionName наименование должности
  customFields - свойства элемента, зависят от типа элемента (смотрите пункт про определение типа сущности по идентификатору)
  
  Определение типа сущности по идентификатору и доп поля этой сущности
  если userID начинается
  "g-" - группа (type - groupId, id - идентификатор группы)
  "contact-" - контакт (contactType - организация или человек, email - почта если есть, id - идентификатор контакта, type - contact, calendarColor - цвет статуса, calendarStatusLabel - подпись статуса)
  "text-" - текст (type - text, text - true, calendarColor - цвет статуса, calendarStatusLabel - подпись статуса)
  иначе пользователь( type - person, id идентификатор пользователя, calendarType - тип календарного статуса, calendarStatus - статус, calendarColor - цвет статуса, calendarTitle - название статуса, calendarStatusLabel - подпись в чузере статуса, calendarStartDate - дата начала, calendarFinishDate - дата завершения
  
  если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

• getPositions

  public Response getPositions(java.util.List<java.lang.String> positionIDs,
                      java.lang.String locale)

  получение информации о должностях
  url: /rest/api/userchooser/getUserInfo
  method : GET

  Parameters:

  positionIDs - идентификаторы должностей передаются как positionID=identifier1&positionID=identifier2&positionID=identifier3

  locale -

  Returns:

  
  code код
  departmentName наименование департамента
  elementID идентификатор должности
  elementName наименование должности
  id идентификатор должности
  info наименование департамента
  name наименование должности
  translation не используется
  type не используется
  
  если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

• getDepartments

  public Response getDepartments(java.util.List<java.lang.String> departmentIDs,
                        java.lang.String locale)

  получение информации о должностях
  url: /rest/api/userchooser/getUserInfo
  method : GET

  Parameters:

  departmentIDs - идентификаторы должностей передаются как positionID=identifier1&positionID=identifier2&positionID=identifier3

  locale -

  Returns:

  
  departmentId - идентификатор департамента
  departmentName наименование
  parentName наименование родительского департамента
  hasChildren - имеет ли департамент дочерние департаменты
  
  если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

• getUsersCalendarStatus

  public Response getUsersCalendarStatus(java.util.List<java.lang.String> users,
                                java.lang.String date,
                                java.lang.String locale)

  
  url: /rest/api/userchooser/getUsersCalendarStatus
  method : GET
  users параметры передаются userID=userid1&userID=userid2& etc
  date дата в формате yyy-MM-dd
  locale локаль

  Returns:

  мэп следующего вида
  {
  "4bd1ef2e-3271-4dd3-ac67-9a8017abe1f4": {
  "type": 1,
  "status": "free",
  "color": "#fecebe",
  "title": "ОТПУСК!!!",
  "statusLabel": "отпуск",
  "startDate": 1456423200000,
  "finishDate": 1474480800000
  },
  "1": {
  "type": 1,
  "status": "free",
  "color": "#456789",
  "title": "Командировка",
  "statusLabel": "Командировка",
  "startDate": 1456423200000,
  "finishDate": 1474480800000
  }
  }
  
  если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

• getUserCalendarStatus

  public Response getUserCalendarStatus(java.lang.String userID,
                               java.lang.String date,
                               java.lang.String locale)

  
  url: /rest/api/userchooser/getUserCalendarStatus
  method : GET
  userID идентификатор пользователя чьи статусы нам необходимо получить
  date дата в формате yyy-MM-dd
  locale локаль Пример запроса:

  `rest/api/userchooser/getUserCalendarStatus?userID=407d94f5-c8dd-469d-8328-ae426f04dbd4`

  Пример возвращаемого объекта JSON: [ { "type": 3, "status": "free", "color": "green", "title": "Ежегодный оплачиваемый отпуск", "statusLabel": "В отпуске с 28.12.16 по 04.01.17", "startDate": "2016-12-28", "finishDate": "2017-01-04", "makeVacant": 0 }, { "type": 3, "status": "free", "color": "green", "title": "Ежегодный оплачиваемый отпуск", "statusLabel": "В отпуске с 26.12.16 по 29.12.16", "startDate": "2016-12-26", "finishDate": "2016-12-29", "makeVacant": 0 } ]

• getUserStatusInPeriod

  public Response getUserStatusInPeriod(java.lang.String start,
                               java.lang.String finish,
                               java.lang.String type,
                               java.lang.String locale,
                               int startRecord,
                               int recordsCount,
                               java.lang.String sortByDate)

  Апи получения пользователей с назначенным календарем

  Метод возвращает список пользователей, назначенный период которых полностью или
  частично попадает в указанный промежуток времени.
  URL метода: /rest/api/userchooser/getUserStatusInPeriod
  method : GET

  Parameters:

  start - дата начала периода, в формате `YYYY-MM-DD` (обяз.)

  finish - дата завершения периода, в формате `YYYY-MM-DD` (обяз.);

  type - тип назначенного статуса, соответствует полю type справочника "Назначение календаря" c кодом calendar_types (необяз.). Если задан данный параметр, то возвращаются пользователи, тип периода которых соответствует указанному значению, может принимать только целые положительные значения;

  locale - локаль;

  startRecord - номер записи результатов, начиная с которой будут возвращены записи (по умолчанию 0)

  recordsCount - количество результатов, которое необходимо вернуть (по умолчанию 30). Максимальное значение параметра 100

  sortByDate - направление сортировки результатов по выходному параметру дате начала периода start. Тип сортировки - дата. Принимает следующие значения (необяз.):

  • asc - записи отсортируются по возрастанию;
  • desc- записи отсортируются по убыванию.

  По умолчанию параметр принимает значение asc, любое другое значение,
  несоответствующее ни одному из возможных значений, будет интерпретировано
  как asc.

  Returns:

  В случае успешного выполнения метод возвращает массив объектов JSON, состоящий из следующих полей:

  • userID - идентификатор пользователя;
  • start - дата начала периода;
  • finish - дата завершения периода;
  • type - тип статуса;
  • title - название статуса;
  • statusLabel - название текущего статуса сотрудника;
  • color - цвет статуса;
  • busyStatus - тип занятости в данный период. Принимает следующие значения:
  • busy - занят в каждый день периода,
  • standart - обычное рабочее время,
  • free - свободен в каждый день периода.
  • makeVacant - признак занятости штатной единицы. Принимает следующие значения:
  • 0 - пользователь с таким статусом занимает штатную единицу на период действия статуса;
  • 1 - пользователь с таким статусом не занимает штатную единицу на период действия статуса.

  Примечание. Пользователь может возвращаться в списке результатов несколько раз, так как пользователю может быть назначено несколько статусов в разные периоды времени.

  Для пользователя может быть несколько статусов в течение выбранного периода времени
  Пример ответа: ```javascript
  
  [
  {
  "userID": "8f85e270-ebf1-11e5-835c-525400bb7fc6",
  "start": "2016-02-05",
  "finish": "2016-02-25",
  "calendarType":
  {
  "type": "0",
  "title": "Отпуск",
  "statusLabel": "В отпуске с {date.start} по {date.finish}",
  "color": "#5462ef",
  "busyStatus": "free",
  "makeVacant": "0"
  }
  },
  {
  "userID": "59377550-ea78-11e5-835c-525400bb7fc6",
  "start": "2016-02-15",
  "finish": "2017-02-15",
  "calendarType":
  {
  "type": "2",
  "title": "Декретный отпуск",
  "stateLabel": "В декретном отпуске с {date.start} по {date.finish}",
  "color": "#5462ef",
  "busyStatus": "free",
  "makeVacant": "1"
  }
  },
  {
  "userID": "8f85e270-ebf1-11e5-835c-525400bb7fc6",
  "start": "2016-02-28",
  "finish": "2016-03-05",
  "calendarType":
  {
  "type": "1",
  "title": "Командировка",
  "statusLabel": "В командировке с {date.start} по {date.finish}",
  "color": "#5462ef",
  "busyStatus": "busy",
  "makeVacant": "0"
  }
  },
  {
  "userID": "08c164b0-e775-11e5-835c-525400bb7fc6",
  "start": "2016-03-17",
  "finish": "2016-03-23",v "calendarType":
  {
  "type": "1",
  "title": "Командировка",
  "stateLabel": "В командировке с {date.start} по {date.finish}",
  "color": "#5462ef",
  "busyStatus": "busy",
  "makeVacant": "0"
  }
  }
  ]

  В случае передачи неверных параметров или внутренней ошибки сервера будет
  возвращен массив следующего содержания (сообщение об ошибке будет менятся):

   {
  
   "errorCode": 13,
  
   "errorMessage": "Передан некорректный параметр start"
  
   }
  
   

  Код ответа для внутренней ошибки - HTTP 500(INTERNAL_SERVER_ERROR), для неверных параметров - HTTP 400(BAD_REQUEST)

• checkUsers

  public Response checkUsers(java.lang.String locale,
                    boolean showAll,
                    int levelsCount,
                    int groupID,
                    java.lang.String search,
                    java.lang.Integer operationType,
                    java.lang.Integer ownerOperationType,
                    java.lang.String departmentID,
                    java.lang.String userID,
                    java.lang.String showNoPosition,
                    java.lang.String filterPositionID,
                    java.lang.String filterDepartmentID,
                    java.lang.String positionType,
                    java.util.List<java.lang.String> usersToCheck)

  проверка подходят ли данные пользователи под указанные параметры
  url: /rest/api/userchooser/search_ext
  method : GET
  locale локаль пользователя
  showAll Если значение переменной стоит true, то должны быть отображены не только подчиненные но и все пользователи
  levelsCount Количество уровней "вниз" по оргструктуре от данного пользователя
  groupID идентификатор группы. Если параметр задан в чузер подтягиваются пользователи, входящие в данную группу
  search Строка поиска
  operationType Тип действия Если данный параметр задан, то список пользователей будет подгружаться не только от имени userID, но и от имени тех пользователей, которые делегировали ему право на operationType
  ownerOperationType Если данный параметр задан, то список пользователей в выборке ограничивается теми пользователями, которые делегировали userID право на ownerOperationType и самим userID
  departmentID Идентификатор подразделения. Если он задан должен отображаться список пользователей только этого подразделения
  userID Идентификатор пользователя от имени которого выполняется поиск пользователей
  showNoPosition Отображать пользователей, не назначенных на должность
  filterPositionID UUID должности - фильтра. В чузере отображаются только пользователи, занимающие данную должность
  filterDepartmentID UUID подразделения - фильра. В чузере отображаются только пользователи, занимающие должность в данном подразделении (рекурсивно)
  userToCheck Список идентификаторов пользователей. Это поле используется если задан один из параметров фильтра (должность или подразделение)
  positionType Тип должности
  customFields перечень дополнительных полей, которые можно подгрузить для данного пользователя (передаются параметрами с названием customField=) может принимать одно значение is_inferior
  userNameDisplayType тип отображения имени пользователя (full, short)

  Returns:

  возвращается первый подходящий по параметры поиска пользователь среди переданных, если таковых нет, то возвращается первый из выборки
  personName имя (полное в формате)
  personID идентификатор
  departmentName наименование департамента
  positionName должность
  customFields доп поля (которые запрашивались)
  lastname фамилия
  firstname имя
  patronymic отчество
  
  если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

• checkPositions

  public Response checkPositions(int startRecord,
                        int recordsCount,
                        boolean showAll,
                        boolean showOnlyVacant,
                        java.lang.String locale,
                        java.lang.String userID,
                        java.lang.Integer operationType,
                        java.lang.String search,
                        java.lang.String departmentID,
                        java.lang.String filterDepartmentID,
                        java.lang.String filterUserID,
                        java.util.List<java.lang.String> valuesToCheck)

  проверка подходят ли переданные должности под переданные параметры выборки

  Parameters:

  startRecord - первая позиция выборки (по умолчанию 0)

  recordsCount - количество в выборке (по умолчанию 30)

  showAll - показывать все должности, по умолчанию нет (если нет - то отображаются только подчиненные должности)

  showOnlyVacant - отображать только вакантные должности, по умолчанию нет

  locale - локаль

  userID - идентификатор пользователя от имени которого нужно выполнять поиск

  operationType - - тип операции для получения пользователей которые делегировали права пользователю (по ним определяется максимальный уровень иерархии верх который нужно отображать и подчиненные должности)

  search - текстовый поиск

  departmentID - идентификатор департамента, чьи дочерние должности (всю иерархию) необходимо отображать для всей иерархии

  filterDepartmentID - идентификатор департамента чьи непосредственные должности нужно отображать

  filterUserID - идентификатор пользователя чьи должности необходимо отображать

  valuesToCheck - проверяемые значения идентификаторов должностей передается как valuesToCheck=identifier1&valuesToCheck=identifier2

  Returns:

  возвращается массив, который содержит один элемент: первый подходящий по параметры поиска пользователь среди переданных, если таковых нет, то возвращается первый из выборки поля возвращаемой сущности
  code код
  departmentName наименование департамента
  elementID идентификатор должности
  elementName наименование должности
  translation не используется
  type не используется
  
  если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

• addOftenChosenUsers

  public Response addOftenChosenUsers(java.util.List<java.lang.String> users)

  метод сохраняет последних выбранных пользователей для пользователя
  url: /rest/api/userchooser/addOftenUsers
  method: GET
  Parameters:
  userID - идентификатор пользователя (может повторяться)
  
  Возвращает json c полями errorCode, errorMessage, где
  - errorCode код ошибки (0, если ошибки нет)
  - errorMessage расшифровка ошибки (пустая строка, если ошибки нет)
  
  если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

• getOftenChosenUsers

  public Response getOftenChosenUsers(int startRecord,
                             int recordsCount,
                             java.lang.String locale,
                             boolean showAll,
                             java.lang.String search,
                             java.lang.Integer operationType,
                             java.lang.Integer ownerOperationType,
                             java.lang.String filterPositionID,
                             java.lang.String filterDepartmentID,
                             java.lang.Integer positionType,
                             java.util.List<java.lang.String> customFields,
                             java.lang.String userNameDisplayType)

  получение списка часто выбираемых пользователей пользователей url: /rest/api/userchooser/getOftenChosenUsers method : GET
  startRecord C какой записи поднимать пользователей
  recordsCount Какое кол-во записей поднимать
  locale локаль пользователя
  showAll Если значение переменной стоит true, то должны быть отображены не только подчиненные но и все пользователи
  search Строка поиска
  operationType Тип действия Если данный параметр задан, то список пользователей будет подгружаться не только от имени actorID, но и от имени тех пользователей, которые делегировали ему право на operationType
  ownerOperationType Если данный параметр задан, то список пользователей в выборке ограничивается теми пользователями, которые делегировали actorID право на ownerOperationType и самим actorID
  filterPositionID UUID должности - фильтра. В чузере отображаются только пользователи, занимающие данную должность
  filterDepartmentID UUID подразделения - фильра. В чузере отображаются только пользователи, занимающие должность в данном подразделении (рекурсивно)
  positionType Тип должности
  customFields перечень дополнительных полей, которые можно подгрузить для данного пользователя (передаются параметрами с названием customField=) может принимать одно значение is_inferior
  userNameDisplayType тип отображения имени пользователя (full, short)

  Returns:

  список пользователей с полями
  personName имя (полное в формате)
  personID идентификатор
  departmentName наименование департамента
  positionName должность
  customFields доп поля (которые запрашивались)
  lastname фамилия
  firstname имя
  patronymic отчество
  
  если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

• getPositions

  public Response getPositions(int startRecord,
                      int recordsCount,
                      boolean showAll,
                      boolean showOnlyVacant,
                      java.lang.String locale,
                      java.lang.String userID,
                      java.lang.Integer operationType,
                      java.lang.String search,
                      java.lang.String departmentID,
                      java.lang.String filterDepartmentID,
                      java.lang.String filterUserID,
                      java.util.List<java.lang.String> customFields)

  получение списка должностей url: /rest/api/userchooser/search_pos method : GET
  startRecord - по умолчанию 0
  recordsCount - по умолчанию 30
  locale - локаль
  departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть
  search параметр текстового поиска
  showAll - false по умолчанию; отображать все должности (false - отображать подчиненные должности)
  showOnlyVacant - false по умолчанию, отображать только вакантные должности
  operationType - тип операции для получения пользователей которые делегировали права пользователю (по ним определяется максимальный уровень иерархии верх который нужно отображать и подчиненные должности)
  mode - по умолчанию 0(COMMON_MODE). Если 1(OFTEN_CHOSEN_MODE)
  actorID пользователь от имени которого выполнять поиск
  customFields не используется
  filterDepartmentID идентификатор непосредственного родительского подразделения
  filterUserID идентификатор пользователя чьи должности необходимо показать

  Returns:

  массив найденных должностей поля возвращаемой сущности
  code код
  departmentName наименование департамента
  elementID идентификатор должности
  elementName наименование должности
  translation не используется
  type не используется
  customFields не используется
  
  если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

• getAllPositions

  public Response getAllPositions(int startRecord,
                         int recordsCount,
                         boolean showOnlyVacant,
                         java.lang.String locale,
                         java.lang.String userID,
                         java.lang.String search,
                         java.lang.String departmentID,
                         java.lang.String filterDepartmentID,
                         java.lang.String filterUserID)

  получение списка должностей url: /rest/api/userchooser/search_all_positions method : GET
  startRecord - по умолчанию 0
  recordsCount - по умолчанию 30
  locale - локаль
  departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть
  search параметр текстового поиска
  showOnlyVacant - false по умолчанию, отображать только вакантные должности
  actorID пользователь от имени которого выполнять поиск
  filterDepartmentID идентификатор непосредственного родительского подразделения
  filterUserID идентификатор пользователя чьи должности необходимо показать

  Returns:

  массив найденных должностей поля возвращаемой сущности
  code код
  departmentName наименование департамента
  elementID идентификатор должности
  elementName наименование должности
  translation не используется
  type не используется
  customFields не используется
  
  если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

• getOftenPositions

  public Response getOftenPositions(int startRecord,
                           int recordsCount,
                           boolean showAll,
                           boolean showOnlyVacant,
                           java.lang.String locale,
                           java.lang.String userID,
                           java.lang.Integer operationType,
                           java.lang.String search,
                           java.lang.String departmentID,
                           java.lang.String filterDepartmentID,
                           java.lang.String filterUserID,
                           java.util.List<java.lang.String> customFields)

  получение списка часто выбираемых должностей url: /rest/api/userchooser/getOftenChosenPositions method : GET
  startRecord - по умолчанию 0
  recordsCount - по умолчанию 30
  locale - локаль
  departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть
  search параметр текстового поиска
  showAll - false по умолчанию; отображать все должности (false - отображать подчиненные должности)
  showOnlyVacant - false по умолчанию, отображать только вакантные должности
  operationType - тип операции для получения пользователей которые делегировали права пользователю (по ним определяется максимальный уровень иерархии верх который нужно отображать и подчиненные должности)
  mode - по умолчанию 0(COMMON_MODE). Если 1(OFTEN_CHOSEN_MODE)
  actorID пользователь от имени которого выполнять поиск
  customFields не используется
  filterDepartmentID идентификатор непосредственного родительского подразделения
  filterUserID идентификатор пользователя чьи должности необходимо показать

  Returns:

  массив найденных должностей поля возвращаемой сущности
  code код
  departmentName наименование департамента
  elementID идентификатор должности
  elementName наименование должности
  translation не используется
  type не используется
  
  если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

• getDepartments

  public Response getDepartments(int pageNumber,
                        int countInPart,
                        java.lang.String departmentID,
                        java.lang.String filterDepartmentID,
                        java.lang.String filterChildDepartmentID,
                        java.lang.String filterPositionID,
                        java.lang.String search,
                        boolean showChildDepartments,
                        java.lang.String filterHrUser,
                        java.lang.String filterUserID,
                        java.lang.String locale)

  получение списка департаментов url: /rest/api/userchooser/search_dept method : GET
  startRecord - по умолчанию 0
  recordsCount - по умолчанию 30
  locale - локаль
  departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть
  search параметр текстового поиска
  filterDepartmentID идентификатор непосредственного родительского подразделения
  filterChildDepartmentID идентификатор непосредственного родительского подразделения
  filterPositionID идентификатор непосредственного родительского подразделения
  filterUserID идентификатор пользователя чьи должности необходимо показать

  Returns:

  массив найденных должностей поля возвращаемой сущности
  departmentId -идентификатор департамента
  departmentName наименование
  hasChildren имеются ли дочерние подразделения
  parentName наименование родительского департамента
  
  если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

• checkDepartments

  public Response checkDepartments(int pageNumber,
                          int countInPart,
                          java.lang.String departmentID,
                          java.lang.String filterDepartmentID,
                          java.lang.String filterChildDepartmentID,
                          java.lang.String filterPositionID,
                          java.lang.String search,
                          boolean showChildDepartments,
                          java.lang.String filterHrUser,
                          java.util.List<java.lang.String> valuesToCheck,
                          java.lang.String filterUserID,
                          java.lang.String locale)

  проверка подходят ли переданные департаменты под указанные параметры поиска url: /rest/api/userchooser/checkDepartments method : GET
  startRecord - по умолчанию 0
  recordsCount - по умолчанию 30
  locale - локаль
  departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть
  search параметр текстового поиска
  customFields не используется
  filterDepartmentID идентификатор непосредственного родительского подразделения
  filterChildDepartmentID идентификатор непосредственного родительского подразделения
  filterPositionID идентификатор непосредственного родительского подразделения
  filterUserID идентификатор пользователя чьи должности необходимо показать
  valuesToCheck проверяемые значения идентификаторов передается как valuesToCheck=identifier1&valuesToCheck=identifier2

  Returns:

  массив найденных департаментов поля возвращаемой сущности
  departmentId -идентификатор департамента
  departmentName наименование
  hasChildren имеются ли дочерние подразделения
  parentName наименование родительского департамента
  
  если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

Constructor Detail

• AddressBookService

  public AddressBookService()

Method Detail

• getAddressBookItem

  public java.lang.String getAddressBookItem(java.lang.String itemID,
                                    java.lang.String locale)

  Получение данных об объекте из адресной книги по id
  Тип: GET
  URL: rest/api/addressbook/get_addressbook_item

  Parameters:

  itemID - - id объекта

  locale - - локаль

  Returns:

  - json с данными

  
  Пример персона
  {
  "type": "person",
  "lastName": "Иванов",
  "firstName": "Иван",
  "patronymic": "Иванович",
  "birthDate": "1993-10-12",
  "isPublic": "false",
  "photoUrl": "contact_photo?itemID=6de27bc6-1da0-4fec-b03f-5d917c3f3413",
  "note": "Пример примечания",
  "tags": "Ключевое слово1, Ключевое слово2",
  "formUUID": "null",
  "formCode": "",
  "phone": [
  "230101"
  ],
  "im": [
  "i.ivanov@jabber.arta.kz"
  ],
  "mail": [
  "ivanov_ivan@ivan.ru"
  ],
  "mobile": [
  "87022301010",
  "87012301010"
  ],
  "url": [
  "http://ww.kz"
  ]
  }
  Поле photoUrl - относительная ссылка на фото, добавляется к url, пример: http://127.0.0.1:8080/Synergy/contact_photo?itemID=6de27bc6-1da0-4fec-b03f-5d917c3f3413

• getAddressBookItems

  public Response getAddressBookItems(int countInPart,
                             int pageNumber,
                             java.lang.String search,
                             java.lang.String startLetter,
                             int itemType,
                             java.lang.String userID,
                             java.lang.String locale)

  Parameters:

  countInPart - сколько элементов в одной странице, по умолчанию 15

  pageNumber - номер страницы, по умолчанию 0

  search - текст поска

  startLetter - точно не знаю

  itemType - 0 искать по пользователям, 1 искать по организациям по умолчанию 0.

  userID - пользователь, чья адресная книга просматривается

  locale - локаль

  Returns:

Constructor Detail

• TranslationService

  public TranslationService()

Method Detail

• getSynergyLocales

  public java.util.List<SynergyLocale> getSynergyLocales(boolean visible)

  Description copied from interface: TranslationServiceIF
  Получение языков находящихся в Synergy

  Specified by:

  getSynergyLocales in interface TranslationServiceIF

  Parameters:

  visible - - только видимые

• saveLocales

  public java.lang.Boolean saveLocales(java.util.List<SynergyLocale> locales)

  Description copied from interface: TranslationServiceIF
  Сохранение локалей

  Specified by:

  saveLocales in interface TranslationServiceIF

  Parameters:

  locales - - список локалей

• getTranslations

  public EntityTranslation getTranslations(long translationID)

  Description copied from interface: TranslationServiceIF
  Получение переводов по id перевода

  Specified by:

  getTranslations in interface TranslationServiceIF

  Parameters:

  translationID - - id перевода

• saveTranslations

  public java.lang.Long saveTranslations(EntityTranslation entityTranslation)

  Description copied from interface: TranslationServiceIF
  Сохранение переводов

  Specified by:

  saveTranslations in interface TranslationServiceIF

  Parameters:

  entityTranslation - - переводы

• getTranslationSize

  public Translation getTranslationSize(int entityType,
                               boolean notTranslated)

  Description copied from interface: TranslationServiceIF
  Получение количества записей при запросе ресурсов

  Specified by:

  getTranslationSize in interface TranslationServiceIF

• removeTranslations

  public java.lang.Boolean removeTranslations(long translationID)

  Description copied from interface: TranslationServiceIF
  Удаление перевода сущности

  Specified by:

  removeTranslations in interface TranslationServiceIF

  Parameters:

  translationID - - id перевода

• saveResourceTranslations

  public java.lang.Boolean saveResourceTranslations(java.util.List<TranslationObject> translations)

  Description copied from interface: TranslationServiceIF
  Сохранение переводов сущностей и переводов сообшений, используется в редакторе ресурсов

  Specified by:

  saveResourceTranslations in interface TranslationServiceIF

  Parameters:

  translations - - список объектов с переводами

• searchObjects

  public java.util.List<TranslationObject> searchObjects(java.lang.String localeID,
                                                java.lang.String searchString,
                                                int start,
                                                int length,
                                                int entityType,
                                                boolean notTranslated)

  Description copied from interface: TranslationServiceIF
  Поиск объектов соответствующий запросу частями

  Specified by:

  searchObjects in interface TranslationServiceIF

  Parameters:

  localeID - - локаль

  searchString - - строка поиска, может быть пустой, тогда будет выборка из всех, нужно для выборки по типу и непереведенности

  start - - откуда начинать выбирать

  length - - сколько выбрать

  entityType - - тип сущности

  notTranslated - - выбирать только не переведенные

• getSearchObjectsSize

  public java.lang.Integer getSearchObjectsSize(java.lang.String localeID,
                                       java.lang.String searchString,
                                       int entityType,
                                       boolean notTranslated)

  Description copied from interface: TranslationServiceIF
  Получение размера возвращаемого результата при поиске

  Specified by:

  getSearchObjectsSize in interface TranslationServiceIF

  Parameters:

  localeID - - локаль

  searchString - - строка поиска, может быть пустой, тогда будет выборка из всех, нужно для выборки по типу и непереведенности

  entityType - - тип сущности

  notTranslated - - выбирать только не переведенные

• getLocale

  public java.lang.String getLocale()

Constructor Detail

• DelegationService

  public DelegationService()

Method Detail

• getDelegatedActions

  public java.lang.String getDelegatedActions(java.lang.String userID,
                                     java.lang.String delegatedID,
                                     int objectType,
                                     java.lang.String locale)

  Возвращает список делегированных пользователю прав сгруппированных по типу объекта

  
  

  URL rest/api/delegation/get_delegated_actions
  Method GET
  
  Возвращает список делегированных пользователю прав как список json
  Поля одного права
  
  actionID - id права
  actionName - название права
  isDelegated - признак назначенного делегированного права
  isRequired - признак обязательности права
  
  Пример
  http://хост:порт/Synergy/rest/api/delegation/get_delegated_actions?userID=966f46bf-7c95-4e16-93b7-69ead48a94cd&objectType=0
  
  

  Parameters:

  userID - uuid пользователя - обязательный параметр

  delegatedID - uuid пользователя, кем были делегированы права, если не указано возвращаются все права пользователя

  objectType - тип объекта, если 0 возвращаются права по всем типам

  locale - локаль пользователя

  Returns:

  возвращается json вида
  [{objectType: 4, actions: [{"actionID": "111", "actionName": "Просмотр", "isDelegated": true, "isRequired": true }, {"actionID": "106", "actionName": "Изменение процента выполнения", "isDelegated": true, "isRequired": false }]}, {objectType: 8, actions: []}, {objectType: 64, actions: []}]

• delegatedActions

  public java.lang.String delegatedActions(java.lang.String locale)

  Возвращает список делегированных пользователем прав

  
  

  URL rest/api/delegation/delegated_actions
  Method GET
  

  Parameters:

  locale - локаль пользователя

  Returns:

  возвращается json вида
  
  {
  "delegatedTasks": [{
  "userId": "id",
  "userName": "Фамилия И.",
  "actions":[{"actionId" :6, "actionName": "Просмотр" }]
  }],
  "delegatedActions": [{
  "userId": "id",
  "userName": "Фамилия И.",
  "actions":[{"actionId" :130, "actionName": "Просмотр" }]
  }],
  "delegatedAssignments": [{
  "userId": "id",
  "userName": "Фамилия И.",
  "actions":[{"actionId" :111, "actionName": "Просмотр" }]
  }]
  }

• addDelegatedActions

  public java.lang.String addDelegatedActions(java.lang.String userID,
                                     java.util.ArrayList<java.lang.String> actionID,
                                     java.lang.String locale)

  Добавление делегированных прав на выполнение действий в системе

  
  URL: rest/api/delegation/add_delegated_actions
  Method POST

  Parameters:

  userID - UUID пользователя, которому делегированы права (обяз., FormParam)

  actionID - ID действий, на которые следует добавить права (целое число, обяз., FormParam) Возможные значения перечислены в описании класса - константы из OperationType

  locale - локаль пользователя (QueryParam)

  Returns:

  json объект с полями - errorCode - код выполнения операции (0 успешно, иначе - ошибка)

• deleteDelegatedActions

  public java.lang.String deleteDelegatedActions(java.lang.String userID,
                                        java.util.ArrayList<java.lang.String> actionID,
                                        java.lang.String locale)

  Удаление делегированных прав на выполнение действий в системе

  
  URL: rest/api/delegation/delete_delegated_actions
  Method POST

  Parameters:

  userID - UUID пользователя, которому делегированы права (обяз., FormParam)

  actionID - ID действий, права на которые следует удалить (целое число, обяз., FormParam). Возможные значения перечислены в описании класса - константы из OperationType

  locale - локаль пользователя (QueryParam)

  Returns:

  json объект с полями - errorCode - код выполнения операции (0 успешно, иначе - ошибка)

Field Detail

• WORK

  public static final java.lang.String WORK

  Комментарии для работы

  See Also:

  Constant Field Values

• DOCUMENT

  public static final java.lang.String DOCUMENT

  Комментарии для документа

  See Also:

  Constant Field Values

• PERSONAL

  public static final java.lang.String PERSONAL

  Личные комментарии

  See Also:

  Constant Field Values

Constructor Detail

• WorkFlowService

  public WorkFlowService()

Method Detail

• getWorks

  public Response getWorks(int startRecord,
                  int recordsCount,
                  java.lang.String search,
                  java.lang.String filterType,
                  java.lang.String filterID,
                  java.lang.String objectID,
                  java.lang.String sortColumn,
                  boolean isAscSort,
                  boolean hasExtSearchParams,
                  int periodType,
                  java.lang.String extStartDate,
                  java.lang.String extFinishDate,
                  boolean extShowCompleted,
                  boolean extShowDeleted,
                  int extDateSearchType,
                  java.lang.String userID,
                  java.lang.String locale)

  Возвращает список работ пользователя userID.

  URL rest/api/workflow/works/list/{userID}
  Method GET

  Parameters:

  startRecord - номер записи начала списка

  recordsCount - максимальное количество записей в списке, 0 - если необходимо получить все записи списка

  search - строка фильтра

  filterType - одно из значений перечисления WorkFilterType, если filterType DELEGATED, то userID должен быть равным objectID, если они не равны, то userID заменяется на objectID, поскольку objectID - UUID пользователя, чью работы просматриваются в автофильтре делегированные

  На исполнении
  OWN_WORKS,
  На контроле
  ON_CONTROL,
  протокольные
  PROTOCOL_WORKS,
  проектные
  PROJECT_WORKS,
  автофильтр делегированные
  DELEGATED,
  группы
  GROUPS;
  

  filterID - UUID пользовательского фильтра

  objectID - UUID объекта фильтра (например проекта, группы работ, пользователя)

  sortColumn - название столбца сортировки

  isAscSort - true - прямой порядок сортировки, false - обратный

  hasExtSearchParams - заданы ли параметры расширенного фильтра, нижеследующие переменные, начинающиеся с ext имеют смысл, только если значение данной переменной true

  periodType - целочисленная переменная, приминающая следующие значения
  

  Текущие мероприятия
  SEARCH_TYPE_CURRENT = 0;
  Мероприятия за произвольный промежуток времени
  SEARCH_TYPE_CUSTOM = 1;
  Будущая неделя (+7 дней от текущей даты)
  NEAREST_WEEK_ACTIONS = 2;
  Будущий месяц (+1 месяц от текущей даты)
  NEAREST_MONTH_ACTIONS = 3;
  Будущий квартал (+3 месяца от текущей даты)
  NEAREST_QUARTER_ACTIONS = 4;
  Прошедшая неделя (-7 дней от текущей даты)
  LATEST_WEEK_ACTIONS = 7;
  Прошедший месяц (-1 месяц от текущей даты)
  LATEST_MONTH_ACTIONS = 8;
  Прошедший квартал (-3 месяца от текущей даты)
  LATEST_QUARTER_ACTIONS = 9;
  Сегодня
  NEAREST_DAY_ACTIONS = 6;
  

  extStartDate - дата начала поискового периода, имеет смысл если значение periodType=SEARCH_TYPE_CUSTOM, format dd-MM-yyyy

  extFinishDate - дата начала поискового периода, имеет смысл если значение periodType=SEARCH_TYPE_CUSTOM, format dd-MM-yyyy

  extShowCompleted - true - отображать завершенные, false - не отображать

  extShowDeleted - true - отображать удаленные, false - не отображать

  extDateSearchType - целочисленная переменная, принимающая следующие значения
  

  Поиск по всем датам
  SEARCH_DATES_ALL = 0;
  Поиск по дате завершения
  SEARCH_DATES_STARTDATE = 1;
  Поиск по дате начала
  SEARCH_DATES_FINISHDATE = 2;
  Поиск по дате фактического завершения
  SEARCH_DATES_FINISHED = 3;
  

  userID - UUID пользователя

  locale - локаль пользователя

  Returns:

  список работ

  Если авторизованный пользователь не имеет право видеть список работ userID, то вернется ошибка

    {
     "errorCode":2,
     "errorMessage":"У вас нет доступа к списку работ указанного пользователя"
     }
    

  See Also:

  arta.synergy.web.common.client.data.actions.filter.WorkFilterType, arta.synergy.web.common.client.constants.SearchConstants, arta.synergy.web.common.client.data.actions.ActionSearchParams, WorkUtilWrapper#getWorkJson(arta.synergy.web.common.client.data.actions.Action, arta.synergy.web.common.client.data.mbo.User, String, String)

• getWorksById

  public java.lang.String getWorksById(java.util.List<java.lang.String> workID,
                              java.lang.String locale)

  Возвращает список работ по их идентификаторам

  URL rest/api/workflow/works_by_id
  Method GET

  Parameters:

  workID - идентификатор работы (параметр может передан несколько раз)

  locale - локаль пользователя

  Returns:

• getFilters

  public java.lang.String getFilters(java.lang.String filterType,
                            java.lang.String parentID,
                            java.lang.String parentObjectID,
                            boolean getCounters,
                            java.lang.String locale,
                            java.lang.String userID)

  Возвращает список фильтров пользователя.

  URL rest/api/workflow/works/filters/{userID}
  Method GET

  
  Про фильтры:
  Фильтры имеют иерархическую структуру. Условно фильтры можно разделить на четыре категории:
  1. Фильтры первого уровня
  Это фильтры находящиеся на первом уровне иерархии, например: на исполнении, на контроле и т.д. Такие фильтры характеризуются только типом фильтра.
  2. Статические фильтры
  Это постоянные фильтры, физически хранящиеся в БД, каждый такой фильтр имеет свой уникальный идентификатор, характеризуется идентификатором, типом и идентификатором родительского фильтра (если такой существует)
  3. Динамические фильтры
  Это фильтры динамически формируемые согласно объектам родительского фильтра. Например, содержимое фильтра "На контроле" - это динамические фильтры, каждый фильтр соответствует пользователю; аналогично у фильтра Проекты - состав так же динамический, зависит от количества проектов, по которым у данного пользователя есть работы. Эти фильтры не фиксированные и в базе не хранятся и не имеют собственных идентификаторов, главный характеризующий их признак - тип фильтра и идентификатор объекта.
  4. Статические подфильтры динамических фильтров
  Это фильтры хранящиеся в БД, но отбражающиеся пользователю только в случае если отображается родительский фильтр. Для фильтров данного типа характеризуюшими параметрами являются - тип фильтра, идентификатор фильтра, тип родительского объекта, идентификатор родительского фильтра (если такой существует)

  
  Для использования API надо руководствоваться несколькими правилами:
  1. Корневые элементы можно получить отправив запрос без параметров
  2. Для получения дочерних элементов корневых фильров надо передать один параметр - тип фильтра
  3. Для получения дочерних элементов динамического фильтра надо передать два парамтра - тип фильтра и идентификатор объекта родительского фильтра
  4. Для получения дочерних элементов фильтра, имеющего идентификатор, надо передать - тип и идентификатор
  
  Примеры
  
  Для получения корневых элементов, надо послать запрос
  rest/api/workflow/works/filters/{userID}
  
  Рассмотрим получение статических фильтров. Допустим у нас есть фильтр верхнего уровня с типом OWN_WORKS, описание которого выглядит следующим образом:
  {"name": "На исполнении", "filterType":"OWN_WORKS"},
  для получения его дочерних фильтров надо послать запрос:
  rest/api/workflow/works/filters/{userID}?filterType=OWN_WORKS
  Допустим в результате был возвращен фильтр с uuid-ом filterUUID-1 который описывается, так:
  {"filterID": "filterUUID-1", "name": "На подпись", "filterType":"OWN_WORKS"}
  чтобы получить его дочерние фильтры необходимо отправить такой запрос
  rest/api/workflow/works/filters/{userID}?filterType=OWN_WORKS&parentID=filterUUID-1
  
  Рассмотрим получение динамических фильтров.

  Допустим у нас есть фильтр верхнего уровня, который может содержать динамически формируемые подфильтры и тип этого фильтра PROJECT_WORKS. Для получения его подфильтров необходимо отправить запрос:
  rest/api/workflow/works/filters/{userID}?filterType=PROJECT_WORKS
  Например, среди возвращенных фильтров был следующий
  {"objectID": "b2b78b71-2419-4ef1-a834-a74125dfbdf5", "name": "План моих работ"}
  Тогда получение его дочерних фильтров будет выглядеть:
  rest/api/workflow/works/filters/{userID}?filterType=PROJECT_WORKS&parentObjectID=b2b78b71-2419-4ef1-a834-a74125dfbdf5
  И в результате получим ответ:
  {"parentObjectID": "b2b78b71-2419-4ef1-a834-a74125dfbdf5", "filterID": "ee230d4f-6def-4d1c-9127-092a0963d029", "name": "от Руководителя"}
  Для того чтобы получить дочерние элементы этого фильтра необходимо отправить запрос:
  rest/api/workflow/works/filters/{userID}filterType=PROJECT_WORKS&parentID=ee230d4f-6def-4d1c-9127-092a0963d029

  Parameters:

  filterType - тип фильтра,

  parentID - UUID родительского фильтра

  parentObjectID - UUID объекта родительского фильтра

  locale - локаль пользователя

  userID - UUID пользователя

  Returns:

  список фильтров в формате json

  See Also:

  WorkUtilWrapper#getFilterJson(arta.synergy.web.common.client.data.actions.filter.Filter, arta.synergy.web.common.client.data.actions.WorkCounters), arta.synergy.ejb.works

• getComments

  public java.lang.String getComments(java.lang.String workID,
                             int start,
                             int count,
                             boolean getCounters,
                             java.lang.String type,
                             java.lang.String locale)

  Возвращает комментарии к работе отсортированные в обратном порядке по дате добавления

  
  

  URL rest/api/workflow/work/{workID}/comments
  Method GET
  
  Возвращает информацию о комментариях как список json
  Поля одного комментария
  
  commentID - uuid комментария
  comment - текст комментария
  author - автор
  author.userID - uuid автора
  author.name - имя автора же
  created - дата создания
  comment_icon_type - тип иконки комментария
  created_label - время от даты создания либо время создания
  type - тип, константы в arta.synergy.web.common.client.constants.CommentType
  is_editable - возможно ли редактирование данного комментария
  is_deletable - возможно ли удаление данного комментария
  
  Пример получения последних трех комментариев
  http://хост:порт/Synergy/rest/api/workflow/work/uuid_работы/comments?count=3
  
  

  Parameters:

  workID - uuid работы

  start - номер первой записи (отсчет с 0)

  count - количество записей в возвращаемом списке

  type - для чего получаем комментарии (WORK - работа, DOCUMENT - документ принадлежащий работе, PERSONAL - личные комментарии)

  getCounters - true - получить количество комментариев, иначе - false

  locale - локаль пользователя

  Returns:

  Если getCounters= true, возвращается json вида
  {list: [{комментарий_1}, {комментарий_2}, ..., {комментарий_n}], count: количество_комментариев_в_фильтре}
  Если getCounters=false, возвращается просто список комментариев [{комментарий_1}, {комментарий_2}, ..., {комментарий_n}]

  See Also:

  arta.synergy.web.common.client.constants.CommentType

• addComment

  public java.lang.String addComment(java.lang.String workID,
                            java.lang.String commentID,
                            java.lang.String comment,
                            java.lang.String type,
                            java.lang.String locale)

  Добавляет/изменяет комментарий к работе

  
  

  URL rest/api/workflow/work/{workID}/comments/save
  Method POST
  

  Parameters:

  workID - uuid работы

  commentID - uuid комментария, для добавления нового комментария - не передавать

  comment - текст комментария (передается как параметр формы)

  locale - локаль пользователя

  type - если к работе добавляется личный комментарий - передать: PERSONAL

  Returns:

  код выполнения result и сообщение об ошибке message в случае неуспешного выполнения. Если result = 0, выполнено успешно, иначе произошла ошибка

• addAttachment

  public java.lang.String addAttachment(java.lang.String workID,
                               MultipartFormDataInput input,
                               java.lang.String path,
                               java.lang.String locale)

  Deprecated. используйте StorageService#startUploadFile и createAttachment

  Добавляет файл к работе

  
  

  URL rest/api/workflow/work/{workID}/attachment/add
  Method POST
  Enctype multipart/form-data

  
  

  
  название поля формы для вложения - body

  Parameters:

  workID - uuid работы

  path - строка показывающая, в какую подпапку контейнера файлов работы необходимо положить файл. Возможные значения:

  • ase:attachmentContainer (DocFileType.INBOX_FILE)
  • ase:workContainer (DocFileType.WORK_FILE)

  locale - локаль пользователя

  Returns:

  код выполнения result и сообщение об ошибке message в случае неуспешного выполнения. Если result = 0, выполнено успешно, иначе произошла ошибка

• createAttachment

  public java.lang.String createAttachment(java.lang.String workID,
                                  java.lang.String path,
                                  java.lang.String fileName,
                                  java.lang.String filePath,
                                  java.lang.String locale)

  Метод добавляет вложение к работе из временного файла, загруженного на сервер с помощью API хранилища

  URL work/{workID}/attachment/create
  Method POST

  Parameters:

  workID - UUID работы

  path - строка показывающая, в какую подпапку контейнера файлов работы необходимо положить файл. Возможные значения:

  • ase:attachmentContainer (DocFileType.INBOX_FILE)
  • ase:workContainer (DocFileType.WORK_FILE)

  fileName - Название загружаемого файла

  filePath - Путь к временному файлу, загруженному на сервер

  locale - локаль пользователя

  Returns:

  json объект с полями - result - код выполнения операции (0 - успешно, 666 - предупреждение (на добавление файла во вложения нет прав, и файл добавился в прочие), 13 - внутреняя ошибка сервера или ошибка данных), В случае успешного выполнения так же возвращается полная информация о работе.

  See Also:

  StorageService.startUploadFile(String), StorageService#uploadPart(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput, String, String)

• doCreateAttachment

  public java.lang.String doCreateAttachment(java.lang.String workID,
                                    java.lang.String path,
                                    java.lang.String fileName,
                                    java.lang.String filePath,
                                    java.lang.String locale,
                                    int successResult,
                                    java.lang.String successMessage)

• deleteComment

  public java.lang.String deleteComment(java.lang.String commentID,
                               java.lang.String locale)

  Удаляет комментарий

  URL rest/api/workflow/work/comments/remove
  Method GET
  
  Пример удаления комментария

  
  

  Parameters:

  commentID - uuid комментария

  locale - локаль пользователя

  Returns:

• getAttachments

  public java.lang.String getAttachments(java.lang.String workID,
                                int count,
                                boolean getCounters,
                                java.lang.String locale)

  Возвращает отсортированный в обратном порядке по дате добавления список файлов работы (из вложений и прочих)

  URL rest/api/workflow/work/{workID}/last_attachments
  Method GET

  
  
  Возвращает информацию о вложениях как список json.
  Поля одного вложения
  uuid - идентификатор файла
  dataUUID - идентификатор данных по форме (только если это файл по форме)
  mobile - имеется ли мобильное представление у формы (только если это файл по форме)
  name - название файла
  is_editable - возможно ли изменять/удалять файл
  created_label - читабельное время создания файла от текущего момента
  created - время создания файла
  icon урл изображения для предпросмотра, в случае его отсутствия - урл иконки типа файла
  
  Пример запроса на получение трех последних вложений
  http://хост:порт/Synergy/rest/api/workflow/work/uuid_работы/last_attachments?count=3
  

  Parameters:

  workID - uuid работы

  count - количество файлов которое должно быть возвращено (по умолчанию 0)

  getCounters - если true, метод так же возвращает общее количество вложений данной работы

  locale - локаль пользователя

  Returns:

  Если getCounters= true, возвращается json вида
  {list: [{вложение_1}, {вложение_2}, ..., {вложение_n}], count: количество_вложений работы}
  Если getCounters=false, возвращается просто список вложений [{вложение_1}, {вложение_2}, ..., {вложение_n}]

• getWorkDocumentInfo

  public java.lang.String getWorkDocumentInfo(java.lang.String workID,
                                     java.lang.String locale)

  Возвращает информацию о документе, соответствующем данной работе

  URL rest/api/workflow/work/{workID}/document
  Method GET
  
  
  

  Parameters:

  workID - UUID работы

  locale - локаль пользователя

  Returns:

  json c полями:
  documentID

• getFullAttachments

  public java.lang.String getFullAttachments(java.lang.String workID,
                                    java.lang.String locale)

  Возвращает все файлы данной работы по двум группам - вложения и прочие

  URL rest/api/workflow/work/{workID}/attachments
  Method GET

  
  
  Возвращает информацию о файлах как объект json:
  
  [{attachments: [..list of attachments ..]}, {work_files: [..list of work files ..]}]
  
  Каждый файл из attachments и work_files описывается следующими полями
  uuid - идентификатор файла
  name - название файла
  is_editable - возможно ли изменять/удалять файл
  created_label - читабельное время создания файла от текущего момента
  created - время создания файла
  icon урл изображения для предпросмотра, в случае его отсутствия - урл иконки типа файла
  
  Пример ответа, в котором есть один файл вложений и один файл прочих
  

            [{"attachments":
                [{"uuid": "d55ae76a-f451-452d-93cb-3c6b28ba2335",
                  "name": "Изображение.jpg",
                  "created_label": "15 минут назад",
                  "created": "2013-06-26 09:12:54","icon":
                  "preview?identifier=d55ae76a-f451-452d-93cb-3c6b28ba2335"}]
             },
             {"work_files":
                [{"uuid": "d55ae76a-f451-452d-93cb-3c6b28ba2332",
                  "name": "Документ.doc",
                  "created_label": "15 минут назад",
                  "created": "2013-06-26 09:12:54","icon":
                  "preview?identifier=d55ae76a-f451-452d-93cb-3c6b28ba2332"}]
             }]
   

  Parameters:

  workID - - uuid работы

  locale - - локаль пользователя

  Returns:

• deleteAttachment

  public java.lang.String deleteAttachment(java.lang.String nodeUUID,
                                  java.lang.String locale)

  Удаляет файл вложений к работе

  URL rest/api/workflow/work/remove_file
  Method GET

  Parameters:

  nodeUUID - идентификатор файла который надо удалить

  locale - локаль пользователя

  Returns:

  Объект json с полями
  errorCode код выполнения (0- успешно, иначе - ошибка)
  errorMessage сообщение, характеризующее успешное выполнение либо ошибку

• getDefaultWorkFields

  public java.lang.String getDefaultWorkFields(java.lang.String locale)

  Возвращает значения по умолчанию для создания новой работы в формате yyyy-MM-dd HH:mm

  URL rest/api/workflow/work/create_defaults
  Method GET

  Parameters:

  locale -

  Returns:

• createWork

  public java.lang.String createWork(java.lang.String name,
                            java.lang.String startDate,
                            java.lang.String finishDate,
                            java.lang.String userID,
                            java.lang.String authorID,
                            java.util.List<java.lang.String> resUserID,
                            java.lang.String priority,
                            java.lang.String completionFormID,
                            boolean force,
                            java.lang.String moduleID,
                            java.lang.String comment,
                            java.lang.String repeat,
                            java.util.HashSet<java.lang.String> path,
                            java.lang.String locale)

  Создает новую работу и возвращает полную информацию о ней

  URL rest/api/workflow/work/create
  POST POST

  Обязательные для создания работы поля, в списке ниже отмечены *

  Parameters:

  name - *название работе (FormParam)

  startDate - *дата и время начала работы в формате yyyy-MM-dd HH:mm:ss (FormParam)

  finishDate - *дата и время завершения работы в формате yyyy-MM-dd HH:mm:ss (FormParam)

  userID - uuid ответственного (FormParam)

  authorID - *uuid автора работы (FormParam)

  resUserID - uuid исполнителей работы (параметр resUserID должен быть указан столько раз- сколько исполнителей есть у работы, например resUserID=user_uid_1&resUserID=user_uid_2&resUserID=user_uid_3) (FormParam)

  priority - *приоритет (FormParam)

  completionFormID - форма завершения (FormParam)

  locale - локаль (QueryParam)

  force - необходимо передать true для того чтобы можно было создать работу, даже если у авторизованного пользователя нет прав ставить работу исполнителю. Этот параметр принимается в счет только если одновременно передается параметр moduleID, который равен идентификатору внешнего модуля. Это ограничение сделано с целью не допустить без контрольное создание работ в обход системы прав.

  moduleID - идентификатор модуля (из таблицы outer_modules)

  comment - комментарий, который будет добавлен к работе после ее создания

  path - список вложений, которые будут добавлены при создании работы. параметр path должен быть указан столько раз, сколько вложений нужно добавить строка path должна выгядеть слеующим обраом: ПУТЬ:ИМЯ, где: ПУТЬ - путь до врменного файла, созданого на серере при помощи метода rest/api/storage/start_upload, ИМЯ - имя добавляемого вложения

  repeat - данные о периоде повторения работы (не обяз., по умолчанию "Нет");

  Returns:

  json объект с полями - errorCode - код выполнения операции (0 успешно, иначе - ошибка), errorMessage - сообщение об ошибке.
  В случае успешного выполнения так же возвращается полная информация о работе ответственного пользователя. Если работа создается без указания ответственного (только для исполнителей) информация о созданных работах не возвращается.

  See Also:

  WorkUtilWrapper#getCommentJson(arta.synergy.web.common.client.data.actions.ActionComment, String, String), StorageService.startUploadFile(java.lang.String), StorageService#uploadPart(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput, java.lang.String, java.lang.String)

• saveWork

  public java.lang.String saveWork(java.lang.String name,
                          java.lang.String startDate,
                          java.lang.String userID,
                          java.lang.String finishDate,
                          java.lang.String priority,
                          java.lang.String completionFormID,
                          java.lang.String actionID,
                          java.lang.String repeat,
                          java.lang.String locale)

  Изменяет работу и возвращает информацию об измененной работе

  URL rest/api/workflow/work/save
  POST

  Parameters:

  name - название работы

  startDate - дата и время начала работы в формате yyyy-MM-dd HH:mm:00

  finishDate - дата и время завершения работы в формате yyyy-MM-dd HH:mm:00

  priority - приоритет работы

  userID - uuid ответственного

  completionFormID - идентификатор формы завершения

  actionID - uuid работы

  locale - локаль работы

  repeat - данные о периоде повторения работы (не обяз., по умолчанию "Нет");

  Returns:

• getSubWorks

  public java.lang.String getSubWorks(java.lang.String workID,
                             int startRecord,
                             int recordsCount,
                             java.lang.String locale)

  Возвращает работы дочерние для данной работы

  URL rest/api/workflow/subworks/{workID}
  GET

  Parameters:

  workID - uuid работы

  locale - локаль пользователя

  Returns:

  список дочерних работ как json

  See Also:

  WorkUtilWrapper#getCommentJson(arta.synergy.web.common.client.data.actions.ActionComment, String, String)

• deleteWork

  public java.lang.String deleteWork(java.lang.String locale,
                            java.lang.String workID)

  Удаляет работу

  URL rest/api/workflow/work/delete
  GET

  Parameters:

  locale - локаль пользователя

  workID - uuid работы, которую необходимо удалить

  Returns:

  json объект информацию о результате выполнения действия
  errorCode - результат выполнения (0 - успешно, 1 - иначе)
  errorMessage - сообщение о результате выполнения (для положительного и отрицательного результата)

• setWorkProgress

  public java.lang.String setWorkProgress(java.lang.String workID,
                                 int progress,
                                 java.lang.String locale)

  Изменяет прогресс работы

  URL rest/api/workflow/work/set_progress
  Method GET

  Parameters:

  workID - uuid работы

  progress - новое значение прогресса (0-100)

  locale - локаль пользователя

  Returns:

• setWorkState

  public java.lang.String setWorkState(java.lang.String workID,
                              int stateID,
                              java.lang.String locale)

  URL rest/api/workflow/work/set_state
  Method GET

  Parameters:

  workID - UUID работы

  stateID - новый статус работы

  locale - локаль пользователя

  Returns:

  json объект:
  errorCode код выполнения, 0 - успешно, иначе - произошла ошибка
  errorMessage сообщение о результате выполнения (успешном либо не успешном)
  work измененные данные о работе (только в результате успешного выполнения)

  See Also:

  ActionStates#COMPLETED, WorkUtilWrapper#getWorkJson(arta.synergy.web.common.client.data.actions.Action, arta.synergy.web.common.client.data.mbo.User, String, String)

• markWorkSeen

  public java.lang.String markWorkSeen(java.lang.String workID)

  Метод отмечает данную работу как "просмотренную"

  URL rest/api/workflow/work/set_seen
  Method GET

  Parameters:

  workID - uuid работы

  Returns:

  Возвращает json объект о результате выполнения errorCode = 0 - выполнено успешно, иначе - нет

• getWorkCompletionResult

  public java.lang.String getWorkCompletionResult(java.lang.String workID,
                                         java.lang.String locale)

  Метод возвращает информацию о результате завершения данной работы

  URL rest/api/workflow/work/completion_result
  Method GET

  Parameters:

  workID - UUID работы

  locale - локаль пользователя

  Returns:

  объект json с информацией о результате завершения

  See Also:

  WorkUtilWrapper#getJson(arta.synergy.web.common.client.data.actions.completion.CompletionResult, String)

• getWorkActions

  @Deprecated
  public java.lang.String getWorkActions(java.lang.String workID,
                                           java.lang.String locale)

  Deprecated. этот метод считается устаревшим, используйте rest/api/workflow/work_actions

  Возвращает набор действий, которые может совершить авторизованный пользователь над данной работой

  URL rest/api/workflow/work/get_actions
  GET

  
  Каждое действие характеризуется следующими полями:
  action - идентификатор действия, значение из WorkActionType
  operation - идентификатор операции, значение из WorkActionSubType (может отсутствовать)
  label - название действия
  color - идентификатор цвета, значение из ActionColor

  Parameters:

  workID - uuid работы

  locale - локаль пользователя

  Returns:

  массив json объектов с информацией о возможных действиях

  See Also:

  WorkActionType, WorkActionSubType, ActionColor

• getProcessFinishInfo

  public java.lang.String getProcessFinishInfo(java.lang.String workID,
                                      java.lang.String locale)

  Возвращает информацию, необходимую для построения диалога завершения работы по согласованию/утверждению/ознакомлению

  URL rest/api/workflow/process_info
  GET
  
  Поля для описания экрана завершения работы:
  need_comment_input - необходимо ли наличие поля ввода для комментария
  need_enter_positive_comment - обязателен ли ввод комментария при согласии/утверждении
  need_enter_negative_comment - обязателен ли ввод комментария при отказе
  rawdata - Base64 закодированная строка для идентификации подписываемых данных
  demandSign - требовать подписи
  Для каждой кнопки:
  label - Название кнопки
  signal - результат завершения
  color - цвет (значение из ActionColor)
  

  Parameters:

  workID - идентификатор работы

  locale - локаль пользователя

  Returns:

  информацию необходимую для построения экрана завершения работы

  See Also:

  ActionColor

• getSendWorkInfo

  public java.lang.String getSendWorkInfo(java.lang.String workID,
                                 java.lang.String documentID,
                                 java.lang.String actionType,
                                 java.lang.String operationType,
                                 java.lang.String locale)

  Возвращает информацию необходимую для построения диалога отправки работы на согласование/утверждение/ознакомление/перепоручение/передача

  URL rest/api/workflow/send_work_info
  GET
  
  Поля для описания экрана завершения работы:
  name - название отправляемой работы
  finish_date - дата завершения отправляемой работы по-умолчанию (в формате yyyy-MM-dd HH:mm:ss)
  button_name - название кнопки действия
  screen_name - название экрана
  button_color - цвет кнопки действия (константа из ActionColor)
  show_all - true - отображать всех пользователей, false - только подчиненных
  

  Parameters:

  workID - идентификатор работы

  documentID - идентификатор документа

  actionType - идентификатор действия

  operationType - идентификатор операции

  locale - локаль пользователя

  Returns:

  информацию необходимую для построения экрана завершения работы

  See Also:

  ActionColor

• finishProcess

  public Response finishProcess(java.lang.String procInstID,
                       java.lang.String signal,
                       java.lang.String comment,
                       java.lang.String rawdata,
                       java.lang.String signdata,
                       java.lang.String certificate,
                       java.lang.String certID,
                       boolean addSignature,
                       java.lang.String locale)

  Метод завершает процесс согласования/утверждения/ознакомления

  URL rest/api/workflow/finish_process
  Method POST
  

  Parameters:

  procInstID - идентификатор процесса (родительского для процесса работы, поле procInstID работы)

  signal - название сигнала

  comment - комментарий, может отсутствовать

  rawdata - base-64 закодированные подписываемые данные (получаются в методе getProcessFinishInfo/process_info) (параметр обязателен если включена настройка требовать подпись)

  signdata - base-64 закодированные подписанные данные (параметр обязателен если включена настройка требовать ключ и сертификат)

  certificate - base-64 закодированный сертификат пользователя (параметр обязателен при наличии параметра signdata) (обяз. если включена настройка требовать ключ и сертификат)

  certID - идентификатор сертификата, получаемый в методе verificationkey (certID::::sigalg) (обяз. если включена настройка требовать ключ и сертификат)

  addSignature - необходимо ли добавить подпись

  locale - локаль пользователя

  Returns:

  информацию о результате выполнения действия: errorCode = 0 - выполнено успешно, иначе - не выполнено, errorMessage - сообщение об ошибке/успешном выполнении действия

• getWorkCompletionData

  public java.lang.String getWorkCompletionData(java.lang.String workID,
                                       java.lang.String locale)

  Метод возвращает информацию о результате завершения данной работы и список подтвержденных результатов дочерних работ

  URL rest/api/workflow/work/get_completion_data
  Method GET
  

  Parameters:

  workID - UUID работы

  locale - локаль пользователя

  Returns:

  возвращает json следующей структуры:
  result - результат завершения данной работы
  previous_results - список подтвержденных результатов дочерних работ

  See Also:

  WorkUtilWrapper#getJson(arta.synergy.web.common.client.data.actions.completion.CompletionResult, String)

• acceptWorkResult

  public java.lang.String acceptWorkResult(java.lang.String workID,
                                  java.lang.String resultID,
                                  java.lang.String locale)

  Метод подтверждает результат работы

  URL rest/api/workflow/work/accept_result
  Method GET
  

  Parameters:

  workID - UUID работы

  resultID - UUID результата работы

  locale - локаль пользователя

  Returns:

  json объект:
  errorCode код выполнения, 0 - успешно, иначе - произошла ошибка
  errorMessage сообщение о результате выполнения (успешном либо не успешном)
  work измененные данные о работе (только в результате успешного выполнения)

• rejectWorkResult

  public java.lang.String rejectWorkResult(java.lang.String workID,
                                  java.lang.String resultID,
                                  java.lang.String startDate,
                                  java.lang.String finishDate,
                                  int progress,
                                  java.lang.String comment,
                                  java.lang.String locale)

  Метод отклоняет результат работы

  URL rest/api/workflow/work/reject_result
  Method POST
  

  Parameters:

  workID - UUID работы

  resultID - UUID результата работы

  startDate - дата время начала работы в формате yyyy-MM-dd HH:mm

  finishDate - дата время завершения работы в формате yyyy-MM-dd HH:mm

  progress - измененный прогресс работы

  comment - комментарий отклонения

  locale - локаль пользователя

  Returns:

  json объект:
  errorCode код выполнения, 0 - успешно, иначе - произошла ошибка
  errorMessage сообщение о результате выполнения (успешном либо не успешном)
  work измененные данные о работе (только в результате успешного выполнения)

• setWorkResult

  public java.lang.String setWorkResult(java.lang.String workID,
                               java.lang.String completionForm,
                               java.lang.String locale)

  Задает результат завершения работы

  
  

  URL rest/api/workflow/work/set_result
  Method POST

  
  Набор полей передаваемых методу зависит от формы завершения данной работы.
  Для формы завершения файл надо передать поля:
  type должно быть равно file, если выбран новый файл, storage - если выбран файл из хранилища, work - если выбран файл работы.
  file_identifier идентификатор файла, нужен если type == storage || type == work
  file_name название файла, нужен если type == storage || type == work || type == file
  file_path путь ко временному файлу результата, type = file (для загрузки файла надо использовать методы StorageService#startUploadFile и StorageService#uploadPart)
  
  Для формы завершения комментарий надо передать поле:
  comment сам комментарий результата
  
  Для того, чтобы в качестве собственного результата завершения данной работы указать подтвержденный результат дочерней работы необходимо передать поле:
  resultID идентификатор результата завершения дочерней работы
  
  
  Примеры параметров для задания результата.
  Для формы завершения "комментарий"
  workID=UUID_работы
  completionForm=COMMENT
  comment=Текст комментария о резульате завершения работы
  
  Для формы завершения "файл" (выбор нового файла с устройства)
  workID=UUID_работы
  completionForm=FILE
  type=file
  file_name=Название_выбранного_изображения.png
  file_path=Путь_ко_временному_файлу_полученный_от_метода_startUploadFile
  
  Для формы завершения "файл" (выбор из работы)
  workID=UUID_работы
  completionForm=FILE
  type=work
  file_name=Название_выбранного_файла.doc
  file_identifier=идентификатор файла
  
  Для формы завершения "форма"
  workID=UUID_работы
  completionForm=FILE
  type=work
  file_identifier=идентификатор файла формы
  
  Для задания в качестве собственного результата результата дочерней работы (для любой формы завершения)
  workID=UUID_работы
  completionForm=форма_завершения_данной_работы
  resultID=идентификатор_результата_завершения_дочерней_работы
  

  Parameters:

  workID - UUID работы

  completionForm - форма завершения работы

  locale - локаль пользователя

  Returns:

  json объект:
  errorCode код выполнения, 0 - успешно, иначе - произошла ошибка
  errorMessage сообщение о результате выполнения (успешном либо не успешном)
  work измененные данные о работе (только в результате успешного выполнения)

  See Also:

  StorageService.startUploadFile(String), (String)

• getFormForCompletionResult

  public Response getFormForCompletionResult(java.lang.String formUUID,
                                    java.lang.String formCode,
                                    java.lang.String workID,
                                    java.lang.String locale)

  Создает форму для создания результата по форме завершения "форма"

  
  

  URL rest/api/workflow/work/get_form_for_result
  Method GET

  Parameters:

  formUUID - UUID формы, соответствующей форме завершения

  formCode - код формы, соответствующей форме завершения

  workID - UUID работы

  locale - локаль пользователя

  Returns:

  Json с полями:
  file_identifier - uuid файла с данными
  dataUUID - uuid файла с данными
  dataUUID - uuid данных по форме
  comment - комментарий

• startRoute

  public java.lang.String startRoute(java.lang.String finishDate,
                            java.util.List<java.lang.String> resUserID,
                            java.lang.String userID,
                            java.lang.Integer type,
                            java.lang.String name,
                            java.lang.String completionFormID,
                            java.lang.String workID,
                            java.lang.String documentID,
                            java.lang.String locale)

  Отправляет работу по маршруту (перепоручение, согласование, ознакомление или утверждение)

  
  

  URL rest/api/workflow/work/start_route
  Method POST
  
  

  Parameters:

  finishDate - Дата завершения работ по маршруту в формате yyyy-MM-dd HH:mm:ss

  resUserID - список идентификаторов пользователей, которым отправляется работа

  userID - uuid ответственного (можно не передавать)

  type - тип, одно из значений:
  RouteItemElementType.AGREEMENT_ITEM 0 - согласование
  RouteItemElementType.APPROVAL_ITEM 1 - утверждение
  RouteItemElementType.ACQUAINTANCE_ITEM 2 - ознакомление
  RouteItemElementType.ASSIGNMENT_ITEM 3 - перепоручение

  name - название работы

  completionFormID - UUID формы завершения, имеет смысл только для типа RouteItemElementType.ASSIGNMENT_ITEM 3

  workID - UUID родительской работы

  documentID - UUID документа

  locale - локаль пользователя

  Returns:

  json объект:
  errorCode код выполнения, 0 - успешно, иначе - произошла ошибка
  errorMessage сообщение о результате выполнения (успешном либо не успешном)
  work измененные данные о работе (только в результате успешного выполнения)

• getResponsibleRoute

  public Route getResponsibleRoute(java.lang.String userID,
                          java.lang.String name,
                          java.util.Date finishDate,
                          java.lang.String completionFormID)

• transferWork

  public java.lang.String transferWork(java.lang.String workID,
                              java.lang.String name,
                              java.lang.String userID,
                              java.lang.String locale)

  Метод выполняет передачу работы другому пользователю

  
  

  URL rest/api/workflow/work/transfer
  Method POST
  
  

  Parameters:

  workID - UUID работы (FormParam)

  name - название работы (FormParam)

  userID - UUID пользователя, которому необходимо передать работу

  locale - локаль пользователя (QueryParam)

  Returns:

  json объект:
  errorCode код выполнения, 0 - успешно, иначе - произошла ошибка
  errorMessage сообщение о результате выполнения (успешном либо не успешном)
  workID id работы при успешном выполнении

• getCounters

  public java.lang.String getCounters()

  Метод возвращает информацию о счетчиках работ

  
  

  URL rest/api/workflow/get_counters
  Method GET
  
  Метод список элементов json следующего формата:
  key - идентификатор фильтра,
  value - значение фильтра
  Идентификатор фильтра строится по следующему правилу
  для общего количества работ в фильтре: {тип фильтра}_{uuid фильтра}_{uuid объекта}
  для новых работ в фильтре: {тип фильтра}_{uuid фильтра}_{uuid объекта}_
  Если для данного фильтра uuid фильтра или uuid объекта отсутствуют, то вместо них подставляется null
  
  Примеры
  
  Идентификатор для фильтра "На исполнении" OWN_WORKS_null_null - общее количество работ и OWN_WORKS_null_null_ - количество новых работ
  Если в списке будет возвращено
  { "key": "OWN_WORKS_null_null", "value": "198"}, { "key": "OWN_WORKS_null_null_", "value": "2"},
  значит у пользователя На исполнении 198 работ и из них 2 новых.
  
  Идентификатор для фильтра "На подпись": OWN_WORKS_c83a3be1-3659-43eb-a600-5ca1efd8dddb_null - для общего количества работ, OWN_WORKS_c83a3be1-3659-43eb-a600-5ca1efd8dddb_null_ - для новых работ, (c83a3be1-3659-43eb-a600-5ca1efd8dddb uuid фильтра разный для всех пользователей)
  Если в списке будет возвращено
  { "key": "OWN_WORKS_c83a3be1-3659-43eb-a600-5ca1efd8dddb_null", "value": "12"}, { "key": "OWN_WORKS_c83a3be1-3659-43eb-a600-5ca1efd8dddb_null_", "value": "0"}
  Значит у данного пользователя 12 работ в фильтре на подпись и из них 0 новых
  
  Рассмотрим дочерние фильтры для фильтра "на контроле". У этих фильтров может отсутствовать идентификатор фильтра, но присутствует идентификатор объекта (т.е. пользователя)
  
  Для фильтра первого уровня вложенности в фильтре "На контроле" идентификаторы будут выглядеть следующим образом: ON_CONTROL_null_43e85c79-91a2-4b40-8896-6c63f8e1adc6 для общего количества работ в фильтре.
  
  Если для данного фильтра в списке отсутствует количество работ, значит счетчик для данного фильтра в интерфейсе пользователя отображать не нужно. Если отсутствует счетчик количества новых работ, значит количество новых работ можно считать равным 0
  

  Returns:

  список счетчиков // * @see #getFilters(String, String, String, String, String)

• getExecutionProcess

  public java.lang.String getExecutionProcess(java.lang.String locale,
                                     java.lang.String documentID,
                                     java.lang.String workID)

  Метод возвращает ход исполнения по документу

  
  

  URL rest/api/workflow/get_execution_process
  Method GET
  

  Parameters:

  locale - локаль пользователя

  documentID - идентификатор документа

  workID - идентификатор работы (должен быть указан один параметр или идентификатор документа или идентификатор работы)

  Returns:

  
  Метод возвращает список элементов хода исполнения,информацию о типах работ и маршруте выполнения. Для каждого элeмента передаются:
  
  authorID идентификатор пользователя запустившего процесс
  authorName имя пользователя запустившего процесс
  name название элемента хода исполнения
  started стамп времени начала процесса в формате yyyy-MM-dd HH:mm:ss
  finished стамп времени завершения процесса в формате yyyy-MM-dd HH:mm:ss (отсутствует, если процесс еще не завершен)
  comment комментарий хода исполнения
  finishedUserID UUID пользователя, завершившего процесс
  finishedUser имя пользователя, завершившего процесс (не менять формат, в котором это имя выводится)
  responsibleUserID UUID пользователя, ответственного за выполнение
  responsibleUserName ФИО пользователя, ответственного за выполнение
  itemID UUID процесса
  code код процесса в строковом формате
  typeID тип процесса. Допустимые варианты описаны ниже
  actionID UUID действия, создаваемого процессом (работы, согласования, отправки документа и т.д.)
  length заданная длительность процесса
  lengthType тип длительности (*). Один из следующих вариантов:HOURS - длительность задана в часах;DAYS - длительность задана в рабочих днях;
  completionFormID UUID формы завершения
  subProcesses массив подпроцессов, который содержит те же элементы, что и сам процесс
  

  Список допустимых вариантов для поля typeID:

  • ASSIGNMENT_ITEM - работа
  • AGREEMENT_ITEM - согласование
  • APPROVAL_ITEM - утверждение
  • ACQUAINTANCE_ITEM - ознакомление
  • RESOLUTION_ACTION - резолюция
  • SEND_DOCUMENT - отправка документа
  • BLOCKING_PROCESS - блокирующий процесс
  • REGISTRATION_ITEM - регистрация
  • ROUTE_ITEM - маршрут
  • SEND_DOCUMENT_BY_FORM - отправка документа по форме
  • POSITION_APPOINMENT_ITEM - назначение на должность
  • POSITION_TRANSFER_ITEM - перевод
  • POSITION_DISCHARGE_ITEM - увольнение
  • COPY_TO_PR_FOLDER_ITEM - копирование в личную папку
  • CALENDAR_APPOINTEMENT_ITEM - назначение календаря
  • REGISTER_EVENT_ITEM - событие реестра
  • QUERY_RESULT - результат запроса
  • COMMON_PROCESS_BY_FORM - работа по форме
  • POINTERS_INPUT - ввод значения показателя
  • TIMER - таймер
  • ROUTE_TEMPLATE - запуск маршрута по шаблону
  • CONDITION - условный переход
  • COPY_TO_CARD - копирование в карточку
  • REASSIGN_WORK - переназначение работ

  
  

  Пример возвращаемого массива:

   [
     {
        "authorID": "cf9f8a9a-1ccc-4327-b829-a71e472d393e",
        "authorName": "Калиев Е.Д. (+77015550077)",
        "name": "Согласовано",
        "started": "2015-10-13 10:37:45",
        "finished": "2015-10-13 11:37:45",
        "comment": "OK",
        "finishedUserID": "179bda2e-6d55-4ed5-b1be-890ffad280ba",
        "finishedUser": "Акбердиева И.М. (+ 7 702 560 89 89)",
        "responsibleUserID": "179bda2e-6d55-4ed5-b1be-890ffad280ba",
        "responsibleUserName": "Акбердиева И.М. (+ 7 702 560 89 89)",
        "itemID": "7b097e72-e303-487f-83a1-cb76397abd57",
        "code": "soglasovanie",
        "typeID": "AGREEMENT_ITEM",
        "actionID": "33397e72-e303-487f-83a1-bb12397abd57",
        "length": "8.0",
        "lengthType": "HOURS",
        "completionFormID": "",
        "subProcesses": []
    },
    {
        "authorID": "dd7f8a9a-1ccc-4327-b829-a71e472d393e",
        "authorName": "Калиев Е.Д. (+77015550077)",
        "name": "На ознакомлении",
        "started": "2015-10-13 11:37:45",
        "finished": "",
        "comment": "",
        "finishedUserID": "",
        "finishedUser": "",
        "responsibleUserID": "aa497e72-e222-487f-83a1-cb76397abd57",
        "responsibleUserName": "Колыванов И.М. (+ 7 707 565 89 89)",
        "itemID": "88897e72-e303-487f-83a1-cb76397abd57",
        "code": "",
        "typeID": "ACQUAINTANCE_ITEM",
        "actionID": "44x97e72-e303-487f-83a1-bb12397abd57",
        "length": "8.0",
        "lengthType": "HOURS",
        "completionFormID": "",
        "subProcesses": [
            {
                "authorID": "cf9f8a9a-1ccc-4327-b829-a71e472d393e",
                "authorName": "Акбердиева И.М. (+ 7 702 560 89 89)",
                "name": "Согласовано",
                "started": "2015-10-13 12:37:45",
                "finished": "2015-10-13 13:37:45",
                "comment": "OK",
                "finishedUserID": "179bda2e-6d55-4ed5-b1be-890ffad280ba",
                "finishedUser": "Арыстанов И.М. (+ 7 707 565 89 89)",
                "responsibleUserID": "179bda2e-6d55-4ed5-b1be-890ffad280ba",
                "responsibleUserName": "Арыстанов И.М. (+ 7 707 565 89 89)",
                "itemID": "99997e72-e303-487f-83a1-cb76397abd57",
                "code": "soglasovanie",
                "typeID": "AGREEMENT_ITEM",
                "actionID": "12397e72-e303-487f-83a1-bb12397abd57",
                "length": "8.0",
                "lengthType": "HOURS",
                "completionFormID": "",
                "subProcesses": []
            }
        ]
    }
   ]
   

• getHost

  public java.lang.String getHost()

• getUserID

  public java.lang.String getUserID()

• getWorkItems

  public java.lang.String getWorkItems(java.lang.String workID,
                              java.lang.String locale)

  Метод возвращает набор действий, которые может совершить авторизованный пользователь над работой
  
  URL: rest/api/workflow/work_actions
  Тип: GET
  
  Каждое действие характеризуется следующими полями:
  action - идентификатор действия, значение из WorkActionType
  operation - идентификатор операции, значение из WorkActionSubType (может отсутствовать)
  label - название действия
  color - идентификатор цвета, значение из ActionColor

  Parameters:

  workID - uuid работы

  locale - локаль пользователя

  Returns:

  массив json объектов с информацией о возможных действиях

  See Also:

  WorkActionType, WorkActionSubType, ActionColor

• resolutionInfo

  public java.lang.String resolutionInfo(java.lang.String workID,
                                java.lang.String locale)

  Метод возвращает описание экрана для завершения процесса резолюции
  
  URL: rest/api/workflow/screen_resolution_info
  Тип: GET
  

  Parameters:

  workID - workID (uuid работы)

  locale - локаль

  Returns:

  json строка, где: name - название экрана, label - заголовок сообщения, message - сообщение, buttons - кнопки

• getWorkDialogs

  public java.lang.String getWorkDialogs(java.lang.String uuid,
                                java.lang.String type,
                                java.lang.String locale)

  Метод возвращает описание диалога по его uuid
  
  URL: rest/api/workflow/get_dialog_info
  Тип: GET
  

  Parameters:

  uuid - uuid диалога (параметр не обязателен)

  type - используется для получения описания диалога по умолчанию ( WORK - диалог создания работы, DOCUMENT_PROJECT - диалог создания документа, TEMPLATE_PROJECT - диалог создания документа по шаблону)

  locale - локаль

  Returns:

  json строка
  

      {
      name: "КАСТОМНЫЙ ДИАЛОГ",
      uuid: "363fed9c-2dcc-4037-936d-6338cebcb4bc",
      default: "true",
      special: "true",
      type: "WORK",
      steps: [
      [{
      "type": "NAME",
      "number": 1,
      "show": true
      }... ...{
      "type": "COMMENT",
      "number": 7,
      "show": false
      }] ...
      ]
      }
      

  
  
  name - название диалога (в зависимости от локали)
  uuid - идентификатор диалога
  default - является ли диалог диалогом по умолчанию для текущего типа
  special - является ли диалог "особым"
  type - тип диалога (WORK, DOCUMENT_PROJECT, TEMPLATE_PROJECT)
  steps - список компонентов для каждого из шагов
  
  Каждое поле состоит из следующих полей:
  type - тип, все возможные типы указаны ниже
  number - порядковый номер поле
  show - показать или нет
  Внимание: поле number может остуствовать или иметь значение null, это означает для типа компонента не указан номер и он имеет порядок по умолчаню
  
  Описание типы компонентов для диалога создания работы:
  
  NAME - Название
  RESPONSIBLE - Ответственный
  AUTHOR - Автор
  USERS - Исполнитель
  DATES - Сроки
  PRIORITY - Приоритет
  LOAD - Нагрузка
  ATTACH_FILE - Приложить файл
  KEYWORDS - Ключевые слова
  REPEAT - Повторять
  COMPLETION_FORM - Форма завершения
  COMMENT - Комментарий
  
  Описание типы компонентов для диалога создания проекта документа:
  
  NAME_P - Название
  DOCUMENT_TYPE - Тип документа
  COMPLETION_P - Завершение
  PRIORITY_P - Приоритет
  ATTACH_FILE_P - Прикрепить файл
  KEYWORDS_P - Ключевые слова
  
  Описание типы компонентов для диалога создания проекта документа по шаблону:
  
  NAME_T - Название
  DOC_TEMPLATE - Шаблон документа
  CREATE_WORK - Создать работу
  COMPLETION_T - Завершение
  PRIORITY_T - Приоритет
  KEYWORDS_T - Ключевые слова
  

  See Also:

  arta.synergy.web.common.client.data.actions.dialog.WorkDialogType#WORK, arta.synergy.web.common.client.data.actions.dialog.WorkDialogType#DOCUMENT_PROJECT, arta.synergy.web.common.client.data.actions.dialog.WorkDialogType#TEMPLATE_PROJECT

Constructor Detail

• RegistryService

  public RegistryService()

Method Detail

• createRegistryDocument

  public java.lang.String createRegistryDocument(java.lang.String registryID,
                                        java.lang.String registryCode,
                                        java.lang.String locale,
                                        boolean wasOpened)

  Создает новый документ по реестру
  
  URL rest/api/registry/create_doc
  Method GET
  
  Пример использования можно посмотреть в классе kz.arta.synergy.rest.api.sample.registry.CreateAndFillDocExample

  Parameters:

  registryID - UUID реестра (параметр обязателен если не передан код реестра)

  registryCode - код реестра (параметр обязателен если не передан UUID реестра)

  wasOpened - был ли документ ранее открыт. Не обязательный, по умолчанию - false. Определяет вид документа при первом открытии в клиенте.

  locale - локаль пользователя

  Returns:

  В случае успешного выполнения возвращает json c полями
  errorCode - код выполнения (в случае успешного выполнения - 0)
  documentID - uuid созданного документа
  dataUUID - uuid созданных данных по форме
  asfNodeID - uuid файла по форме в хранилище
  В случае не успешного выполнения возвращается json с полями
  errorCode - код выполнения (число, отличное от 0)
  errorMessage - сообщение об ошибке

• createRegistryDocumentWithRCC

  public Response createRegistryDocumentWithRCC(CreateRegistryDocumentOperation operation)

  Создает новый документ по реестру с возможностью вводить значения полей РКК
  
  URL rest/api/registry/create_doc_rcc
  Method POST
  

  Parameters:

  operation - Метод принимает следующие входные параметры

  • registryID - uuid реестра (параметр обязателен если не передан код реестра)
  • registryCode - код реестра (параметр обязателен если не передан uuid реестра)
  • locale - локаль
  • wasOpened - был ли документ ранее открыт. Не обязательный, по умолчанию - false. Определяет вид документа при первом открытии в клиенте.
  • rcc - объект (необяз.), состоящий из следующих полей:
    • subject - краткое содержание документа
    • number - редактируемая часть номера документа, используется если у номера присутствует редактируемая часть
    • doc_type - код типа документа
    • reg_date - дата регистрации, в формате YYYY-MM-DD
    • duration - длительность, используется если для типа документа выбран способ ввода срока "Длительность". Принимает только целые положительные числа (кроме 0)
    • finish_date - дата завершения, используется если для типа документа выбран способ ввода срока "Дата завершения". В формате YYYY-MM-DD
    • correspondent_org - корреспондент-организация
    • correspondent - корреспондент
    • control - принимает следующие значения:true - является контрольным, false - не является контрольным
    • base_number - номер исходящего документа
    • base_date - дата исходящего документа, в формате YYYY-MM-DD
    • doc_file - uuid дела
    • base - массив, состоящий из uuid документа
    • user - uuid пользователя

  Метод создает документ по реестру с учетом прав пользователя, который вызывает API метод, на реестр.
  Если для параметров объекта rcc, кроме subject, doc_type, duration, finish_date, введены некорректные (несуществующие) данные, то данные значение не присваиваются соответствующим полям РКК, и поля остаются пустые

  Returns:

  В случае успешного выполнения возвращается объект JSON с полями

  • errorCode - код выполнения (0 - успешно
  • documentID - uuid созданного документа
  • dataID - uuid созданных данных по форме
  • asfNodeID - uuid файла по форме в хранилище
  • rcc - массив объектов со следующими полями
    • number - порядковый номер поля, отсутствует для поля user
    • name - название поля, одно из следующих вариантов:
      • subject - краткое содержание
      • doc_type - тип документа
      • number - номер
      • reg_date - дата регистрации
      • duration - длительность
      • finish_date - дата завершения
      • correspondent_org - корреспондент (орг)
      • correspondent - корреспондент
      • author - автор
      • reg_user - зарегистрировал
      • control - является контрольным
      • base_number - номер исх.
      • base_date - дата исх.
      • doc_file - дело
      • base - основание
      • user - исполнитель
    • value - значение данного поля

  В случае неуспешного выполнения возвращается соответствующая ошибка HTTP в виде JSON объекта со следующими полями:

  • errorCode - код выполнения (число, отличное от 0)
  • errorMessage - сообщение об ошибке

  Пример передаваемого запроса:

      {
          "registryID" : "f30f6b31-4cbe-11e6-8030-001ef892a4ee",
          "wasOpened"  : true,
              "rcc" :
          {
              "subject" : "Новый документ",
                  "number" : "122cp",
                  "doc_type" : "internal",
                  "reg_date" : "2016-08-07",
                  "duration" : 5,
                  "correspondent_org" : "ТОО Астана",
                  "correspondent" : "Акбердиева",
                  "control" : true,
                  "base_number" : "152-552",
                  "base_date" : "2016-08-02",
                  "doc_file" : "fd96dff0-4e37-11e6-8030-001ef892a4ee",
                  "base" :
              [
              "v12dsdff0-4e37-11e6-8030-001ef892a4ee",
                      "1d5gsdff0-4e37-11e6-8030-001ef892a4ee"
              ],
              "user" : "ea989670-4e44-11e6-8030-001ef892a4ee"
          }
      }
   

  
  Пример возвращаемого объекта JSON:

       {
          "errorCode" : 0,
                  "documentID" : "66df2270-4cc0-11e6-8030-001ef892a4ee",
                  "dataID" : "a14a9ad0-585e-11e6-9e86-5a14ad700067",
                  "asfNodeID" : "75d4e590-4cbf-11e6-8030-001ef892a4ee",
                  "rcc" :
          [
          {   "number" : 1,
                  "name" : "subject",
                  "value" : "Документ 1233"
          },
          {   "number" : 2,
                  "name" : "number",
                  "value" : "{outgoing}/{dd}-{MM}-{yy}"
          },
          {   "number" : 4,
                  "name" : "doc_type",
                  "value" : "outgoing"
          },
          {   "number" : 7,
                  "name" : "base",
                  "value" : "6dgdr6gad0-585e-11e6-9e86-5a14ad700067"
          },
          {   "number" : 7,
                  "name" : "base",
                  "value" : "kljfsd56fd-585e-11e6-9e86-5a14ad700067"
          }
  
          ]
      }
   

• createCollectionRegistryDocument

  public java.lang.String createCollectionRegistryDocument(java.lang.String registryID,
                                                  java.lang.String registryCode,
                                                  java.lang.String locale,
                                                  int count)

  Создает указанное количество новых документов по реестру
  
  URL rest/api/registry/create_collection_doc
  Method GET
  

  Parameters:

  registryID - UUID реестра (параметр обязателен если не передан код реестра)

  registryCode - Код реестра (параметр обязателен если не передан UUID реестра)

  locale - локаль пользователя

  count - количество записей

  Returns:

  В случае успешного выполнения возвращает json c полями
  errorCode - код выполнения (в случае успешного выполнения - 0)
  documents - массив объектов с полями:
  documentID - uuid созданного документа
  dataUUID - uuid созданных данных по форме
  asfNodeID - uuid файла по форме в хранилище
  В случае не успешного выполнения возвращается json с полями
  errorCode - код выполнения (число, отличное от 0)
  errorMessage - сообщение об ошибке