Constructor Detail

• DictionaryService

  public DictionaryService()

Method Detail

• getDictionaryValues

  public java.lang.String getDictionaryValues(java.lang.String locale,
                                              java.lang.String dictionaryCode)

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

  URL rest/api/dictionary/get_by_code
  Method GET

  
  Метод возвращает json с полями:
  dictionary_code - код справочника
  dictionaryID - идентификатор справочника
  columns - список столбцов справочника
  items - список значений справочника
  
  Для каждого столбца (columns) передается:
  columnID идентификатор столбца
  code код столбца
  
  Для каждого значения (items) передаются:
  itemID - идентификатор значения
  values - список значений каждого столбца. Для каждого значения передаются:
  columnID - идентификатор столбца
  value - значение
  translation - перевод значения согласно локали пользователя (перевод может отсутствовать. Если перевод присутствует, значит в качестве значения для данного столбца надо брать его, если отсутствует - значение поля value)
  
  
  Рассмотрим пример справочника форм завершения с кодом work_completion:

   {"dictionary_code" : "work_completion", "dictionaryID": "0b247762-f049-49e7-93e5-fa7c93a779d7", "columns": [
   {
   "columnID": "27e8d020-5db5-4b05-a3e2-ba364453a940",
   "code": "form_type"
   },
   {
   "columnID": "5b3ab9bc-ea13-4fce-a37c-a83298dee427",
   "code": "form_type_name"
   },
   {
   "columnID": "9f7778ba-c3b9-4653-ba4e-560ddb800ded",
   "code": "is_result_free"
   },
   {
   "columnID": "3b359c6b-5f17-4324-a6c2-3a3bc2e400b6",
   "code": "additional_params"
   }
   ], "items": [
   {
   "itemID": "36826cf9-5da9-49bf-9b79-3e3f9c0873a1",
   "values": [
   {
   "value": "child=true",
   "columnID": "3b359c6b-5f17-4324-a6c2-3a3bc2e400b6"
   },
   {
   "value": "0",
   "columnID": "9f7778ba-c3b9-4653-ba4e-560ddb800ded"
   },
   {
   "value": "2",
   "columnID": "27e8d020-5db5-4b05-a3e2-ba364453a940"
   },
   {
   "value": "Документ",
   "columnID": "5b3ab9bc-ea13-4fce-a37c-a83298dee427" ,
   "translation": "Документ"
   }
   ]
   },
   {
   "itemID": "55dad228-2653-47c2-898a-ad263c2e7def",
   "values": [
   {
   "value": "0",
   "columnID": "9f7778ba-c3b9-4653-ba4e-560ddb800ded"
   },
   {
   "value": "0",
   "columnID": "27e8d020-5db5-4b05-a3e2-ba364453a940"
   },
   {
   "value": "Комментарий",
   "columnID": "5b3ab9bc-ea13-4fce-a37c-a83298dee427" ,
   "translation": "Комментарий"
   }
   ]
   },
   {
   "itemID": "5a753b31-db44-4e56-b922-fabeb29502ff",
   "values": [
   {
   "value": "1",
   "columnID": "27e8d020-5db5-4b05-a3e2-ba364453a940"
   },
   {
   "value": "Файл",
   "columnID": "5b3ab9bc-ea13-4fce-a37c-a83298dee427" ,
   "translation": "Файл"
   }
   ]
   }
   ]}
   

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

       ____________________________________________________________________________________________________________________________
       |form_type       |form_type_name         | is_result_free        |additional_params  | Идентификатор значения              |
       |2               |Документ               |0                      |child=true         |36826cf9-5da9-49bf-9b79-3e3f9c0873a1 |
       |0               |Комментарий            |0                      |                   |55dad228-2653-47c2-898a-ad263c2e7def |
       |1               |Файл                   |                       |                   |5a753b31-db44-4e56-b922-fabeb29502ff |
       ____________________________________________________________________________________________________________________________
   

  
  
  

  Parameters:

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

  dictionaryCode - код справочника

  Returns:

  json с полями описанными выше

• addRecord

  public java.lang.String addRecord(DictionaryRecord record)

  Добавляет запись справочника

  URL rest/api/dictionary/record/add
  Method POST
  
  Вызывать метод можно только от имени пользователя с ролью "Методолог"
  
  "Content-type" запроса должен быть "application/json; charset=utf-8" и в теле запроса JSON в следующем формате

   {
   "dictCode": "apitest",
   "itemID": null,
   "columns": [
    {
        "code": "number",
        "value": "42",
        "valueKZ": null,
        "valueRU": null,
        "valueEN": null
    },
    {
        "code": "field_name",
        "value": "Поле с переводами",
        "valueKZ": "казахский",
        "valueRU": "русский",
        "valueEN": "английский"
    },
    {
        "code": "field_desc",
        "value": "Тест переводов",
        "valueKZ": null,
        "valueRU": null,
        "valueEN": null
    }
   ]
   }
   

  , где
  dictCode - код справочника
  itemID - идентификатор записи справочника (в данном методе не используется)
  columns - список столбцов справочника, где

      code - код столбца справочника

      value - значение столбца справочника

      valueKZ, valueRU, valueEN - локализованные значения столбца справочника

  Parameters:

  record - запись справочника в формате JSON

  Returns:

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

• editRecord

  public java.lang.String editRecord(DictionaryRecord record)

  Изменяет запись справочника

  URL rest/api/dictionary/record/edit
  Method POST
  
  Вызывать метод можно только от имени пользователя с ролью "Методолог"
  
  "Content-type" запроса должен быть "application/json; charset=utf-8" и в теле запроса JSON в следующем формате

   {
   "dictCode": "apitest",
   "itemID": "195af529-35ee-4bd7-a2b8-bcc04c731283",
   "columns": [
    {
        "code": "number",
        "value": "42",
        "valueKZ": null,
        "valueRU": null,
        "valueEN": null
    },
    {
        "code": "field_name",
        "value": "Поле с переводами",
        "valueKZ": "казахский",
        "valueRU": "русский",
        "valueEN": "английский"
    },
    {
        "code": "field_desc",
        "value": "Тест переводов",
        "valueKZ": null,
        "valueRU": null,
        "valueEN": null
    }
   ]
   }
   

  , где
  dictCode - код справочника
  itemID - идентификатор редактируемой записи справочника
  columns - список столбцов справочника, где

      code - код столбца справочника

      value - значение столбца справочника

      valueKZ, valueRU, valueEN - локализованные значения столбца справочника

  Parameters:

  record - запись справочника в формате JSON

  Returns:

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

• editRecords

  public Response editRecords(DictionaryRecord[] records)

  Изменяет запись справочника

  URL rest/api/dictionary/record/edit
  Method POST
  
  Вызывать метод можно только от имени пользователя с ролью "Методолог"
  
  "Content-type" запроса должен быть "application/json; charset=utf-8" и в теле запроса JSON в следующем формате

   {
   "dictCode": "apitest",
   "itemID": "195af529-35ee-4bd7-a2b8-bcc04c731283",
   "columns": [
    {
        "code": "number",
        "value": "42",
        "valueKZ": null,
        "valueRU": null,
        "valueEN": null
    },
    {
        "code": "field_name",
        "value": "Поле с переводами",
        "valueKZ": "казахский",
        "valueRU": "русский",
        "valueEN": "английский"
    },
    {
        "code": "field_desc",
        "value": "Тест переводов",
        "valueKZ": null,
        "valueRU": null,
        "valueEN": null
    }
   ]
   }
   

  , где
  dictCode - код справочника
  itemID - идентификатор редактируемой записи справочника
  columns - список столбцов справочника, где

      code - код столбца справочника

      value - значение столбца справочника

      valueKZ, valueRU, valueEN - локализованные значения столбца справочника

  Parameters:

  record - запись справочника в формате JSON

  Returns:

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

• removeRecord

  public java.lang.String removeRecord(DictionaryRecord record)

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

  URL rest/api/dictionary/record/remove
  Method POST
  
  Вызывать метод можно только от имени пользователя с ролью "Методолог"
  
  "Content-type" запроса должен быть "application/json; charset=utf-8" и в теле запроса JSON в следующем формате

   {
   "dictCode": "apitest",
   "itemID": "195af529-35ee-4bd7-a2b8-bcc04c731283",
   }
   

  , где
  dictCode - код справочника
  itemID - идентификатор удаляемой записи справочника

  Parameters:

  record - запись справочника в формате JSON

  Returns:

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

• getHost

  public java.lang.String getHost()

• getUserID

  public java.lang.String getUserID()

• findDictionaryItems

  public java.util.Collection<DictionaryItem> findDictionaryItems(java.lang.String organizationRecordIdColumnId,
                                                                  java.lang.String orgID)

• updateDictionary

  public Response updateDictionary(DictionaryDefinitionJson json)

• saveItem

  public java.lang.String saveItem(DictionaryItem item)

• saveTranslations

  public java.lang.String saveTranslations(java.lang.String id,
                                           java.lang.String nameId,
                                           java.lang.String mapJS)

• getDictionaryByCode

  public java.util.Dictionary getDictionaryByCode(java.lang.String fieldsDictionaryCode,
                                                  boolean loadItems)

Constructor Detail

• DictionariesService

  public DictionariesService()

Method Detail

• getDictionariesList

  public Response getDictionariesList(boolean getHidden,
                                      java.lang.String locale)

  Получение списка справочников

  URL rest/api/dictionaries
  Method GET

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

  Parameters:

  getHidden - возвращать ли скрытые справочники, true/false (не обяз., по умолчанию false)

  locale - код локали (не обяз., по умолчанию ru)

  Returns:

  Данные в JSON формате

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

          [
              {
              "id": "eb77639e-60b8-4a50-8327-0482063e8935",
              "code": "resolution_work_types",
              "name": "Типы работ по резолюции",
              "comment": "Значения выпадающего списка типа работы при наложении резолюции"
              },
              {
              "id": "467d3eac-252c-427e-bd27-ba8704587257",
              "code": "calendar_types",
              "name": "Назначения календаря",
              "comment": "Статусы сотрудников"
              },
              {
              "id": "7b953be8-bddb-4ce4-bbfd-ae9548f69c7f",
              "code": "BookPointer",
              "name": "Уровень проведения тренингов",
              "comment": ""
              },
              {
              "id": "a830ed90-1ef5-4829-b3a4-efa8d087ed6a",
              "code": "BookPointer2",
              "name": "Уровень корпоративного духа",
              "comment": ""
              },
              {
              "id": "9b077c41-4efa-48ce-8ce9-af2fe6145e96",
              "code": "send_items",
              "name": "Пункты меню отправки",
              "comment": "Пункты меню отправки документа/работы"
              },
              {
              "id": "f75e8f6a-7b5a-493b-946b-ac35a628624f",
              "code": "Vid_otpuska",
              "name": "Виды отпусков",
              "comment": ""
              },
              {
              "id": "dfb986ca-6dd2-415f-9304-bfab19d6d4af",
              "code": "nazionalnost",
              "name": "Национальности",
              "comment": ""
              },
              {
              "id": "a0b8ee66-2820-4fb7-991d-4723955ccef5",
              "code": "action_progress",
              "name": "Подписи прогресса поручений",
              "comment": "Подписи прогресса поручений"
              },
              {
              "id": "2d7729d7-1230-4c1c-a952-ebb4cf65278a",
              "code": "resolution",
              "name": "Тексты резолюций",
              "comment": "Справочник стандартных текстов резолюций"
              },
              {
              "id": "b08289f0-fd6b-4b3c-bc99-fae8d4296acb",
              "code": "obrazovanie",
              "name": "Образование",
              "comment": ""
              }
          ]
   

• getDictionaryInfo

  public Response getDictionaryInfo(java.lang.String code,
                                    boolean getColumns,
                                    boolean getItems,
                                    java.lang.String locale)

  Получение описания и/или записей справочника

  URL rest/api/dictionaries/{code}
  Method GET

  Parameters:

  code - код справочника.

  getColumns - возвращать ли описание справочника, true/false (не обяз., по умолчанию true)

  getItems - возвращать ли записи справочника, true/false (не обяз., по умолчанию true)

  locale - код локали (не обяз., по умолчанию ru)

  Returns:

  Данные в JSON формате.

  Метод должен возвращать массив с параметрами:

  • id - идентификатор справочника
  • code - код справочника
  • name - имя справочника
  • comment - комментарий к справочнику
  • columns - список столбцов справочника (для getColumns = true)
  • items - список значений справочника (для getItems = true)

  Для каждого столбца справочника (columns) передается:

  • id - идентификатор столбца
  • code - код столбца
  • name - имя столбца
  • comment - комментарий столбца
  • translate - переводить ли значение столбца, true/false

  Примечание: Каждый столбец из columns определяется ключом, который соответствует значению кода столбца (поле code).

  Для каждой записи справочника (items) передаются значения кода столбца, а внутри каждого столбца - непосредственно значения записи

  • id - идентификатор значения
  • value - значение
  • translation - перевод значения согласно локали пользователя; может отсутствовать (соответствует значению null), тогда в качестве значения для данного столбца надо использовать значение поля value

  Примечание

  Каждая запись из items определяется ключом, который соответствует значению идентификатора значения (поле id)

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

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

          {
              "id": "eb77639e-60b8-4a50-8327-0482063e8935",
              "code": "send_items",
              "name": "Пункты меню отправки",
              "comment": "Пункты меню отправки документа/работы",
              "columns": {
                  "item_number": {
                      "id": "e5d3ce83-25d1-46ae-94f9-c33930fc1565",
                      "code": "item_number",
                      "name": "Порядковый номер",
                      "comment": "Используется для задания порядка пунктов меню отправки",
                      "translate": false
                  },
                  "item_name": {
                      "id": "03e23318-71ec-4ced-a54c-73affaf43079",
                      "code": "item_name",
                      "name": "Название пункта меню отправки",
                      "comment": "Текст, который будет отображаться в соответствующем пункте меню",
                      "translate": true
                  },
                  "item_process": {
                      "id": "27f3090b-0a57-4c1f-8343-c56e8d39117d",
                      "code": "item_process",
                      "name": "Действие, которое осуществляет пункт",
                      "comment": "",
                      "translate": false
                  }
              },
              "items": {
                  "b7c8861f-37df-4fe4-9f67-4f1cb243b008": {
                      "item_number": {
                          "id": "b7c8861f-37df-4fe4-9f67-4f1cb243b008",
                          "value": "3",
                          "translation": null
                      },
                      "item_name": {
                          "id": "b7c8861f-37df-4fe4-9f67-4f1cb243b008",
                          "value": "Перепоручить",
                          "translation": "Перепоручить"
                      },
                      "item_process": {
                          "id": "b7c8861f-37df-4fe4-9f67-4f1cb243b008",
                          "value": "assignment",
                          "translation": null
                      }
                  },
                  "80c92a72-988f-422a-92b9-70cd37f15dbc": {
                      "item_number": {
                          "id": "80c92a72-988f-422a-92b9-70cd37f15dbc",
                          "value": "6",
                          "translation": null
                      },
                      "item_name": {
                          "id": "80c92a72-988f-422a-92b9-70cd37f15dbc",
                          "value": "На утверждение",
                          "translation": "На утверждение"
                      },
                      "item_process": {
                          "id": "80c92a72-988f-422a-92b9-70cd37f15dbc",
                          "value": "approval",
                          "translation": null
                      }
                  }
              }
          }
   

  Альтернативный поток событий. Передан некорректный параметр code: справочника с таким кодом не существует. Сервер возвращает следующий ответ (с HTTP-кодом 200):

          {
              "errorCode": "13",
              "errorMessage": "Справочник с кодом %значение% не найден"
          }
   

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

• 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 groupCode,
                                   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 группы пользователя
  groupCode код группы пользователя
  levelsCount параметр для будущего использования

  Returns:

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

• getUsersExt

  public Response getUsersExt(int startRecord,
                              int recordsCount,
                              java.lang.String locale,
                              boolean showAll,
                              int levelsCount,
                              int groupID,
                              java.lang.String groupCode,
                              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 идентификатор группы. Если параметр задан в чузер подтягиваются пользователи, входящие в данную группу
  groupCode код группы. Если параметр задан в чузер подтягиваются пользователи, входящие в данную группу
  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 Описание ответа: массив объектов с информацией о пользователях
  departmentName наименование департамента
  firstname имя
  lastname фамилия
  patronymic отчество
  personID идентификатор пользователя
  personName имя пользователя
  positionName наименование должности
  customFields - свойства элемента, зависят от типа элемента (смотрите пункт про определение типа сущности по идентификатору)
  
  Определение типа сущности по идентификатору и доп поля этой сущности
  если userID начинается
  "g-" - группа (type - groupId, id - идентификатор группы, code - код группы)
  "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

  Parameters:

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

  locale - локаль

• 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 Пример ответа:

    {
        "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

  Parameters:

  users - несколько пользователей userID=userid1&userID=userid2

  date - дата в формате yyy-MM-dd

  locale - локаль

• 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
  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 идентификатор пользователя чьи должности необходимо показать массив найденных должностей поля возвращаемой сущности
  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
  showAll - false по умолчанию; отображать все должности (false - отображать подчиненные должности)
  showOnlyVacant - false по умолчанию, отображать только вакантные должности
  locale - локаль
  userID пользователь от имени которого выполнять поиск
  operationType - тип операции для получения пользователей которые делегировали права пользователю (по ним определяется максимальный уровень иерархии верх который нужно отображать и подчиненные должности)
  search параметр текстового поиска
  departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть
  filterDepartmentID идентификатор непосредственного родительского подразделения
  filterUserID идентификатор пользователя чьи должности необходимо показать
  customField не используется

  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 Параметры:
  locale - локаль
  departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть
  filterDepartmentID идентификатор непосредственного родительского подразделения
  filterChildDepartmentID идентификатор непосредственного родительского подразделения
  filterPositionID идентификатор непосредственного родительского подразделения
  search параметр текстового поиска
  Описание ответа:
  массив найденных должностей
  поля возвращаемой сущности
  departmentId -идентификатор департамента
  departmentName наименование
  hasChildren имеются ли дочерние подразделения
  parentName наименование родительского департамента
  
  если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

  Parameters:

  pageNumber - номер страницы результата (0 по умолчанию)

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

  showChildDepartments - показывать ли дочерние подразделения

  filterHrUser - Фильтр ограничивает департаменты теми, к которым имеет доступ hr-пользователь

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

• 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

• getUserID

  public java.lang.String getUserID()

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:

• getUserID

  public java.lang.String getUserID()

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(<any> settings)

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

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

  
  

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

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

  {"errorCode": 13, "errorMessage": ""Настройка с id {id} не найдена"} Объект ответа это 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"
    }
                  ]
    }
  

• getUserID

  public java.lang.String getUserID()

  Метод возвращает UUID пользователя, вызвавшего метод

• getProcessSettings

  public Response getProcessSettings(java.lang.String typeID,
                                     java.lang.String locale)

  Метод возвращает описания настроек процессов
  
  URL: rest/api/settings/get_process_settings
  Тип GET
  

  Parameters:

  typeID - - тип процесса.(обяз) Допустимые варианты описаны ниже.

  locale - - локаль пользователя, ru/en/kz (не обяз., по умолчанию ru). Список допустимых вариантов для передаваемого параметра typeID: ASSIGNMENT_ITEM - работа AGREEMENT_ITEM - согласование APPROVAL_ITEM - утверждение ACQUAINTANCE_ITEM - ознакомление RESOLUTION_ACTION - резолюция SEND_DOCUMENT - отправка документа BLOCKING_PROCESS - блокирующий процесс REGISTRATION_ITEM - регистрация ROUTE_ITEM - маршрут

  Returns:

   Пример запроса:
    `rest/api/settings/get_process_settings?typeID=ASSIGNMENT_ITEM`
   Пример ответа на запрос для ASSIGNMENT_ITEM :
   {"data":{
        "type":"assignment",
        "number":1,
        "name":"Работа2",
        "ph":{
            "phInProgress":"",
            "phNegativeAnswer":"",
            "phPositiveAnswer":"",
            "phInterrupted":"",
            "phFuture":""
         },
        "wl":{
            "wlNegativeAnswer":"",
            "wlWaiting":"",
            "wlPositiveAnswer":""
         },
         "wr":{
            "wrAcceptButton":"",
            "wrFinishButton":""
         },
         "pf":{
            "pfNegativeAnswer":"",
            "pfPositiveAnswer":"",
            "pfTitle":""
         },
         "rcSubstitution":"",
         "apTitle":"В работу",
         "apCompleteButton":"Завершить",
         "wcSubstitution":"",
         "wcSendButton":"Перепоручить",
         "n":{
            "nNegativeAnswer":"",
            "nWorkPercentChanged":"Пользователь {0} изменил процент выполнения работы \"{1}\" - {2}% 
  
                                   
  Для просмотра документа данной работы перейдите по ссылке.",
            "nFinishWork":"Пользователь {0} отметил работу \"{1}\" как {2} 
  
  Для просмотра документа данной работы перейдите по ссылке.",
            "nPositiveAnswer":"",
            "nPositiveAnswerWithComment":"",
            "nCreateDocument":"Пользователь {0}поручил вам работу по документу \"{1}\",
                               срок: {2} 
  
  Для просмотра документа данной работы перейдите по ссылке.",
            "nNegativeAnswerWithComment":"",
            "nCreateWork":"Пользователь {0} создал для Вас новую работу \"{1}\",
                            срок: {2} 
   
  Для просмотра документа данной работы перейдите по ссылке."
            }
          }
   }
  
  

• getProcessSettingsWrapper

  public java.util.LinkedHashMap getProcessSettingsWrapper(ProcessMessages pm,
                                                           java.lang.String processType,
                                                           java.lang.String locale)

Constructor Detail

• AuthService

  public AuthService()

Method Detail

• checkUserIsAdmin

  public Response checkUserIsAdmin(java.lang.String role)

  API для авторизации суперадмина и суперметодолога
  
  URL rest/api/auth/{role}
  Method GET
  

  Parameters:

  role - роль пользователя, с которой он хочет авторизоваться, один из трех вариантов
  

  • user - пользователь (по умолчанию)
  • methodologist - суперметодолог
  • administrator - суперадминистратор

  Returns:

  HTTP код 200 в случае успешной аутентификации, 401 - если пользователь не имеет доступа в систему, не найден или передан неправильный пароль, 403 - в случае, если он не обладает указанной ролью, 500 - ошибка на сервере.
  
  Альтернативные потоки событий.
  Альтернативный поток №1. Переданный в HTTP Basic Auth пароль пользователя неверен, такой пользователь отсутствует в системе или он не имеет доступа в систему. Сервер возвращает ошибку HTTP 401.
  Альтернативный поток №2. Пользователь не обладает указанной в параметре ролью. Сервер возвращает ошибку HTTP 403.
  Альтернативный поток №3. Во время выполнения метода на сервере произошла ошибка. Сервер возвращает ошибку HTTP 500.

• checkUser

  public Response checkUser()

  API для авторизации пользователя

  Returns:

  See Also:

  checkUserIsAdmin(java.lang.String)

• getUserID

  public java.lang.String getUserID()

Constructor Detail

• ProcessesService

  public ProcessesService()

Method Detail

• competeProcess

  public Response competeProcess(java.lang.String signal,
                                 java.lang.String executionID,
                                 java.lang.String locale)

  Метод отправляет сигнал блокирующему процессу для его завершения в системе и восстановления работы маршрута

  URL rest/api/processes/signal
  Method GET

  Так же метод принимает дополнительные опциональные параметры, передаваемые процессу.
  Для того чтобы передать параметр и значение необходимо передать запросу параметры :
  paramN=название_параметра и valueN=значение_параметра, где N - порядковый номер параметра (нумерация с 1)
  Поддерживаемые параметры:

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

  Примеры:

  Успешное завершение процесса с комментарием
  rest/api/processes/signal?signal=got_agree¶m1=resolution&value1=Действие успешно выполнено&executionID=id_процесса
  

  Успешное завершение процесса без комментария
  rest/api/processes/signal?signal=got_agree&executionID=id_процесса
  

  Не успешное завершение процесса с комментарием
  rest/api/processes/signal?signal=got_refuse¶m1=resolution&value1=Действие не выполнено&executionID=id_процесса
  

  Не успешное завершение процесса без комментария
  rest/api/processes/signal?signal=got_refuse&executionID=id_процесса
  

  Parameters:

  signal - результат завершения блокирующего процесса: got_agree - успешное завершения, got_refuse - неуспешное завершение

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

  locale - локаль

  Returns:

• retryBP

  public Response retryBP(java.lang.String documentID)

  Метод переотправки в очередь незавершенных блок процессов в указанном документе *

  URL rest/api/processes/retry_bp *
  Method POST

  Пример:

  
  rest/api/processes/retry_bp?documentID=document_identifier
  

  Parameters:

  documentID - query param ид документа

  Returns:

  сообщение о выполнении метода

• getHost

  public java.lang.String getHost()

• getUserID

  public java.lang.String getUserID()

Constructor Detail

• MobileUtilsService

  public MobileUtilsService()

Method Detail

• addDeviceToken

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

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

  
  

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

  errorCode

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

  errorMessage

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

• removeDeviceToken

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

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

  
  

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

  errorCode

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

  errorMessage

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

• getUserID

  public java.lang.String getUserID()

• getLocale

  public java.lang.String getLocale()

Constructor Detail

• UsersService

  public UsersService()

Method Detail

• logout

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

• listLoggedInUsers

  public Response listLoggedInUsers(java.lang.String showIdsStr)

• getUserID

  public java.lang.String getUserID()

Constructor Detail

• ActionsIndexService

  public ActionsIndexService()

Method Detail

• getMaxVersion

  public Response getMaxVersion(java.lang.String locale,
                                boolean continueLast,
                                long sleepTime)

  Начинает индекс работ

  URL: /rest/api/admin/actions/index

  Тип: POST

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

  continue(true, false) - продолжить предыдущий индекс, по умолчанию false

  interval(число) - время между индексом на отдельные данные форм

  Returns:

  Возвращает 200, если индексирование началось. Json объект в противном случае: { "errorCode": 13, "errorMessage":"Индексирование уже начато" }

• getState

  public Response getState(java.lang.String locale,
                           boolean getMessages)

  Статус текущего индексирования

  URL: /rest/api/admin/actions/index

  Тип: GET

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

  messages(true, false) - возвращать ли сообщения индексирования

  Returns:

  Возвращает 200, если индексирование началось. Json объект в противном случае. { "running": true, "messages": ["first messages", "second message"] }

Constructor Detail

• FormIndexService

  public FormIndexService()

Method Detail

• getMaxVersion

  public Response getMaxVersion(java.lang.String locale,
                                boolean continueLast,
                                long sleepTime)

  Начинает индекс форм

  URL: /rest/api/admin/forms/index

  Тип: POST

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

  continue(true, false) - продолжить предыдущий индекс, по умолчанию false

  interval(число) - время между индексом на отдельные данные форм

  Returns:

  Возвращает 200, если индексирование началось. Json объект в противном случае: { "errorCode": 13, "errorMessage":"Индексирование уже начато" }

• getState

  public Response getState(java.lang.String locale,
                           boolean getMessages)

  Статус текущего индексирования

  URL: /rest/api/admin/forms/index

  Тип: GET

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

  messages(true, false) - возвращать ли сообщения индексирования

  Returns:

  Возвращает 200, если индексирование началось. Json объект в противном случае. { "running": true, "messages": ["first messages", "second message"] }

• getUserID

  public java.lang.String getUserID()

Constructor Detail

• DocumentIndexService

  public DocumentIndexService()

Method Detail

• getMaxVersion

  public Response getMaxVersion(java.lang.String locale,
                                boolean continueLast,
                                long sleepTime)

  Начинает индекс документов

  URL: /rest/api/admin/docs/index

  Тип: POST

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

  continue(true, false) - продолжить предыдущий индекс, по умолчанию false

  interval(число) - время между индексом на отдельные данные форм

  Returns:

  Возвращает 200, если индексирование началось. Json объект в противном случае: { "errorCode": 13, "errorMessage":"Индексирование уже начато" }

• getState

  public Response getState(java.lang.String locale,
                           boolean getMessages)

  Статус текущего индексирования

  URL: /rest/api/admin/docs/index

  Тип: GET

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

  messages(true, false) - возвращать ли сообщения индексирования

  Returns:

  Возвращает 200, если индексирование началось. Json объект в противном случае. { "running": true, "messages": ["first messages", "second message"] }

• getUserID

  public java.lang.String getUserID()

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": "Ошибка исполнения"
  }

• getUserID

  public java.lang.String getUserID()

Constructor Detail

• DiaryService

  public DiaryService()

Method Detail

• getModifiedTasks

  public java.lang.String getModifiedTasks(java.lang.String userID,
                                           java.lang.String locale,
                                           java.lang.String lastModified)

  
  

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

  URL rest/api/diary/tasks/{userID}
  Method GET

  
  Пример:
  http://хост:порт/Synergy/rest/api/diary/tasks/uuid_пользователя?last-modified=2013-01-01%2008:00:00
  Для описания оорфмата json смотрите документацию метода taskToJson(Task)

  Parameters:

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

  locale - локаль

  lastModified - стамп времени

  Returns:

  список заметок, измененных с момента lastModified в формате json

  See Also:

  #taskToJson(arta.synergy.web.common.client.data.tasks.Task)

• createTask

  public java.lang.String createTask(java.lang.String task,
                                     java.lang.String taskID,
                                     java.lang.String start,
                                     java.lang.String finish,
                                     boolean wholeDay,
                                     java.lang.String userID,
                                     java.lang.String locale)

  Метод для создания/изменения задачи

  URL rest/api/diary/tasks/{userID}/save
  Method POST

  Parameters:

  task - текст задачи

  taskID - идентификатор задачи (в случае добавления новой задачи должен отсутствовать)

  start - дата начала в формате yyyy-MM-dd либо yyyy-MM-dd HH:mm:00 (первый для задач в течение дня, второй для задач с конкретным временем)

  finish - дата завершения в формате yyyy-MM-dd либо yyyy-MM-dd HH:mm:00 (первый для задач в течение дня, второй для задач с конкретным временем)

  wholeDay - в течение целого дня или нет

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

  locale - локаль

  Returns:

  json вида {errorCode: code_value, errorMessage: some_message} Если errorCode = 0, значит действие было выполнено успешно, иначе- нет и в errorMessage должна содержаться информация об ошибке

• deleteTask

  public java.lang.String deleteTask(java.lang.String taskID,
                                     java.lang.String locale)

  Метод для удаление задачи

  URL rest/api/diary/tasks/delete
  Method GET

  Parameters:

  taskID - идентификатор задачи

  locale - локаль

• setTaskState

  public Response setTaskState(java.lang.String taskID,
                               java.lang.String locale)

  Метод для завершения заментки

  URL rest/api/diary/tasks/complete
  Method GET

  Parameters:

  taskID - идентификатор задачи (в случае добавления новой задачи должен отсутствовать)

  locale - локаль

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

  `/rest/api/diary/tasks/complete?taskID=e6fc40b0-9fe4-11e6-9ce4-001ef892a4ee`

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

  { "errorCode": 0, "errorMessage": "Заметка успешно завершена" }

• getTask

  public Response getTask(java.lang.String taskID,
                          java.lang.String locale)

  Получение заметки по идентификатору

  URL /rest/api/diary/tasks/get
  Method GET Метод принимает следующие входные параметры:

  - `taskID` - `uuid` заметки (обяз.);

  - `locale` - локаль.

  Метод возвращает описание заметки с указанным идентификатором.

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

  - `taskID` - `uuid` заметки;

  - `task` - текст заметки;

  - `start` - дата и время начала исполнения заметки, в формате `yyyy-MM-dd HH:mm:ss`;

  - `finish` - дата и время завершения исполнения заметки, в формате `yyyy-MM-dd HH:mm:ss`;

  - `wholeDay` - признак исполнения заметки в течение дня. Одно из следующих значений:

  - `true` - установлен срок исполнения "в течение дня";

  - `false` - не установлен срок исполнения "в течение дня".

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

  `rest/api/diary/tasks/get?taskID=e6fc40b0-9fe4-11e6-9ce4-001ef892a4ee`

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

  { "taskID" : "e6fc40b0-9fe4-11e6-9ce4-001ef892a4ee", "task" : "заметка №1", "start" : "2016-12-05 10:00:00", "finish" : "2016-12-05 16:00:00", "wholeDay" : false }

• getUserTasks

  public Response getUserTasks(java.lang.String userID,
                               java.lang.String start,
                               java.lang.String finish,
                               java.lang.String locale)

  Получения заметок пользователя из календаря за промежуток времени

  URL rest/api/diary/tasks/{userID}/all
  Method GET

  Parameters:

  start - дата начала в формате yyyy-MM-dd

  finish - дата завершения в формате yyyy-MM-dd

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

  locale - локаль

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

  `rest/api/diary/tasks/8f60bf3b-0fff-11e9-bfb4-001ef892a4ee/all?start=2016-12-05&finish=2016-12-25`

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

  [ { "taskID" : "e6fc40b0-9fe4-11e6-9ce4-001ef892a4ee", "task" : "заметка №1", "start" : "2016-12-05 10:00:00", "finish" : "2016-12-05 16:00:00" }, { "taskID" : "5dfc40b0-9fe4-11e6-9ce4-001ef892a4ee", "task" : "заметка №2", "start" : "2016-12-10 09:45:00", "finish" : "2016-12-10 12:00:00" }, { "taskID" : "21sdd1sb0-9fe4-11e6-9ce4-001ef892a4ee", "task" : "заметка №3", "start" : "2016-12-20 09:00:00", "finish" : "2016-12-20 18:00:00" }, { "taskID" : "11lc40b0-5fkh-11e6-9ce4-001ef892a4ee", "task" : "заметка №4", "start" : "2016-12-25 09:00:00", "finish" : "2016-12-25 18:00:00" } ]

• getUserID

  public java.lang.String getUserID()

Constructor Detail

• ApplicationImportServlet

  public ApplicationImportServlet()

Method Detail

• doPost

  protected void doPost(HttpServletRequest req,
                        HttpServletResponse res)
                 throws ServletException,
                        java.io.IOException

  Throws:

  ServletException

  java.io.IOException

Constructor Detail

• ApplicationExportServlet

  public ApplicationExportServlet()

Method Detail

• doGet

  protected void doGet(HttpServletRequest req,
                       HttpServletResponse res)
                throws ServletException,
                       java.io.IOException

  Throws:

  ServletException

  java.io.IOException

Constructor Detail

• PersonalRecordService

  public PersonalRecordService()

Method Detail

• getForms

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

  Метод возвращает информацию о личных карточках пользователя (названия и идентификаторы форм)

  URL rest/api/personalrecord/forms/{userID}
  Method GET
  
  Метод возвращает список из элементов, каждый из которых описывает одну личную карточку. Для каждой личной карточки возвращаются поля:
  form-uuid - идентификатор формы
  formCode - код формы
  name - название личной карточки
  editable - есть ли право у данного пользователя менять поля данной карточки
  data-uuid - идентификатор файла по форме
  mandatory - является ли данная карточка обязательной к заполнению

  Parameters:

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

  locale - локаль пользователя, делающего запрос (QueryParam)

  Returns:

  список элементов json

• getUserID

  public java.lang.String getUserID()

Constructor Detail

• GroupsService

  public GroupsService()

Method Detail

• getGroups

  public Response getGroups(java.lang.String search,
                            java.lang.Integer parentGroupID,
                            java.lang.String parentGroupCode,
                            java.lang.Integer startRecord,
                            java.lang.Integer recordsCount,
                            boolean loadAllHierarchy,
                            java.lang.Integer right,
                            boolean loadAutoGroups,
                            java.lang.String locale)

  поиск групп

• getGroupContent

  public Response getGroupContent(java.lang.String search,
                                  java.lang.Integer parentGroupID,
                                  java.lang.Integer startRecord,
                                  java.lang.Integer recordsCount,
                                  java.lang.Integer right,
                                  boolean loadAutoGroups,
                                  java.lang.String locale)

• get

  public Response get(int groupID,
                      java.lang.String search,
                      java.lang.String locale)

• getUserID

  public java.lang.String getUserID()

Constructor Detail

• DepartmetnsService

  public DepartmetnsService()

Method Detail

• saveDepartment

  public java.lang.String saveDepartment(java.lang.String nameRu,
                                         java.lang.String nameKz,
                                         java.lang.String nameEn,
                                         java.lang.String positionNameRu,
                                         java.lang.String positionNameKz,
                                         java.lang.String positionNameEn,
                                         java.lang.String pointersCode,
                                         java.lang.String departmentID,
                                         java.lang.String parentDepartmentID,
                                         int number,
                                         java.lang.String locale)

  Метод создает/изменяет подразделение орг структуры

  URL rest/api/departments/save
  Method POST

  Parameters:

  nameRu - Название подразделения на русском языке, FormParam

  nameKz - Название подразделения на казахском языке, FormParam

  nameEn - Название подразделения на английском языке, FormParam

  positionNameRu - Название должности руководителя на русском языке, FormParam

  positionNameKz - Название должности руководителя на казахском языке, FormParam

  positionNameEn - Название должности руководителя на английском языке, FormParam

  pointersCode - код показателя, FormParam

  number - порядковый номер подразделения

  departmentID - UUID подразделения (для создания нового подразделения необходимо передать null), FormParam

  parentDepartmentID - UUID родительского подразделения, FormParam

  locale - локаль, QueryParam

  Returns:

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

• deleteDepartment

  public java.lang.String deleteDepartment(java.lang.String departmentID,
                                           java.lang.String locale)

  Метод удаляет подразделение

  URL rest/api/departments/delete
  Method GET

  Parameters:

  departmentID - UUID подразделения, которое надо удалить (QueryParam)

  locale - локаль (QueryParam)

  Returns:

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

• getDepartment

  public java.lang.String getDepartment(java.lang.String departmentID,
                                        java.lang.String locale)

  Метод возвращает информацию о подразделении подразделение

  URL rest/api/departments/get
  Method GET

  Parameters:

  departmentID - UUID подразделения, QueryParam

  locale - локаль, QueryParam

  Returns:

  json, описание полей см в FileCabinetWrapper#getDepartmentasJson

  See Also:

  FileCabinetWrapper#getDepartmentasJson(arta.synergy.web.common.client.data.filecabinet.Department, String)

• getDepartmentsAsList

  public java.lang.String getDepartmentsAsList(java.lang.String locale,
                                               java.lang.Integer partNumber,
                                               java.lang.Integer countInPart)

  Метод возвращает список подразделений (без учета структуры)

  URL rest/api/departments/list
  Method GET
  * @return Список департаментов, описание полей департамента смотрите в методе FileCabinetWrapper#getDepartmentasJson

  See Also:

  FileCabinetWrapper#getDepartmentasJson(arta.synergy.web.common.client.data.filecabinet.Department, String)

• getDepartmentsContent

  public java.lang.String getDepartmentsContent(java.lang.String departmentID,
                                                boolean onlyPosition,
                                                boolean onlyDepartments,
                                                java.lang.String locale)

  Метод используется для получения информации о департаменте (подразделения и должности)
  Тип: GET
  URL: rest/api/departments/content

  Parameters:

  departmentID - идентификатор департамента

  onlyPosition - true - отображение должностей только одного департамента (по умолчанию false)

  onlyDepartments - true - отображение подотделов только одного департамента (по умолчанию false)

  locale - локаль

  Returns:

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

          [
            {
              "departments":
              [
                {
                  "departmentID": "7b097e72-e303-487f-83a1-cb76397abd57",
                  "departmentName": "Департамент технологий",
                  "hasChildDepartments" : false,
                  "pointerCode" : "code",
                  "departmentHead":
                  {
                    "headID": "f9b0b304-c856-4bcf-8615-e13cded16a14",
                    "headName": "Иванов И.И."
                  }
                },
                {
                  "departmentID": "8ii056e72-e563-667f-14j7-cb31867qwe66",
                  "departmentName": "Департамент развития",
                  "hasChildDepartments" : true,
                  "departmentHead":
                  {
                    "headID": "179bda2e-6d55-4ed5-b1be-890ffad280ba",
                    "headName": "Петров П.П."
                  }
                }
              ],
              "positions":
              [
                {
                  "positionID": "dc890ecf-e340-4ada-b7e6-d6541486a599",
                  "positionName": "Маркетолог",
                  "code": "shifr2",
                  "pointerCode": "code2",
                  "employees":
                  [
                    {
                      "employeeID": "f40b665c-f1f4-40b3-bdc5-291911def539",
                      "employeeName": "Попов П.В."
                    },
                    {
                      "employeeID": "22cc3118-3bcd-4543-98b4-a30982ba5c2a",
                      "employeeName": "Сидоров С.В."
                    },
                    {
                      "employeeID": "414acd59-aaf8-4202-8c00-b39e1fe73bbc",
                      "employeeName": "Орлов О.О."
                    }
                  ]
                },
                {
                  "positionID": "2d9a641d-178c-4b05-b2f4-a231958718fd",
                  "positionName": "Финансовый аналитик",
                  "code": "shifr1",
                  "pointerCode": "code1",
                  "employees":
                  [
                    {
                      "employeeID": "c4ddd6b1-ade2-4ee2-ace5-aaec6a81d02a",
                      "employeeName": "Мартынов М.М."
                    },
                    {
                      "employeeID": "ee71a4c6-888a-4f04-86de-44ab394f5749",
                      "employeeName": "Быков Г.Г."
                    }
                  ]
                },
                {
                  "positionID": "22a48f88-199a-4398-8eb6-15ba8ef35deb",
                  "positionName": "Юрист",
                  "code": "shifr3",
                  "pointerCode": "code3",
                  "employees":
                  [
                    {
                      "employeeID": "a2ba229b-366f-4d9c-b8bd-31742a7a519a",
                      "employeeName": "Мусина А.М."
                    },
                    {
                      "employeeID": "a5b67a57-bcba-4513-bc2d-089400457a53",
                      "employeeName": "Дарбаева Г.Г."
                    },
                    {
                      "employeeID": "ca936f83-3d4e-4c09-b393-9e548d18bc04",
                      "employeeName": "Жакин Н.Б."
                    },
                    {
                      "employeeID": "ff666f77-7ii8-5b09-o565-2f555v33qq11",
                      "employeeName": "Васильев Г.В."
                    }
                  ]
                }
              ]
            }
          ]
       
   departments - массив подотделов данного департамента:
       
        departmentID - UUID подразделения
       
        departmentName - название подотдела на языке локали, переданной в параметре locale
       
        hasChildDepartments - есть ли дочерние департаменты
       
        pointerCode - код для показателей департамента
       
        departmentHead - руководитель подотдела:
       
            headID - UUID руководителя
       
            headName - Ф.И.О. руководителя в формате "Фамилия И.О."
       
   positions - массив должностей данного департамента:
       
        positionID - UUID должности
       
        positionName - название должности на языке локали, переданной в параметре locale
       
        pointerCode - код для показателей должности
       
        code - шифр должности
       
        type - тип должности
       
        employees - массив сотрудников на данной должности:
       
            employeeID - UUID сотрудника
       
            employeeName - Ф.И.О. сотрудника в формате "Фамилия И.О."
       

• getDepartmentCards

  public java.lang.String getDepartmentCards(java.lang.String departmentID,
                                             java.lang.String locale)

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

  URL rest/api/departments/get_cards
  Method GET
  Для заполнения полей карточки надо использовать метод APIFormsService#save

  Parameters:

  departmentID - UUID подразделения

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

  Returns:

  список json объектов с информацией о карточке подразделения, для каждой карточки присутствуют поля:
  form-uuid uuid формы
  formCode - код формы
  name название карточки
  editable true - есть право наредактирование, иначе - false
  data-uuid uuid данных по данной карточке
  mandatory true - карточкая обязательна для заполнения, иначе - false

  See Also:

  APIFormsService.save(String, String, String, String, String, String)

• getDepartmentsByFieldValue

  public java.lang.String getDepartmentsByFieldValue(java.lang.String formUUID,
                                                     java.lang.String formCode,
                                                     java.lang.String fieldName,
                                                     java.lang.String value,
                                                     java.lang.String locale)

  ВНИМАНИЕ! Логика данного метода реализована некорректно, поэтому не рекомендуем его использовать. В скором времени метод будет заменен на правильный

  Находит подразделения по значению поля дополнительной карточки и возвращает список их идентификаторов

  URL rest/api/departments/get_by_field_value
  Method GET

  
  

  Предполагается, что данный метод будет использоваться для реализации интеграционных решений (синхронизации орг структуры ARTA Synergy с орг структурой сторонней системы). В дополнительной карточке подразделения может храниться идентификатор соответствующего подразделения в сторонней системе, этот метод позволит найти идентификатор подразделения в нашей системе по его идентификатору из сторонней системы

  Поиск производится по сначала по ключу, а в случае отсутствия ключа - по значению (key и value из данных компонента, /api/asforms/data/{dataUUID}).

  Для компонента "Переключатель вариантов" это порядок обратный, сначала по value, затем - по key. Надо учитывать, что в этом компоненте из-за особенностей реализации в key хранится название вариантов, а в value - значение.

  Parameters:

  formUUID - uuid формы, по полю которой необходимо произвести поиск

  formCode - code формы, по полю которой необходимо произвести поиск

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

  value - значение поля

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

  Returns:

  список, состоящий из идентификаторов подразделений

• getUserID

  public java.lang.String getUserID()

• searchDepartments

  public Response searchDepartments(java.util.List<java.lang.String> codes,
                                    java.util.List<java.lang.String> names,
                                    int recordsCount,
                                    int startRecord,
                                    java.lang.String codeSearchTypeP,
                                    java.lang.String nameSearchTypeP,
                                    java.lang.String deleted,
                                    java.lang.String locale)

  Метод поиска подразделений

  URL: /rest/api/departments/search

  Тип: GET

  Метод принимает следующие параметры:

  • name - название подразделения (необяз.), может быть передано несколько значений
  • pointer_code - код показателя (необяз.), может быть передано несколько значений
  • recordsCount - количество результатов, которые необходимо вернуть (по умолчанию 30). Максимальное значение параметра 100
  • startRecord - номер записи результатов, начиная с которой будут возвращены записи (по умолчанию 0)
  • searchTypeN - тип сравнения для параметра name (по умолчанию partial). Может принимать следующие значения:
    • exact - точное совпадение поискового запроса и значения поля
    • partial - вхождение поискового запроса в значение поля
  • searchTypePC - тип сравнения для параметра pointer_code (по умолчанию exact). Может принимать следующие значения:
    • exact - точное совпадение поискового запроса и значения поля
    • partial - вхождение поискового запроса в значение поля
  • deleted - включать ли в результат поиска удаленные департаменты. Допустимые значения: true или false
  • locale - локаль пользователя. Данный параметр учитывается при поиске по названию должности

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

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

  /rest/api/departments/search?pointer_code=dep1&pointer_code=dep3

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

  [ "rgg66d1-ad54-5462-aef5-aggrr55fd02a", "vgikwj4c6-88gh-ef44-3ffe-oepjfee5d6" ]

  При указании одновременно разных параметров результат запроса будет связан логическим И.

  Пример запроса: /rest/api/departments/search?pointer_code=dep5&name=Департамент5

  А при указании одновременно одинаковых параметров, результат будет производится по логическому ИЛИ.

  Пример запроса: /rest/api/departments/search?pointer_code=code1&pointer_code=code2

  В случае если по переданным входным параметрам ничего не найдено, сервер возвращает пустой массив.

Constructor Detail

• UsersService

  public UsersService()

Method Detail

• getUser

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

  Load and return basic iformation on user as json object

• getUserInner

  public static Response getUserInner(java.lang.String userId,
                                      java.lang.String locale,
                                      boolean getGroups)

• getUserContacts

  public Response getUserContacts(java.lang.String userID,
                                  java.lang.String locale)

  Список контактов пользователя

  Parameters:

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

  locale - локаль

  Returns:

• createUser

  public java.lang.String createUser(java.lang.String lastname,
                                     java.lang.String firstname,
                                     java.lang.String patronymic,
                                     java.lang.String pointersCode,
                                     boolean isChancellery,
                                     boolean isConfigurator,
                                     boolean isAdmin,
                                     java.lang.String email,
                                     java.lang.String jid,
                                     java.lang.String privateFolder,
                                     boolean hasAccess,
                                     boolean hasPrivateFolder,
                                     java.util.List<java.lang.String> hrDepartmentID,
                                     java.lang.String userID,
                                     java.lang.String login,
                                     java.lang.String password,
                                     java.lang.String locale)

  Метод создает/изменяет пользователя

  URL rest/api/filecabinet/user/save
  Method POST

  Parameters:

  lastname - фамилия, FormParam

  firstname - имя, FormParam

  patronymic - отчество, FormParam

  pointersCode - код показателя, FormParam

  isChancellery - является ли сотрудником канцелярии, FormParam

  isConfigurator - является ли методологом, FormParam

  isAdmin - является ли администратором системы, FormParam

  email - почтовый адрес для уведомлений, FormParam

  jid - адрес jabber аккаунта, FormParam

  privateFolder - личная папка, FormParam

  hasAccess - имеет ли доступ в систему, FormParam

  hrDepartmentID - UUID подразделений, в которых является сотрудником ОКК, FormParam

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

  hasPrivateFolder - создавать ли личную папку пользователя. Имеет смысл только при создании пользователя

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

  Returns:

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

• changeCredentials

  public Response changeCredentials(java.lang.String login,
                                    java.lang.String password,
                                    java.lang.String passwordConfirm,
                                    java.lang.String actionCode,
                                    java.lang.String locale)

  API для изменение логина или пароля текущего пользователя.

  URL rest/api/filecabinet/user/changeCredentials
  Method POST

  Parameters:

  login - новый логин, x-www-form-urlencoded

  password - новый пароль, x-www-form-urlencoded

  passwordConfirm - подтвержение нового пароля, x-www-form-urlencoded

  actionCode - тип дейтсвия. CHANGE_ALL - смена логина и пароля, CHANGE_LOGIN - смена логина, CHANGE_PASSWORD - смена пароля. x-www-form-urlencoded

  locale - локаль, x-www-form-urlencoded

  Returns:

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

• deleteUser

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

  Метод удаляет пользователя из системы

  URL rest/api/filecabinet/user/delete
  Method GET

  Parameters:

  userID - UUID пользователя, которого надо удалить (QueryParam)

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

  Returns:

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

• checkExistence

  public java.lang.String checkExistence(java.lang.String login,
                                         java.lang.String code,
                                         java.lang.String mail)

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

  URL rest/api/filecabinet/user/checkExistence
  Method GET

  Parameters:

  login - логин пользователя (QueryParam)

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

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

  Returns:

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

• getUsersByFieldValue

  public java.lang.String getUsersByFieldValue(java.lang.String formUUID,
                                               java.lang.String formCode,
                                               java.lang.String fieldName,
                                               java.lang.String value,
                                               java.lang.String locale)

  ВНИМАНИЕ! Логика данного метода реализована некорректно, поэтому не рекомендуем его использовать. В скором времени метод будет заменен на правильный

  Находит пользователей по значению поля дополнительной карточки и возвращает список их идентификаторов

  URL rest/api/filecabinet/get_by_field_value
  Method GET

  
  

  Предполагается, что данный метод будет использоваться для реализации интеграционных решений (синхронизации пользователей ARTA Synergy с пользователями сторонней системы). В дополнительной карточке пользователя может храниться идентификатор соответствующего пользователя в сторонней системе (или иное поле, присутствующее в обоих системах и позволяющее установить соответствие между пользователями, например, ИИН) этот метод позволит найти идентификатор пользователя в нашей системе по его идентификатору из сторонней системы

  Поиск производится по сначала по ключу, а в случае отсутствия ключа - по значению (key и value из данных компонента, /api/asforms/data/{dataUUID}).

  Для компонента "Переключатель вариантов" это порядок обратный, сначала по value, затем - по key. Надо учитывать, что в этом компоненте из-за особенностей реализации в key хранится название вариантов, а в value - значение.

  Parameters:

  formUUID - uuid формы, по полю которой необходимо произвести поиск

  formCode - uuid формы, по полю которой необходимо произвести поиск

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

  value - значение поля

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

  Returns:

  список, состоящий из идентификаторов пользователей

• getUserID

  public java.lang.String getUserID()