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

Версия API1.0.6


Содержание

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.6

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

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

Пример запроса
GET /model.xsd
Пример ответа  Развернуть
<Model xmlns="http://v8.1c.ru/8.1/xdto"
       xmlns:xs="http://www.w3.org/2001/XMLSchema"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<package targetNamespace="http://www.1cfresh.com/sd/api" elementFormQualified="true" attributeFormQualified="false">
		<valueType name="ComparisonOperator" base="xs:string">
			<enumeration>=</enumeration>
			<enumeration><></enumeration>
			<enumeration>></enumeration>
			<enumeration>>=</enumeration>
			<enumeration><</enumeration>
			<enumeration><=</enumeration>
			<enumeration>LIKE</enumeration>
			<enumeration>IN</enumeration>
			<enumeration>IN HIERARCHY</enumeration>
		</valueType>
		<valueType name="GetNewSubActions" base="xs:string">
			<enumeration>FillFromArticle</enumeration>
		</valueType>
		<valueType name="PostActions" base="xs:string">
			<enumeration>StartProcess</enumeration>
		</valueType>
		<valueType name="PutActions" base="xs:string">
			<enumeration>Consider</enumeration>
		</valueType>
		<valueType name="PutСompleteTaskActions" base="xs:string">
			<enumeration>CompleteTask</enumeration>
			<enumeration>ReturnOnCompletion</enumeration>
			<enumeration>CancelOrder</enumeration>
		</valueType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="ActualWork" base="d3p1:Record">
			<property name="addDate" type="xs:dateTime" lowerBound="0"/>
			<property name="description" type="xs:string" lowerBound="0"/>
			<property name="source" type="d3p1:Object" lowerBound="0"/>
			<property name="user" type="d3p1:User" lowerBound="0"/>
			<property name="supportLine" type="d3p1:SupportLine" lowerBound="0"/>
			<property name="partner" type="d3p1:Partner" lowerBound="0"/>
			<property name="duration" type="xs:int" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Application" base="d3p1:Object">
			<property name="service" type="d3p1:Service" lowerBound="0"/>
			<property name="code" type="xs:string" lowerBound="0"/>
			<property name="subscriber" type="d3p1:Subscriber" lowerBound="0"/>
			<property name="infoBase" type="d3p1:InfoBase"/>
			<property name="status" type="d3p1:ApplicationStatus"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="ApplicationStatus" base="d3p1:Object"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="ArticleComment" base="d3p1:Record">
			<property name="date" type="xs:dateTime" lowerBound="0"/>
			<property name="author" type="d3p1:User" lowerBound="0"/>
			<property name="comment" type="xs:string" lowerBound="0"/>
			<property name="supportLine" type="d3p1:SupportLine" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Component" base="d3p1:Object">
			<property name="service" type="d3p1:Service" lowerBound="0"/>
			<property name="code" type="xs:string" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Configuration" base="d3p1:Object">
			<property name="name" type="xs:string" lowerBound="0"/>
			<property name="owner" type="d3p1:Subscriber" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="ConfigurationVersion" base="d3p1:Object">
			<property name="configuration" type="d3p1:Configuration"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Consultation" base="d3p1:KnowledgeBaseArticle">
			<property name="status" type="d3p1:ConsultationStatus" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="ConsultationStatus" base="d3p1:Object"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="DeleteRequest" base="d3p1:Request">
			<property name="objectIds" type="d3p1:ObjectId" upperBound="-1"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="DeleteResponse" base="d3p1:Response"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="DynamicAttribute" base="d3p1:Object">
			<property name="simpleValue" lowerBound="0" nillable="true"/>
			<property name="objectValue" type="d3p1:Object" lowerBound="0"/>
			<property name="valueTypes" type="d3p1:Type" lowerBound="0" upperBound="-1"/>
			<property name="usedIn" type="d3p1:Type" lowerBound="0" upperBound="-1"/>
			<property name="tooltip" type="xs:string" lowerBound="0"/>
			<property name="format" type="xs:string" lowerBound="0"/>
			<property name="required" type="xs:boolean" lowerBound="0"/>
			<property name="multilineInput" type="xs:int" lowerBound="0"/>
			<property name="services" type="d3p1:Service" lowerBound="0" upperBound="-1"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="DynamicAttributeValue" base="d3p1:Object">
			<property name="owner" type="d3p1:DynamicAttribute" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="DynamicAttributeValueHierarchy" base="d3p1:Object">
			<property name="owner" type="d3p1:DynamicAttribute" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="EMailAccount" base="d3p1:Object">
			<property name="useForSending" type="xs:boolean" lowerBound="0"/>
			<property name="useForReceiving" type="xs:boolean" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="EMailBodyType" base="d3p1:Object"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Error" base="d3p1:Response">
			<property name="subject" type="xs:string" lowerBound="0"/>
			<property name="description" type="xs:string" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="File" base="d3p1:Object">
			<property name="name" type="xs:string" lowerBound="0"/>
			<property name="author" type="d3p1:User" lowerBound="0"/>
			<property name="binaryData" type="xs:base64Binary" lowerBound="0"/>
			<property name="creationDate" type="xs:dateTime" lowerBound="0"/>
			<property name="description" type="xs:string" lowerBound="0"/>
			<property name="extension" type="xs:string" lowerBound="0"/>
			<property name="modificationDateUniversal" type="xs:dateTime" lowerBound="0"/>
			<property name="size" type="xs:integer" lowerBound="0"/>
			<property name="text" type="xs:string" lowerBound="0"/>
			<property name="owner" type="d3p1:Object" lowerBound="0"/>
			<property name="deletionMark" type="xs:boolean" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="GetCurrentUserRequest" base="d3p1:Request"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="GetCurrentUserResponse" base="d3p1:Response">
			<property name="object" type="d3p1:Object"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="GetListRequest" base="d3p1:Request">
			<property name="type" type="xs:string"/>
			<property name="query" type="d3p1:ListQuery" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="GetListResponse" base="d3p1:Response">
			<property name="items" type="d3p1:ListItem" lowerBound="0" upperBound="-1"/>
			<property name="tooManyObjects" type="xs:boolean" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="GetNewRequest" base="d3p1:Request">
			<property name="type" type="xs:string"/>
			<property name="columns" type="xs:string" lowerBound="0" upperBound="-1"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="GetNewResponse" base="d3p1:Response">
			<property name="record" type="d3p1:Record"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="GetNewSubRequest" base="d3p1:GetNewRequest">
			<property name="targetId" type="d3p1:ObjectId"/>
			<property name="action" type="d3p1:GetNewSubActions" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="GetNewSubResponse" base="d3p1:GetNewResponse"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="GetRequest" base="d3p1:Request">
			<property name="objectIds" type="d3p1:ObjectId" lowerBound="0" upperBound="-1"/>
			<property name="columns" type="xs:string" lowerBound="0" upperBound="-1"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="GetResponse" base="d3p1:Response">
			<property name="records" type="d3p1:Record" upperBound="-1"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="GetServiceUserInfoListRequest" base="d3p1:Request">
			<property name="serviceId" type="d3p1:ObjectId"/>
			<property name="subscriberCode" type="xs:int" lowerBound="0"/>
			<property name="applicationCode" type="xs:int" lowerBound="0"/>
			<property name="serviceUserEMail" type="xs:string" lowerBound="0"/>
			<property name="serviceUserLogin" type="xs:string" lowerBound="0"/>
			<property name="dynamicAttributes" type="d3p1:DynamicAttribute" lowerBound="0" upperBound="-1"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="GetServiceUserInfoListResponse" base="d3p1:Response">
			<property name="items" type="d3p1:ServiceUserInfoItem" lowerBound="0" upperBound="-1"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="GetSubListRequest" base="d3p1:Request">
			<property name="targetId" type="d3p1:ObjectId"/>
			<property name="type" type="xs:string"/>
			<property name="columns" type="xs:string" lowerBound="0" upperBound="-1"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="GetSubListResponse" base="d3p1:Response">
			<property name="records" type="d3p1:Record" lowerBound="0" upperBound="-1"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="GetVersionRequest" base="d3p1:Request"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="GetVersionResponse" base="d3p1:Response">
			<property name="version" type="xs:string"/>
		</objectType>
		<objectType name="HTMLObject">
			<property name="htmlText" type="xs:string"/>
			<property xmlns:d4p1="http://www.1cfresh.com/sd/api" name="images" type="d4p1:HTMLObjectImage" lowerBound="0" upperBound="-1"/>
		</objectType>
		<objectType name="HTMLObjectImage">
			<property name="name" type="xs:string"/>
			<property name="data" type="xs:base64Binary"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Importance" base="d3p1:Object"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Incident" base="d3p1:Object">
			<property name="objectVersion" type="xs:string" lowerBound="0"/>
			<property name="importance" type="d3p1:Importance" lowerBound="0"/>
			<property name="subject" type="xs:string" lowerBound="0"/>
			<property name="type" type="d3p1:IncidentType" lowerBound="0"/>
			<property name="status" type="d3p1:IncidentStatus" lowerBound="0"/>
			<property name="deadline" type="xs:dateTime" lowerBound="0"/>
			<property name="initiator" type="d3p1:ServiceUser" lowerBound="0"/>
			<property name="partner" type="d3p1:Partner" lowerBound="0"/>
			<property name="supportLine" type="d3p1:SupportLine" lowerBound="0"/>
			<property name="responsible" type="d3p1:Object" lowerBound="0"/>
			<property name="number" type="xs:string" lowerBound="0"/>
			<property name="date" type="xs:dateTime" lowerBound="0"/>
			<property name="service" type="d3p1:Service" lowerBound="0"/>
			<property name="component" type="d3p1:Component" lowerBound="0"/>
			<property name="section" type="d3p1:Section" lowerBound="0"/>
			<property name="recievingChannel" type="d3p1:RecievingChannel" lowerBound="0"/>
			<property name="knowledgeBaseArticle" type="d3p1:KnowledgeBaseArticle" lowerBound="0"/>
			<property name="description" type="xs:string" lowerBound="0"/>
			<property name="descriptionHTML" type="d3p1:HTMLObject" lowerBound="0"/>
			<property name="hasNewInteractions" type="xs:boolean" lowerBound="0"/>
			<property name="subscriber" type="d3p1:Subscriber" lowerBound="0"/>
			<property name="subscriberPartner" type="d3p1:Subscriber" lowerBound="0"/>
			<property name="eMailForCorrespondence" type="xs:string" lowerBound="0"/>
			<property name="comments" type="d3p1:IncidentComment" lowerBound="0" upperBound="-1"/>
			<property name="modifiedDate" type="xs:dateTime" lowerBound="0"/>
			<property name="dynamicAttributes" type="d3p1:DynamicAttribute" lowerBound="0" upperBound="-1"/>
			<property name="closingDate" type="xs:dateTime" lowerBound="0" nillable="true"/>
			<property name="generalComment" type="xs:string" lowerBound="0" nillable="true"/>
			<property name="subscription" type="d3p1:Subscription" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="IncidentComment" base="d3p1:Record">
			<property name="date" type="xs:dateTime" lowerBound="0"/>
			<property name="author" type="d3p1:User" lowerBound="0"/>
			<property name="comment" type="xs:string" lowerBound="0"/>
			<property name="supportLine" type="d3p1:SupportLine" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="IncidentStatus" base="d3p1:Object"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="IncidentType" base="d3p1:Object"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="IncomingEMail" base="d3p1:Object">
			<property name="subject" type="xs:string" lowerBound="0"/>
			<property name="target" type="d3p1:Object"/>
			<property name="creationDate" type="xs:dateTime" lowerBound="0"/>
			<property name="considered" type="xs:boolean" lowerBound="0"/>
			<property name="body" type="xs:string" lowerBound="0"/>
			<property name="bodyHTML" type="d3p1:HTMLObject" lowerBound="0"/>
			<property name="bodyType" type="d3p1:EMailBodyType" lowerBound="0"/>
			<property name="sender" type="xs:string" lowerBound="0"/>
			<property name="recipients" type="xs:string" lowerBound="0"/>
			<property name="recipientsOfCopies" type="xs:string" lowerBound="0"/>
			<property name="internal" type="xs:boolean" lowerBound="0"/>
			<property name="importance" type="d3p1:InteractionImportance" lowerBound="0"/>
			<property name="containsAttachments" type="xs:boolean" lowerBound="0"/>
			<property name="attachments" type="d3p1:File" lowerBound="0" upperBound="-1"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="InfoBase" base="d3p1:Object">
			<property name="configurationVersion" type="d3p1:ConfigurationVersion"/>
			<property name="service" type="d3p1:Service" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="InteractionImportance" base="d3p1:Object"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="KnowledgeBaseArticle" base="d3p1:Object" abstract="true">
			<property name="objectVersion" type="xs:string" lowerBound="0"/>
			<property name="code" type="xs:string" lowerBound="0"/>
			<property name="name" type="xs:string" lowerBound="0"/>
			<property name="services" type="d3p1:Service" lowerBound="0" upperBound="-1"/>
			<property name="components" type="d3p1:Component" lowerBound="0" upperBound="-1"/>
			<property name="sections" type="d3p1:Section" lowerBound="0" upperBound="-1"/>
			<property name="creationDate" type="xs:dateTime" lowerBound="0"/>
			<property name="modifiedDate" type="xs:dateTime" lowerBound="0"/>
			<property name="description" type="xs:string" lowerBound="0"/>
			<property name="descriptionHTML" type="d3p1:HTMLObject" lowerBound="0"/>
			<property name="comments" type="d3p1:ArticleComment" lowerBound="0" upperBound="-1"/>
		</objectType>
		<objectType name="ListFilter">
			<property name="property" type="xs:string"/>
			<property xmlns:d4p1="http://www.1cfresh.com/sd/api" name="comparisonOperator" type="d4p1:ComparisonOperator" lowerBound="0"/>
			<property name="value" lowerBound="0"/>
			<property name="valueList" lowerBound="0" upperBound="-1"/>
		</objectType>
		<objectType name="ListItem">
			<property xmlns:d4p1="http://www.1cfresh.com/sd/api" name="object" type="d4p1:Object"/>
			<property name="isFolder" type="xs:boolean"/>
			<property xmlns:d4p1="http://www.1cfresh.com/sd/api" name="parentId" type="d4p1:ObjectId" lowerBound="0"/>
			<property name="canHaveChildren" type="xs:boolean"/>
		</objectType>
		<objectType name="ListQuery">
			<property xmlns:d4p1="http://www.1cfresh.com/sd/api" name="filter" type="d4p1:ListFilter" lowerBound="0" upperBound="-1"/>
			<property name="limit" type="xs:integer" lowerBound="0"/>
			<property name="columns" type="xs:string" lowerBound="0" upperBound="-1"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="OK" base="d3p1:Response"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Object" base="d3p1:Record">
			<property name="objectId" type="d3p1:ObjectId" nillable="true"/>
		</objectType>
		<objectType name="ObjectId">
			<property name="id" type="xs:string"/>
			<property name="navRef" type="xs:string" lowerBound="0"/>
			<property name="type" type="xs:string"/>
			<property name="view" type="xs:string" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Order" base="d3p1:Object">
			<property name="objectVersion" type="xs:string" lowerBound="0"/>
			<property name="creationDate" type="xs:dateTime" lowerBound="0"/>
			<property name="number" type="xs:string" lowerBound="0"/>
			<property name="name" type="xs:string" lowerBound="0"/>
			<property name="description" type="xs:string" lowerBound="0"/>
			<property name="descriptionHTML" type="d3p1:HTMLObject" lowerBound="0"/>
			<property name="author" type="d3p1:User" lowerBound="0"/>
			<property name="importance" type="d3p1:TaskImportance" lowerBound="0"/>
			<property name="endDate" type="xs:dateTime" lowerBound="0"/>
			<property name="deadline" type="xs:dateTime" lowerBound="0"/>
			<property name="performer" type="d3p1:TaskPerformer" lowerBound="0"/>
			<property name="reviewer" type="d3p1:TaskPerformer" lowerBound="0"/>
			<property name="reviewPeriod" type="xs:dateTime" lowerBound="0"/>
			<property name="target" type="d3p1:Object" lowerBound="0"/>
			<property name="status" type="d3p1:ProcessStatus" lowerBound="0"/>
			<property name="runtimeComments" type="xs:string" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="OrderRoutePoint" base="d3p1:RoutePoint"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="OutgoingEMail" base="d3p1:Object">
			<property name="account" type="d3p1:EMailAccount" lowerBound="0"/>
			<property name="creationDate" type="xs:dateTime" lowerBound="0"/>
			<property name="dateSent" type="xs:dateTime" lowerBound="0"/>
			<property name="subject" type="xs:string" lowerBound="0"/>
			<property name="importance" type="d3p1:InteractionImportance" lowerBound="0"/>
			<property name="body" type="xs:string" lowerBound="0"/>
			<property name="bodyHTML" type="d3p1:HTMLObject" lowerBound="0"/>
			<property name="bodyType" type="d3p1:EMailBodyType" lowerBound="0"/>
			<property name="baseId" type="xs:string" lowerBound="0"/>
			<property name="target" type="d3p1:Object" lowerBound="0"/>
			<property name="considered" type="xs:boolean" lowerBound="0"/>
			<property name="recipients" type="xs:string" lowerBound="0"/>
			<property name="recipientsOfCopies" type="xs:string" lowerBound="0"/>
			<property name="recipientsOfBlindCopies" type="xs:string" lowerBound="0"/>
			<property name="containsAttachments" type="xs:boolean" lowerBound="0"/>
			<property name="status" type="d3p1:OutgoingEMailStatus" lowerBound="0"/>
			<property name="internal" type="xs:boolean" lowerBound="0"/>
			<property name="attachments" type="d3p1:File" lowerBound="0" upperBound="-1"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="OutgoingEMailStatus" base="d3p1:Object"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Partner" base="d3p1:Object">
			<property name="code" type="xs:string" lowerBound="0"/>
			<property name="interactionEnabled" type="xs:boolean" lowerBound="0"/>
			<property name="firstSupportLine" type="d3p1:SupportLine" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="PhoneCall" base="d3p1:Object">
			<property name="objectVersion" type="xs:string" lowerBound="0"/>
			<property name="target" type="d3p1:Object" lowerBound="0"/>
			<property name="creationDate" type="xs:dateTime" lowerBound="0"/>
			<property name="subject" type="xs:string" lowerBound="0"/>
			<property name="description" type="xs:string" lowerBound="0"/>
			<property name="considered" type="xs:boolean" lowerBound="0"/>
			<property name="incoming" type="xs:boolean" lowerBound="0"/>
			<property name="internal" type="xs:boolean" lowerBound="0"/>
			<property name="contact" type="d3p1:Subscriber" lowerBound="0"/>
			<property name="callCode" type="xs:string" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="PostRequest" base="d3p1:Request">
			<property name="objects" type="d3p1:Object" lowerBound="0" upperBound="-1"/>
			<property name="action" type="d3p1:PostActions" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="PostResponse" base="d3p1:Response">
			<property name="objects" type="d3p1:Object" lowerBound="0" upperBound="-1"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="PostSubRequest" base="d3p1:Request">
			<property name="targetId" type="d3p1:ObjectId"/>
			<property name="record" type="d3p1:Record"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="PostSubResponse" base="d3p1:Response">
			<property name="record" type="d3p1:Record"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Problem" base="d3p1:KnowledgeBaseArticle">
			<property name="critical" type="xs:boolean" lowerBound="0"/>
			<property name="status" type="d3p1:ProblemStatus" lowerBound="0"/>
			<property name="playback" type="xs:string" lowerBound="0"/>
			<property name="playbackHTML" type="d3p1:HTMLObject" lowerBound="0"/>
			<property name="solution" type="xs:string" lowerBound="0"/>
			<property name="solutionHTML" type="d3p1:HTMLObject" lowerBound="0"/>
			<property name="bypass" type="xs:string" lowerBound="0"/>
			<property name="bypassHTML" type="d3p1:HTMLObject" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="ProblemStatus" base="d3p1:Object"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="ProcessStatus" base="d3p1:Object"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="PutAcceptRequest" base="d3p1:Request">
			<property name="targetId" type="d3p1:ObjectId"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="PutCompleteTaskRequest" base="d3p1:Request">
			<property name="targetId" type="d3p1:ObjectId"/>
			<property name="comment" type="xs:string" lowerBound="0"/>
			<property name="action" type="d3p1:PutСompleteTaskActions" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="PutRedirectRequest" base="d3p1:Request">
			<property name="targetId" type="d3p1:ObjectId"/>
			<property name="query" type="d3p1:RedirectQuery"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="PutRequest" base="d3p1:Request">
			<property name="objects" type="d3p1:Object" upperBound="-1"/>
			<property name="action" type="d3p1:PutActions" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="PutResponse" base="d3p1:Response">
			<property name="objects" type="d3p1:Object" upperBound="-1"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="RecievingChannel" base="d3p1:Object">
			<property name="code" type="xs:string" lowerBound="0"/>
		</objectType>
		<objectType name="Record" abstract="true"/>
		<objectType name="RedirectQuery">
			<property name="comment" type="xs:string" lowerBound="0"/>
			<property xmlns:d4p1="http://www.1cfresh.com/sd/api" name="performerId" type="d4p1:ObjectId"/>
		</objectType>
		<objectType name="Request" abstract="true"/>
		<objectType name="Response" abstract="true"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="RoutePoint" base="d3p1:Object" abstract="true"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Section" base="d3p1:Object">
			<property name="code" type="xs:string" lowerBound="0"/>
			<property name="services" type="d3p1:Service" lowerBound="0" upperBound="-1"/>
			<property name="components" type="d3p1:Component" lowerBound="0" upperBound="-1"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Service" base="d3p1:Object">
			<property name="code" type="xs:string" lowerBound="0"/>
			<property name="tariffsEnabled" type="xs:boolean" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="ServiceUser" base="d3p1:Object">
			<property name="service" type="d3p1:Service" lowerBound="0"/>
			<property name="eMails" type="xs:string" lowerBound="0"/>
			<property name="login" type="xs:string" lowerBound="0"/>
			<property name="phone" type="xs:string" lowerBound="0"/>
			<property name="fullName" type="xs:string" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="ServiceUserComment" base="d3p1:Object">
			<property name="target" type="d3p1:Object" lowerBound="0"/>
			<property name="creationDate" type="xs:dateTime" lowerBound="0"/>
			<property name="considered" type="xs:boolean" lowerBound="0"/>
			<property name="subject" type="xs:string" lowerBound="0"/>
			<property name="description" type="xs:string" lowerBound="0"/>
			<property name="descriptionHTML" type="d3p1:HTMLObject" lowerBound="0"/>
			<property name="author" type="d3p1:Object" lowerBound="0"/>
			<property name="responsible" type="d3p1:User" lowerBound="0"/>
		</objectType>
		<objectType name="ServiceUserInfoItem">
			<property xmlns:d4p1="http://www.1cfresh.com/sd/api" name="subscriber" type="d4p1:Subscriber" lowerBound="0"/>
			<property xmlns:d4p1="http://www.1cfresh.com/sd/api" name="subscriberPartner" type="d4p1:Subscriber" lowerBound="0"/>
			<property xmlns:d4p1="http://www.1cfresh.com/sd/api" name="serviceUser" type="d4p1:ServiceUser" lowerBound="0"/>
			<property name="applicationsCodes" type="xs:string" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Subscriber" base="d3p1:Object">
			<property name="service" type="d3p1:Service" lowerBound="0"/>
			<property name="code" type="xs:string" lowerBound="0"/>
			<property name="serviceUsers" type="d3p1:ServiceUser" lowerBound="0" upperBound="-1"/>
			<property name="dynamicAttributes" type="d3p1:DynamicAttribute" lowerBound="0" upperBound="-1"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Subscription" base="d3p1:Object">
			<property name="subscriber" type="d3p1:Subscriber" lowerBound="0"/>
			<property name="partner" type="d3p1:Subscriber" lowerBound="0"/>
			<property name="startDate" type="xs:dateTime" lowerBound="0"/>
			<property name="completionDate" type="xs:dateTime" lowerBound="0"/>
			<property name="parent" type="d3p1:Subscription" lowerBound="0"/>
			<property name="service" type="d3p1:Service" lowerBound="0"/>
			<property name="tariff" type="d3p1:Tariff" lowerBound="0"/>
			<property name="type" type="d3p1:SubscriptionType" lowerBound="0"/>
			<property name="comment" type="xs:string" lowerBound="0"/>
			<property name="number" type="xs:string" lowerBound="0"/>
			<property name="created" type="xs:dateTime" lowerBound="0"/>
			<property name="amount" type="xs:decimal" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="SubscriptionType" base="d3p1:Object"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Suggestion" base="d3p1:KnowledgeBaseArticle">
			<property name="status" type="d3p1:SuggestionStatus" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="SuggestionStatus" base="d3p1:Object"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="SupportLine" base="d3p1:Object">
			<property name="partner" type="d3p1:Partner" lowerBound="0"/>
			<property name="interactionEnabled" type="xs:boolean" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Tariff" base="d3p1:Object">
			<property name="service" type="d3p1:Service" lowerBound="0"/>
			<property name="code" type="xs:string" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="Task" base="d3p1:Object">
			<property name="objectVersion" type="xs:string" lowerBound="0"/>
			<property name="process" type="d3p1:Order" lowerBound="0"/>
			<property name="creationDate" type="xs:dateTime" lowerBound="0"/>
			<property name="number" type="xs:string" lowerBound="0"/>
			<property name="routePoint" type="d3p1:RoutePoint" lowerBound="0"/>
			<property name="name" type="xs:string" lowerBound="0"/>
			<property name="done" type="xs:boolean" lowerBound="0"/>
			<property name="importance" type="d3p1:TaskImportance" lowerBound="0"/>
			<property name="author" type="d3p1:User" lowerBound="0"/>
			<property name="target" type="d3p1:Object" lowerBound="0"/>
			<property name="description" type="xs:string" lowerBound="0"/>
			<property name="performer" type="d3p1:TaskPerformer" lowerBound="0"/>
			<property name="performerComment" type="xs:string" lowerBound="0"/>
			<property name="deadline" type="xs:dateTime" lowerBound="0"/>
			<property name="startDate" type="xs:dateTime" lowerBound="0"/>
			<property name="endDate" type="xs:dateTime" lowerBound="0"/>
			<property name="accepted" type="xs:boolean" lowerBound="0"/>
			<property name="acceptDate" type="xs:dateTime" lowerBound="0"/>
			<property name="status" type="d3p1:ProcessStatus" lowerBound="0"/>
			<property name="myTask" type="xs:boolean" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="TaskAddressingObject" base="d3p1:Object"/>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="TaskImportance" base="d3p1:Object"/>
		<objectType name="TaskPerformer">
			<property xmlns:d4p1="http://www.1cfresh.com/sd/api" name="user" type="d4p1:User" lowerBound="0"/>
			<property xmlns:d4p1="http://www.1cfresh.com/sd/api" name="role" type="d4p1:TaskPerformerRole" lowerBound="0"/>
			<property xmlns:d4p1="http://www.1cfresh.com/sd/api" name="mainAddressingObject" type="d4p1:TaskAddressingObject" lowerBound="0"/>
			<property xmlns:d4p1="http://www.1cfresh.com/sd/api" name="secondaryAddressingObject" type="d4p1:TaskAddressingObject" lowerBound="0"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="TaskPerformerRole" base="d3p1:Object"/>
		<objectType name="Type">
			<property name="xdtoClassName" type="xs:string"/>
			<property name="presentation" type="xs:string"/>
		</objectType>
		<objectType xmlns:d3p1="http://www.1cfresh.com/sd/api" name="User" base="d3p1:Object">
			<property name="partner" type="d3p1:Partner" lowerBound="0"/>
			<property name="supportLine" type="d3p1:SupportLine" lowerBound="0"/>
			<property name="interactionEnabled" type="xs:boolean" lowerBound="0"/>
		</objectType>
	</package>
</Model>

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

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

Запрос
GET /currentuser
Пример ответа  Развернуть
<User
 xmlns="http://www.1cfresh.com/sd/api"
      xmlns:xs="http://www.w3.org/2001/XMLSchema"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<objectId>
		<id>a14919f5-0dad-11e4-93f4-0050568b4127</id>
		<navRef>e1cib/data/Справочник.Пользователи?ref=93f40050568b412711e40dada14919f5</navRef>
		<type>User</type>
		<view>Иванов</view>
	</objectId>
	<partner>
		<objectId>
			<id>70cd3c69-0e54-11e4-93f4-0050568b4127</id>
			<type>Partner</type>
			<view>Служба поддержки</view>
		</objectId>
	</partner>
	<supportLine>
		<objectId>
			<id>d1f2a6e2-17b4-11e4-93f4-0050568b4127</id>
			<type>SupportLine</type>
			<view>Первая линия поддержки</view>
		</objectId>
	</supportLine>
</User>

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

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

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

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

GET /incidents

Для списков доступны возможности:

  • Определить выводимые колонки. Для этого нужно использовать параметр columns.
  • Установить отборы. Для этого нужно использовать параметр filter.
  • Установить лимит на количество получаемых записей. Для этого нужно использовать параметр limit.

Эти параметры можно использовать в одном запросе в любой комбинации. Например:

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

В запросе можно использовать большие и маленькие буквы в именах классов и свойств.

Лимит на количество получаемых записей

Указание параметра limit. позволяет установить лимит на количество получаемых записей при получении списка объектов. Например, следующий запрос выдаст сведения о не более чем 3 инцидентах .

Пример запроса
GET /incidents?&limit=3
Пример ответа  Развернуть
<GetListResponse xmlns="http://www.1cfresh.com/sd/api"
                 xmlns:xs="http://www.w3.org/2001/XMLSchema"
                 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<items>
		<object xsi:type="Incident">
			<objectId>
				<id>7dd9ff73-26a0-11e4-93f4-0050568b4127</id>
				<type>Incident</type>
				<view>BO-78 пропадает описание от 18.08.2021 (Обращение)</view>
			</objectId>
		</object>
		<isFolder>false</isFolder>
		<canHaveChildren>false</canHaveChildren>
	</items>
	<items>
		<object xsi:type="Incident">
			<objectId>
				<id>403fcc92-26b6-11e4-93f4-0050568b4127</id>
				<type>Incident</type>
				<view>FR-65 Заполнение нового пользователя от 18.08.2021 (Обращение)</view>
			</objectId>
		</object>
		<isFolder>false</isFolder>
		<canHaveChildren>false</canHaveChildren>
	</items>
	<items>
		<object xsi:type="Incident">
			<objectId>
				<id>1d4be38d-26b6-11e4-93f4-0050568b4127</id>
				<type>Incident</type>
				<view>FR-59 Нет документации по интеграции от 18.08.2021 (Обращение)</view>
			</objectId>
		</object>
		<isFolder>false</isFolder>
		<canHaveChildren>false</canHaveChildren>
	</items>
	<tooManyObjects>true</tooManyObjects>
</GetListResponse>
Вывод реквизитов в списке

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

Значение параметра это:

  • имена полей класса, перечисленные через запятую;
  • или * — выводить в ответе все колонки (все поля класса)

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

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

Как уже говорилось, параметр запроса  columns можно использовать одновременно с параметрами filter и/или limit.

Пример запроса
GET /incidents?limit=3&columns=date,number,subject,initiator
Пример ответа  Развернуть
<GetListResponse 
  xmlns="http://www.1cfresh.com/sd/api" 
  xmlns:xs="http://www.w3.org/2001/XMLSchema" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <items>
    <object xsi:type="Incident">
      <objectId>
        <id>7dd9ff73-26a0-11e4-93f4-0050568b4127</id>
        <type>Incident</type>
        <view>BO-785 пропадает описание от 18.08.2021 (Обращение)</view>
      </objectId>
      <subject>пропадает описание</subject>
      <initiator>
        <objectId>
          <id>3e74b908-638a-11ea-80cc-08002706d699</id>
          <type>ServiceUser</type>
          <view>Тест БО</view>
        </objectId>
      </initiator>
      <number>BO-785</number>
      <date>2021-08-18T10:23:41</date>
    </object>
    <isFolder>false</isFolder>
    <canHaveChildren>false</canHaveChildren>
  </items>
  <items>
    <object xsi:type="Incident">
      <objectId>
        <id>403fcc92-26b6-11e4-93f4-0050568b4127</id>
        <type>Incident</type>
        <view>FR-66 Заполнение нового пользователя от 18.08.2021 (Обращение)</view>
      </objectId>
      <subject>Заполнение нового пользователя</subject>
      <initiator>
        <objectId>
          <id>1f0c622c-2542-11e4-93f4-0050568b4127</id>
          <type>ServiceUser</type>
          <view>Петров (Менеджер 1 линии)</view>
        </objectId>
      </initiator>
      <number>FR-66</number>
      <date>2021-08-18T13:00:32</date>
    </object>
    <isFolder>false</isFolder>
    <canHaveChildren>false</canHaveChildren>
  </items>
  <items>
    <object xsi:type="Incident">
      <objectId>
        <id>1d4be38d-26b6-11e4-93f4-0050568b4127</id>
        <type>Incident</type>
        <view>FR-65 тест от 18.08.2021 (Обращение)</view>
      </objectId>
      <subject>тест</subject>
      <initiator>
        <objectId>
          <id>1f0c622c-2542-11e4-93f4-0050568b4127</id>
          <type>ServiceUser</type>
          <view>Петров (Менеджер 1 линии)</view>
        </objectId>
      </initiator>
      <number>FR-65</number>
      <date>2021-08-18T13:00:35</date>
    </object>
    <isFolder>false</isFolder>
    <canHaveChildren>false</canHaveChildren>
  </items>
  <tooManyObjects>true</tooManyObjects>
</GetListResponse>
Отборы в списке

Возможна установка отборов на получаемый список. Для этого нужно использовать параметр 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

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

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

  • 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

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

Получение экземпляра нового подчиненного объекта 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Любой тип
Значение поля отбора. Заполняется для всех условий кроме "IN" и "IN HIERARCHY"
valueListЛюбой тип
Список значений поля отбора. Заполняется только для условий "IN" и "IN HIERARCHY"
Класс 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

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

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

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

Дополнительное действие при изменении объекта
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
Описывает обращение в УСП.

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

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

Класс IncidentType

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

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

Класс IncidentStatus

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

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

Класс Importance

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

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

Класс RecievingChannel

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

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

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

  • ИнформационныйЦентр
  • СервисРегистрацииОшибок
  • ТелефонГорячейЛинии
  • ЭлектроннаяПочта

Класс 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
Описывает объект адресации задач

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

НСИ

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

Класс Component

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

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

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

Разделы

Класс Section

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

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

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

Сервисы

Класс Service

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

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

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

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

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

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

Класс Partner

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

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

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

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

Класс SupportLine

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

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

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

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

Класс User

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

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

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

Абоненты

Класс Subscriber

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

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

Подписки на тарифы

Класс Subscription НОВЫЙ

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

СвойствоТипОписание
amountdecimalКоличество
commentstringКомментарий
completionDatedateTimeДата завершения подписки
createddateTimeДата создания документа
numberstringНомер документа
parentSubscriptionВедущая подписка
partnerSubscriberВедущий абонент
serviceServiceСервис
startDatedateTimeДата начала подписки
subscriberSubscriberАбонент
tariffTariffТариф
typeSubscriptionTypeТип подписки
Класс SubscriptionType НОВЫЙ

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

  • Продлевающая
  • Основная
  • Расширяющая


Класс Tariff НОВЫЙ

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

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

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

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

Класс ServiceUser

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

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

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

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

Приложения

Класс Application

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

СвойствоТипОписание
codestringНомер приложения
infoBaseInfoBaseИнформационная база
serviceServiceСервис
statusApplicationStatusСостояние приложения
subscriberSubscriberАбонент
Класс ApplicationStatus НОВЫЙ

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

  • Готова
  • ГотовитсяКИспользованию
  • Используется
  • Конвертируется
  • Копируется
  • КУдалению
  • МиграцияПриложения
  • Новая
  • Отсутствует
  • ОшибкаПодготовки
  • Удалена

Информационные базы

Класс InfoBase

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

СвойствоТипОписание
configurationVersionConfigurationVersionВерсия конфигурации
service НОВЫЙ
ServiceСервис

Конфигурации

Класс Configuration

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

СвойствоТипОписание
name НОВЫЙ
stringИмя
owner НОВЫЙ
SubscriberВладелец

Версии конфигураций

Класс ConfigurationVersion

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

СвойствоТипОписание
configurationConfigurationКонфигурация

Прочее

Класс 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
Базовый класс для определения точек маршрута процессов
Производные классы: