Версия API1.0.3

API службы поддержки предоставляет возможность работы через SOAP и REST веб-сервисы. Примеры использования веб-сервисов показаны в конфигурации 1C:Библиотека интеграции со службой поддержки. В ней реализована подсистема для встраивания в конфигурации партнеров. Подсистема включает в себя набор команд, форм и модулей, необходимых для встраивания пользовательского интерфейса службы поддержки в другие конфигурации. Библиотека интеграции предоставляет набор процедур и функций, облегчающих работу с API. Вызовы процедур и функций для работы с API будут рассмотрены в примерах.

Содержание

REST-сервис API-XML

Сервис используется для интеграции приложения 1С:Управление службой поддержки с другими приложениями. Примеры работы с веб-сервисом приведены в конфигурации 1С:Библиотека интеграции со службой поддержки. Ответы веб-сервиса формируются в формате XML. Также в формате XML нужно формировать запросы при отправке объектов на запись и изменение. Для упрощения работы, веб-сервис предоставляет модель описания фабрики объектов.
Пример использования в 1С:Предприятии:

// получим соединение с веб-сервисом
Соединение = Новый HTTPСоединение(Хост, Порт, ИмяПользователя, Пароль);
Запрос = Новый HTTPЗапрос("sdapi/hs/api-xml/version");
Ответ = Соединение.Получить(Запрос);
Версия = Ответ.ПолучитьТелоКакСтроку(); //возвращает строку с номером версии

SOAP-сервис API-SOAP

Сервис используется для интеграции приложения 1С:Управление службой поддержки с другими приложениями. Синхронная интеграция применяется для реализации пользовательского интерфейса и онлайн взаимодействия интегрированных приложений.

Операция execute

Обрабатывает переданный запрос и возвращает результат обработки.
Возвращаемое значение: Response

ПараметрТипОписание
requestRequestСодержит запрос на выполнение операции, например 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.1.1

Получение модели описания для фабрики объектов REST

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

GET /model.xsd

Получение данных авторизованного пользователя REST

Возвращает данные авторизованного пользователя.
Запрос:

GET /currentuser

Получение списка объектов REST

В качестве запроса передается имя класса.
Доступно для объектов всех классов-потомков от класса Object.
Шаблон запроса:

GET /{ТипОбъекта}s

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

GET /incidents

По умолчанию возвращается только ссылка. Можно определить состава выводимых колонок с помощью параметра columns.
В качестве выводимых колонок можно использовать все доступные поля класса, возможные для вывода в списке.
Доступно для объектов всех классов-потомков от класса Object.
Пример запроса:

GET /incidents?columns=date,number,subject,initiator

Возможна установка отборов на получаемый список. Для этого нужно использовать параметр filter.
Фильтр можно накладывать на все доступные поля класса, возможные для вывода в списке.
Пример запроса:

GET /incidents?filter=modifiedDate>2014-09-01;component={Component,34f2ef0f-e63e-11e3-9905-bcaec5d6c3e4}

Можно установить лимит количество получаемых записей. Для этого нужно использовать параметр limit.
Можно использовать параметры columnsfilter и limit в одном запросе.
Для объектов, поддерживающих дополнительные реквизиты, можно осуществлять отбор, используя в качестве имени реквизита идентификатор дополнительного реквизита, например:

GET /subscribers?filter=a68efcf3-015d-11e6-9575-005056c00008=12345

Получает список Абонентов с отбором по значению дополнительного реквизита.
В запросе можно использовать большие и маленькие буквы в именах классов и свойств.
Пример запроса:

GET /incidents?columns=...&filter=...&limit=

Получение списка подчиненных объектов REST

Можно получать подчиненные объекты от основного объекта.
Шаблон получения подчиненных объектов:

GET /{ТипПредмета}/{ИдПредмета}/{ТипОбъекта}

Пример получения взаимодействий и файлов по обращению:

GET /incident/8756ca78-551c-11e4-93f4-0050568b4127/phonecalls
GET /incident/8756ca78-551c-11e4-93f4-0050568b4127/files

Доступно для предметов:

Доступно для подчиненных объектов

  • File - присоединенные файлы
  • Interaction - все типы взаимодействий по предмету
  • PhoneCall - телефонный звонок
  • ServiceUserComment - комментарий пользователя сервиса
  • IncomingEMail - входящее электронное письмо
  • OutgoingEMail - исходящее электронное письмо

Получение объекта REST

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

GET /incident/8756ca78-551c-11e4-93f4-0050568b4127

Доступно для всех объектов классов-потомков от класса Object.

Получение экземпляра нового объекта REST

Шаблон запроса:

GET /{ТипОбъекта}/new

Запрос доступен для:

Получение экземпляра нового подчиненного объекта REST

Шаблон запроса:

GET /{ТипПредмета}/{ИдПредмета}/{ТипОбъекта}/new

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

GET /incident/8756ca78-551c-11e4-93f4-0050568b4127/phonecall/new

Доступно для предметов:

Доступно для подчиненных объектов:

  • ActualWork - запись о трудозатратах
  • PhoneCall - телефонный звонок
  • OutgoingEMail - исходящее электронное письмо
  • Order - поручение

Добавление объекта REST

Объект передается в теле запроса в формате XML. Объект должен соответствовать описанию класса в модели.
Шаблон запроса:

POST /{ТипОбъекта}

Запрос доступен для:

Для старта процесса "Поручение" нужно указать дополнительные действия при добавлении объекта:

POST /Order?action=StartProcess

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

Добавление подчиненного объекта REST

Данные подчиненного объекта передаются в теле запроса в формате XML.
Шаблон запроса:

POST /{ТипПредмета}/{ИдПредмета}/{ТипОбъекта}

Пример добавления файлов к обращению:

POST /incident/8756ca78-551c-11e4-93f4-0050568b4127/file

Доступно для предметов:

Доступно для объектов:

  • IncidentComment - комментарий обращения
  • ArticleComment - комментарий карточки базы знаний
  • ActualWork - запись фактических трудозатрат
  • File - присоединенный файл

Обновление объекта REST

Объект передается в теле запроса.
Пример запроса:

PUT /incident

Запрос доступен для:

Для взаимодействий этот запрос доступен с действием Consider.
При выполнении такого запроса у взаимодействий устанавливается признак Рассмотрено.
При использовании параметра action тело запроса может не устанавливаться.
Пример запроса:

PUT /IncomingEmail/36c95f80-eca9-11e3-899c-bcaec5d6c3e4?action=consider

Объекты взаимодействий:

Перенаправление объекта REST

Параметры перенаправления передаются в теле запроса.
Шаблон запроса:

PUT /{ТипОбъекта}/{ИдОбъекта}?action=redirect

Запрос доступен для объектов:

  • Incident - обращения
  • Task - задача исполнителя

Принятие задачи к исполнению REST

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

PUT /Task/e23e968a-26c5-11e4-93f4-0050568b4127?action=redirect

Выполнение задачи REST

Для выполнения задач используется отдельный запрос.
Шаблон запроса:

PUT /Task/{ИдЗадачи}?action={Действие}

Комментарий выполнения задачи передается в теле запроса.
При выполнении задачи возможно указание дополнительных действий:

  • CompleteTask - выполнить задачу по умолчанию
  • ReturnOnСompletion - вернуть на доработку
  • CancelOrder - отменить поручение

Удаление объекта REST

Запрашивается тип объекта и уникальный идентификатор объекта.
Пример запроса:

DELETE /{ТипОбъекта}/{id}

Доступно для объектов:

Запросы к SOAP сервису

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

Версия сервиса помогает определить внешней системе доступную функциональность сервиса.
Для получения версии сервиса нужно отправить запрос класса GetVersionRequest. Возвращается ответ класса GetVersionResponse, содержащий номер версии сервиса. Пример использования:

Запрос = СлужбаПоддержки.СоздатьОбъект("GetVersionRequest");
Версия = СлужбаПоддержкиПовтИсп.Прокси().execute(Запрос).version;
Класс GetVersionRequest

Базовый класс: Request
Запрос для получения текущей версии веб-сервиса.

▲ в начало

Класс GetVersionResponse

Базовый класс: Response
Ответ на запрос GetVersionResponse. Возвращает текущую версию веб-сервиса.

СвойствоТипОбязательноеОписание
versionstringДаНомер версии web-сервиса. Строка вида 1.0.1.1

▲ в начало

Получение данных авторизованного пользователя SOAP

Для получения данных авторизованного пользователя нужно отправить запрос класса GetCurrentUserRequest. Возвращается ответ класса GetCurrentUserResponse, содержащий данные текущего пользователя.
Пример использования:

Пользователь = СлужбаПоддержкиПовтИсп.ТекущийПользователь();

Результат запроса кэшируется на время сеанса.

Класс GetCurrentUserRequest

Базовый класс: Request
Запрашивает данные авторизованного пользователя.

▲ в начало

Класс GetCurrentUserResponse

Базовый класс: Response
Возвращается в результате выполнения запроса GetCurrentUserRequest. Содержит в теле значение авторизованного пользователя.

СвойствоТипОбязательноеОписание
objectObjectДаАвторизованный пользователь

▲ в начало

Получение списка объектов SOAP

Получение списка объектов выполняется с помощью запроса класса GetListRequest. В качестве параметров запросу передаются строка с типом объекта и условия, включающие, набор колонок и отборы. При удачном выполнении запроса возвращается объект класса GetListResponse, содержащий список объектов запрошенного типа с указанными колонками. В случае ошибки возвращается Error.
С помощью этого запроса можно получить списки всех типов объектов из производных классов класса Object.
Пример использования:

Колонки = СтрРазделить("importance, subject, type, status, initiator, responsible, number, date", ", ", Ложь);    
СписокXDTO = СлужбаПоддержки.ПолучитьСписокОбъектов("Incident", Колонки);

Для Каждого ОбъектXDTO Из СписокXDTO Цикл // ОбъектXDTO имеет тип ObjectListItem
    СтрокаСписка = Список.Добавить(); // Список - произвольный список для заполнения данными из Api
    // заполним строку из объекта в отдельной процедуре
    ЗаполнитьСтрокуСписка(СтрокаСписка, ОбъектXDTO.object) 
КонецЦикла;
Класс GetListRequest

Базовый класс: Request
Запрашивает список объектов (элементов справочника, документов, бизнес-процессов, задач или значений перечисления), удовлетворяющих указанному условию.

СвойствоТипОбязательноеОписание
queryListQuery
Параметры запроса.
typestringДаУказывает тип объектов, список которых нужно получить. Например, Incident.

▲ в начало

Класс GetListResponse

Базовый класс: Response
Возвращается в результате успешной обработки запроса GetListRequest.

СвойствоТипОбязательноеСписокОписание
itemsListItem
ДаСписок объектов.
tooManyObjectsboolean

Признак того, что в выборке больше объектов, чем запрашивалось.

▲ в начало

Свойства запроса
Класс ListQuery

Параметры запроса GetListRequest.

СвойствоТипОбязательноеСписокОписание
columnsstring
ДаИмена свойств, которые нужно заполнить у запрошенных объектов.
filterListFilter
ДаНабор условий отбора.
limitinteger

Предельное количество выбираемых объектов.

▲ в начало

Класс ListFilter

Условие отбора для запроса GetListRequest.

СвойствоТипОбязательноеОписание
comparisonOperatorComparisonOperator
Оператор сравнения. Если не заполнено, то используется значение "=".
propertystringДаИмя поля для отбора.
valueлюбой типДаЗначение поля отбора.

▲ в начало

Класс ComparisonOperator

Оператор сравнения для указания сложных условий в условии ListFilter запроса GetListRequest.

Значения перечисления:

  • = – равно
  • > – больше
  • < – меньше
  • >= – больше или равно
  • <= – меньше или равно
  • <> – не равно
  • LIKE – подобно
  • IN – в
  • IN HIERARCHY – в иерархии

▲ в начало

Свойства ответа

Каждый объект оборачивается в объект типа ListItem, содержащий сам объект, а также дополнительные свойства, для удобства отображения в списках и получения дочерних элементов.

Класс ListItem

Описывает элемент списка объектов.

СвойствоТипОбязательноеОписание
canHaveChildrenbooleanДаПризнак того, что данный объект может содержать дочерние (т.е. является веткой дерева).
isFolderbooleanДаПризнак того, что данный объект является группой.
objectObjectДаОбъект УСП.
parentIdObjectId
Указывает на объект, который является родительским для данного объекта в контексте списка объектов.

▲ в начало

Получение списка подчиненных объектов SOAP

Получение списка подчиненных объектов, например взаимодействий, выполняется с помощью запроса класса GetSubListRequest. В качестве параметров запросу передаются ссылка на предмет взаимодействия и условия, включающие, набор колонок и отборы. При удачном выполнении запроса возвращается объект класса GetSubListResponse, содержащий список объектов запрошенного типа с указанными колонками. В случае ошибки возвращается Error.
Пример использования при получении взаимодействий:

Взаимодействия = СлужбаПоддержки.ПолучитьСписокПодчиненныхОбъектов(ВладелецТип, ВладелецID, "Interaction")

При получении взаимодействий можно использовать имена типов взаимодействий, либо имя Interaction, для получения списка взаимодействий всех типов.
Пример получения списка файлов:

Колонки = СтрРазделить("size, creationDate, modificationDateUniversal, extension, description",", ", Ложь);
Файлы = СлужбаПоддержки.ПолучитьСписокПодчиненныхОбъектов("Incident", Id, "File", Колонки); 
Класс GetSubListRequest

Базовый класс: Request
Запрашивает список объектов по предмету.
Доступно для предметов

Доступно для подчиненных объектов

  • File - присоединенные файлы
  • Interaction - все типы взаимодействий по предмету
  • PhoneCall - телефонный звонок
  • ServiceUserComment - комментарий пользователя сервиса
  • IncomingEMail - входящее электронное письмо
  • OutgoingEMail - исходящее электронное письмо
СвойствоТипОбязательноеСписокОписание
columnsstring
ДаНабор свойств объекта, которые необходимо заполнить. Если список пуст или не указан, то заполняются все свойства.
targetIdObjectIdДа
Ссылка на предмет:
typestringДа
Тип объекта. При получении взаимодействий можно указать тип Interaction для получения взаимодействий всех типов.

▲ в начало

Класс GetSubListResponse

Базовый класс: Response
Возвращается в результате успешной обработки запроса GetSubListRequest.

СвойствоТипОбязательноеСписокОписание
recordsRecord
ДаПолученные записи.

▲ в начало

Получение списка сведений по пользователям SOAP

Получение списка сведений по пользователям выполняется с помощью запроса GetServiceUserInfoListRequest. При удачном выполнении запроса возвращается объект класса GetServiceUserInfoListResponse, содержащий список сведений по пользователям сервиса. В случае ошибки возвращается Error.

Класс GetServiceUserInfoListRequest

Базовый класс: Request
Запрос для получения списка пользователей сервисов с дополнительной информацией. В параметрах можно указать частичные значения для поиска. Количество букв в строковых парамтрах не должно быть меньше 3.

СвойствоТипОбязательноеСписокОписание
applicationCodeint

Номер приложения
dynamicAttributesDynamicAttribute
ДаПараметры отборов по дополнительным реквизитам
serviceIdObjectIdДа
Ссылка на сервис
serviceUserEMailstring

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

Логин пользователя сервиса
subscriberCodeint

Код абонента

▲ в начало

Класс GetServiceUserInfoListResponse

Базовый класс: Response
Ответ на запрос получения списка пользователей с расширенной информацией. Содержит запрашиваемый список.

СвойствоТипОбязательноеСписокОписание
itemsServiceUserInfoItem
ДаЭлементы списка с расширенной информацией по пользователям сервиса

▲ в начало

Получение объекта SOAP

Для получения объектов используется запрос класса GetRequest. В качестве параметров в запросе передаются список ссылок на требуемые объекты и набор колонок, которые требуется получить. В случае удачного выполнения запроса возвращается ответ класса GetResponse, содержащий требуемые объекты. В случае ошибки возвращается Error.
Пример использования:

ОбъектXDTO = СлужбаПоддержки.ПолучитьОбъект("Incident", Id);
Класс GetRequest

Базовый класс: Request
Получает массив указанных объектов.

СвойствоТипОбязательноеСписокОписание
columnsstring
ДаМассив имен свойств, которые должны быть заполнены. Если массив не указан или пустой, то заполняются все свойства.
objectIdsObjectId
ДаСсылки на объекты.

▲ в начало

Класс GetResponse

Базовый класс: Response
Возвращается в результате успешной обработки запроса GetRequest.

СвойствоТипОбязательноеСписокОписание
recordsRecordДаДаМассив записей.

▲ в начало

Получение экземпляра нового объекта SOAP

Можно получить экземпляр нового объекта с предварительно заполненными по умолчанию полями. Это удобно при создании новых объектов. Для получения экземпляра объекта отправляется запрос класса GetNewRequest. В качестве параметра в запросе передается строка с именем типа требуемого объекта. При успешном выполнении запроса возвращается ответ класса GetNewResponse, который содержит новый объект, заполненные по умолчанию. При возникновении ошибки возвращается Error.
Пример использования:

ОбъектXDTO = СлужбаПоддержки.ПолучитьНовыйОбъект("Incident")
Класс GetNewRequest

Базовый класс: Request
Запрашивает новый объект указанного типа, заполненный значениями по умолчанию.
Доступно для объектов:

СвойствоТипОбязательноеСписокОписание
columnsstring
ДаСписок свойств объекта, которые должны быть заполнены. Если список пуст или не указан, то будут заполнены все свойства, для которых предусмотрены или могут быть вычислены значения по умолчанию.
typestringДа
Имя типа XDTO объекта, который требуется получить.

Производные классы:

▲ в начало

Класс GetNewResponse

Базовый класс: Response
Возвращается в результате успешной обработки запроса GetNewRequest и производных от него запросов.

СвойствоТипОбязательноеОписание
recordRecordДаНовая запись, заполненная по умолчанию.

Производные классы:

▲ в начало

Получение экземпляра нового подчиненного объекта SOAP

Для получения экземпляра нового взаимодействия отправляется запрос класса GetNewSubRequest. В качестве параметра в запросе передается ссылка на предмет и строка с именем типа требуемого объекта. При успешном выполнении запроса возвращается ответ класса GetNewSubResponse, который содержит новый объект, заполненные по умолчанию. При возникновении ошибки возвращается Error.
Пример использования:

// Получает новый телефонный эвонок по обращению
СлужбаПоддержки.ПолучитьНовыйПодчиненныйОбъект("Incident", Id, "PhoneCall");
Класс GetNewSubRequest

Базовый класс: GetNewRequest
Запрашивает новый объект взаимодействия указанного типа, заполненный значениями по умолчанию.
Доступно для объектов:

  • PhoneCall - телефонный звонок
  • OutgoingEMail - исходящее электронное письмо
  • ActualWork - запись фактических трудозатрат
  • Order - поручение
СвойствоТипОбязательноеОписание
actionGetNewSubActions
Действие при получении нового объкта
targetIdObjectIdДаСсылка на предмет взаимодействия:

▲ в начало

Класс GetNewSubResponse

Базовый класс: GetNewResponse
Возвращается в результате успешной обработки запроса GetNewSubRequest.

▲ в начало

Свойства запроса
Класс GetNewSubActions

Описывает возможные действия при получении нового подчиненного объекта.

Значения перечисления:

  • Answer – ответить
  • AnswerToAll – ответить всем
  • Transfer – переслать
  • FillFromArticle – заполнить по карточке базы знаний

▲ в начало

Добавление объекта SOAP

Для создания объекта используется запрос класса PostRequest. В качестве параметра передается список объектов с пустыми ссылками. При удачном выполнении запроса возвращается ответ класса PostResponse, содержащий созданные объекты. В случае неудачи возвращается Error.
Пример использования:

ОбъектXDTO = СлужбаПоддержки.ПолучитьНовыйОбъект("Consultation");
ЗаполнитьОбъект(ОбъектXDTO); // здесь выполняется заполнение объекта
СлужбаПоддержки.ДобавитьОбъект(ОбъектXDTO);

Для добавления нескольких объектов одним запросом следует использовать функцию:

СлужбаПоддержки.ДобавитьОбъекты(МассивОбъектовXDTO);

При записи процесса можно указать, что он должен быть стартован:

СлужбаПоддержки.ДобавитьОбъект(ОбъектXDTO, "StartProcess");
Класс PostRequest

Базовый класс: Request
Добавляет новые объекты в приложение.
Запрос доступен для:

СвойствоТипОбязательноеСписокОписание
actionPostActions

Дополнительное действие при записи объекта
objectsObject
ДаСодержит объекты, который требуется создать.

▲ в начало

Класс PostResponse

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

СвойствоТипОбязательноеСписокОписание
objectsObject
ДаСозданные объекы.

▲ в начало

Свойства запроса
Класс 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
Добавляет новый объект или запись к указанному объекту.
Доступно для предметов:

Доступно для объектов:

  • IncidentComment - комментарий обращения
  • ArticleComment - комментарий карточки базы знаний
  • ActualWork - запись фактических трудозатрат
  • File - присоединенный файл
СвойствоТипОбязательноеОписание
recordRecordДаДобавляемая запись. 
Для объекта типа File должны быть обязательно заполнены свойства:
  • binaryData
  • text
  • name
  • extension
  • modificationDateUniversal
  • size
targetIdObjectIdДаСсылка на объект, например, Incident, к которому будет привязан созданный объект или запись.

▲ в начало

Класс PostSubResponse

Базовый класс: Response
Возвращается в случае успешной обработки запроса PostSubRequest.

СвойствоТипОбязательноеОписание
recordRecordДаОписание записи, которая были добавлена в УСП.

▲ в начало

Обновление объекта SOAP

Для обновления объекта используется запрос класса PutRequest. В качестве параметров запроса передаются объекты, которые требуется обновить. В случае удачного выполнения запроса возвращается ответ класса PutResponse, содержащий все измененные объекты. В случае ошибки возвращается Error.
Пример использования:

СлужбаПоддержки.ОбновитьОбъект(ОбъектXDTO);

Для обновления нескольких объектов одним запросом следует использовать функцию:

СлужбаПоддержки.ОбновитьОбъекты(МассивОбъектовXDTO);

Для установки признака Рассмотрено следует использовать функцию библиотеки:

СлужбаПоддержки.УстановитьПризнакРассмотрено(ОбъектТип, ОбъектИд);
Класс PutRequest

Базовый класс: Request
Запрос на изменение объектов (например, справочники, документы, бизнес-процессы, задачи).
Доступно для объектов:

Объекты, для которых можно установить признак Рассмотрено (action=Consider):

СвойствоТипОбязательноеСписокОписание
action НовыйPutActions

Дополнительное действие при изменении объекта
objectsObjectДаДаСписок объектов, которые нужно обновить.

▲ в начало

Класс PutResponse

Базовый класс: Response
Возвращается в результате успешной обработки запроса PutRequest.

СвойствоТипОбязательноеСписокОписание
objectsObjectДаДаСписок обновленных объектов.

▲ в начало

Класс PutActions Новый

Описывает действия при изменении объектов.

Значения перечисления:

  • Consider – При указании дествия для объектов типа IncomingEmail, OutgoingEmail, PhoneCall, ServiceUserComment у перечисленных объектов будет устанавливаться признак Рассмотрено.

▲ в начало

Перенаправление объекта SOAP

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

ТекущийПользователь = СлужбаПоддержкиПовтИсп.ТекущийПользователь().objectId;
СлужбаПоддержки.ПеренаправитьОбъект("Incident", Id, ТекущийПользователь.type, ТекущийПользователь.id);

Пример перенаправления на линию поддержки:

ЛинияПоддержки = СлужбаПоддержкиПовтИсп.ТекущийПользователь().supportLine.objectId;
СлужбаПоддержки.ПеренаправитьОбъект("Incident", Id, ЛинияПоддержки.type, ЛинияПоддержки.id);
Класс PutRedirectRequest

Базовый класс: Request
Выполняет перенаправление объекта. В случае удачного выполнения возвращается OK, в случае ошибки Error.
Доступно для объектов:

  • Incident - обращение
  • Task - задача исполнителя
СвойствоТипОбязательноеОписание
queryRedirectQueryДаПараметры перенаправления.
targetIdObjectIdДаСсылка на перенаправляемый объект.

▲ в начало

Свойства запроса
Класс RedirectQuery

Описывает параметры перенаправления.

СвойствоТипОбязательноеОписание
commentstring
Комментарий перенаправления - обязательное заполнение при перенаправлении другому партнеру или за рамки своей линии поддержки.
performerIdObjectIdДаНовый ответственный. Возможные значения:
  • SupportLine - линия поддержки
  • User - пользователь

▲ в начало

Принятие задачи к исполнению SOAP

Класс PutAcceptRequest

Базовый класс: Request
Выполняет принятие задачи к исполнению. В случае удачного выполнения возвращается OK, в случае ошибки Error.

СвойствоТипОбязательноеОписание
targetIdObjectIdДаСсылка на задачу

▲ в начало

Выполнение задачи SOAP

Пример выполнения задачи:

СлужбаПоддержки.ВыполнитьЗадачу("Task", Ид, КомментарийВыполнения);

Пример выполнения задачи с возвратом на исполнение:

СлужбаПоддержки.ВыполнитьЗадачу("Task", Ид, КомментарийВыполнения, "ReturnOnСompletion");
Класс PutCompleteTaskRequest

Базовый класс: Request
Запрос на выполнение задачи исполнителя.

СвойствоТипОбязательноеОписание
actionPutСompleteTaskActions
Дополнительное действие при выполнении задачи
commentstring
Комментарий выполнения
targetIdObjectIdДаСсылка на задачу

▲ в начало

Свойства запроса
Класс PutСompleteTaskActions

Описывает дополнительные действия при выполнении задачи 
Значения перечисления:

  • CompleteTask – выполнить здачу
  • ReturnOnCompletion – вернуть на исполнение
  • CancelOrder – отменить задачу

▲ в начало

Удаление объекта SOAP

Пометка на удаление выполняется с помощью запроса класса DeleteRequest. В качестве параметров запроса передаются ссылки на объекты. Можно пометить на удаление несколько объектов. Пометка удаления выполняется в транзакции. В случае успешного выполнения запроса возвращается ответ класса DeleteResponse. В случае неудачи возвращается Error.
Пример использования:

СлужбаПоддержки.УдалитьОбъект("File", Id);

Для удаления нескольких объектов следует использовать функцию:

СлужбаПоддержки.УдалитьОбъектыПоСсылкам(МассивСсылокXDTO);
Класс DeleteRequest

Базовый класс: Request
Помечает объекты на удаление.
Доступно только для объектов типа:

СвойствоТипОбязательноеСписокОписание
objectIdsObjectIdДаДаСписок ссылок на объекты, которые нужно пометить на удаление.

▲ в начало

Класс DeleteResponse

Базовый класс: Response
Возвращается в случае успешной обработки запроса DeleteRequest.

▲ в начало

Обращения

Пример использования в библиотеке интеграции:
Обработки.СлужбаПоддержки.Формы.Обращение

Класс Incident

Базовый класс: Object
Описывает обращение в УСП.

СвойствоТипСписокОписание
commentsIncidentCommentДаКомментарии исполнителей
componentComponent
Компонент
datedateTime
Дата
deadlinedateTime
Срок обработки
descriptionstring
Описание
descriptionHTMLHTMLObject
Описание в формате HTML с картинками
dynamicAttributesDynamicAttributeДаДополнительные реквизиты
eMailForCorrespondencestring
Адрес для переписки
hasNewInteractionsboolean
Наличие новых взаимодействий
importanceImportance
Важность
initiatorServiceUser
Инициатор
knowledgeBaseArticleKnowledgeBaseArticle
Карточка базы знаний
modifiedDatedateTime
Дата изменения
numberstring
Номер
objectVersionstring
Версия объекта - обязательна при записи существующего объекта
partnerPartner
Обслуживающая организация
recievingChannelRecievingChannel
Канал получения
responsibleObject
Ответственный
sectionSection
Раздел
serviceService
Сервис
statusIncidentStatus
Состояние
subjectstring
Тема
subscriberSubscriber
Абонент
subscriberPartnerSubscriber
Обслуживающая организация абонента
supportLineSupportLine
Линия поддержки
typeIncidentType
Тип обращения

▲ в начало

Свойства класса

Класс IncidentType

Базовый класс: Object
Описывает тип обращения в УСП.
Значения перечисления:

  • Консультация
  • Ошибка


▲ в начало

Класс IncidentStatus

Базовый класс: Object
Описывает состояния обращения.
Значения перечисления:

  • Новое
  • Расследование
  • Исправление
  • ОжиданиеИнициатора
  • Закрыто


▲ в начало

Класс Importance

Базовый класс: Object
Описывает варианты важности.
Значения перечисления:

  • ВысокаяВажность - высокая важность
  • ОбычнаяВажность - обычная важность
  • НизкаяВажность - низкая важность


▲ в начало

Класс RecievingChannel

Базовый класс: Object
Описывает каналы получения обращений.

СвойствоТипОписание
codestringКод

▲ в начало

Класс IncidentComment

Базовый класс: Record
Описывает список комментариев исполнителей к обращению.

СвойствоТипОписание
authorUserАвтор комментария
commentstringТекст комментария
datedateTimeДата и время комментария
supportLineSupportLineЛиния поддержки автора

▲ в начало

Специальные отборы при получении списка

Для быстрого отбора обращений можно использовать фильтры:

  • onMy - отбор по текущему пользователю
  • onMyLine - отбор по линии поддержки текущего пользователя
  • onMyCollegues - отбор по сотрудникам линии текущего пользователя

Взаимодействия

Пример получения списка взаимодействий по объекту в библиотеке интеграции:
Обработки.СлужбаПоддержки.Формы.Взаимодействия.
Для работы с взаимодействиями можно использовать общие запросы:

  • Получение объекта
  • Обновление объекта
  • Удаление объекта

Так как взаимодействия принадлежат какому либо предмету, для получения списка взаимодействий и для получения экземпляра нового взаимодействия используются запросы:

  • Получение списка подчиненных объектов
  • Получение эклемпляра нового подчиненного объекта
  • Добавление подчиненного объекта

Телефонный звонок

Пример использования в библиотеке интеграции:
Обработки.СлужбаПоддержки.Формы.ТелефонныйЗвонок

Класс PhoneCall

Базовый класс: Object
Описывает телефонный звонок

СвойствоТипОписание
callCodestringКод звонка
consideredbooleanРассмотрено
contactSubscriberАбонант - контакт
creationDatedateTimeДата создания
descriptionstringОписание
incomingbooleanВходящий
internalbooleanФлаг внутренней переписки
objectVersionstringВерсия объекта - обязательна при записи существующего объекта
subjectstringТема
targetObjectПредмет:

▲ в начало

Комментарий пользователя сервиса

Пример использования в библиотеке интеграции:
Обработки.СлужбаПоддержки.Формы.КомментарийПользователя

Класс ServiceUserComment

Базовый класс: Object
Описывает комментарий пользователя к обращению. Создается в случае создания сообщения пользователем из приложения.

СвойствоТипОписание
authorObjectАвтор
consideredbooleanРассмотрено
creationDatedateTimeДата создания
descriptionstringОписание
descriptionHTMLHTMLObjectОписание в формате HTML
responsibleUserОтветственный
subjectstringТема
targetObjectПредмет:

▲ в начало

Электронное письмо входящее

Класс IncomingEMail

Базовый класс: Object
Описывает входящее электронное письмо.

СвойствоТипСписокОписание
attachmentsFileДаВложения
bodystring
Текст
bodyHTMLHTMLObject
Текст HTML
bodyTypeEMailBodyType
Тип текста
consideredboolean
Рассмотрено
containsAttachmentsboolean
Содержит вложения
creationDatedateTime
Дата создания
importanceInteractionImportance
Важность
internalboolean
Флаг внутренней переписки
recipientsstring
Получатели
recipientsOfCopiesstring
Получатели копий
senderstring
Отправитель
subjectstring
Тема
targetObject
Предмет:

▲ в начало

Электронное письмо исходящее

Класс OutgoingEMail

Базовый класс: Object
Описывает исходящее электронное письмо.

СвойствоТипСписокОписание
accountEMailAccount
Учетная запись
attachmentsFileДаВложения
baseIdstring
Идентификатор основания
bodystring
Текст
bodyHTMLHTMLObject
Текст в формате HTML с картинками
bodyTypeEMailBodyType
Тип текста
consideredboolean
Рассмотрено
containsAttachmentsboolean
Содержит вложения
creationDatedateTime
Дата создания
dateSentdateTime
Дата и время отправки
importanceInteractionImportance
Важность
internalboolean
Флаг внутренней переписки
recipientsstring
Получатели
recipientsOfBlindCopiesstring
Получатели скрытых копий
recipientsOfCopiesstring
Получатели копий
statusOutgoingEMailStatus
Состояние
subjectstring
Тема
targetObject
Предмет:

▲ в начало

Свойства класса

Класс OutgoingEMailStatus

Базовый класс: Object
Описывает состояния исходящего письма.
Значения перечисления:

  • Черновик - письмо записано но не отправлено
  • Отправлено - письмо отправлено
  • Исходящее - письмо находится в состоянии отправки


▲ в начало

Класс EMailAccount

Базовый класс: Object
Описывает учетную запись электронной почты.

СвойствоТипОписание
useForReceivingbooleanИспользовать для получения
useForSendingbooleanИспользовать для отправки

▲ в начало

Общие свойства взаимодействий

Класс InteractionImportance

Базовый класс: Object
Описывает варианты важности взаимодействий.
Значения перечисления:

  • Высокая - высокая важность
  • Обычная - обычная важность
  • Низкая - низкая важность


▲ в начало

Класс EMailBodyType

Базовый класс: Object
Описывает перечисление Типы текстов электронных писем.
Значения перечисления:

  • HTML
  • HTMLСКартинками
  • ПростойТекст
  • РазмеченныйТекст


▲ в начало

Карточки базы знаний

Класс KnowledgeBaseArticle

Абстрактный класс. Объекты этого класса не могут быть созданы.
Базовый класс: Object
Базовый класс для описания карточек базы знаний.

СвойствоТипСписокОписание
codestring
Код
commentsArticleCommentДаКомментарии
componentsComponentДаКомпоненты
creationDatedateTime
Дата регистрации
descriptionstring
Описание
descriptionHTMLHTMLObject
Описание в формате HTML с картинками
modifiedDatedateTime
Дата изменения
namestring
Наименование
objectVersionstring
Версия объекта - обязательна при записи существующего объекта
sectionsSectionДаРазделы
servicesServiceДаСервисы

Производные классы:

▲ в начало

Общие свойства карточек базы знаний

Класс ArticleComment

Базовый класс: Record
Описывает комментарий к карточке базы знаний.

СвойствоТипОписание
authorUserАвтор
commentstringТекст комментария
datedateTimeДата
supportLineSupportLineЛиния поддержки

▲ в начало

Консультации

Пример использования в библиотеке интеграции:
Обработки.СлужбаПоддержки.Формы.Консультация

Класс Consultation

Базовый класс: KnowledgeBaseArticle
Описывает карточку Консультации.

СвойствоТипОписание
statusConsultationStatusСостояние консультации

▲ в начало

Свойства класса

Класс ConsultationStatus

Базовый класс: Object
Описывает перечисление Состояния консультаций.
Значения перечисления:

  • Не актуальна
  • Актуальна


▲ в начало

Ошибки

Пример использования в библиотеке интеграции:
Обработки.СлужбаПоддержки.Формы.Ошибка

Класс Problem

Базовый класс: KnowledgeBaseArticle
Описывает карточку ошибки.

СвойствоТипОписание
bypassstringОбходной путь
bypassHTMLHTMLObjectОбходной путь в формате HTML с картинками
criticalbooleanКритичная
playbackstringВоспроизведение
playbackHTMLHTMLObjectВоспроизведение в формате HTML с картинками
solutionstringРешение
solutionHTMLHTMLObjectРешение в формате HTML с картинками
statusProblemStatusСостояние

▲ в начало

Свойства класса

Класс ProblemStatus

Базовый класс: Object
Описывает перечисление Состояния ошибок.
Значения перечисления:

  • Запланирована
  • Расследование
  • На исправлении
  • Исправлена


▲ в начало

Пожелания

Пример использования в библиотеке интеграции:
Обработки.СлужбаПоддержки.Формы.Пожелание

Класс Suggestion

Базовый класс: KnowledgeBaseArticle
Описывает Пожелание.

СвойствоТипОписание
statusSuggestionStatusСостояние

▲ в начало

Свойства класса

Класс SuggestionStatus

Базовый класс: Object
Описывает перечисление Состояния пожеланий.
Значения перечисления:

  • Принято
  • Запланировано
  • Реализовано
  • Отклонено


▲ в начало

Файлы

Пример использования в библиотеке интеграции:
Обработки.СлужбаПоддержки.Формы.ПрисоединенныеФайлы.
Для работы с файлами можно использовать общие запросы для работы с объектами, такие как:

  • Получение объекта
  • Обновление объекта
  • Удаление объекта

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

  • Получение списка подчиненных объекта.
  • Добавление подчиненного объекта.

Класс File

Базовый класс: Object
Описывает присоединенный файл.

СвойствоТипОписание
authorUserАвтор файла.
binaryDatabase64BinaryДвоичные данные файла.
creationDatedateTimeДата создания файла.
deletionMarkbooleanПометка удаления.
descriptionstringОписание.
extensionstringРасширение файла.
modificationDateUniversaldateTimeВсемирное координированное время (UTC) изменения файла.
namestringИмя файла.
ownerObjectВладелец файла.
sizeintegerРазмер файла в байтах.
textstringТекст, извлеченный из файла.

▲ в начало

Трудозатраты

Трудозатраты могут добавляться по объектам:

При работе с трудозатратами можно использовать запросы:

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

Класс ActualWork

Базовый класс: Record
Описывает запись фактических трудозатрат.

СвойствоТипОписание
addDatedateTimeДата добавления
descriptionstringОписание
durationintДлительность в секундах
partnerPartnerОбслуживающая организация (определяется при записи автоматически)
sourceObjectИсточник
Типы:
supportLineSupportLineЛиния поддержки (определяется при записи автоматически)
userUserПользователь (если не заполнено, определяется при записи автоматически)

▲ в начало

Процессы и задачи

Поручение

Пример использования в библиотеке интеграции:
Обработки.СлужбаПоддержки.Формы.Поручение

Класс Order

Базовый класс: Object
Описывает Поручение

СвойствоТипОписание
authorUserАвтор
creationDatedateTimeДата создания
deadlinedateTimeСрок исполнения
descriptionstringОписание
descriptionHTMLHTMLObjectОписание в формате HTML с картинками
endDatedateTimeДата завершения
importanceTaskImportanceВажность
namestringНаименование
numberstringНомер
objectVersionstringВерсия объекта - обязательна при записи существующего объекта
performerTaskPerformerИсполнитель
reviewerTaskPerformerПроверяющий
reviewPerioddateTimeСрок проверки
runtimeCommentsstringКомментарий выполнения
statusProcessStatusСостояние
targetObjectПредмет

▲ в начало

Свойства класса

Класс ProcessStatus

Базовый класс: Object
Описывает состояния процесса:

  • Активен
  • Остановлен


▲ в начало

Класс OrderRoutePoint

Базовый класс: RoutePoint
Описывает точки маршрута процесса Поручение 
▲ в начало

Задача исполнителя

Пример использования в библиотеке интеграции:
Обработки.СлужбаПоддержки.Формы.Задача

Класс Task

Базовый класс: Object
Описывает задачу исполнителя

СвойствоТипОписание
acceptDatedateTimeДата принятия к исполнению
acceptedbooleanПринята к исполнению
authorUserАвтор
creationDatedateTimeДата создания
deadlinedateTimeСрок исполнения
descriptionstringОписание
donebooleanВыполнено
endDatedateTimeДата исполнения
importanceTaskImportanceВажность
myTaskbooleanЗадача направлена текущему пользователю
namestringНаименование
numberstringНомер
objectVersionstringВерсия объекта - обязательна при записи существующего объекта
performerTaskPerformerИсполнитель
performerCommentstringКоментарий исполнения
processOrderПроцесс
routePointRoutePointТочка маршрута
startDatedateTimeДата начала выполнения
statusProcessStatusСостояние
targetObjectПредмет

▲ в начало

Свойства класса

Класс TaskImportance

Базовый класс: Object
Описывает важность задачи:

  • Высокая
  • Обычная
  • Низкая


▲ в начало

Класс TaskPerformer

Описывает исполнителя задачи

СвойствоТипОписание
mainAddressingObjectTaskAddressingObjectОсновной объект адресации
roleTaskPerformerRoleРоль исполнителя
secondaryAddressingObjectTaskAddressingObjectДополнительный объект адресации
userUserПользователь

▲ в начало

Класс TaskPerformerRole

Базовый класс: Object
Описывает роль исполнителя задачи 
▲ в начало

Класс TaskAddressingObject

Базовый класс: Object
Описывает объект адресации задач 
▲ в начало

Общие объекты

НСИ

Сервисы

Класс Service

Базовый класс: Object
Описывает список Сервисов.

СвойствоТипОписание
codestringКод
tariffsEnabledbooleanПризнак использования тарифов

Используется в обращениях и карточках базы знаний.
▲ в начало

Компоненты сервисов

Класс Component

Базовый класс: Object
Описывает справочник Компоненты сервиса.

СвойствоТипОписание
codestringКод
serviceServiceСервис

Используется в обращениях и карточках базы знаний.
▲ в начало

Разделы

Класс Section

Базовый класс: Object
Описывает список Разделов.

СвойствоТипСписокОписание
codestring
Код
componentsComponentДаКомпоненты
servicesServiceДаСервисы

Используется в обращениях и карточках базы знаний.
▲ в начало

Структура поддержки

Обслуживающие организации

Используется в обращениях и карточках базы знаний.

Класс Partner

Базовый класс: Object
Описывает обслуживающую организацию (партнера) в УСП.

СвойствоТипОписание
codestringКод
firstSupportLineSupportLineПервая линия поддержки
interactionEnabledbooleanРазрешено взаимодействие - если установлено, возможно перенаправление обращения этому партнеру.

▲ в начало

Линии поддержки

Используется в обращениях и карточках базы знаний.

Класс SupportLine

Базовый класс: Object
Описывает линию поддержки в УСП.

СвойствоТипОписание
interactionEnabledbooleanРазрешено взаимодействие - если установлено, возможно перенаправление обращения этой линии поддержки.
partnerPartnerОбслуживающая организация (партнер)

▲ в начало

Пользователи

Используется в обращениях и карточках базы знаний.

Класс User

Базовый класс: Object
Описывает пользователя Службы поддержки.

СвойствоТипОписание
interactionEnabledbooleanРазрешено взаимодействие - если установлено, возможно перенаправление обращения этому пользователю.
partnerPartnerОбслуживающая организация (партнер)
supportLineSupportLineЛиния поддержки

▲ в начало

Объекты обслуживания

Абоненты

Класс Subscriber

Базовый класс: Object
Описывает Абонента сервиса.

СвойствоТипСписокОписание
codestring
Номер абонента
dynamicAttributesDynamicAttributeДаДополнительные реквизиты. Возможно получение только для объекта.
serviceService
Сервис
serviceUsersServiceUserДаПользователи абонента. Возможно получение только для объекта.

▲ в начало

Пользователи сервисов

Используется в обращениях в качестве инициатора обращения.

Класс ServiceUser

Базовый класс: Object
Описывает пользователя сервиса.

СвойствоТипОписание
eMailsstringАдреса электронной почты
fullNamestringПолное имя
loginstringЛогин
phonestringНомер телефона
serviceServiceСервис

▲ в начало

Класс ServiceUserInfoItem

Информация о пользователе сервиса.

СвойствоТипОписание
applicationsCodesstringНомера приложений пользователя сервиса
serviceUserServiceUserПользователь сервиса
subscriberSubscriberАбонент
subscriberPartnerSubscriberОбслуживающая организация абонента

▲ в начало

Приложения

Класс Application

Базовый класс: Object
Описывает приложение в сервисе

СвойствоТипОписание
codestringНомер приложения
serviceServiceСервис

▲ в начало

Прочее

Класс Type

Описывает тип объекта API

СвойствоТипОписание
presentationstringПредставление класса
xdtoClassNamestringИмя класса

▲ в начало

Класс ObjectId

Описывает ссылку на объект УСП. Используется в качестве параметра во многих запросах.
Является основным свойством объекта Object.

СвойствоТипОбязательноеОписание
idstringДаИдентификатор объекта в УСП. Если объект представляет собой элемент справочника или документа, задачу исполнителя или бизнес-процесс, то значением свойства является уникальный идентификатор (UUID) объекта. Если объект представляет собой значение перечисления, то в свойство записывается строковое представление значения перечисления.
navRefstring
Навигационная ссылка, заполняется только при получении объекта.
typestringДаИмя класса XDTO, который соответствует данному объекту УСП.
viewstring
Сроковое представление ссылки.

▲ в начало

Класс Error

Базовый класс: Response
Предназначен для информирования внешнего приложения о произошедшей ошибке, если при обработке запроса произошла исключительная ситуация. Может быть возвращен вместо ответа на любой из запросов.

СвойствоТипОбязательноеОписание
descriptionstring
Текстовое описание ошибки, а также отладочная информация.
subjectstring
Тема сообщения об ошибке.

▲ в начало

Класс OK

Базовый класс: Response
Возвращается в случае удачного выполнения некоторых запросов.

▲ в начало

HTML документ

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

Класс HTMLObject

Описывает HTML документ с картинками.

СвойствоТипОбязательноеСписокОписание
htmlTextstringДа
Текст документа.
imagesHTMLObjectImage
ДаКартинки, входящие в документ.

▲ в начало

Класс HTMLObjectImage

Описывает картинку, входящую в состав HTML документа.

СвойствоТипОбязательноеОписание
database64BinaryДаДвоичные данные картинки.
namestringДаИмя картинки.

▲ в начало

Дополнительные реквизиты

Класс DynamicAttribute

Базовый класс: Object
Описывает дополнительный реквизит объекта.

СвойствоТипСписокОписание
formatstring
Формат редактирования
multilineInputint
Многострочная строка
objectValueObject
Значение объектного типа
requiredboolean
Обязательное заполнение
servicesServiceДаСервисы, для объектов которых доступен реквизит
simpleValueлюбой тип
Значение простого типа
tooltipstring
Подсказка
usedInTypeДаТипы объектов, в которых может использоваться этот реквизит
valueTypesTypeДаВозможные типы значений

▲ в начало

Класс DynamicAttributeValue

Базовый класс: Object
Описывает значение дополнительного реквизита объекта.

СвойствоТипОписание
ownerDynamicAttributeВладелец

▲ в начало

Класс DynamicAttributeValueHierarchy

Базовый класс: Object
Описывает иерархию значений дополнительных реквизитов объектов.

СвойствоТипОписание
ownerDynamicAttributeВладелец

▲ в начало

Абстрактные классы

Класс Request

Абстрактный класс. Объекты этого класса не могут быть созданы.
Базовый класс для запросов.

Производные классы:

▲ в начало

Класс Response

Абстрактный класс. Объекты этого класса не могут быть созданы.
Базовый класс для ответов на запросы.

Производные классы:

▲ в начало

Класс Record

Абстрактный класс. Объекты этого класса не могут быть созданы.
Базовый абстрактный класс для описания записей УСП.

Производные классы:

▲ в начало

Класс Object

Базовый класс: Record
Базовый абстрактный класс для описания объектов.

СвойствоТипОбязательноеОписание
objectIdObjectIdДаСсылка на объект.

Производные классы:

▲ в начало

Класс RoutePoint

Абстрактный класс. Объекты этого класса не могут быть созданы.
Базовый класс: Object
Базовый класс для определения точек маршрута процессов 
Производные классы:

▲ в начало