Инструкция по работе с внешним сервисом для обращений

1. Запрос на список обращений

Для выполнения запроса, необходимо отправить POST-запрос на адрес /externalapi/getIncidentsList.

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

• startFrom — указывается с какого обращения нужно загружать список, например, при подгрузке обращений нужно указывать порядковый номер последнего загруженного обращения (0 для первого обращения);
• count — указывается сколько обращений нужно загружать.

Ответом на запрос является json содержащий ключ Incidents, в котором хранится массив из записей с ключами:

• linkUuid — уид ссылки на обращения, служит для получения детальной информации по обращению и выполнению с ним определенных действий;
• date — дата регистрации обращения;
• number — номер обращения;
• state — состояние обращения;
• stateUuid — уид состояния, например, для изменения состояний из списка;
• topic — тема обращения;
• description — описание обращения.
• availableStates — массив доступных состояний, состоящий из пар state и stateUuid.

2. Отборы на список обращений

Для установки отборов на список обращений необходимо в json запроса добавить поля:

• andOr — содержит одно из двух доступных значений: and — будут отобраны все обращения, которые попадают под совокупность отборов; or — будут отобраны все обращения, которые попадают хотя бы под одно условие отбора. Это поле является обязательным при использовании отборов.
• dateStart — содержит дату начала отбора в формате yyyymmdd. В качестве даты отбора используется дата регистрации обращения;
• dateEnd — содержит дату окончания отбора в формате yyyymmdd. В качестве даты отбора используется дата регистрации обращения;
• date — содержит дату в формате yyyymmdd, на которую будут выбраны все обращения, зарегистрированные в этот день;
• responsibleUuid — содержит уид ответственного. Для
• workgroupUuid — содержит уид рабочей группы;
• clientUuid — содержит уид клиента;
• initiatorUuid — содержит уид инициатора;
• stateUuid — содержит уид состояния;
• categoryUuid — содержит уид категории;
• priorityUuid — содержит уид приоритета;
• sourceUuid — содержит уид источника;
• serviceUuid — содержит уид услуги;
• serviceComponentUuid — содержит уид состава услуги;
• typeUuid — содержит уид типа обращения;
• operatorUuid — содержит уид оператора;
• curatorUuid — содержит уид куратора;
• closingCodeUuid — содержит уид кода закрытия;
• deadlineDateStart — содержит дату начала отбора в формате yyyymmdd. В качестве даты отбора используется крайний срок обращения;
• deadlineDateEnd — содержит дату окончания отбора в формате yyyymmdd. В качестве даты отбора используется крайний срок обращения;
• deadlineDate — содержит дату в формате yyyymmdd, на которую будут выбраны все обращения, имеющие крайний срок в этот день;
• mass — содержит значение true или false, признак массового обращения;
• number — содержит номер обращения.

Для отборов по теме, описанию или решению обращения используются поля:

• topic — тема обращения;
• description — описание обращения;
• solution — решение обращения;

Обращения будут добавлены, при совпадении передаваемой фразы с частью текста (первые 1000 символов) в этих полях в самом документе.

3. Запросы на получение данных для отборов.

Запрос 1

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

Для выполнения запроса, необходимо отправить POST-запрос на адрес /externalapi/getWorkgroups.

Ответом на запрос является json содержащий ключ Workgroups, в котором хранится массив из записей с ключами:

• Workgroup — наименование рабочей группы;
• WorkgroupUuid — уид рабочей группы;
• WorkgroupCode — код рабочей группы.

Запрос 2

Получает список сотрудников. Используется для заполнения списка сотрудников в отборах: responsibleUuid, operatorUuid, curatorUuid. Для выполнения запроса, необходимо отправить POST-запрос на адрес /externalapi/getEmployers. В отправляемом запросе можно указать ключ empWorkgroupUuid, для отбора сотрудников определенной рабочей группы.

Ответом на запрос является json содержащий ключ Employers, в котором хранится массив из записей с ключами:

• Employer — имя сотрудника;
• EmployerUuid — уид сотрудика;
• EmployerCode — код сотрудника.

Запрос 3

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

Для выполнения запроса, необходимо отправить POST-запрос на адрес /externalapi/getClients.

Ответом на запрос является json содержащий ключ Clients, в котором хранится массив из записей с ключами:

• Client – наименование клиента;
• ClientUuid – уид клиента;
• ClientCode – код клиента.

Запрос 4

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

Для выполнения запроса, необходимо отправить POST-запрос на адрес /externalapi/getInitiators. В отправляемом запросе можно указать ключ initClientUuid, для отбора инициаторов определенного клиента.

Ответом на запрос является json содержащий ключ Initiators, в котором хранится массив из записей с ключами:

• Initiator – имя инициатора;
• InitiatorUuid – уид инициатора;
• InitiatorCode – код инициатора.

Запрос 5

Получает список категорий. Используется в отборе categoryUuid.

Для выполнения запроса, необходимо отправить POST-запрос на адрес /externalapi/getCategories.

Ответом на запрос является json содержащий ключ Categories, в котором хранится массив из записей с ключами:

• Categorу – наименование категории;
• CategorуUuid – уид категории;
• CategorуCode – код категории.

Запрос 6

Получает список приоритетов. Используется в отборе priorityUuid.

Для выполнения запроса, необходимо отправить POST-запрос на адрес /externalapi/getPriorities.

Ответом на запрос является json содержащий ключ Priorities, в котором хранится массив из записей с ключами:

• Prioritу – наименование приоритета;
• CategorуUuid – уид приоритета;
• CategorуCode – код приоритета.

Запрос 7

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

Для выполнения запроса, необходимо отправить POST-запрос на адрес /externalapi/getSources. Ответом на запрос является json содержащий ключ Sources, в котором хранится массив из записей с ключами:

• Source – наименование источника;
• SourceUuid – уид источника;
• SourceCode – код источника.

Запрос 8

Получает список услуг. Используется в отборе serviceUuid.

Для выполнения запроса, необходимо отправить POST-запрос на адрес /externalapi/getServices.

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

Ответом на запрос является json содержащий ключ Services, в котором хранится массив из записей с ключами:

• Service – наименование услуги;
• ServiceUuid – уид услуги;
• ServiceCode – код услуги.

Запрос 9

Получает список составов услуг. Используется в отборе serviceComponentUuid.

Для выполнения запроса, необходимо отправить POST-запрос на адрес /externalapi/getServiceComponents.

В отправляемом запросе можно указать ключи: servCompClientUuid – для отбора составов услуг доступных по SLA определенному клиенту; servCompServiceUuid – для отбора составов услуг определенной услуги.

Ответом на запрос является json содержащий ключ ServiceComponents, в котором хранится массив из записей с ключами:

• ServiceComponent – наименование услуги;
• ServiceComponentUuid – уид услуги;
• ServiceComponentCode – код услуги.

Запрос 10

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

Для выполнения запроса, необходимо отправить POST-запрос на адрес /externalapi/getTypes.

Ответом на запрос является json содержащий ключ Types, в котором хранится массив из записей с ключами:

• Type – наименование типа обращения;
• TypeUuid – уид типа обращения;
• TypeCode – код типа обращения.

Запрос 11

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

Для выполнения запроса, необходимо отправить POST-запрос на адрес /externalapi/getClosingCodes.

Ответом на запрос является json, содержащий ключ ClosingCodes, в котором хранится массив из записей с ключами:

• ClosingCode – наименование кода закрытия;
• ClosingCodeUuid – уид кода закрытия;
• ClosingCodeCode – код кода закрытия.

Запрос 12

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

Для выполнения запроса, необходимо отправить POST-запрос на адрес /externalapi/getStates.

Ответом на запрос является json, содержащий ключ States, в котором хранится массив из записей с ключами:

• State – наименование состояния;
• StateUuid – уид состояния;
• StateCode – код состояния.

4. Запрос на смену состояния обращения

Для смены состояния обращения необходимо отправить POST-запрос на адрес /externalapi/ changeIncidentState. В отправляемом запросе можно указать ключ docUuid, в котором необходимо передать уид обращения, и newStateUuid, в котором нужно указать уид нового состояния.

5. Запрос на получение данных обращения

Для получения детальной информации по обращению, необходимо отправить POST-запрос на адрес /externalapi/extGetDetailIncidentInfo.

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

Ответом на запрос является json, содержащий ключи:

uuid – ссылка на обращение в виде уида;

number – номер обращения;

date – дата регистрации обращения;

description – описание обращения без форматирования;

formattedDescription – описание обращения в формате html-текста;

solution – решение обращения;

formattedSolution – решение обращения в формате html-текста;

commentaryOnTheNotice – комментарий к извещению пользователя;

formattedCommentaryOnTheNotice – комментарий к извещению пользователя в формате html-текста;

topic – тема обращения;

responsible – ответственный;

responsibleUuid – ссылка на ответственного в виде уида;

workgroup – ответственная рабочая группа;

workgroupUuid – ссылка на ответственную рабочую группу в виде уида;

state – состояние обращения;

stateUuid – ссылка на состояние обращения в виде уида;

priority – приоритет обращения;

priorityUuid – ссылка на приоритет обращения в виде уида;

client – клиент;

clientUuid – ссылка на клиента в виде уида;

initiator – инициатор обращения;

initiatorUuid – ссылка на инициатора обращения в виде уида;

service – услуга;

serviceUuid – ссылка на услугу в виде уида;

serviceComponent – состав услуги;

serviceComponentUuid – ссылка на состав услуги в виде уида;

mass – признак массового обращения;

operator – оператор обращения;

operatorUuid – ссылка на оператора обращения в виде уида;

curator – куратор обращения;

curatorUuid – ссылка на куратора обращения в виде уида;

workplace – рабочее место;

workplaceUuid – ссылка на рабочее место в виде уида;

commentaryOnTheAssessment – комментарий к оценке;

grade – оценка;

lastModifiedDate – дата последнего изменения обращения;

type – тип обращения;

typeUuid – ссылка на тип обращения в виде уида;

deadline – крайний срок обращения;

confirmed – признак «Подтверждено»;

rejected – признак «Отклонено»;

category – категория обращения;

categoryUuid – ссылка на категорию обращения в виде уида;

documentBase – документ основание;

documentBaseUuid – ссылка на документ основание в виде уида;

timezone – часовой пояс обращения;

timezoneUuid – ссылка на часовой пояс обращения в виде уида;

source – источник;

sourceUuid – ссылка на источник в виде уида;

closingCode – код закрытия обращения;

closingCodeUuid – ссылка на код закрытия обращения в виде уида;

registrationStartDate – дата начала регистрации обращения;

firstLineSolution – признак «Решено на первой линии»;

mainDocument – главный документ;

mainDocumentUuid – ссылка на главный документ в виде уида;

organization – организация;

organizationUuid – ссылка на организацию в виде уида;

counterpartyAgreement – договор контрагента;

counterpartyAgreementUuid – ссылка на договор контрагента в виде уида;

externalTreaty – внешний договор;

externalTreatyUuid – ссылка на внешний договор в виде уида;

transferredToExternalOrganization – признак «Передано внешней организации»;

externalID – внешний номер;

externalDeadline – внешний крайний срок;

processingScript – сценарий обработки обращения;

processingScriptUuid – ссылка на сценарий обработки обращения в виде уида;

serviceUnavailable – признак «Услуга недоступна»;

commentOnTheDeadlineChange – комментарий к крайнему сроку;

basedOnMass – признак «На основании массового»;

issueRegistrationRequired – признак «Необходима регистрация проблемы»;

templateApprovalCommittee – комитет согласования из шаблона;

templateApprovalCommitteeUuid – ссылка на комитет согласования из шаблона в виде уида;

useDynamicWorkgroup – признак «Использовать динамическую рабочую группу»;

actualClosingDate – фактическая дата закрытия;

TheHistoryOfCommunication – массив с сообщениями во внешнем общении по обращению, включает в себя элементы с полями:

Text – текст сообщения;

HTMLText – текст сообщения с форматированием;

Data – дата отправки сообщения;

Autor – имя пользователя, который отправил сообщение;

IsMyMessage – признак «Это мое сообщение»;

Files – массив файлов прикрепленных к сообщению, включает в себя элементы с полями:

UUID – уид файла, для возможности его получить;

Name – имя файла.

ConfigurationItems – список КЕ прикрепленных к обращению, содержащий элементы с полями:

{

Metadata – структура КЕ, состоящая из свойств:

Name – наименование КЕ;

UID – уид КЕ;

Cod – код КЕ;

Classifier – структура классификатора, состоящая из элементов

Name – наименование классификатора;

UID – уид классификатора;

Services – массив услуг, состоящий из элементов:

Service – структура услуги, состоящая из:

Name – имя услуги, связанной с КЕ;

UID – уид услуги, связанной с КЕ;

FilesDefinitions – список файлов прикрепленных к обращению, включает в себя элементы с полями:

UUID – уид файла, для возможности его получить;

Name – имя файла.

ThereAreFiles – признак «Наличие файлов в обращении»

AdditionalFields – массив дополнительных полей обращения, содержит поле Fields в котором находится список доп. полей, включающий в себя элементы с полями:

GUID – уид поля;

Name – имя поля;

Value – значение поля;

ValueType – тип поля;

Required – обязательность заполнения;

Comment – комментарий;

Types – массив доступных типов, содержащий поля:

TypeName – имя справочника/документа типа поля;

ObjectType – справочник или документ;

ObjectName – название типа;

Availability – доступность доп. полей;

AvailaibleStates – массив доступных состояний, состоящий из элементов:

Name – имя состояния;

UID – уид состояния.

Реквизиты объекта

Реквизиты формы

6. Получение файлов

Для получения файлов обращения необходимо отправить POST-запрос на адрес /externalapi/extGetFileData.

Нужно передать ключ idFile, в котором необходимо указать ID получаемого файла. В ответном сообщении вернутся ключи: Name – имя файла и Data – данные файла в формате base64.

> Следующая глава «Управление производительностью»

<  Обратно к оглавлению