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

• 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

• 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

• 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

• 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()

Field Detail

• WORK

  public static final java.lang.String WORK

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

  See Also:

  Constant Field Values

• DOCUMENT

  public static final java.lang.String DOCUMENT

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

  See Also:

  Constant Field Values

• PERSONAL

  public static final java.lang.String PERSONAL

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

  See Also:

  Constant Field Values

Constructor Detail

• WorkFlowService

  public WorkFlowService()

Method Detail

• getWorks

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

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

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

  Parameters:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  Returns:

  список работ

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

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

  See Also:

  arta.synergy.web.common.client.data.actions.filter.WorkFilterType, arta.synergy.web.common.client.constants.SearchConstants, arta.synergy.web.common.client.data.actions.ActionSearchParams

• getWorksByFilterCode

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

  Возвращает список работ пользователя userID с общим числом работ, удовлетворяющих условиям поиска

  URL rest/api/workflow/works/list_ext
  Method GET

  Parameters:

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

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

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

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

  filterType - одно из значений перечисления WorkFilterType

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

  filterCode - код централизованного фильтра

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

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

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

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

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

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

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

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

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

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

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

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

  Returns:

  список работ

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

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

  See Also:

  arta.synergy.web.common.client.data.actions.filter.WorkFilterType, arta.synergy.web.common.client.constants.SearchConstants, arta.synergy.web.common.client.data.actions.ActionSearchParams

• getWorksById

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

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

  URL rest/api/workflow/works_by_id
  Method GET

  Parameters:

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

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

  Returns:

• getFilters

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

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

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

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

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

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

  Parameters:

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

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

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

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

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

  Returns:

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

  See Also:

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

• getComments

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

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

  
  

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

  Parameters:

  workID - uuid работы

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

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

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

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

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

  Returns:

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

  See Also:

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

• addComment

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

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

  
  

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

  Parameters:

  workID - uuid работы

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

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

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

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

  Returns:

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

• addAttachment

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

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

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

  
  

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

  
  

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

  Parameters:

  workID - uuid работы

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

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

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

  Returns:

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

• createAttachment

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

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

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

  Parameters:

  workID - UUID работы

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

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

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

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

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

  Returns:

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

  See Also:

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

• doCreateAttachment

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

• deleteComment

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

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

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

  
  

  Parameters:

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

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

  Returns:

• getAttachments

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

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

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

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

  Parameters:

  workID - uuid работы

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

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

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

  Returns:

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

• getWorkDocumentInfo

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

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

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

  Parameters:

  workID - UUID работы

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

  Returns:

  json c полями:
  documentID

• getFullAttachments

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

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

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

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

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

  Parameters:

  workID - - uuid работы

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

  Returns:

• deleteAttachment

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

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

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

  Parameters:

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

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

  Returns:

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

• getDefaultWorkFields

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

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

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

  Parameters:

  locale -

  Returns:

• createWork

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

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

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

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

  Parameters:

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

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

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

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

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

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

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

  completionFormID - идентификатор формы завершения (FormParam) ( можно указывать либо данный параметр либо параметр completionFormCode, при этом если передаются оба поля, то completionFormCode в приоритете)

  completionFormCode - код формы завершения (FormParam) ( можно указывать либо данный параметр либо параметр completionFormID, при этом если передаются оба поля, то completionFormCode в приоритете)

  locale - локаль (QueryParam)

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

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

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

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

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

  Returns:

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

  See Also:

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

• saveWork

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

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

  URL rest/api/workflow/work/save
  POST

  Parameters:

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

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

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

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

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

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

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

  actionID - uuid работы

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

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

  Returns:

• getSubWorks

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

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

  URL rest/api/workflow/subworks/{workID}
  GET Возвращает список дочерних работ

  Parameters:

  workID - uuid работы

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

  startRecord - начальный офсет в общем списке результатов

  recordsCount - колечество результатов в ответе

  See Also:

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

• deleteWork

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

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

  URL rest/api/workflow/work/delete
  GET

  Parameters:

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

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

  Returns:

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

• setWorkProgress

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

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

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

  Parameters:

  workID - uuid работы

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

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

  Returns:

• setWorkState

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

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

  Parameters:

  workID - UUID работы

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

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

  Returns:

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

  See Also:

  ActionStates#COMPLETED

• markWorkSeen

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

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

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

  Parameters:

  workID - uuid работы

  Returns:

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

• getWorkCompletionResult

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

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

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

  Parameters:

  workID - UUID работы

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

  Returns:

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

  See Also:

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

• getWorkActions

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

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

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

  URL rest/api/workflow/work/get_actions
  GET

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

  Parameters:

  workID - uuid работы

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

  Returns:

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

  See Also:

  WorkActionType, WorkActionSubType, ActionColor

• getProcessFinishInfo

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

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

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

  Parameters:

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

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

  Returns:

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

  See Also:

  ActionColor

• getSendWorkInfo

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

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

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

  Parameters:

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

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

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

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

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

  Returns:

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

  See Also:

  ActionColor

• finishProcess

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

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

  URL rest/api/workflow/finish_process
  Method POST
  

  Parameters:

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

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

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

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

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

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

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

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

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

  Returns:

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

• getWorkCompletionData

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

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

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

  Parameters:

  workID - UUID работы

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

  Returns:

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

  See Also:

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

• acceptWorkResult

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

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

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

  Parameters:

  workID - UUID работы

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

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

  Returns:

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

• rejectWorkResult

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

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

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

  Parameters:

  workID - UUID работы

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

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

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

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

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

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

  Returns:

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

• setWorkResult

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

  Parameters:

  workID - UUID работы

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

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

  Returns:

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

  See Also:

  StorageService.startUploadFile(String), (String)

• getFormForCompletionResult

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

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

  
  

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

  Parameters:

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

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

  workID - UUID работы

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

  Returns:

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

• startRoute

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

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

  
  

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

  Parameters:

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

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

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

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

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

  completionFormID - UUID формы завершения, имеет смысл только для типа RouteItemElementType.ASSIGNMENT_ITEM 3 ( можно указывать либо данный параметр либо параметр completionFormCode, при этом если передаются оба поля, то completionFormCode в приоритете)

  completionFormCode - Код формы завершения, имеет смысл только для типа RouteItemElementType.ASSIGNMENT_ITEM 3 ( можно указывать либо данный параметр либо параметр completionFormID, при этом если передаются оба поля, то completionFormCode в приоритете)

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

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

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

  Returns:

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

• getResponsibleRoute

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

• transferWork

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

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

  
  

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

  Parameters:

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

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

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

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

  Returns:

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

• getCounters

  public java.lang.String getCounters()

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

  
  

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

  Returns:

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

• getExecutionProcess

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

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

  
  

  URL rest/api/workflow/get_execution_process
  Method GET
  

  Parameters:

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

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

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

  Returns:

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

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

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

  
  

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

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

• getHost

  public java.lang.String getHost()

• getUserID

  public java.lang.String getUserID()

• getWorkTime

  public Response getWorkTime(java.lang.String startDate,
                              java.lang.String finishDate)

  Метод возвращает время в секундах от указанного времени `startDate` и `finishDate` в рабочих часах.
  
  URL: rest/api/workflow/getWorkTime
  Тип: GET
  

  Parameters:

  startDate - Дата начала

  finishDate - Конечная дата

  Returns:

  json объект времени в рабочих часах возвращающий: миллисекунды, секунды, минуты, часы, дни
  
  startDate Передать значение в виде: 2019-02-20 09:40:52
  finishDate Передать значение в виде: 2019-02-20 15:49:16

• getFinishDate

  public Response getFinishDate(java.lang.String startDate,
                                java.lang.String duration)

  Метод возвращает дату завершения по дате начала и длительности
  
  URL: rest/api/workflow/get_finish_date
  Тип: GET
  

  Parameters:

  startDate - Дата начала

  duration - Длительность (в минутах)

  Returns:

  string в формате yyyy-MM-dd HH:mm:ss
  
  startDate Передать значение в виде: 2019-02-20 09:40:52
  duration Передать значение в виде: 90

• getWorkItems

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

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

  Parameters:

  workID - uuid работы

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

  Returns:

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

  See Also:

  WorkActionType, WorkActionSubType, ActionColor

• resolutionInfo

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

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

  Parameters:

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

  locale - локаль

  Returns:

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

• getWorkDialogs

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

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

  Parameters:

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

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

  locale - локаль

  Returns:

  json строка
  

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

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

  See Also:

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

• setWorkResponsibles

  public Response setWorkResponsibles(java.lang.String locale,
                                      ActionResponsibles responsibles)

  Метод API указывает исполнителей для работ, где указана должность URL: rest/api/workflow/work/set_responsibles
  Method POST
  Метод принимает следующие входные параметры (json):
  
  workID - ид работы
  responsibles - массив uuid пользователей должности, которым будет назначена работа; Пример передаваемого запроса: { "workID": "6e90e0a1-efe4-4d78-93e5-4540315560e0", "responsibles":["02a5723f-811d-4f62-94c9-ccdf2d74cd1e"] } В случае успешного выполнения json со следующими полями:

  • errorCode = 0
  • errorMessage = Данные сохранены

  в случае ошибки вернет json со следующими полями

  • errorCode = код ошибки
  • errorMessage = сообщение

  Пример возвращаемого json-объекта при успешном выполнении метода:

       {
          "errorCode": 0,
          "errorMessage": "Данные сохранены"
       }
   

  Parameters:

  responsibles - json-объект;

  locale - локаль

  Returns:

• dismissTimer

  public Response dismissTimer(java.lang.String id)

  Метод API для прерывания таймера URL: rest/api/workflow/dismiss_timer
  Method POST
  Метод принимает следующие входные параметры:
  
  id - ид таймера В случае успешного выполнения json со следующими полями:

  • errorCode = 0
  • errorMessage = Таймер прерван

  в случае ошибки вернет json со следующими полями

  • errorCode = код ошибки
  • errorMessage = сообщение

  Пример возвращаемого json-объекта при успешном выполнении метода:

       {
       "errorCode": 0,
       "errorMessage": "Таймер прерван"
       }
   

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

       {
       "errorCode": 0,
       "errorMessage": "Таймер прерван"
       }
   

  
  

       {
       "errorCode": 3,
       "errorMessage": "Не передан либо передан некорректный параметр id"
       }
   

  
  

       {
       "errorCode": 2,
       "errorMessage": "Пользователь не авторизован, или у пользователя недостаточно прав для изменения."
       }
   

  
  

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

  Parameters:

  id - ;

  Returns:

• setStartdate

  public Response setStartdate(java.lang.String id,
                               java.lang.String startdate)

  Метод API для обновления таймера URL: rest/api/workflow/set_startdate
  Method POST
  Метод принимает следующие входные параметры:
  
  id - ид таймера
  startdate - Дата и время запуска таймера в формате yyyy-MM-dd либо yyyy-MM-dd HH:mm:00 В случае успешного выполнения json со следующими полями:

  • errorCode = 0
  • errorMessage = Таймер обновлен

  в случае ошибки вернет json со следующими полями

  • errorCode = код ошибки
  • errorMessage = сообщение

  Пример возвращаемого json-объекта при успешном выполнении метода:

       {
       "errorCode": 0,
       "errorMessage": "Таймер обновлен"
       }
   

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

       {
       "errorCode": 3,
       "errorMessage": "Не передан либо передан некорректный параметр id"
       }
   

  
  

       {
       "errorCode": 2,
       "errorMessage": "Пользователь не авторизован, или у пользователя недостаточно прав для изменения."
       }
   

  
  

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

  
  

       {
       "errorCode": 666,
       "errorMessage": "Таймер ранее запущен"
       }
   

  
  

       {
       "errorCode": 4,
       "errorMessage": "Некорректно указана дата startdate"
       }
   

  Parameters:

  id - ;

  startdate - ;

  Returns:

Field Detail

• WWW_AUTHENTICATE

  public static final java.lang.String WWW_AUTHENTICATE

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

  See Also:

  Constant Field Values

• WWW_AUTHENTICATE_VALUE

  public static final java.lang.String WWW_AUTHENTICATE_VALUE

  See Also:

  Constant Field Values

Constructor Detail

• AccessForbiddenServlet

  public AccessForbiddenServlet()

Method Detail

• service

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

  Throws:

  ServletException

  java.io.IOException

Constructor Detail

• 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

• 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

• IconServlet

  public IconServlet()

Method Detail

• init

  public static void init(ServletContext cnxt)

• doGet

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

  Throws:

  ServletException

  java.io.IOException

Constructor Detail

• StorageService

  public StorageService()

Method Detail

• startUploadFile

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

  Метод создает временный файл на стороне сервера

  
  

  URL rest/api/storage/start_upload
  Method GET
  

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

  Процесс загрузки файла на сервер должен выглядить следующим образом:

  • 1. Вызываем метод start_upload и получаем путь ко временному файлу
  • 2. Записываем частями байты файла, несколько раз последовательно вызывая метод upload_part
  • 3. используем идентификатор файла в другом методе API, где это необходимо (добавление файла к работе, указание результата работы и т.п.)

  Parameters:

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

  Returns:

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

• uploadPart

  public java.lang.String uploadPart(MultipartFormDataInput input,
                                     java.lang.String file,
                                     java.lang.String locale)

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

  
  

  URL rest/api/storage/upload_part
  Method POST
  Enctype multipart/form-data
  
  название поля формы для части файла должно называться - body

  Parameters:

  file - имя временного файла, полученного методом startUploadFile (QueryParam)

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

  Returns:

  See Also:

  startUploadFile(String)

• getIdentifierByPath

  public java.lang.String getIdentifierByPath(java.lang.String path)

  Получение идентификатора файла либо папки по пути
  

  URL: rest/api/storage/get_identifier_by_path
  Тип: GET
  

  Parameters:

  path - путь до файла или папки хранилища

  Returns:

  json с описанием папки/файла:
  * identifier - идентификатор папки или файла;
  * is_folder (true/false) - папка («true») или файл («false»);
  * size - размер файла в байтах (для папки значение = 0);
  * path - полный путь до папки или файла;
  * name - название папки или файла;
  * modified - дата и время последнего изменения папки или файла (в формате yyyy-mm-dd hh:mm:ss);
  * userName - ФИО пользователя, выполнившего последнее изменение папки или файла (в формате Фамилия Имя О.);
  * userID - идентификатор пользователя, выполнившего последнее изменение папки или файла;
  * right - сумма чисел, определяющая набор прав на папку или файл;
  * mime - mime тип файла (отображается только при значении is_folder = «false»);
  * icon - ссылка до иконки файла (отображается только при значении is_folder = «false»).
  
  Пример возвращаемого json для папки http://host:port/Synergy/rest/api/storage/get_identifier_by_path?path=Хранилище/01_

       {
          "identifier": "6cacb59f-a1d6-447b-9f85-06829e942309",
          "is_folder": true,
          "size": "0",
          "path": "/company_root/01_",
          "name": "01_",
          "modified": "2013-05-24 16:15:03",
          "userName": "Admin1 Admin1 A.",
          "userID": "1",
          "right": 0,
          "notEmpty": true
       }
   
  
   Пример возвращаемого json для файла http://host:port/Synergy/rest/api/storage/get_identifier_by_path?path=Хранилище/01_/1.doc
   
       {
          "identifier": "d2a75a06-618a-4058-a6ae-99f8440d8973",
          "is_folder": false,
          "size": "2218",
          "path": "/company_root/01_/1.doc",
          "name": "1.doc",
          "modified": "2014-01-28 11:05:39",
          "userName": "Petrov Petrov ",
          "userID": "a8b370ee-138a-40a6-bd32-7f6435a1b4af",
          "right": 0,
          "mime": "text/html",
          "ai_type": "ai_text",
          "icon": "rest/api/storage/icons/get?aiType=ai_text&fileName=1.doc",
          "notEmpty": false
       }
   
  

• listFiles

  public java.lang.String listFiles(java.lang.String parentID,
                                    boolean getOnlyFolders,
                                    java.lang.String locale)

  Метод возвращает список файлов в папке с идентификатором parentID

  
  

  URL rest/api/storage/list
  Method GET
  

  Parameters:

  parentID - - идентификатор папки, если не передан, то возвращаются все корневые папки, на которые пользователь имеет право, в том числе личная папка пользователя

  getOnlyFolders - - (true/false) - отображать ли только папки (не обяз., по умолчанию значение false);

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

  Returns:

  json со списком файлов и папок:
  * identifier - идентификатор папки или файла;
  * is_folder (true/false) - папка («true») или файл («false»);
  * size - размер файла в байтах (для папки значение = 0);
  * path - полный путь до папки или файла;
  * name - название папки или файла;
  * modified - дата и время последнего изменения папки или файла (в формате yyyy-mm-dd hh:mm:ss);
  * userName - ФИО пользователя, выполнившего последнее изменение папки или файла (в формате Фамилия Имя О.);
  * userID - идентификатор пользователя, выполнившего последнее изменение папки или файла;
  * right - сумма чисел, определяющая набор прав на папку или файл;
  * mime - mime тип файла (отображается только при значении is_folder = «false»);
  * icon - ссылка до иконки файла (отображается только при значении is_folder = «false»).
  
  Пример возвращаемого массива для папок

     [
       {
         "identifier": "5719212b-97b9-4558-9e67-baa04d0adc62",
         "is_folder": true,
         "size": "0",
         "path": "/aiservice/home/ee71a4c6-888a-4f04-86de-44ab394f5749",
         "name": "Мои документы",
         "modified": "0007-05-04 10:12:00",
         "userName": "Слепаков Иван И.",
         "userID": "ee71a4c6-888a-4f04-86de-44ab394f5749",
         "right": 7,
        },
        {
          "identifier": "91d1816a-b30e-47ea-988c-bd8864daa253",
          "is_folder": true,
          "size": "0",
          "path": "/company_root",
          "name": "company_root",
          "modified": "2011-10-10 09:13:39",
          "userName": " ",
          "userID": "0000-0000-0000-0002",
          "right": 7,
        }
     ]
   

  Пример возвращаемого массива для файлов

     [
       {
         "identifier":"f5003070-3740-4920-a4c5-01f8bf440774",
         "is_folder":false,
         "size":"19644",
         "path":"/company_root/Проект/Файл1.odt",
         "name":"Файл1.odt",
         "modified":"2013-03-13 16:35:45",
         "userName":"Слепаков Иван И.",
         "userID":"ee71a4c6-888a-4f04-86de-44ab394f5749",
         "right":7,
         "mime ":"application/vnd.oasis.opendocument.text",
         "icon":"rest/api/storage/icons/get?aiType=ai_text&fileName=Файл1.odt"
       },
       {
         "identifier":"a8bb8fba-b418-4fcb-9b86-519c261c446f",
         "is_folder":false,
         "size":"850",
         "path":"/company_root/Проект/Файл2.htd",
         "name":"Файл2.htd",
         "modified":"0016-05-03 03:15:00",
         "userName":"Слепаков Иван И.",
         "userID":"ee71a4c6-888a-4f04-86de-44ab394f5749",
         "right":7,
         "mime ":"text/htd",
         "icon":"rest/api/storage/icons/get?aiType=ai_htd&fileName=Файл2.htd"
       }
     ]
     

• listFavoriteFolders

  public java.lang.String listFavoriteFolders()

  Метод возвращает избранные папки в хранилище

  Метод не принимает никакие параметры.

  
  

  URL: rest/api/storage/favorite_folders
  Тип: GET
  

  Returns:

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

  • identifier - идентификатор папки
  • name - название закладки.

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

    [
       {
           "identifier": "5719212b-97b9-4558-9e67-baa04d0adc62"
           "name": "Общие документы"
       },
       {
           "identifier": "91d1816a-b30e-47ea-988c-bd8864daa253"
           "name": "Регламенты"
       }
    ]
   

• search

  public java.lang.String search(java.lang.String contains,
                                 java.lang.String notContains,
                                 java.util.List<java.lang.Integer> categoryID,
                                 java.lang.String aiType,
                                 java.lang.String folderID,
                                 java.lang.String modifiedFrom,
                                 java.lang.String modifiedTo,
                                 int sizeType,
                                 int sortType,
                                 boolean includeUnpublished,
                                 boolean includeExpired,
                                 boolean includeCompanions,
                                 int firstResult,
                                 int maxResult,
                                 java.lang.String searchArea,
                                 java.lang.String locale)

  Выполняет поиск в хранилище и возвращает список найденных файлов/папок

  
  

  URL rest/api/storage/search
  Method POST
  

  Parameters:

  contains - строка, которая должна содержаться в искомых файлах

  notContains - строка, которая не должна содержаться в искомых файлах

  categoryID - идентификатор классификатора, которому должны принадлежать искомые файлы. Значение данного параметра может быть передано несколько раз.

  aiType - определяет тип искомых файлов. Может быть передано значение одной из констант:

  • AIConstants.AI_FOLDER
  • AIConstants.AI_DOCUMENT
  • AIConstants.AI_IMAGE
  • AIConstants.AI_AUDIO
  • AIConstants.AI_VIDEO
  • AI_APPLICATION

  
  Параметр можно не передавать. В этом случае поиск вернет все файлы.

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

  modifiedFrom - начало периода последнего изменения в формате yyyy-MM-dd, параметр не нужно передавать если нет необходимости выполнять поиск по дате изменения

  modifiedTo - завершение периода последнего изменения в формате yyyy-MM-dd, параметр не нужно передавать если нет необходимости выполнять поиск по дате изменения

  sizeType - определяет размер искомого файла. Значением параметра может быть одно из значений констант:

  • AIConstants.ALL_SIZES
  • AIConstants.LITTLE
  • AIConstants.MIDDLE
  • AIConstants.BIG

  Значение по-умолчанию: AIConstants.ALL_SIZES

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

  • ExtendedSearchParams.SORT_RELEVANCE
  • ExtendedSearchParams.SORT_DATE
  • ExtendedSearchParams.SORT_READSCOUNT

  Значение по-умолчанию ExtendedSearchParams.SORT_RELEVANCE

  includeUnpublished - отображать ли в результатах поиска неопубликованные файлы, значение по-умолчаню - нет

  includeExpired - отображать ли в результатах поиска файлы, срок действия которых истек,

  includeCompanions - осуществлять ли поиск в папках документов, проектов, значение по-умолчанию - нет

  firstResult - номер первой записи для возвращаемых результатов выборки, значение по-умолчанию - 1

  maxResult - количество записей, которые должны быть возвращены, значение по-умолчанию - 30

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

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

  • name - осуществлять поиск только по названиям файлов
  • content - осуществлять поиск только по содержимому файлов
  • all - осуществлять поиск одновременно и по названию, и по содержимому файлов. Значение по умолчанию.

  Returns:

  json вида

   
      {
   
          "list": []           список найденных файлов
   
          "begin": "",         номер первой записи
   
          "length": "",        количество возвращенных записей
   
          "count": ""          общее количество найденных записей
   
      }
   

  Json каждого результата поиска имеет вид

   
     {
   
          identifier:      идентификатор файла
   
          ai_type:         тип файла
   
          name:            название файла
   
          path:            путь к файлу
   
          modified:        стам изменения
   
          parentID:        идентификатор родительского элемента
   
          fragments:       фрагменты текста файла наиболее удовлетворяющие поиску (поле может отсутствовать)
   
          icon_url:        ссылка до иконки файла (поле может отсутствовать)
   
          right:           сумма чисел, определяющая набор прав на папку или файл
   
     }
   

  See Also:

  arta.remote.client.AIConstants#AI_FOLDER, arta.remote.client.AIConstants#AI_DOCUMENT, arta.remote.client.AIConstants#AI_IMAGE, arta.remote.client.AIConstants#AI_AUDIO, arta.remote.client.AIConstants#AI_VIDEO, arta.remote.client.AIConstants#AI_APPLICATION, arta.remote.client.AIConstants#ALL_SIZES, arta.remote.client.AIConstants#LITTLE, arta.remote.client.AIConstants#MIDDLE, arta.remote.client.AIConstants#BIG, ExtendedSearchParams#SORT_RELEVANCE, ExtendedSearchParams#SORT_DATE, ExtendedSearchParams#SORT_READSCOUNT

• getPathToElement

  public java.lang.String getPathToElement(java.lang.String elementID,
                                           java.lang.String locale)

• getUserID

  public java.lang.String getUserID()

• createAttachment

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

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

  
  

  URL rest/api/storage/document/{docID}/attachment/create
  Method POST
  

  Parameters:

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

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

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

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

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

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

  Returns:

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

  See Also:

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

• remove

  public java.lang.String remove(java.lang.String elementID,
                                 java.lang.String locale)

  Метод используется для удаления файла или папки в хранилище
  Тип: POST
  URL: rest/api/storage/remove

  Parameters:

  elementID - идентификатор файла либо папки (обязательный параметр)

  locale - локаль

  Returns:

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

• move

  public java.lang.String move(java.lang.String elementID,
                               java.lang.String folderID,
                               java.lang.String locale)

  Метод используется для перемещения файла или папки в хранилище
  Тип: POST
  URL: rest/api/storage/move

  Parameters:

  elementID - идентификатор файла либо папки (что перемещаем, обязательный параметр)

  folderID - идентификатор папки (куда перемещаем, обязательный параметр)

  locale - локаль

  Returns:

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

• rename

  public java.lang.String rename(java.lang.String elementID,
                                 java.lang.String elementName,
                                 java.lang.String locale)

  Метод используется для переименования файла/папки в хранилище
  Тип: POST
  URL: rest/api/storage/rename

  Parameters:

  elementID - идентификатор файла либо папки (обязательный параметр)

  elementName - новое имя файла либо папки (обязательный параметр)

  locale - локаль

  Returns:

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

• create

  public java.lang.String create(java.lang.String folderID,
                                 java.lang.String folderName,
                                 java.lang.String locale)

  Метод используется для создания папки в хранилище
  Тип: POST
  URL: rest/api/storage/create

  Parameters:

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

  folderName - имя новой папки

  locale - локаль

  Returns:

  в случае успешного выполнения метод возвращает объект json с одним полем folderID - идентификатор новой папки, в случае ошибки:
  
  errorCode 13
  errorMessage сообщение, характеризующее ошибку
  Пример успешного выполнения: {"folderID" : "550e8400-e29b-41d4-a716-446655440000"}

• copy

  public java.lang.String copy(java.lang.String fileID,
                               java.lang.String documentID,
                               java.lang.String container,
                               java.lang.String locale)

  Метод используется для копирования файла из хранилища в документ
  Тип: POST
  URL: rest/api/storage/copy

  Parameters:

  fileID - идентификатор файла (обязательный параметр)

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

  container - контейнер (приложения либо прочие, по умолчанию - ase:attachmentContainer)

  locale - локаль

  Returns:

  в случае успешного выполнения сервер возвращает объект json с одним полем fileID - идентификатор нового файла, в случае ошибки:
  
  errorCode 13
  errorMessage сообщение, характеризующее ошибку
  Пример успешного выполнения: {"fileID" : "550e8400-e29b-41d4-a716-446655440000"}

  See Also:

  arta.synergy.web.common.client.data.bp.docflow.constants.DocFileType#INBOX_FILE, arta.synergy.web.common.client.data.bp.docflow.constants.DocFileType#WORK_FILE

• add

  public java.lang.String add(java.lang.String folderID,
                              java.lang.String path,
                              java.lang.String name,
                              java.lang.String locale)

  Метод используется для добавления файла в хранилище
  Тип: POST
  URL: rest/api/storage/add

  Parameters:

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

  path - абсолютный путь до файла (обязательное поле)

  name - имя файла (обязательное поле)

  locale - локаль

  Returns:

  в случае успешного выполнения сервер возвращает объект json с одним полем fileID - идентификатор нового файла, в случае ошибки:
  
  errorCode 13
  errorMessage сообщение, характеризующее ошибку
  Пример успешного выполнения: {"fileID" : "550e8400-e29b-41d4-a716-446655440000"}

• getDescription

  public java.lang.String getDescription(java.lang.String elementID,
                                         boolean mobile,
                                         java.lang.String locale)

  Возвращает детальную информацию папки/файла
  URL: rest/api/storage/description
  Тип: GET

  Parameters:

  elementID - идентификатор папки или файла (обяз.)

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

  Returns:

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

  • identifier - идентификатор папки или файла
  • is_folder (true/false) - папка («true») или файл («false»)
  • size - размер файла в байтах (для папки значение = 0)
  • path - полный путь до папки или файла
  • name - название папки или файла
  • modified - дата и время последнего изменения папки или файла (в формате yyyy-mm-dd hh:mm:ss)
  • userName - ФИО пользователя, выполнившего последнее изменение папки или файла (в формате Фамилия Имя О.)
  • userID - идентификатор пользователя, выполнившего последнее изменение папки или файла
  • right - сумма чисел, определяющая набор прав на папку или файл
  • mime - mime тип файла (отображается только при значении is_folder = «false»)
  • icon - ссылка до иконки файла (отображается только при значении is_folder = «false»)
  • parents - массив идентификаторов всех папок из path, причем порядок следования идентификаторов в массиве должен соответствовать порядку в параметре path (слева направо)
  • ai_type - тип элемента хранилища, один из следующих вариантов:
  • ai_folder - папка
  • ai_document - текстовый файл
  • ai_image - файл изображения
  • ai_audio - аудиофайл
  • ai_video - видеофайл
  • ai_application - прочие файлы

  Набор прав на папку или файл, права в системе:

     READ = 1 (право на просмотр элемента)
     ADD = 2 (право на добавление нового элемента)
     DELETE = 4 (право на удаление элемента)
     EDIT_FOLDER_VIEW = 8 (право на редактирование index страницы папки)
     EDIT_DOCUMENT = 16 (право на редактирование документа)
     ADD_COMMENT = 32 (право на добавление комментариев)
     EDIT_COMMENT = 64 (право на редактирование комментариев)
     DELETE_COMMENT = 128 (право на удаление комментариев)
     READ_COMMENT = 256 (право на просмотр комментариев)
     READ_VERSIONS = 512 (право на просмотр версий документа)
     EDIT_VERSIONS = 1024 (право на восстановление версий документа)
     EDIT_METADATA = 2048 (право на редактирование свойств документа)
     READ_METADATA = 4096 (право на просмотр свойств документа)
     EDIT_CATEGORIES = 8192 (право на редактирование классификатора документа)
     READ_CATEGORIES = 16384 (право на просмотр классификатора документа)
     ADD_DOCUMENT_REFERENCES = 32768 (право на добавление документа в список ссылок документа)
     EDIT_DOCUMENT_REFERENCES = 65536 (право на редактирование списка ссылок документа)
     DELETE_DOCUMENT_REFERENCES = 131072 (право на удаление ссылок документа)
     READ_DOCUMENT_REFERENCES = 262144 (право на просмотр списка ссылок документа)
     LOAD_DOCUMENT = 524288 (право на загрузку файла документа)
     MOVE = 2097152 (право на перемещение / переименовывание элемента)
     CHANGE_PERMISSION = 4194304 (право на назначение прав)
     FULL_ACCESS = 2147483647
   

  В случае неуспешного выполнения вовзращается json с полями:

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

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

    {
        "identifier": "f5003070-3740-4920-a4c5-01f8bf440774",
        "is_folder": false,
        "size": "19644",
        "path": "/company_root/Проект/Файл1.odt",
        "name": "Файл1.odt",
        "modified": "2013-03-13 16:35:45",
        "userName": "Слепаков Иван И.",
        "userID": "ee71a4c6-888a-4f04-86de-44ab394f5749",
        "right": 7,
        "mime ": "application/vnd.oasis.opendocument.text",
        "icon": "rest/api/storage/icons/get?aiType=ai_text&fileName=Файл1.odt",
        "parents": ["d1f91787-ac5d-4650-a7c0-1cdfbdd12165", "5860da7f-0615-4f46-8264-d8605d97ef9e"],
  "     ai_type": "ai_document"
    }
   

• createHtd

  public Response createHtd(java.util.Map<java.lang.String,java.lang.String> params)

• copy

  public Response copy(java.util.Map<java.lang.String,java.lang.String> params)

  копировать файл из хранилища в файл по форме Path rest/api/storage/asffile/copy

  Parameters:

  params - {objectId : , targetId : , dataId : } где objectId - идентификатор объекта targetId - идентификатор ноды данных по форме dataId - идентификатор данных по форме

  Returns:

• asfFile

  public Response asfFile(MultipartFormDataInput input,
                          java.lang.String nodeID,
                          java.lang.String dataUUID)
                   throws java.io.IOException,
                          javax.naming.NamingException,
                          RepositoryException

  загрузка файла в файл по форме (для реквестов более 2-х мегабайт работать не будет) Path rest/api/storage/asffile/upload

  Parameters:

  input - данные файла

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

  dataUUID - идентификатор данных

  Returns:

  {fileId : identifier}

  Throws:

  java.io.IOException

  javax.naming.NamingException

  RepositoryException

• addFile

  public Response addFile(java.lang.String dataUUID,
                          java.lang.String filePath,
                          java.lang.String fileName)
                   throws java.io.IOException,
                          javax.naming.NamingException,
                          RepositoryException

  добавляет загруженный на сервер файл в файл по форме Path rest/api/storage/asffile/addFile

  Parameters:

  dataUUID - идентификатор данных по форме

  filePath - путь до загруженного файла

  fileName - имя файла

  Returns:

  {fileId : identifier}

  Throws:

  java.io.IOException

  javax.naming.NamingException

  RepositoryException

• canEditAsfData

  public Response canEditAsfData(java.lang.String documentId)

• getDescription

  public Response getDescription(java.lang.String nodeId)

  Возвращает список версий

  Parameters:

  nodeId - идентификатор узла (документа, файла и тд)

  Returns:

  массив AIVersion

  • identifier - Ид файла
  • nodeIdentifier - Ид ноды
  • author - Автор
  • created - Дата создания
  • modified - Дата изменения
  • comment - Комментарий версии
  • length - Размер файла

Constructor Detail

• StorageGroupsService

  public StorageGroupsService()

Method Detail

• addUserToGroup

  public java.lang.String addUserToGroup(java.lang.String userID,
                                         int groupID,
                                         java.lang.String groupCode,
                                         java.lang.String locale)

  Метод добавляет пользователя в группу

  URL rest/api/storage/groups/add_user
  Method GET
  

  Parameters:

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

  groupID - идентификатор группы

  groupCode - код группы

  locale -

  Returns:

• removeUserFromGroup

  public java.lang.String removeUserFromGroup(java.lang.String userID,
                                              int groupID,
                                              java.lang.String groupCode,
                                              java.lang.String locale)

  Удаляет пользователя из группы

  URL rest/api/storage/groups/remove_user
  Method GET
  

  Parameters:

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

  groupID - идентификатор группы

  groupCode - код группы

  locale -

  Returns:

• getGroups

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

  Метод возвращает список групп

  URL rest/api/storage/groups/list
  Method GET
  

  Parameters:

  locale - локаль авторизованного пользователя

  startRecord - номер первой записи

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

  Returns:

  json объект - список групп, для каждой группы указаны:
  groupID - идентификатор группы
  groupCode - код группы
  name - название группы

• getUserID

  public java.lang.String getUserID()

Constructor Detail

• ASFFileServlet

  public ASFFileServlet()

Method Detail

• doPost

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

  Throws:

  ServletException

  java.io.IOException

• doGet

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

  Throws:

  ServletException

  java.io.IOException

• getImportingForms

  public java.util.Map<java.lang.String,java.lang.Object> getImportingForms()

Constructor Detail

• PDFDownloadServlet

  public PDFDownloadServlet()

Method Detail

• doGet

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

  Throws:

  ServletException

  java.io.IOException

Constructor Detail

• FileDownloadServlet

  public FileDownloadServlet()

Method Detail

• doGet

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

  Throws:

  ServletException

  java.io.IOException

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

Constructor Detail

• PositionsService

  public PositionsService()

Method Detail

• savePosition

  public java.lang.String savePosition(java.lang.String nameRu,
                                       java.lang.String nameKz,
                                       java.lang.String nameEn,
                                       java.lang.String pointersCode,
                                       java.lang.String departmentID,
                                       java.lang.String positionID,
                                       int positionType,
                                       int number,
                                       java.lang.String locale)

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

  URL rest/api/positions/save
  Method POST

  Parameters:

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

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

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

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

  positionID - UUID должности, FormParam

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

  positionType - тип должности, FormParam

  number - порядковый номер дожности, может отсутствовать, FormParam

  locale - локаль, QueryParam

  Returns:

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

• deletePosition

  public java.lang.String deletePosition(java.lang.String positionID,
                                         java.lang.String locale)

  Метод удаляет должность специалиста

  URL rest/api/positions/delete
  Method GET

  Parameters:

  positionID - UUID должности, которую необходимо удалить (QueryParam)

  locale - локаль (QueryParam)

  Returns:

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

• getPosition

  public java.lang.String getPosition(java.lang.String positionID,
                                      java.lang.String locale)

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

  URL rest/api/positions/get
  Method GET

  Parameters:

  positionID - UUID должности (QueryParam)

  locale - локаль (QueryParam)

  Returns:

• getPositionsWithCards

  public Response getPositionsWithCards(java.lang.String departmentID,
                                        int startRecord,
                                        int recordsCount,
                                        java.lang.String locale)

  Метод для получения информации о должностях департамента с карточками

  URL /rest/api/positions/getPositionsWithCards
  Method GET
  
  Можно указать несколько компонентов для каждой карточки. При этом необходимо будет указать параметр positionFormID и один или несколько cmpID.
  При указании одновременно нескольких наборов параметров необходимо дополнительно передать параметры поиска, прибавив к названиям параметров
  порядковый номер набора параметров. Количество наборов параметров, которые можно добавить неограничено. Главное соблюдать правильную нумерацию
  названий параметров: 1, 2, 3 и т.д. Первый набор не имеет порядкового номера. Таким образом, метод получит дополнительный набор параметров
  positionFormID1, cmpID1, positionFormID2, cmpID2 и т.д.Соотношение positionFormIDx к cmpIDx - один ко многим.
  Пример запроса:
  /rest/api/positions/getPositionsWithCards?departmentID=4df92af0-da1d-11e5-9c63-1e88d1bc0767&positionFormID=373c3270-cf0b-11e5-a154-1e88d1bc0767&cmpID=category&cmpID=rang
  &positionFormID1=23727710-cf22-11e5-a154-1e88d1bc0767&cmpID1=group&positionFormID2=13727710-cf22-11e5-a154-1e88d1bc0767&cmpID2=text&cmpID2=date

  Parameters:

  departmentID - идентификатор подразделения, должности которого необходимо вернуть;
  recursive - флаг рекурсивности поиска должностей (по умолч. false, необязательный):

  • true - поиск производится по всему дереву подразделения;
  • false - поиск производится непосредственно в указанном подразделении;

  
  cmpIsNeeded - флаг необходимости возврата полей карточки (по умолч. true, не обязательный). Принимает значения:

  • true - возврат полей карточки требуется;
  • false - возврат полей карточки не требуется;

  
  positionFormID - идентификатор карточки должностей, данные которой необходимо вернуть,обязателен, если в запросе не указан параметр cmpIsNeeded=false;
  positionFormCode - код карточки должностей, данные которой необходимо вернуть,обязателен, если в запросе не указан параметр cmpIsNeeded=false;
  cmpID - идентификатор элемента формы, информацию из которого необходимо вернуть. Может быть передано несколько значений, обязателен, если в запросе не указан параметр cmpIsNeeded=false;

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

  recordsCount - количество результатов, которые необходимо вернуть (по умолчанию 30, максимум 50, не обязательный);

  locale - локаль;

  Returns:

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

  • positionID - идентификатор должности;
  • positionName - наименование должности;
  • positionType - тип должности, один из следующих вариантов:
  • 1 - Руководитель;
  • 2 - Специалист;
  • 32 - Исполняющий обязанности;
  • 256 - Заместитель;
  • formUUID - идентификатор формы карточки должности;
  • formCode - код формы карточек должностей;
  • cmpData - данные из поля в карточке должностей.

  
  

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

   [
   { "positionID": "81ac53f0-c351-11e5-ab17-1e88d1bc0767",
    "positionName": "Водитель",
    "positionType": "256",
    "forms":[
      {
         "formUUID":"373c3270-cf0b-11e5-a154-1e88d1bc0767",
         "formCode":"form_code",
         "asfDataUUID":"41fd8240-b822-11e5-8630-525400bb7fc6",
      "values":[
         { "category":"2" },
         { "rang":"5" } ]
   },
   {
     "formUUID":"23727710-cf22-11e5-a154-1e88d1bc0767",
     "formCode":"form_code",
    "asfDataUUID":"182eeca0-d98e-11e5-8c91-525400bb7fc6",
     "values":[
         { "group":"основная" } ]
   },
   {
     "formUUID":"13727710-cf22-11e5-a154-1e88d1bc0767",
     "formCode":"form_code",
     "asfDataUUID":"45dg8240-b822-11e5-8630-525400bb7fc6",
     "values":[
         { "text":"Добавить в штатное расписание" },
         { "date":"2016-05-02" } ]
   }
     ]
   },
   { "positionID": "693616c0-d49b-11e5-a5fb-1e88d1bc0767",
    "positionName": "Водитель",
    "positionType": "2",
    "forms":[
    {
      "formUUID":"373c3270-cf0b-11e5-a154-1e88d1bc0767",
      "formCode":"form_code",
      "asfDataUUID":"c952f930-cfd5-11e5-bae8-525400bb7fc6",
      "values":[
         { "category":"3" },
         { "rang":"7" } ]
   },
   {
     "formUUID":"23727710-cf22-11e5-a154-1e88d1bc0767",
     "formCode":"form_code",
     "asfDataUUID":"1d8b0c40-91dd-11e5-9fa7-525400bb7fc6",
     "values":[
         { "group":"вспомогательная" } ]
   },
   {
     "formUUID":"13727710-cf22-11e5-a154-1e88d1bc0767",
     "formCode":"form_code",
     "asfDataUUID":"26lg8240-25jz-11e5-8630-525400bb7fc6",
     "values":[
         { "text":"Есть в штатном расписании" },
         { "date":"2015-06-02" } ]
         }
   ]
   },
   { "positionID": "ccee5340-c991-11e5-afba-1e88d1bc0767",
    "positionName": "Водитель",
    "positionType": "2",
    "forms":[
   {
      "formUUID":"373c3270-cf0b-11e5-a154-1e88d1bc0767",
      "formCode":"form_code",
      "asfDataUUID":"822ac240-b428-11e5-8630-525400bb7fc6",
      "values":[
         { "category":"2" },
         { "rang":"6" } ]
   },
   {
     "formUUID":"23727710-cf22-11e5-a154-1e88d1bc0767",
     "formCode":"form_code",
     "asfDataUUID":"39877130-9f17-11e5-9ae6-525400bb7fc6",
     "values":[
         { "group":"обслуживающая" } ]
   },
   {
     "formUUID":"13727710-cf22-11e5-a154-1e88d1bc0767",
     "formCode":"form_code",
     "asfDataUUID":"d66dd140-b822-11e5-8630-525400bb7fc6",
     "values":[
         { "text":"Добавить в штатное расписание" },
         { "date":"2016-02-15" } ]
   }
     ]
   }
   ]
   

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

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

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