API службы поддержки предоставляет возможность работы через SOAP и REST веб-сервисы. Примеры использования веб-сервисов показаны в конфигурации 1C:Библиотека интеграции со службой поддержки . В ней реализована подсистема для встраивания в конфигурации партнеров. Подсистема включает в себя набор команд, форм и модулей, необходимых для встраивания пользовательского интерфейса службы поддержки в другие конфигурации. Библиотека интеграции предоставляет набор процедур и функций, облегчающих работу с API. Вызовы процедур и функций для работы с API будут рассмотрены в примерах.
| Версия API | 1.0.6 |
|---|
Содержание
REST-сервис API-XML
Сервис используется для интеграции приложения 1С:Управление службой поддержки с другими приложениями. Примеры работы с веб-сервисом приведены в конфигурации 1С:Библиотека интеграции со службой поддержки. Ответы веб-сервиса формируются в формате XML. Также в формате XML нужно формировать запросы при отправке объектов на запись и изменение. Для упрощения работы, веб-сервис предоставляет модель описания фабрики объектов.
Пример использования в 1С:Предприятии:
// получим соединение с веб-сервисом
Соединение = Новый HTTPСоединение(Хост, Порт, ИмяПользователя, Пароль);
Запрос = Новый HTTPЗапрос("sdapi/hs/api-xml/version");
Ответ = Соединение.Получить(Запрос);
Версия = Ответ.ПолучитьТелоКакСтроку(); //возвращает строку с номером версии
SOAP-сервис API-SOAP
Сервис используется для интеграции приложения 1С:Управление службой поддержки с другими приложениями. Синхронная интеграция применяется для реализации пользовательского интерфейса и онлайн взаимодействия интегрированных приложений.
Операция execute
Обрабатывает переданный запрос и возвращает результат обработки.
Возвращаемое значение: Response
| Параметр | Тип | Возможно пустое | Направление передачи | Описание |
|---|---|---|---|---|
| request | Request | Входной | Содержит запрос на выполнение операции, например GetVersionRequest. |
Пример вызова этой операции в 1С:Предприятии:
МестоположениеWSDL = АдресПубликацииВебСервиса + "ws/api-soap?wsdl";
Определение = Новый WSОпределения(МестоположениеWSDL, ИмяПользователя, Пароль);
Прокси = Новый WSПрокси(Определение, "http://www.1cfresh.com/sd/api", "SDApi", "SDApiSoap");
Прокси.Пользователь = ИмяПользователя;
Прокси.Пароль = Пароль;
ЗапросТип = Прокси.ФабрикаXDTO.Тип("http://www.1cfresh.com/sd/api", "GetVersionRequest");
Запрос = Прокси.ФабрикаXDTO.Создать(ЗапросТип);
Версия = Прокси.execute(Запрос).version;
Тот же пример с использованием средств библиотеки :
Запрос = СлужбаПоддержки.СоздатьОбъект("GetVersionRequest");
Версия = СлужбаПоддержкиПовтИсп.Прокси().execute(Запрос).version;
Запросы к сервисам
Запросы к REST сервису
Получение версии сервиса REST
Запрос:
GET /version
Пример ответа:
1.0.6
Получение модели описания для фабрики объектов REST
Модель описания может использоваться для создания, чтения и работы с объектами.
GET /model.xsd
Получение данных авторизованного пользователя REST
Возвращает данные авторизованного пользователя.
GET /currentuser
Получение списка объектов REST
В качестве запроса передается имя класса.
Доступно для объектов всех классов-потомков от класса Object.
Шаблон запроса:
GET /{ТипОбъекта}s
Пример запроса:
GET /incidents
Для списков доступны возможности:
- Определить выводимые колонки. Для этого нужно использовать параметр columns.
- Установить отборы. Для этого нужно использовать параметр filter.
- Установить лимит на количество получаемых записей. Для этого нужно использовать параметр limit.
Эти параметры можно использовать в одном запросе в любой комбинации. Например:
GET /incidents?columns=...&filter=...&limit=...
В запросе можно использовать большие и маленькие буквы в именах классов и свойств.
Лимит на количество получаемых записей
Указание параметра limit. позволяет установить лимит на количество получаемых записей при получении списка объектов. Например, следующий запрос выдаст сведения о не более чем 3 инцидентах .
GET /incidents?&limit=3
Вывод реквизитов в списке
С помощью параметра запроса columns можно определить состава выводимых колонок при получении списка объектов. Доступно для объектов всех классов-потомков от класса Object.
Значение параметра это:
- имена полей класса, перечисленные через запятую;
- или * — выводить в ответе все колонки (все поля класса)
Пример запроса:
GET /incidents?columns=date,number,subject,initiator
Как уже говорилось, параметр запроса columns можно использовать одновременно с параметрами filter и/или limit.
GET /incidents?limit=3&columns=date,number,subject,initiator
Отборы в списке
Возможна установка отборов на получаемый список. Для этого нужно использовать параметр filter.
Фильтр представляет собой набор условий, разделенных символом ;
Условия можно применять ко всем доступным полям класса, возможным для вывода в списке. В условиях могут использоваться операторы:
- = – равно
- > – больше
- < – меньше
- >= – больше или равно
- <= – меньше или равно
- <> – не равно
- LIKE – подобно
- IN – в
- IN HIERARCHY – в иерархии
Для условий IN и IN HIERARCHY указывается список значений, разделенных символом |
GET /incidents?filter=modifiedDate>2021-09-01;component={Component,34f2ef0f-e63e-11e3-9905-bcaec5d6c3e4}
GET /applications?filter=code IN 9|1992|1005|10049
Для объектов, поддерживающих дополнительные реквизиты, можно осуществлять отбор, используя в качестве имени реквизита идентификатор дополнительного реквизита, например:
GET /subscribers?filter=a68efcf3-015d-11e6-9575-005056c00008=12345
Получает список Абонентов с отбором по значению дополнительного реквизита.
Получение списка подчиненных объектов REST
Можно получать подчиненные объекты от основного объекта.
Шаблон получения подчиненных объектов:
GET /{ТипПредмета}/{ИдПредмета}/{ТипОбъекта}
Пример получения взаимодействий и файлов по обращению с идентификатором (свойством id свойства objectId) 8756ca78-551c-11e4-93f4-0050568b4127:
GET /incident/8756ca78-551c-11e4-93f4-0050568b4127/phonecalls GET /incident/8756ca78-551c-11e4-93f4-0050568b4127/files
Доступно для предметов:
- Incident — обращения
- Consultation — консультации
- Problem — ошибка
- Suggestion — пожелание
Доступно для подчиненных объектов
- File — присоединенные файлы
- Interaction — все типы взаимодействий по предмету
- PhoneCall — телефонный звонок
- ServiceUserComment — комментарий пользователя сервиса
- IncomingEMail — входящее электронное письмо
- OutgoingEMail — исходящее электронное письмо
Получение объекта REST
Шаблон получения объектов:
GET /{ТипОбъекта}/{ИдОбъекта}
Например, запрос для получения обращения с идентификатором (свойством id свойства objectId) 8756ca78-551c-11e4-93f4-0050568b4127:
GET /incident/8756ca78-551c-11e4-93f4-0050568b4127
Доступно для всех объектов классов-потомков от класса Object.
Получение экземпляра нового объекта REST
Шаблон запроса:
GET /{ТипОбъекта}/new
Запрос доступен для:
- Incident — обращения
- Consultation — консультации
- Suggestion — пожелание
Получение экземпляра нового подчиненного объекта REST
Шаблон запроса:
GET /{ТипПредмета}/{ИдПредмета}/{ТипОбъекта}/new
GET /incident/8756ca78-551c-11e4-93f4-0050568b4127/phonecall/new
Доступно для предметов:
- Incident — обращения
- Consultation — консультации
- Problem — ошибки
- Suggestion — пожелание
Доступно для подчиненных объектов:
- ActualWork — запись о трудозатратах
- PhoneCall — телефонный звонок
- OutgoingEMail — исходящее электронное письмо
- Order — поручение
Добавление объекта REST
Объект передается в теле запроса в формате XML. Объект должен соответствовать описанию класса в модели.
Шаблон запроса:
POST /{ТипОбъекта}
Запрос доступен для:
- Incident — обращения
- Consultation — консультации
- Suggestion — пожелание
- OutgoingEMail — исходящее электронное письмо
- PhoneCall — телефонный звонок
- Order — поручение
Для старта процесса "Поручение" нужно указать дополнительные действия при добавлении объекта:
POST /Order?action=StartProcess
Если дополнительное действие не будет указано, то процесс будет добавлен, но не будет стартован.
Добавление подчиненного объекта REST
Данные подчиненного объекта передаются в теле запроса в формате XML.
Шаблон запроса:
POST /{ТипПредмета}/{ИдПредмета}/{ТипОбъекта}
Пример добавления файлов к обращению:
POST /incident/8756ca78-551c-11e4-93f4-0050568b4127/file
Доступно для предметов:
- Incident — обращения
- Consultation — консультации
- Problem — ошибка
- Suggestion — пожелание
Доступно для объектов:
- IncidentComment — комментарий обращения
- ArticleComment — комментарий карточки базы знаний
- ActualWork — запись фактических трудозатрат
- File — присоединенный файл
Обновление объекта REST
Объект передается в теле запроса.
Пример запроса:
PUT /incident
Запрос доступен для:
- Incident — обращения
- Consultation — консультации
- Suggestion — пожелание
- PhoneCall — телефонный звонок
- OutgoingEMail — исходящее электронное письмо
- Order — поручение
- Task — задача исполнителя
Для взаимодействий этот запрос доступен с действием Consider.
При выполнении такого запроса у взаимодействий устанавливается признак Рассмотрено.
При использовании параметра action тело запроса может не устанавливаться.
PUT /IncomingEmail/36c95f80-eca9-11e3-899c-bcaec5d6c3e4?action=consider
Объекты взаимодействий:
- IncomingEMail — входящее электронное письмо
- ServiceUserComment — комментарий пользователя
- OutgoingEMail — исходящее электронное письмо
- PhoneCall — телефонный звонок
Перенаправление объекта REST
Параметры перенаправления передаются в теле запроса.
Шаблон запроса:
PUT /{ТипОбъекта}/{ИдОбъекта}?action=redirect
Запрос доступен для объектов:
Принятие задачи к исполнению REST
Принятие задачи выполняется так же как и перенаправление.
В качестве исполнителя в теле запроса устанавливается текущий пользователь.
PUT /Task/e23e968a-26c5-11e4-93f4-0050568b4127?action=redirect
Выполнение задачи REST
Для выполнения задач используется отдельный запрос.
Шаблон запроса:
PUT /Task/{ИдЗадачи}?action={Действие}
Комментарий выполнения задачи передается в теле запроса.
При выполнении задачи возможно указание дополнительных действий:
- CompleteTask - выполнить задачу по умолчанию
- ReturnOnСompletion — вернуть на доработку
- CancelOrder - отменить поручение
Удаление объекта REST
Запрашивается тип объекта и уникальный идентификатор объекта.
Пример запроса:
DELETE /{ТипОбъекта}/{id}
Доступно для объектов:
- File — файлы
Запросы к SOAP сервису
Получение версии сервиса SOAP
Версия сервиса помогает определить внешней системе доступную функциональность сервиса.
Для получения версии сервиса нужно отправить запрос класса GetVersionRequest. Возвращается ответ класса GetVersionResponse, содержащий номер версии сервиса. Пример использования:
Запрос = СлужбаПоддержки.СоздатьОбъект("GetVersionRequest");
Версия = СлужбаПоддержкиПовтИсп.Прокси().execute(Запрос).version;
Класс GetVersionRequest
Базовый класс: Request
Запрос для получения текущей версии веб-сервиса.
Класс GetVersionResponse
Базовый класс: Response
Ответ на запрос GetVersionResponse. Возвращает текущую версию веб-сервиса.
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| version | string | Да | Номер версии web-сервиса. Строка вида 1.0.1.1 |
Получение данных авторизованного пользователя SOAP
Для получения данных авторизованного пользователя нужно отправить запрос класса GetCurrentUserRequest. Возвращается ответ класса GetCurrentUserResponse, содержащий данные текущего пользователя.
Пример использования:
Пользователь = СлужбаПоддержкиПовтИсп.ТекущийПользователь();
Результат запроса кэшируется на время сеанса.
Класс GetCurrentUserRequest
Базовый класс: Request
Запрашивает данные авторизованного пользователя.
Класс GetCurrentUserResponse
Базовый класс: Response
Возвращается в результате выполнения запроса GetCurrentUserRequest. Содержит в теле значение авторизованного пользователя.
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| object | Object | Да | Авторизованный пользователь |
Получение списка объектов SOAP
Получение списка объектов выполняется с помощью запроса класса GetListRequest. В качестве параметров запросу передаются строка с типом объекта и условия, включающие, набор колонок и отборы. При удачном выполнении запроса возвращается объект класса GetListResponse, содержащий список объектов запрошенного типа с указанными колонками. В случае ошибки возвращается Error.
С помощью этого запроса можно получить списки всех типов объектов из производных классов класса Object.
Пример использования:
Колонки = СтрРазделить("importance, subject, type, status, initiator, responsible, number, date", ", ", Ложь);
СписокXDTO = СлужбаПоддержки.ПолучитьСписокОбъектов("Incident", Колонки);
Для Каждого ОбъектXDTO Из СписокXDTO Цикл // ОбъектXDTO имеет тип ObjectListItem
СтрокаСписка = Список.Добавить(); // Список - произвольный список для заполнения данными из Api
// заполним строку из объекта в отдельной процедуре
ЗаполнитьСтрокуСписка(СтрокаСписка, ОбъектXDTO.object)
КонецЦикла;
Класс GetListRequest
Базовый класс: Request
Запрашивает список объектов (элементов справочника, документов, бизнес-процессов, задач или значений перечисления), удовлетворяющих указанному условию.
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| query | ListQuery | Параметры запроса. | |
| type | string | Да | Указывает тип объектов, список которых нужно получить. Например, Incident. |
Класс GetListResponse
Базовый класс: Response
Возвращается в результате успешной обработки запроса GetListRequest.
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| items | ListItem | Да | Список объектов. | |
| tooManyObjects | boolean | Признак того, что в выборке больше объектов, чем запрашивалось. |
Свойства запроса
Класс ListQuery
Параметры запроса GetListRequest.
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| columns | string | Да | Имена свойств, которые нужно заполнить у запрошенных объектов. | |
| filter | ListFilter | Да | Набор условий отбора. | |
| limit | integer | Предельное количество выбираемых объектов. |
Класс ListFilter
Условие отбора для запроса GetListRequest.
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| comparisonOperator | ComparisonOperator | Оператор сравнения. Если не заполнено, то используется значение "=". | |
| property | string | Да | Имя поля для отбора. |
| value | Любой тип | Значение поля отбора. Заполняется для всех условий кроме "IN" и "IN HIERARCHY" | |
| valueList | Любой тип | Список значений поля отбора. Заполняется только для условий "IN" и "IN HIERARCHY" |
Класс ComparisonOperator
Оператор сравнения для указания сложных условий в условии ListFilter запроса GetListRequest.
Значения перечисления:
- = – равно
- > – больше
- < – меньше
- >= – больше или равно
- <= – меньше или равно
- <> – не равно
- LIKE – подобно
- IN – в
- IN HIERARCHY – в иерархии
Свойства ответа
Каждый объект оборачивается в объект типа ListItem, содержащий сам объект, а также дополнительные свойства, для удобства отображения в списках и получения дочерних элементов.
Класс ListItem
Описывает элемент списка объектов.
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| canHaveChildren | boolean | Да | Признак того, что данный объект может содержать дочерние (т.е. является веткой дерева). |
| isFolder | boolean | Да | Признак того, что данный объект является группой. |
| object | Object | Да | Объект УСП. |
| parentId | ObjectId | Указывает на объект, который является родительским для данного объекта в контексте списка объектов. |
Получение списка подчиненных объектов SOAP
Получение списка подчиненных объектов, например взаимодействий, выполняется с помощью запроса класса GetSubListRequest. В качестве параметров запросу передаются ссылка на предмет взаимодействия и условия, включающие, набор колонок и отборы. При удачном выполнении запроса возвращается объект класса GetSubListResponse, содержащий список объектов запрошенного типа с указанными колонками. В случае ошибки возвращается Error.
Пример использования при получении взаимодействий:
Взаимодействия = СлужбаПоддержки.ПолучитьСписокПодчиненныхОбъектов(ВладелецТип, ВладелецID, "Interaction")
При получении взаимодействий можно использовать имена типов взаимодействий, либо имя Interaction, для получения списка взаимодействий всех типов.
Пример получения списка файлов:
Колонки = СтрРазделить("size, creationDate, modificationDateUniversal, extension, description",", ", Ложь);
Файлы = СлужбаПоддержки.ПолучитьСписокПодчиненныхОбъектов("Incident", Id, "File", Колонки);
Класс GetSubListRequest
Базовый класс: Request
Запрашивает список объектов по предмету.
Доступно для предметов
- Incident — обращения
- Consultation — консультации
- Problem — ошибка
- Suggestion — пожелание
Доступно для подчиненных объектов
- File — присоединенные файлы
- Interaction — все типы взаимодействий по предмету
- PhoneCall — телефонный звонок
- ServiceUserComment — комментарий пользователя сервиса
- IncomingEMail — входящее электронное письмо
- OutgoingEMail — исходящее электронное письмо
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| columns | string | Да | Набор свойств объекта, которые необходимо заполнить. Если список пуст или не указан, то заполняются все свойства. | |
| targetId | ObjectId | Да | Ссылка на предмет:
| |
| type | string | Да | Тип объекта. При получении взаимодействий можно указать тип Interaction для получения взаимодействий всех типов. |
Класс GetSubListResponse
Базовый класс: Response
Возвращается в результате успешной обработки запроса GetSubListRequest.
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| records | Record | Да | Полученные записи. |
Получение списка сведений по пользователям SOAP
Получение списка сведений по пользователям выполняется с помощью запроса GetServiceUserInfoListRequest. При удачном выполнении запроса возвращается объект класса GetServiceUserInfoListResponse, содержащий список сведений по пользователям сервиса. В случае ошибки возвращается Error.
Класс GetServiceUserInfoListRequest
Базовый класс: Request
Запрос для получения списка пользователей сервисов с дополнительной информацией. В параметрах можно указать частичные значения для поиска. Количество букв в строковых парамтрах не должно быть меньше 3.
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| applicationCode | int | Номер приложения | ||
| dynamicAttributes | DynamicAttribute | Да | Параметры отборов по дополнительным реквизитам | |
| serviceId | ObjectId | Да | Ссылка на сервис | |
| serviceUserEMail | string | Адрес электронной почты пользователя сервиса | ||
| serviceUserLogin | string | Логин пользователя сервиса | ||
| subscriberCode | int | Код абонента |
Класс GetServiceUserInfoListResponse
Базовый класс: Response
Ответ на запрос получения списка пользователей с расширенной информацией. Содержит запрашиваемый список.
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| items | ServiceUserInfoItem | Да | Элементы списка с расширенной информацией по пользователям сервиса |
Получение объекта SOAP
Для получения объектов используется запрос класса GetRequest. В качестве параметров в запросе передаются список ссылок на требуемые объекты и набор колонок, которые требуется получить. В случае удачного выполнения запроса возвращается ответ класса GetResponse, содержащий требуемые объекты. В случае ошибки возвращается Error.
Пример использования:
ОбъектXDTO = СлужбаПоддержки.ПолучитьОбъект("Incident", Id);
Класс GetRequest
Базовый класс: Request
Получает массив указанных объектов.
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| columns | string | Да | Массив имен свойств, которые должны быть заполнены. Если массив не указан или пустой, то заполняются все свойства. | |
| objectIds | ObjectId | Да | Ссылки на объекты. |
Класс GetResponse
Базовый класс: Response
Возвращается в результате успешной обработки запроса GetRequest.
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| records | Record | Да | Да | Массив записей. |
Получение экземпляра нового объекта SOAP
Можно получить экземпляр нового объекта с предварительно заполненными по умолчанию полями. Это удобно при создании новых объектов. Для получения экземпляра объекта отправляется запрос класса GetNewRequest. В качестве параметра в запросе передается строка с именем типа требуемого объекта. При успешном выполнении запроса возвращается ответ класса GetNewResponse, который содержит новый объект, заполненные по умолчанию. При возникновении ошибки возвращается Error.
Пример использования:
ОбъектXDTO = СлужбаПоддержки.ПолучитьНовыйОбъект("Incident")
Класс GetNewRequest
Базовый класс: Request
Запрашивает новый объект указанного типа, заполненный значениями по умолчанию.
Доступно для объектов:
- Incident — обращение
- Consultation — консультация
- Suggestion — пожелание
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| columns | string | Да | Список свойств объекта, которые должны быть заполнены. Если список пуст или не указан, то будут заполнены все свойства, для которых предусмотрены или могут быть вычислены значения по умолчанию. | |
| type | string | Да | Имя типа XDTO объекта, который требуется получить. |
Производные классы:
Класс GetNewResponse
Базовый класс: Response
Возвращается в результате успешной обработки запроса GetNewRequest и производных от него запросов.
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| record | Record | Да | Новая запись, заполненная по умолчанию. |
Производные классы:
Получение экземпляра нового подчиненного объекта SOAP
Для получения экземпляра нового взаимодействия отправляется запрос класса GetNewSubRequest. В качестве параметра в запросе передается ссылка на предмет и строка с именем типа требуемого объекта. При успешном выполнении запроса возвращается ответ класса GetNewSubResponse, который содержит новый объект, заполненные по умолчанию. При возникновении ошибки возвращается Error.
Пример использования:
// Получает новый телефонный эвонок по обращению
СлужбаПоддержки.ПолучитьНовыйПодчиненныйОбъект("Incident", Id, "PhoneCall");
Класс GetNewSubRequest
Базовый класс: GetNewRequest
Запрашивает новый объект взаимодействия указанного типа, заполненный значениями по умолчанию.
Доступно для объектов:
- PhoneCall — телефонный звонок
- OutgoingEMail — исходящее электронное письмо
- ActualWork — запись фактических трудозатрат
- Order — поручение
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| action | GetNewSubActions | Действие при получении нового объкта | |
| targetId | ObjectId | Да | Ссылка на предмет взаимодействия:
|
Класс GetNewSubResponse
Базовый класс: GetNewResponse
Возвращается в результате успешной обработки запроса GetNewSubRequest.
Свойства запроса
Класс GetNewSubActions
Описывает возможные действия при получении нового подчиненного объекта.
Значения перечисления:
- FillFromArticle – заполнить по карточке базы знаний
Добавление объекта SOAP
Для создания объекта используется запрос класса PostRequest. В качестве параметра передается список объектов с пустыми ссылками. При удачном выполнении запроса возвращается ответ класса PostResponse, содержащий созданные объекты. В случае неудачи возвращается Error.
Пример использования:
ОбъектXDTO = СлужбаПоддержки.ПолучитьНовыйОбъект("Consultation");
ЗаполнитьОбъект(ОбъектXDTO); // здесь выполняется заполнение объекта
СлужбаПоддержки.ДобавитьОбъект(ОбъектXDTO);
Для добавления нескольких объектов одним запросом следует использовать функцию:
СлужбаПоддержки.ДобавитьОбъекты(МассивОбъектовXDTO);
При записи процесса можно указать, что он должен быть стартован:
СлужбаПоддержки.ДобавитьОбъект(ОбъектXDTO, "StartProcess");
Класс PostRequest
Базовый класс: Request
Добавляет новые объекты в приложение.
Запрос доступен для:
- Incident — обращения
- Consultation — консультации
- Suggestion — пожелание
- PhoneCall — телефонный звонок
- OutgoingEMail — исходящее электронное письмо
- Order — поручение
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| action | PostActions | Дополнительное действие при записи объекта | ||
| objects | Object | Да | Содержит объекты, который требуется создать. |
Класс PostResponse
Базовый класс: Response
Возвращается в случае успешного добавления объекта вызовом PostRequest.
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| objects | Object | Да | Созданные объекы. |
Свойства запроса
Класс PostActions
Описывает дополнительные действия при добавлении объектов.
Значения перечисления:
- StartProcess – стартовать процесс
Добавление подчиненного объекта SOAP
Добавление подчиненных объектов осуществляется с помощью запроса класса PostSubRequest.Запросом передается ссылка на предмет и информация о записываемом объекте. При удачном выполнении запроса возвращается ответ класса PostSubResponse. В случае ошибки возвращается ответ класса Error.
Пример использования при записи файла:
// ПараметрыСоздания — содержит структуру создаваемого файла.
ФайлXDTO = СлужбаПоддержки.СоздатьОбъект("File");
ФайлXDTO.objectId = СлужбаПоддержки.СоздатьObjectID("File", "");
ФайлXDTO.binaryData = ПолучитьИзВременногоХранилища(ПараметрыСоздания.АдресВременногоХранилищаФайла);
ФайлXDTO.extension = ПараметрыСоздания.Расширение;
ФайлXDTO.modificationDateUniversal = ПараметрыСоздания.ВремяИзмененияУниверсальное;
ФайлXDTO.name = ПараметрыСоздания.Имя;
ФайлXDTO.size = ПараметрыСоздания.Размер;
ФайлXDTO.text = ПараметрыСоздания.Текст;
СлужбаПоддержки.ДобавитьПодчиненныйОбъект("Incident", ВладелецID, ФайлXDTO);
Класс PostSubRequest
Базовый класс: Request
Добавляет новый объект или запись к указанному объекту.
Доступно для предметов:
- Incident — обращения
- Consultation — консультации
- Problem — ошибка
- Suggestion — пожелание
Доступно для объектов:
- IncidentComment — комментарий обращения
- ArticleComment — комментарий карточки базы знаний
- ActualWork — запись фактических трудозатрат
- File — присоединенный файл
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| record | Record | Да | Добавляемая запись. Для объекта типа File должны быть обязательно заполнены свойства:
|
| targetId | ObjectId | Да | Ссылка на объект, например, Incident, к которому будет привязан созданный объект или запись. |
Класс PostSubResponse
Базовый класс: Response
Возвращается в случае успешной обработки запроса PostSubRequest.
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| record | Record | Да | Описание записи, которая были добавлена в УСП. |
Обновление объекта SOAP
Для обновления объекта используется запрос класса PutRequest. В качестве параметров запроса передаются объекты, которые требуется обновить. В случае удачного выполнения запроса возвращается ответ класса PutResponse, содержащий все измененные объекты. В случае ошибки возвращается Error.
Пример использования:
СлужбаПоддержки.ОбновитьОбъект(ОбъектXDTO);
Для обновления нескольких объектов одним запросом следует использовать функцию:
СлужбаПоддержки.ОбновитьОбъекты(МассивОбъектовXDTO);
Для установки признака Рассмотрено следует использовать функцию библиотеки :
СлужбаПоддержки.УстановитьПризнакРассмотрено(ОбъектТип, ОбъектИд);
Класс PutRequest
Базовый класс: Request
Запрос на изменение объектов (например, справочники, документы, бизнес-процессы, задачи).
Доступно для объектов:
- Incident — обращение
- Consultation — консультация
- Suggestion — пожелание
- Order — поручение
- Task — задача исполнителя
Объекты, для которых можно установить признак Рассмотрено (action=Consider):
- IncomingEMail — входящее письмо
- OutgoingEMail — исходящее письмо
- PhoneCall — телефонный звонок
- ServiceUserComment — комментарий пользователя
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| action | PutActions | Дополнительное действие при изменении объекта | ||
| objects | Object | Да | Да | Список объектов, которые нужно обновить. |
Класс PutResponse
Базовый класс: Response
Возвращается в результате успешной обработки запроса PutRequest.
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| objects | Object | Да | Да | Список обновленных объектов. |
Класс PutActions
Описывает действия при изменении объектов.
Значения перечисления:
- Consider – При указании дествия для объектов типа IncomingEmail, OutgoingEmail, PhoneCall, ServiceUserComment у перечисленных объектов будет устанавливаться признак Рассмотрено.
Перенаправление объекта SOAP
В процессе работы может потребоваться назначить ответственным за обращение другого исполнителя. Перенаправление обращения можно выполнить с помощью этого запроса.
Пример перенаправления на текущего пользователя:
ТекущийПользователь = СлужбаПоддержкиПовтИсп.ТекущийПользователь().objectId;
СлужбаПоддержки.ПеренаправитьОбъект("Incident", Id, ТекущийПользователь.type, ТекущийПользователь.id);
Пример перенаправления на линию поддержки:
ЛинияПоддержки = СлужбаПоддержкиПовтИсп.ТекущийПользователь().supportLine.objectId;
СлужбаПоддержки.ПеренаправитьОбъект("Incident", Id, ЛинияПоддержки.type, ЛинияПоддержки.id);
Класс PutRedirectRequest
Базовый класс: Request
Выполняет перенаправление объекта. В случае удачного выполнения возвращается OK, в случае ошибки Error.
Доступно для объектов:
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| query | RedirectQuery | Да | Параметры перенаправления. |
| targetId | ObjectId | Да | Ссылка на перенаправляемый объект. |
Свойства запроса
Класс RedirectQuery
Описывает параметры перенаправления.
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| comment | string | Комментарий перенаправления — обязательное заполнение при перенаправлении другому партнеру или за рамки своей линии поддержки. | |
| performerId | ObjectId | Да | Новый ответственный. Возможные значения:
|
Принятие задачи к исполнению SOAP
Класс PutAcceptRequest
Базовый класс: Request
Выполняет принятие задачи к исполнению. В случае удачного выполнения возвращается OK, в случае ошибки Error.
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| targetId | ObjectId | Да | Ссылка на задачу |
Выполнение задачи SOAP
Пример выполнения задачи:
СлужбаПоддержки.ВыполнитьЗадачу("Task", Ид, КомментарийВыполнения);
Пример выполнения задачи с возвратом на исполнение:
СлужбаПоддержки.ВыполнитьЗадачу("Task", Ид, КомментарийВыполнения, "ReturnOnСompletion");
Класс PutCompleteTaskRequest
Базовый класс: Request
Запрос на выполнение задачи исполнителя.
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| action | PutСompleteTaskActions | Дополнительное действие при выполнении задачи | |
| comment | string | Комментарий выполнения | |
| targetId | ObjectId | Да | Ссылка на задачу |
Свойства запроса
Класс PutСompleteTaskActions
Описывает дополнительные действия при выполнении задачи
Значения перечисления:
- CompleteTask – выполнить здачу
- ReturnOnCompletion – вернуть на исполнение
- CancelOrder – отменить задачу
Удаление объекта SOAP
Пометка на удаление выполняется с помощью запроса класса DeleteRequest. В качестве параметров запроса передаются ссылки на объекты. Можно пометить на удаление несколько объектов. Пометка удаления выполняется в транзакции. В случае успешного выполнения запроса возвращается ответ класса DeleteResponse. В случае неудачи возвращается Error.
Пример использования:
СлужбаПоддержки.УдалитьОбъект("File", Id);
Для удаления нескольких объектов следует использовать функцию:
СлужбаПоддержки.УдалитьОбъектыПоСсылкам(МассивСсылокXDTO);
Класс DeleteRequest
Базовый класс: Request
Помечает объекты на удаление.
Доступно только для объектов типа:
- File — файл
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| objectIds | ObjectId | Да | Да | Список ссылок на объекты, которые нужно пометить на удаление. |
Класс DeleteResponse
Базовый класс: Response
Возвращается в случае успешной обработки запроса DeleteRequest.
Обращения
Пример использования в библиотеке :
Обработки.СлужбаПоддержки.Формы.Обращение
Класс Incident
Базовый класс: Object
Описывает обращение в УСП.
| Свойство | Тип | Список | Описание |
|---|---|---|---|
| closingDate | dateTime | Дата закрытия | |
| comments | IncidentComment | Да | Комментарии исполнителей |
| component | Component | Компонент | |
| date | dateTime | Дата | |
| deadline | dateTime | Срок обработки | |
| description | string | Описание | |
| descriptionHTML | HTMLObject | Описание в формате HTML с картинками | |
| dynamicAttributes | DynamicAttribute | Да | Дополнительные реквизиты |
| eMailForCorrespondence | string | Адрес для переписки | |
| generalComment | string | Общий комментарий | |
| hasNewInteractions | boolean | Наличие новых взаимодействий | |
| importance | Importance | Важность | |
| initiator | ServiceUser | Инициатор | |
| knowledgeBaseArticle | KnowledgeBaseArticle | Карточка базы знаний | |
| modifiedDate | dateTime | Дата изменения | |
| number | string | Номер | |
| objectVersion | string | Версия объекта — обязательна при записи существующего объекта | |
| partner | Partner | Обслуживающая организация | |
| recievingChannel | RecievingChannel | Канал получения | |
| responsible | Object | Ответственный | |
| section | Section | Раздел | |
| service | Service | Сервис | |
| status | IncidentStatus | Состояние | |
| subscription | Subscription | Подписка на тариф | |
| subject | string | Тема | |
| subscriber | Subscriber | Абонент | |
| subscriberPartner | Subscriber | Обслуживающая организация абонента | |
| supportLine | SupportLine | Линия поддержки | |
| type | IncidentType | Тип обращения |
Свойства класса
Класс IncidentType
Базовый класс: Object
Описывает тип обращения в УСП.
Значения перечисления:
- Консультация
- Ошибка
- Пожелание
Класс IncidentStatus
Базовый класс: Object
Описывает состояния обращения.
Значения перечисления:
- Новое
- Расследование
- Исправление
- ОжиданиеИнициатора
- Закрыто
- Отложено
Класс Importance
Базовый класс: Object
Описывает варианты важности.
Значения перечисления:
- ВысокаяВажность — высокая важность
- ОбычнаяВажность — обычная важность
- НизкаяВажность — низкая важность
- КритичнаяВажность — критичная важность
Класс RecievingChannel
Базовый класс: Object
Описывает каналы получения обращений.
| Свойство | Тип | Описание |
|---|---|---|
| code | string | Код |
Возможные значения свойства code перечислены в справочнике программы КаналыПолученияОбращений. Предопределенные значения:
- ИнформационныйЦентр
- СервисРегистрацииОшибок
- ТелефонГорячейЛинии
- ЭлектроннаяПочта
Класс IncidentComment
Базовый класс: Record
Описывает список комментариев исполнителей к обращению.
| Свойство | Тип | Описание |
|---|---|---|
| author | User | Автор комментария |
| comment | string | Текст комментария |
| date | dateTime | Дата и время комментария |
| supportLine | SupportLine | Линия поддержки автора |
Специальные отборы при получении списка
Для быстрого отбора обращений можно использовать фильтры:
- onMy — отбор по текущему пользователю
- onMyLine — отбор по линии поддержки текущего пользователя
- onMyCollegues — отбор по сотрудникам линии текущего пользователя
Взаимодействия
Пример получения списка взаимодействий по объекту в библиотеке :
Обработки.СлужбаПоддержки.Формы.Взаимодействия.
Для работы с взаимодействиями можно использовать общие запросы:
- Получение объекта
- Обновление объекта
- Удаление объекта
Так как взаимодействия принадлежат какому либо предмету, для получения списка взаимодействий и для получения экземпляра нового взаимодействия используются запросы:
- Получение списка подчиненных объектов
- Получение эклемпляра нового подчиненного объекта
- Добавление подчиненного объекта
Телефонный звонок
Пример использования в библиотеке :
Обработки.СлужбаПоддержки.Формы.ТелефонныйЗвонок
Класс PhoneCall
Базовый класс: Object
Описывает телефонный звонок
| Свойство | Тип | Описание |
|---|---|---|
| callCode | string | Код звонка |
| considered | boolean | Рассмотрено |
| contact | Subscriber | Абонент — контакт |
| creationDate | dateTime | Дата создания |
| description | string | Описание |
| incoming | boolean | Входящий |
| internal | boolean | Флаг внутренней переписки |
| objectVersion | string | Версия объекта — обязательна при записи существующего объекта |
| subject | string | Тема |
| target | Object | Предмет:
|
Комментарий пользователя сервиса
Пример использования в библиотеке :
Обработки.СлужбаПоддержки.Формы.КомментарийПользователя
Класс ServiceUserComment
Базовый класс: Object
Описывает комментарий пользователя к обращению. Создается в случае создания сообщения пользователем из приложения.
| Свойство | Тип | Описание |
|---|---|---|
| author | Object | Автор |
| considered | boolean | Рассмотрено |
| creationDate | dateTime | Дата создания |
| description | string | Описание |
| descriptionHTML | HTMLObject | Описание в формате HTML |
| responsible | User | Ответственный |
| subject | string | Тема |
| target | Object | Предмет:
|
Электронное письмо входящее
Класс IncomingEMail
Базовый класс: Object
Описывает входящее электронное письмо.
| Свойство | Тип | Список | Описание |
|---|---|---|---|
| attachments | File | Да | Вложения |
| body | string | Текст | |
| bodyHTML | HTMLObject | Текст HTML | |
| bodyType | EMailBodyType | Тип текста | |
| considered | boolean | Рассмотрено | |
| containsAttachments | boolean | Содержит вложения | |
| creationDate | dateTime | Дата создания | |
| importance | InteractionImportance | Важность | |
| internal | boolean | Флаг внутренней переписки | |
| recipients | string | Получатели | |
| recipientsOfCopies | string | Получатели копий | |
| sender | string | Отправитель | |
| subject | string | Тема | |
| target | Object | Предмет:
|
Электронное письмо исходящее
Класс OutgoingEMail
Базовый класс: Object
Описывает исходящее электронное письмо.
| Свойство | Тип | Список | Описание |
|---|---|---|---|
| account | EMailAccount | Учетная запись | |
| attachments | File | Да | Вложения |
| baseId | string | Идентификатор основания | |
| body | string | Текст | |
| bodyHTML | HTMLObject | Текст в формате HTML с картинками | |
| bodyType | EMailBodyType | Тип текста | |
| considered | boolean | Рассмотрено | |
| containsAttachments | boolean | Содержит вложения | |
| creationDate | dateTime | Дата создания | |
| dateSent | dateTime | Дата и время отправки | |
| importance | InteractionImportance | Важность | |
| internal | boolean | Флаг внутренней переписки | |
| recipients | string | Получатели | |
| recipientsOfBlindCopies | string | Получатели скрытых копий | |
| recipientsOfCopies | string | Получатели копий | |
| status | OutgoingEMailStatus | Состояние | |
| subject | string | Тема | |
| target | Object | Предмет:
|
Свойства класса
Класс OutgoingEMailStatus
Базовый класс: Object
Описывает состояния исходящего письма.
Значения перечисления:
- Черновик — письмо записано но не отправлено
- Отправлено — письмо отправлено
- Исходящее — письмо находится в состоянии отправки
Класс EMailAccount
Базовый класс: Object
Описывает учетную запись электронной почты.
| Свойство | Тип | Описание |
|---|---|---|
| useForReceiving | boolean | Использовать для получения |
| useForSending | boolean | Использовать для отправки |
Общие свойства взаимодействий
Класс InteractionImportance
Базовый класс: Object
Описывает варианты важности взаимодействий.
Значения перечисления:
- Высокая — высокая важность
- Обычная — обычная важность
- Низкая — низкая важность
Класс EMailBodyType
Базовый класс: Object
Описывает перечисление Типы текстов электронных писем.
Значения перечисления:
- HTML
- HTMLСКартинками
- ПростойТекст
- РазмеченныйТекст
Карточки базы знаний
Класс KnowledgeBaseArticle
Абстрактный класс. Объекты этого класса не могут быть созданы.
Базовый класс: Object
Базовый класс для описания карточек базы знаний.
| Свойство | Тип | Список | Описание |
|---|---|---|---|
| code | string | Код | |
| comments | ArticleComment | Да | Комментарии |
| components | Component | Да | Компоненты |
| creationDate | dateTime | Дата регистрации | |
| description | string | Описание | |
| descriptionHTML | HTMLObject | Описание в формате HTML с картинками | |
| modifiedDate | dateTime | Дата изменения | |
| name | string | Наименование | |
| objectVersion | string | Версия объекта — обязательна при записи существующего объекта | |
| sections | Section | Да | Разделы |
| services | Service | Да | Сервисы |
Производные классы:
Общие свойства карточек базы знаний
Класс ArticleComment
Базовый класс: Record
Описывает комментарий к карточке базы знаний.
| Свойство | Тип | Описание |
|---|---|---|
| author | User | Автор |
| comment | string | Текст комментария |
| date | dateTime | Дата |
| supportLine | SupportLine | Линия поддержки |
Консультации
Пример использования в библиотеке :
Обработки.СлужбаПоддержки.Формы.Консультация
Класс Consultation
Базовый класс: KnowledgeBaseArticle
Описывает карточку Консультации.
| Свойство | Тип | Описание |
|---|---|---|
| status | ConsultationStatus | Состояние консультации |
Свойства класса
Класс ConsultationStatus
Базовый класс: Object
Описывает перечисление Состояния консультаций.
Значения перечисления:
- Не актуальна
- Актуальна
Ошибки
Пример использования в библиотеке :
Обработки.СлужбаПоддержки.Формы.Ошибка
Класс Problem
Базовый класс: KnowledgeBaseArticle
Описывает карточку ошибки.
| Свойство | Тип | Описание |
|---|---|---|
| bypass | string | Обходной путь |
| bypassHTML | HTMLObject | Обходной путь в формате HTML с картинками |
| critical | boolean | Критичная |
| playback | string | Воспроизведение |
| playbackHTML | HTMLObject | Воспроизведение в формате HTML с картинками |
| solution | string | Решение |
| solutionHTML | HTMLObject | Решение в формате HTML с картинками |
| status | ProblemStatus | Состояние |
Свойства класса
Класс ProblemStatus
Базовый класс: Object
Описывает перечисление Состояния ошибок.
Значения перечисления:
- Запланирована
- Расследование
- На исправлении
- Исправлена
Пожелания
Пример использования в библиотеке :
Обработки.СлужбаПоддержки.Формы.Пожелание
Класс Suggestion
Базовый класс: KnowledgeBaseArticle
Описывает Пожелание.
| Свойство | Тип | Описание |
|---|---|---|
| status | SuggestionStatus | Состояние |
Свойства класса
Класс SuggestionStatus
Базовый класс: Object
Описывает перечисление Состояния пожеланий.
Значения перечисления:
- Рассматривается
- Дубль
- НаГолосовании
- Запланировано
- Реализовано
- Отклонено
Файлы
Пример использования в библиотеке :
Обработки.СлужбаПоддержки.Формы.ПрисоединенныеФайлы.
Для работы с файлами можно использовать общие запросы для работы с объектами, такие как:
- Получение объекта
- Обновление объекта
- Удаление объекта
Так как файлы не существуют самостоятельно, а принадлежат какому либо объекту, для получения списка файлов и для добавления нового файла используются классы запросов для подчиненных объектов:
- Получение списка подчиненных объекта.
- Добавление подчиненного объекта.
Класс File
Базовый класс: Object
Описывает присоединенный файл.
| Свойство | Тип | Описание |
|---|---|---|
| author | User | Автор файла. |
| binaryData | base64Binary | Двоичные данные файла. |
| creationDate | dateTime | Дата создания файла. |
| deletionMark | boolean | Пометка удаления. |
| description | string | Описание. |
| extension | string | Расширение файла. |
| modificationDateUniversal | dateTime | Всемирное координированное время (UTC) изменения файла. |
| name | string | Имя файла. |
| owner | Object | Владелец файла. |
| size | integer | Размер файла в байтах. |
| text | string | Текст, извлеченный из файла. |
Трудозатраты
Трудозатраты могут добавляться по объектам:
- Incident — обращение
- Consultation — консультация
- Problem — ошибка
- Suggestion — пожелание
При работе с трудозатратами можно использовать запросы:
- Получение списка подчиненных объектов.
- Получение экземпляра нового подчиненного объекта.
- Добавление подчиненного объекта.
Класс ActualWork
Базовый класс: Record
Описывает запись фактических трудозатрат.
| Свойство | Тип | Описание |
|---|---|---|
| addDate | dateTime | Дата добавления |
| description | string | Описание |
| duration | int | Длительность в секундах |
| partner | Partner | Обслуживающая организация (определяется при записи автоматически) |
| source | Object | Источник Типы:
|
| supportLine | SupportLine | Линия поддержки (определяется при записи автоматически) |
| user | User | Пользователь (если не заполнено, определяется при записи автоматически) |
Процессы и задачи
Поручение
Пример использования в библиотеке :
Обработки.СлужбаПоддержки.Формы.Поручение
Класс Order
Базовый класс: Object
Описывает Поручение
| Свойство | Тип | Описание |
|---|---|---|
| author | User | Автор |
| creationDate | dateTime | Дата создания |
| deadline | dateTime | Срок исполнения |
| description | string | Описание |
| descriptionHTML | HTMLObject | Описание в формате HTML с картинками |
| endDate | dateTime | Дата завершения |
| importance | TaskImportance | Важность |
| name | string | Наименование |
| number | string | Номер |
| objectVersion | string | Версия объекта — обязательна при записи существующего объекта |
| performer | TaskPerformer | Исполнитель |
| reviewer | TaskPerformer | Проверяющий |
| reviewPeriod | dateTime | Срок проверки |
| runtimeComments | string | Комментарий выполнения |
| status | ProcessStatus | Состояние |
| target | Object | Предмет |
Свойства класса
Класс ProcessStatus
Базовый класс: Object
Описывает состояния процесса:
- Активен
- Остановлен
Класс OrderRoutePoint
Базовый класс: RoutePoint
Описывает точки маршрута процесса Поручение
Задача исполнителя
Пример использования в библиотеке :
Обработки.СлужбаПоддержки.Формы.Задача
Класс Task
Базовый класс: Object
Описывает задачу исполнителя
| Свойство | Тип | Описание |
|---|---|---|
| acceptDate | dateTime | Дата принятия к исполнению |
| accepted | boolean | Принята к исполнению |
| author | User | Автор |
| creationDate | dateTime | Дата создания |
| deadline | dateTime | Срок исполнения |
| description | string | Описание |
| done | boolean | Выполнено |
| endDate | dateTime | Дата исполнения |
| importance | TaskImportance | Важность |
| myTask | boolean | Задача направлена текущему пользователю |
| name | string | Наименование |
| number | string | Номер |
| objectVersion | string | Версия объекта — обязательна при записи существующего объекта |
| performer | TaskPerformer | Исполнитель |
| performerComment | string | Комментарий исполнения |
| process | Order | Процесс |
| routePoint | RoutePoint | Точка маршрута |
| startDate | dateTime | Дата начала выполнения |
| status | ProcessStatus | Состояние |
| target | Object | Предмет |
Свойства класса
Класс TaskImportance
Базовый класс: Object
Описывает важность задачи:
- Критическая
- Высокая
- Обычная
- Низкая
Класс TaskPerformer
Описывает исполнителя задачи
| Свойство | Тип | Описание |
|---|---|---|
| mainAddressingObject | TaskAddressingObject | Основной объект адресации |
| role | TaskPerformerRole | Роль исполнителя |
| secondaryAddressingObject | TaskAddressingObject | Дополнительный объект адресации |
| user | User | Пользователь |
Класс TaskPerformerRole
Базовый класс: Object
Описывает роль исполнителя задачи
Класс TaskAddressingObject
Базовый класс: Object
Описывает объект адресации задач
Общие объекты
НСИ
Компоненты сервисов
Класс Component
Базовый класс: Object
Описывает справочник Компоненты сервиса.
| Свойство | Тип | Описание |
|---|---|---|
| code | string | Код |
| service | Service | Сервис |
Используется в обращениях и карточках базы знаний.
Разделы
Класс Section
Базовый класс: Object
Описывает список Разделов.
Используется в обращениях и карточках базы знаний.
Сервисы
Класс Service
Базовый класс: Object
Описывает список Сервисов.
| Свойство | Тип | Описание |
|---|---|---|
| code | string | Код |
| tariffsEnabled | boolean | Признак использования тарифов |
Используется в обращениях и карточках базы знаний.
Структура поддержки
Обслуживающие организации
Используется в обращениях и карточках базы знаний.
Класс Partner
Базовый класс: Object
Описывает обслуживающую организацию (партнера) в УСП.
| Свойство | Тип | Описание |
|---|---|---|
| code | string | Код |
| firstSupportLine | SupportLine | Первая линия поддержки |
| interactionEnabled | boolean | Разрешено взаимодействие — если установлено, возможно перенаправление обращения этому партнеру. |
Линии поддержки
Используется в обращениях и карточках базы знаний.
Класс SupportLine
Базовый класс: Object
Описывает линию поддержки в УСП.
| Свойство | Тип | Описание |
|---|---|---|
| interactionEnabled | boolean | Разрешено взаимодействие — если установлено, возможно перенаправление обращения этой линии поддержки. |
| partner | Partner | Обслуживающая организация (партнер) |
Пользователи
Используется в обращениях и карточках базы знаний.
Класс User
Базовый класс: Object
Описывает пользователя Службы поддержки.
| Свойство | Тип | Описание |
|---|---|---|
| interactionEnabled | boolean | Разрешено взаимодействие — если установлено, возможно перенаправление обращения этому пользователю. |
| partner | Partner | Обслуживающая организация (партнер) |
| supportLine | SupportLine | Линия поддержки |
Объекты обслуживания
Абоненты
Класс Subscriber
Базовый класс: Object
Описывает Абонента сервиса.
| Свойство | Тип | Список | Описание |
|---|---|---|---|
| code | string | Номер абонента | |
| dynamicAttributes | DynamicAttribute | Да | Дополнительные реквизиты. Возможно получение только для объекта. |
| service | Service | Сервис | |
| serviceUsers | ServiceUser | Да | Пользователи абонента. Возможно получение только для объекта. |
Подписки на тарифы
Класс Subscription НОВЫЙ
Базовый класс: Object
Описывает документ "Подписка"
| Свойство | Тип | Описание |
|---|---|---|
| amount | decimal | Количество |
| comment | string | Комментарий |
| completionDate | dateTime | Дата завершения подписки |
| created | dateTime | Дата создания документа |
| number | string | Номер документа |
| parent | Subscription | Ведущая подписка |
| partner | Subscriber | Ведущий абонент |
| service | Service | Сервис |
| startDate | dateTime | Дата начала подписки |
| subscriber | Subscriber | Абонент |
| tariff | Tariff | Тариф |
| type | SubscriptionType | Тип подписки |
Класс SubscriptionType НОВЫЙ
Базовый класс: Object
Описывает тип подписки.
Значения перечисления:
- Продлевающая
- Основная
- Расширяющая
Класс Tariff НОВЫЙ
Базовый класс: Object
Описывает тариф
| Свойство | Тип | Описание |
|---|---|---|
| code | string | Код тарифа |
| service | Service | Владелец |
Пользователи сервисов
Используется в обращениях в качестве инициатора обращения.
Класс ServiceUser
Базовый класс: Object
Описывает пользователя сервиса.
| Свойство | Тип | Описание |
|---|---|---|
| eMails | string | Адреса электронной почты |
| fullName | string | Полное имя |
| login | string | Логин |
| phone | string | Номер телефона |
| service | Service | Сервис |
Класс ServiceUserInfoItem
Информация о пользователе сервиса.
| Свойство | Тип | Описание |
|---|---|---|
| applicationsCodes | string | Номера приложений пользователя сервиса |
| serviceUser | ServiceUser | Пользователь сервиса |
| subscriber | Subscriber | Абонент |
| subscriberPartner | Subscriber | Обслуживающая организация абонента |
Приложения
Класс Application
Базовый класс: Object
Описывает приложение в сервисе
| Свойство | Тип | Описание |
|---|---|---|
| code | string | Номер приложения |
| infoBase | InfoBase | Информационная база |
| service | Service | Сервис |
| status | ApplicationStatus | Состояние приложения |
| subscriber | Subscriber | Абонент |
Класс ApplicationStatus НОВЫЙ
Базовый класс: Object
Описывает состояние приложения
Значения перечисления:
- Готова
- ГотовитсяКИспользованию
- Используется
- Конвертируется
- Копируется
- КУдалению
- МиграцияПриложения
- Новая
- Отсутствует
- ОшибкаПодготовки
- Удалена
Информационные базы
Класс InfoBase
Базовый класс: Object
Описывает информационные базы сервиса.
| Свойство | Тип | Описание |
|---|---|---|
| configurationVersion | ConfigurationVersion | Версия конфигурации |
service НОВЫЙ | Service | Сервис |
Конфигурации
Класс Configuration
Базовый класс: Object
Описывает конфигурации, доступные в сервисе.
| Свойство | Тип | Описание |
|---|---|---|
name НОВЫЙ | string | Имя |
owner НОВЫЙ | Subscriber | Владелец |
Версии конфигураций
Класс ConfigurationVersion
Базовый класс: Object
Описывает версии конфигураций, доступные в сервисе.
| Свойство | Тип | Описание |
|---|---|---|
| configuration | Configuration | Конфигурация |
Прочее
Класс Type
Описывает тип объекта API
| Свойство | Тип | Описание |
|---|---|---|
| presentation | string | Представление класса |
| xdtoClassName | string | Имя класса |
Класс ObjectId
Описывает ссылку на объект УСП. Используется в качестве параметра во многих запросах.
Является основным свойством объекта Object.
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| id | string | Да | Идентификатор объекта в УСП. Если объект представляет собой элемент справочника или документа, задачу исполнителя или бизнес-процесс, то значением свойства является уникальный идентификатор (UUID) объекта. Если объект представляет собой значение перечисления, то в свойство записывается строковое представление значения перечисления. |
| navRef | string | Навигационная ссылка, заполняется только при получении объекта. | |
| type | string | Да | Имя класса XDTO, который соответствует данному объекту УСП. |
| view | string | Строковое представление ссылки. |
Класс Error
Базовый класс: Response
Предназначен для информирования внешнего приложения о произошедшей ошибке, если при обработке запроса произошла исключительная ситуация. Может быть возвращен вместо ответа на любой из запросов.
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| description | string | Текстовое описание ошибки, а также отладочная информация. | |
| subject | string | Тема сообщения об ошибке. |
Класс OK
Базовый класс: Response
Возвращается в случае удачного выполнения некоторых запросов.
HTML документ
Используется в обращениях и карточках базы знаний в свойствах описаний. Помимо текста содержит форматирование и картинки.
Класс HTMLObject
Описывает HTML документ с картинками.
| Свойство | Тип | Обязательное | Список | Описание |
|---|---|---|---|---|
| htmlText | string | Да | Текст документа. | |
| images | HTMLObjectImage | Да | Картинки, входящие в документ. |
Класс HTMLObjectImage
Описывает картинку, входящую в состав HTML документа.
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| data | base64Binary | Да | Двоичные данные картинки. |
| name | string | Да | Имя картинки. |
Дополнительные реквизиты
Класс DynamicAttribute
Базовый класс: Object
Описывает дополнительный реквизит объекта.
| Свойство | Тип | Список | Описание |
|---|---|---|---|
| format | string | Формат редактирования | |
| multilineInput | int | Многострочная строка | |
| objectValue | Object | Значение объектного типа | |
| required | boolean | Обязательное заполнение | |
| services | Service | Да | Сервисы, для объектов которых доступен реквизит |
| simpleValue | Любой тип | Значение простого типа | |
| tooltip | string | Подсказка | |
| usedIn | Type | Да | Типы объектов, в которых может использоваться этот реквизит |
| valueTypes | Type | Да | Возможные типы значений |
Класс DynamicAttributeValue
Базовый класс: Object
Описывает значение дополнительного реквизита объекта.
| Свойство | Тип | Описание |
|---|---|---|
| owner | DynamicAttribute | Владелец |
Класс DynamicAttributeValueHierarchy
Базовый класс: Object
Описывает иерархию значений дополнительных реквизитов объектов.
| Свойство | Тип | Описание |
|---|---|---|
| owner | DynamicAttribute | Владелец |
Абстрактные классы
Класс Request
Абстрактный класс. Объекты этого класса не могут быть созданы.
Базовый класс для запросов.
Производные классы:
- DeleteRequest
- GetCurrentUserRequest
- GetListRequest
- GetNewRequest
- GetRequest
- GetServiceUserInfoListRequest
- GetSubListRequest
- GetVersionRequest
- PostRequest
- PostSubRequest
- PutAcceptRequest
- PutCompleteTaskRequest
- PutRedirectRequest
- PutRequest
Класс Response
Абстрактный класс. Объекты этого класса не могут быть созданы.
Базовый класс для ответов на запросы.
Производные классы:
- DeleteResponse
- Error
- GetCurrentUserResponse
- GetListResponse
- GetNewResponse
- GetResponse
- GetServiceUserInfoListResponse
- GetSubListResponse
- GetVersionResponse
- OK
- PostResponse
- PostSubResponse
- PutResponse
Класс Record
Абстрактный класс. Объекты этого класса не могут быть созданы.
Базовый абстрактный класс для описания записей УСП.
Производные классы:
Класс Object
Базовый класс: Record
Базовый абстрактный класс для описания объектов.
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| objectId | ObjectId | Да | Ссылка на объект. |
Производные классы:
- Application
- ApplicationStatus
- Component
- Configuration
- ConfigurationVersion
- ConsultationStatus
- DynamicAttribute
- DynamicAttributeValue
- DynamicAttributeValueHierarchy
- EMailAccount
- EMailBodyType
- File
- Importance
- Incident
- IncidentStatus
- IncidentType
- IncomingEMail
- InfoBase
- InteractionImportance
- KnowledgeBaseArticle
- Order
- OutgoingEMail
- OutgoingEMailStatus
- Partner
- PhoneCall
- ProblemStatus
- ProcessStatus
- RecievingChannel
- RoutePoint
- Section
- Service
- ServiceUser
- ServiceUserComment
- Subscriber
- Subscription
- SubscriptionType
- SuggestionStatus
- SupportLine
- Tariff
- Task
- TaskAddressingObject
- TaskImportance
- TaskPerformerRole
- User
Класс RoutePoint
Абстрактный класс. Объекты этого класса не могут быть созданы.
Базовый класс: Object
Базовый класс для определения точек маршрута процессов
Производные классы: