DataService

Реализация создания новой записи в разделе [Контакты] через стороннее приложение 

1. Создать и настроить проект консольного приложения C# 

1. Используя среду разработки Microsoft Visual Studio (версии не ниже 2017), создайте проект консольного приложения Visual C#.

   Работа в Microsoft Visual Studio подробно описана в статье Разработать C# код в пользовательском проекте.

2. Укажите в качестве названия проекта, например, DataServiceInsertExample.
3. Свойству проекта Target framework установите значение ".NET Framework 4.7".
4. В секцию References проекта добавьте зависимости от библиотек:
   • System.Web.Extensions.dll — библиотека классов, входящая в .NET Framework.
   • Terrasoft.Core.dll — библиотека основных классов серверного ядра приложения. Находится по пути ...\Terrasoft.WebApp\bin\Terrasoft.Core.dll.
   • Terrasoft.Nui.ServiceModel.dll — библиотека классов служб приложения. Находится по пути ...\Terrasoft.WebApp\bin\Terrasoft.Nui.ServiceModel.dll.
   • Terrasoft.Common.dll — библиотека основных классов серверного ядра приложения. Находится по пути ...\Terrasoft.WebApp\bin\Terrasoft.Common.dll.
5. В файл исходного кода приложения добавьте директивы using.
   Добавление директив using

   using System;
   using System.Text;
   using System.IO;
   using System.Net;
   using System.Collections.Generic;
   using Terrasoft.Nui.ServiceModel.DataContract;
   using Terrasoft.Core.Entities;
   using System.Web.Script.Serialization;
   

2. Добавить объявление полей и констант 

Добавление полей и констант в исходный код приложения необходимо выполнить для доступа к возможностям сервиса работы с данными DataService.

/* Основной URL приложения Creatio. Необходимо заменить на пользовательский. */
private const string baseUri = @"http://example.creatio.com";
/* Строка запроса к методу Login сервиса AuthService.svc. */
private const string authServiceUri = baseUri + @"/ServiceModel/AuthService.svc/Login";
/* Строка пути запроса InsertQuery. */
private const string insertQueryUri = baseUri + @"/0/DataService/json/reply/InsertQuery";
/* Cookie аутентификации Creatio. */
private static CookieContainer AuthCookie = new CookieContainer();

Здесь объявлены три строковых константных поля, с помощью которых формируются пути выполнения запросов на аутентификацию и запросов на чтение данных. Данные об аутентификации будут сохранены в поле AuthCookie.

3. Добавить метод, выполняющий аутентификацию 

Для доступа создаваемого приложения к сервису работы с данными DataService необходимо выполнить аутентификацию.

4. Реализовать запрос на добавление записи 

Поскольку объявленная ранее константа insertQueryUri содержит путь для отправки данных в формате JSON, то отправляемые данные необходимо предварительно сконфигурировать в виде строки, содержащей описание JSON-объекта, соответствующего контракту данных InsertQuery. Это можно сделать непосредственно в строчной переменной, однако намного удобнее и безопаснее с точки зрения возможности возникновения ошибок создать экземпляр класса InsertQuery, заполнить его свойства, а затем сериализовать его в строку.

/* Экземпляр класса запроса. */
var insertQuery = new InsertQuery()
{
    /* Название корневой схемы. */
    RootSchemaName = "Contact",
    /* Коллекция добавляемых значений колонок. */
    ColumnValues = new ColumnValues()
};
/* Экземпляр класса выражения запроса к схеме объекта.
Предназначен для конфигурирования колонки [ФИО]. */
var columnExpressionName = new ColumnExpression
{
    /* Тип выражения запроса к схеме объекта — параметр. */
    ExpressionType = EntitySchemaQueryExpressionType.Parameter,
    /* Параметр выражения запроса. */
    Parameter = new Parameter
    {
        /* Значение параметра. */
        Value = "Иванов Иван Иванович",
        /* Тип данных параметра — строка. */
        DataValueType = DataValueType.Text
    }
};

/* Экземпляр класса выражения запроса к схеме объекта.
Предназначен для конфигурирования колонки [Рабочий телефон]. */
var columnExpressionPhone = new ColumnExpression
{
    ExpressionType = EntitySchemaQueryExpressionType.Parameter,
    Parameter = new Parameter
    {
        Value = "+12 345 678 00 00",
        DataValueType = DataValueType.Text
    }
};
/* Экземпляр класса выражения запроса к схеме объекта.
Предназначен для конфигурирования колонки [Должность]. */
var columnExpressionJob = new ColumnExpression
{
    ExpressionType = EntitySchemaQueryExpressionType.Parameter,
    Parameter = new Parameter
    {
        /* GUID записи "Разработчик" системного справочника [Должность].
        Необходимо заменить на GUID записи в приложении bpm'online пользователя. */
        Value = "11D68189-CED6-DF11-9B2A-001D60E938C6",
        /* Тип данных параметра — уникальный идентификатор. */
        DataValueType = DataValueType.Guid
    }
};
/* Инициализация коллекции колонок запроса. */
insertQuery.ColumnValues.Items = new Dictionary<string, ColumnExpression>();
/* Добавление выражений запроса в коллекцию добавляемых колонок.
Колонка [ФИО]. */
insertQuery.ColumnValues.Items.Add("Name", columnExpressionName);
/* Колонка [Рабочий телефон]. */
insertQuery.ColumnValues.Items.Add("Phone", columnExpressionPhone);
/* Колонка [Должность]. */
insertQuery.ColumnValues.Items.Add("Job", columnExpressionJob);
/* Сериализация экземпляра класса запроса на добавление в JSON-строку. */
var json = new JavaScriptSerializer().Serialize(insertQuery);

5. Выполнить POST-запрос к DataService 

1. Создайте экземпляр класса HttpWebRequest.
2. Заполните свойства экземпляра.
3. Присоедините к запросу созданную ранее строку с JSON-объектом.
4. Выполните и обработайте результат запроса к сервису работы с данными DataService.
   Реализация POST-запроса

   /* Преобразование строки JSON-объекта в массив байтов. */
   byte[] jsonArray = Encoding.UTF8.GetBytes(json);
   /* Создание экземпляра HTTP-запроса. */
   var insertRequest = HttpWebRequest.Create(insertQueryUri) as HttpWebRequest;
   /* Определение метода запроса. */
   insertRequest.Method = "POST";
   /* Определение типа содержимого запроса. */
   insertRequest.ContentType = "application/json";
   /* Добавление полученных ранее аутентификационных cookie в запрос на получение данных. */
   insertRequest.CookieContainer = AuthCookie;
   /* Установить длину содержимого запроса. */
   insertRequest.ContentLength = jsonArray.Length;
   
   /* Добавление CSRF токена в заголовок запроса. */
   CookieCollection cookieCollection = AuthCookie.GetCookies(new Uri(authServiceUri));
   string csrfToken = cookieCollection["BPMCSRF"].Value;
   insertRequest.Headers.Add("BPMCSRF", csrfToken);
   
   /* Помещение в содержимое запроса JSON-объекта. */
   using (var requestStream = insertRequest.GetRequestStream())
   {
       requestStream.Write(jsonArray, 0, jsonArray.Length);
   }
   /* Выполнение HTTP-запроса и получение ответа от сервера. */
   using (var response = (HttpWebResponse)insertRequest.GetResponse())
   {
       /* Вывод ответа в консоль. */
       using (StreamReader reader = new StreamReader(response.GetResponseStream()))
       {
           Console.WriteLine(reader.ReadToEnd());
       }
   }
   

Реализация создания новой записи в разделе [Контакты] через Creatio IDE 

1. Добавить кнопку в раздел Контакты 

1. Cоздайте пакет и установите его в качестве текущего.
2. Создайте схему замещающей модели представления раздела Контакты (Contacts).
   
3. На панели дизайнера нажмите кнопку и создайте локализуемую строку.

   Для созданной строки установите:

   • Код (Code) — "InsertQueryContactButtonCaption".
   • Значение (Value) — "Добавить контакт" ("Add contact").
   
4. В массив diff добавьте конфигурационный объект с настройками расположения кнопки на странице.
   diff

   diff: /**SCHEMA_DIFF*/[
       /* Метаданные для добавления в раздел пользовательской кнопки. */
       {
           /* Выполняется операция добавления элемента на страницу. */
           "operation": "insert",
           /* Название родительского элемента управления, в который добавляется кнопка. */
           "parentName": "ActionButtonsContainer",
           /* Кнопка добавляется в коллекцию элементов управления родительского элемента (мета-имя которого указано в parentName). */
           "propertyName": "items",
           /* Мета-имя добавляемой кнопки. */
           "name": "InsertQueryContactButton",
           /* Дополнительные свойства элемента. */
           "values": {
               /* Тип добавляемого элемента — кнопка. */
               itemType: Terrasoft.ViewItemType.BUTTON,
               /* Привязка заголовка кнопки к локализуемой строке схемы. */
               caption: { bindTo: "Resources.Strings.InsertQueryContactButtonCaption" },
               /* Привязка метода-обработчика нажатия кнопки. */
               click: { bindTo: "onInsertQueryContactClick" },
               "layout": {
                   "column": 1,
                   "row": 6,
                   "colSpan": 1
               }
           }
       }
   ]/**SCHEMA_DIFF*/
   

2. Добавить метод-обработчик события нажатия кнопки 

Чтобы при нажатии на созданную в разделе Контакты (Contacts) кнопку добавлялась запись с заданными параметрами, в секцию methods замещающей схемы модели представления добавьте метод-обработчик события нажатия кнопки onInsertQueryContactClick.

methods: {
    /* Метод-обработчик нажатия кнопки. */
    onInsertQueryContactClick: function() {
        /* Создание экземпляра класса Terrasoft.InsertQuery. */
        var insert = Ext.create("Terrasoft.InsertQuery", {
            /* Название корневой схемы. */
            rootSchemaName: "Contact"
        });
        /* Установка значений-параметров Terrasoft.ParameterExpression.
        Создается экземпляр значения-параметра и добавляется в коллекцию значений колонок.
        Создание экземпляра значения-параметра для колонки [ФИО]. */
        insert.setParameterValue("Name", "Иванов Иван Иванович", Terrasoft.DataValueType.TEXT);
        /* Создание экземпляра значения-параметра для колонки [Рабочий телефон]. */
        insert.setParameterValue("Phone", "+12 345 678 00 00", Terrasoft.DataValueType.TEXT);
        /* Создание экземпляра значения-параметра для колонки [Должность]. */
        insert.setParameterValue("Job", "11D68189-CED6-DF11-9B2A-001D60E938C6", Terrasoft.DataValueType.GUID);
        /* Запрос к серверу на обновление данных. */
        insert.execute(function(response) {
            /* Вывод ответа от сервера в консоль браузера. */
            window.console.log(response);
        });
        /* Обновление данных реестра. */
        this.reloadGridData();
    }
}

Реализация класса InsertQuery для front-end части ядра приложения отличается от реализации класса InsertQuery для back-end части. Так, для создания параметров предусмотрен метод setParameterValue, а для выполнения запроса — метод execute. Узнать о свойствах и методах класса InsertQuery, реализованного в front-end части ядра приложения, можно в Библиотеке JS классов.

Результат выполнения примера 

После сохранения схемы и обновления страницы приложения с очисткой кэша в разделе Контакты (Contacts) появится кнопка Добавить контакт (Add contact). Кнопка добавляет контакт с заданными параметрами.

Реализация чтения записи раздела [Контакты] через стороннее приложение 

1. Создать и настроить проект консольного приложения C# 

1. Используя среду разработки Microsoft Visual Studio (версии не ниже 2017), создайте проект консольного приложения Visual C#.

   Работа в Microsoft Visual Studio подробно описана в статье Разработать C# код в пользовательском проекте.

2. Укажите в качестве названия проекта, например, DataServiceSelectExample.
3. Свойству проекта Target framework установите значение ".NET Framework 4.7".
4. В секцию References проекта добавьте зависимости от библиотек:
   • System.Web.Extensions.dll — библиотека классов, входящая в .NET Framework.
   • Terrasoft.Core.dll — библиотека основных классов серверного ядра приложения. Находится по пути ...\Terrasoft.WebApp\bin\Terrasoft.Core.dll.
   • Terrasoft.Nui.ServiceModel.dll — библиотека классов служб приложения. Находится по пути ...\Terrasoft.WebApp\bin\Terrasoft.Nui.ServiceModel.dll.
   • Terrasoft.Common.dll — библиотека основных классов серверного ядра приложения. Находится по пути ...\Terrasoft.WebApp\bin\Terrasoft.Common.dll.
5. В файл исходного кода приложения добавьте директивы using.
   Добавление директив using

   using System;
   using System.Text;
   using System.IO;
   using System.Net;
   using System.Collections.Generic;
   using Terrasoft.Nui.ServiceModel.DataContract;
   using Terrasoft.Core.Entities;
   using System.Web.Script.Serialization;
   using Terrasoft.Common;
   

2. Добавить объявление полей и констант 

Добавление полей и констант в исходный код приложения необходимо выполнить для доступа к возможностям сервиса работы с данными DataService.

/* Основной URL приложения Creatio. Необходимо заменить на пользовательский. */
private const string baseUri = @"http://example.creatio.com";
/* Строка запроса к методу Login сервиса AuthService.svc. */
private const string authServiceUri = baseUri + @"/ServiceModel/AuthService.svc/Login";
/* Строка пути запроса SelectQuery. */
private const string selectQueryUri = baseUri + @"/0/DataService/json/SyncReply/SelectQuery";
/* Cookie аутентификации Creatio. */
private static CookieContainer AuthCookie = new CookieContainer();

Здесь объявлены три строковых константных поля, с помощью которых формируются пути выполнения запросов на аутентификацию и запросов на чтение данных. Данные об аутентификации будут сохранены в поле AuthCookie.

3. Добавить метод, выполняющий аутентификацию 

Для доступа создаваемого приложения к сервису работы с данными DataService необходимо выполнить аутентификацию.

4. Реализовать запрос на добавление записи 

Поскольку объявленная ранее константа selectQueryUri содержит путь для отправки данных в формате JSON, то отправляемые данные необходимо предварительно сконфигурировать в виде строки, содержащей описание JSON-объекта, соответствующего контракту данных SelectQuery. Это можно сделать непосредственно в строчной переменной, однако намного удобнее и безопаснее с точки зрения возможности возникновения ошибок создать экземпляр класса SelectQuery, заполнить его свойства, а затем сериализовать его в строку.

/* Экземпляр класса запроса. */
var selectQuery = new SelectQuery()
{
    /* Название корневой схемы. */
    RootSchemaName = "Contact",
    /* Коллекция колонок запроса. */
    Columns = new SelectQueryColumns()
};
/* Выражение, задающее тип колонки [ФИО]. */
var columnExpressionName = new ColumnExpression()
{
    /* Тип выражения — колонка схемы. */
    ExpressionType = EntitySchemaQueryExpressionType.SchemaColumn,
    /* Путь к колонке. */
    ColumnPath = "Name"
};
/* Конфигурирование колонки [Name]. */
var selectQueryColumnName = new SelectQueryColumn()
{
    /* Заголовок. */
    Caption = "ФИО",
    /* Направление сортировки — по возрастанию. */
    OrderDirection = OrderDirection.Ascending,
    /* Позиция порядка сортировки. */
    OrderPosition = 0,
    /* Выражение, задающее тип колонки. */
    Expression = columnExpressionName
};
/* Выражение, задающее тип колонки [Количество активностей]. */
var columnExpressionActivitiesCount = new ColumnExpression()
{
    /* Тип выражения — вложенный запрос. */
    ExpressionType = EntitySchemaQueryExpressionType.SubQuery,
    /* Путь к колонке относительно корневой схемы. */
    ColumnPath = "[Activity:Contact].Id",
    /* Тип функции — агрегирующая. */
    FunctionType = FunctionType.Aggregation,
    /* Тип агрегации — количество. */
    AggregationType = AggregationType.Count
};
/* Конфигурирование колонки [Количество активностей]. */
var selectQueryColumnActivitiesCount = new SelectQueryColumn()
{
    /* Заголовок. */
    Caption = "Количество активностей",
    /* Направление сортировки — по возрастанию. */
    OrderDirection = OrderDirection.Ascending,
    /* Позиция порядка сортировки. */
    OrderPosition = 1,
    /* Выражение, задающее тип колонки. */
    Expression = columnExpressionActivitiesCount
};

/* Добавление колонок в запрос. */
selectQuery.Columns.Items = new Dictionary<string, SelectQueryColumn>()
{
    {
        "Name",
        selectQueryColumnName
    },
    {
        "ActivitiesCount",
        selectQueryColumnActivitiesCount
    }
};
/* Сериализация экземпляра класса запроса на добавление в JSON-строку. */
var json = new JavaScriptSerializer().Serialize(selectQuery);

5. Выполнить POST-запрос к DataService 

1. Создайте экземпляр класса HttpWebRequest.
2. Заполните свойства экземпляра.
3. Присоедините к запросу созданную ранее строку с JSON-объектом.
4. Выполните и обработайте результат запроса к сервису работы с данными DataService.
   Реализация POST-запроса

   /* Преобразование строки JSON-объекта в массив байтов. */
   byte[] jsonArray = Encoding.UTF8.GetBytes(json);
   /* Создание экземпляра HTTP-запроса. */
   var selectRequest = HttpWebRequest.Create(selectQueryUri) as HttpWebRequest;
   /* Определение метода запроса. */
   selectRequest.Method = "POST";
   /* Определение типа содержимого запроса. */
   selectRequest.ContentType = "application/json";
   /* Добавление полученных ранее аутентификационных cookie в запрос на получение данных. */
   selectRequest.CookieContainer = AuthCookie;
   /* Установить длину содержимого запроса. */
   selectRequest.ContentLength = jsonArray.Length;
   /* Добавление CSRF токена в заголовок запроса. */
   CookieCollection cookieCollection = AuthCookie.GetCookies(new Uri(authServiceUri));
   string csrfToken = cookieCollection["BPMCSRF"].Value;
   selectRequest.Headers.Add("BPMCSRF", csrfToken);
   
   /* Помещение JSON-объекта в содержимое запроса. */
   using (var requestStream = selectRequest.GetRequestStream())
   {
       requestStream.Write(jsonArray, 0, jsonArray.Length);
   }
   /* Выполнение HTTP-запроса и получение ответа от сервера. */
   using (var response = (HttpWebResponse)selectRequest.GetResponse())
   {
       /* Вывод ответа в консоль. */
       using (StreamReader reader = new StreamReader(response.GetResponseStream()))
       {
           Console.WriteLine(reader.ReadToEnd());
       }
   }
   

Реализация чтения записи раздела [Контакты] через Creatio IDE 

1. Добавить кнопку в раздел Контакты 

1. Cоздайте пакет и установите его в качестве текущего.
2. Создайте схему замещающей модели представления раздела Контакты (Contacts).
   
3. На панели дизайнера нажмите кнопку и создайте локализуемую строку.

   Для созданной строки установите:

   • Код (Code) — "SelectQueryContactButtonCaption".
   • Значение (Value) — "Выбор контактов" ("Select contacts").
   
4. В массив diff добавьте конфигурационный объект с настройками расположения кнопки на странице.
   diff

   /* Настройка визуализации кнопки в разделе. */
   diff: /**SCHEMA_DIFF*/[
       /* Метаданные для добавления в раздел пользовательской кнопки. */
       {
           /* Указывает на то, что выполняется операция добавления элемента на страницу. */
           "operation": "insert",
           /* Мета-имя родительского элемента управления, в который добавляется кнопка. */
           "parentName": "ActionButtonsContainer",
           /* Указывает на то, что кнопка добавляется в коллекцию элементов управления родительского элемента, мета-имя которого указано в parentName. */
           "propertyName": "items",
           /* Мета-имя добавляемой кнопки. */
           "name": "SelectQueryContactButton",
           /* Дополнительные свойства элемента. */
           "values": {
               /* Тип добавляемого элемента — кнопка. */
               itemType: Terrasoft.ViewItemType.BUTTON,
               /* Привязка заголовка кнопки к локализуемой строке схемы. */
               caption: { bindTo: "Resources.Strings.SelectQueryContactButtonCaption" },
               /* Привязка метода-обработчика нажатия кнопки. */
               click: { bindTo: "onSelectQueryContactClick" },
               "layout": {
                   "column": 1,
                   "row": 6,
                   "colSpan": 1
               }
           }
       }
   
   ]/**SCHEMA_DIFF*/
   

2. Добавить метод-обработчик события нажатия кнопки 

Чтобы при нажатии на созданную в разделе Контакты (Contacts) кнопку читались записи с заданными параметрами, в секцию methods замещающей схемы модели представления добавьте метод-обработчик события нажатия кнопки onSelectQueryContactClick.

methods: {
    /* Метод-обработчик нажатия кнопки. */
    onSelectQueryContactClick: function() {
        /* Создание экземпляра класса Terrasoft.InsertQuery. */
        var select = Ext.create("Terrasoft.EntitySchemaQuery", {
            /* Название корневой схемы. */
            rootSchemaName: "Contact"
        });
        /* Добавление в запрос колонки [ФИО]. */
        select.addColumn("Name");
        /* Добавление в запрос агрегирующей колонки [Количество активностей]. */
        select.addAggregationSchemaColumn(
            /* Путь к колонке относительно корневой схемы. */
            "[Activity:Contact].Id",
            /* Тип агрегации — количество. */
            Terrasoft.AggregationType.COUNT,
            /* Заголовок колонки. */
            "ActivitiesCount",
            /* Область применения агрегирующей функции — для всех элементов. */
            Terrasoft.AggregationEvalType.ALL);
        /* Запрос к серверу на обновление данных.
        Получение всей коллекции записей и ее отображение в консоли браузера. */
        select.getEntityCollection(function(result) {
            if (!result.success) {
                /* Обработка/логирование ошибки. */
                this.showInformationDialog("Ошибка запроса данных");
                return;
            }
            /* Выводимое сообщение. */
            var message = "";
            /* Перебор результирующей коллекции и построение выводимого сообщения. */
            result.collection.each(function(item) {
                message += "ФИО: " + item.get("Name") +
                ". Количество активностей: " + item.get("ActivitiesCount") + "\n";
            });
            /* Вывод сообщения в консоль. */
            window.console.log(message);
        }, this);
    }
}

В front-end части ядра приложения отсутствует класс, аналогичный классу SelectQuery для back-end части. Для выбора данных раздела необходимо использовать класс Terrasoft.EntitySchemaQuery. Подробнее о свойствах и методах этого класса можно узнать в Библиотеке JS классов.

Результат выполнения примера 

После сохранения схемы и обновления страницы приложения с очисткой кэша в разделе Контакты (Contacts) появится кнопка Выбор контактов (Select contacts). В консоли браузера кнопка отобразит записи с заданными параметрами.

Реализовать фильтры 

Предварительно выполните пример чтения записей в стороннем приложении, описанный в статье Добавить кнопку для чтения записей раздела [Контакты].

Результат реализации экземпляра класса запроса на чтение записей в сокращенной форме представлен ниже.

/* Экземпляр класса запроса. */
var selectQuery = new SelectQuery()
{
    /* Название корневой схемы. */
    RootSchemaName = "Contact",
    /* Добавление колонок в запрос. */
    Columns = new SelectQueryColumns()
    {
        /* Коллекция колонок. */
        Items = new Dictionary<string, SelectQueryColumn>()
        {
            /* Колонка [ФИО]. */
            {
                /* Ключ. */
                "Name",
                /* Значение. */
                new SelectQueryColumn()
                {
                    /* Выражение, задающее тип колонки. */
                    Expression = new ColumnExpression()
                    {
                        /* Тип выражения — колонка схемы. */
                        ExpressionType = EntitySchemaQueryExpressionType.SchemaColumn,
                        /* Путь к колонке. */
                        ColumnPath = "Name"
                    }
                }
            },
            /* Колонка [Количество активностей]. */
            {
                "ActivitiesCount",
                new SelectQueryColumn()
                {
                    Expression = new ColumnExpression()
                    {
                        /* Тип выражения — вложенный запрос. */
                        ExpressionType = EntitySchemaQueryExpressionType.SubQuery,
                        /* Путь к колонке относительно корневой схемы. */
                        ColumnPath = "[Activity:Contact].Id",
                        /* Тип функции — агрегирующая. */
                        FunctionType = FunctionType.Aggregation,
                        /* Тип агрегации — количество. */
                        AggregationType = AggregationType.Count
                    }
                }
            }
        }
    }
};

Чтобы реализовать фильтры:

1. Создайте экземпляр класса коллекции фильтров Filters.
2. Заполните необходимые свойства значениями.
3. В свойство Filters экзепляра класса запроса, созданного на предыдущем шаге, передайте ссылку на этот экземпляр.
   Пример реализации класса коллекции фильтров

   /* Фильтры запроса. */
   var selectFilters = new Filters()
   {
       /* Тип фильтра — группа. */
       FilterType = Terrasoft.Nui.ServiceModel.DataContract.FilterType.FilterGroup,
       /* Коллекция фильтров. */
       Items = new Dictionary<string, Filter>
       {
           /* Реализация фильтров. */
       }
   };
   /* Добавление фильтров в запрос. */
   selectQuery.Filters = selectFilters;
   /* Сериализация экземпляра класса запроса на чтение в JSON-строку. */
   var json = new JavaScriptSerializer().Serialize(selectQuery);
   

   Свойство Items должно содержать коллекцию типа "ключ-значение". В качестве ключа указывается строка, содержащая название фильтра, а в качестве значения — экземпляр класса Filters, содержащий непосредственную реализацию фильтра.

4. Реализуйте фильтр, обеспечивающий выбор только тех контактов, у которых количество активностей попадает в диапазон от 1 до 3. Для этого добавьте экземпляр в коллекцию фильтров.
   Пример нового экземпляра коллекции фильтров

   /* Фильтрация по активностям. */
   {
       /* Ключ. */
       "FilterActivities",
       /* Значение. */
       new Filter
       {
           /* Тип фильтра — фильтр диапазона. */
           FilterType = Terrasoft.Nui.ServiceModel.DataContract.FilterType.Between,
           /* Тип сравнения — диапазон. */
           ComparisonType = FilterComparisonType.Between,
           /* Выражение, подлежащее проверке. */
           LeftExpression = new BaseExpression()
           {
               /* Тип выражения — вложенный запрос. */
               ExpressionType = EntitySchemaQueryExpressionType.SubQuery,
               /* Путь к колонке относительно корневой схемы. */
               ColumnPath = "[Activity:Contact].Id",
               /* Тип функции — агрегирующая. */
               FunctionType = FunctionType.Aggregation,
               /* Тип агрегации — количество. */
               AggregationType = AggregationType.Count
           },
           /* Конечное выражение диапазона фильтрации. */
           RightGreaterExpression = new BaseExpression()
           {
               /* Тип выражения — параметр. */
               ExpressionType = EntitySchemaQueryExpressionType.Parameter,
               /* Параметр выражения. */
               Parameter = new Parameter()
               {
                   /* Тип данных параметра — целое число. */
                   DataValueType = DataValueType.Integer,
                   /* Значение параметра. */
                   Value = 3
               }
           },
           /* Начальное выражение диапазона фильтрации. */
           RightLessExpression = new BaseExpression()
           {
               ExpressionType = EntitySchemaQueryExpressionType.Parameter,
               Parameter = new Parameter()
               {
                   DataValueType = DataValueType.Integer,
                   Value = 1
               }
           }
       }
   }
   

5. Реализуйте фильтр, обеспечивающий выбор только тех контактов, у которых значение колонки ФИО (Name) начинается с символа "Ч". Для этого добавьте экземпляр в коллекцию фильтров.
   Пример нового экземпляра коллекции фильтров

   /* Фильтрация по имени. */
   {
       /* Ключ. */
       "FilterName",
       /* Значение. */
       new Filter
       {
           /* Тип фильтра — фильтр сравнения. */
           FilterType = Terrasoft.Nui.ServiceModel.DataContract.FilterType.CompareFilter,
           /* Тип сравнения — начинается выражением. */
           ComparisonType = FilterComparisonType.StartWith,
           /* Выражение, подлежащее проверке. */
           LeftExpression = new BaseExpression()
           {
               /* Тип выражения — колонка схемы. */
               ExpressionType = EntitySchemaQueryExpressionType.SchemaColumn,
               /* Путь к колонке. */
               ColumnPath = "Name"
           },
           /* Выражение фильтрации. */
           RightExpression = new BaseExpression()
           {
               /* Тип выражения — параметр. */
               ExpressionType = EntitySchemaQueryExpressionType.Parameter,
               /* Параметр выражения. */
               Parameter = new Parameter()
               {
                   /* Тип данных параметра — текст. */
                   DataValueType = DataValueType.Text,
                   /* Значение параметра. */
                   Value = "Ч"
               }
           }
       }
   }
   

Реализовать фильтр с макросом 

Предварительно выполните пример чтения записей в стороннем приложении, описанный в статье Добавить кнопку для чтения записей раздела [Контакты].

Результат реализации экземпляра класса запроса на чтение записей в сокращенной форме представлен ниже.

/* Экземпляр класса запроса. */
var selectQuery = new SelectQuery()
{
    /* Название корневой схемы. */
    RootSchemaName = "Contact",
    /* Добавление колонок в запрос. */
    Columns = new SelectQueryColumns()
    {
        /* Коллекция колонок. */
        Items = new Dictionary<string, SelectQueryColumn>()
        {
            /* Колонка [ФИО]. */
            {
                /* Ключ. */
                "Name",
                /* Значение. */
                new SelectQueryColumn()
                {
                    /* Выражение, задающее тип колонки. */
                    Expression = new ColumnExpression()
                    {
                        /* Тип выражения — колонка схемы. */
                        ExpressionType = EntitySchemaQueryExpressionType.SchemaColumn,
                        /* Путь к колонке. */
                        ColumnPath = "Name"
                    }
                }
            }, 
            /* Колонка [Количество активностей]. */
            {
                "ActivitiesCount",
                new SelectQueryColumn()
                {
                    Expression = new ColumnExpression()
                    {
                        /* Тип выражения — вложенный запрос. */
                        ExpressionType = EntitySchemaQueryExpressionType.SubQuery,
                        /* Путь к колонке относительно корневой схемы. */
                        ColumnPath = "[Activity:Contact].Id",
                        /* Тип функции — агрегирующая. */
                        FunctionType = FunctionType.Aggregation,
                        /* Тип агрегации — количество. */
                        AggregationType = AggregationType.Count
                    }
                }
            }
        }
    }
};

Чтобы реализовать фильтр c макросом:

1. Создайте экземпляр класса коллекции фильтров Filters.
2. Заполните необходимые свойства значениями.
3. В свойство Filters экземпляра класса запроса, созданного на предыдущем шаге, передайте ссылку на этот экземпляр.
   Пример реализации класса коллекции фильтров

   /* Фильтры запроса. */
   var selectFilters = new Filters()
   {
       /* Тип фильтра — группа. */
       FilterType = Terrasoft.Nui.ServiceModel.DataContract.FilterType.FilterGroup,
       /* Коллекция фильтров. */
       Items = new Dictionary<string, Filter>
       {
           
           /* Фильтрация по году рождения. */
           {
               /* Ключ. */
               "FilterYear",
               /* Значение. */
               new Filter
               {
                   /* Тип фильтра — фильтр сравнения. */
                   FilterType = Terrasoft.Nui.ServiceModel.DataContract.FilterType.CompareFilter,
                   /* Тип сравнения — равенство. */
                   ComparisonType = FilterComparisonType.Equal,
                   /* Выражение, подлежащее проверке. */
                   LeftExpression = new BaseExpression()
                   {
                       /* Тип выражения — колонка схемы. */
                       ExpressionType = EntitySchemaQueryExpressionType.SchemaColumn,
                       /* Путь к схеме. */
                       ColumnPath = "BirthDate"
                   },
                   /* Выражение, с которым сравнивается проверяемое значение. */
                   RightExpression = new BaseExpression
                   {
                       /* Тип выражения — функция. */
                       ExpressionType = EntitySchemaQueryExpressionType.Function,
                       /* Тип функции — макрос. */
                       FunctionType = FunctionType.Macros,
                       /* Тип макроса — год. */
                       MacrosType = EntitySchemaQueryMacrosType.Year,
                       /* Аргумент функции. */
                       FunctionArgument = new BaseExpression
                       {
                           /* Тип выражения, определяющего аргумент — параметр. */
                           ExpressionType = EntitySchemaQueryExpressionType.Parameter,
                           /* Инициализация параметра. */
                           Parameter = new Parameter
                           {
                               /* Тип параметра — целое число. */
                               DataValueType = DataValueType.Integer,
                               /* Значение параметра. */
                               Value = "1992"
                           }
                       }
                   }
               }
           }
       }
   };
   /* Добавление фильтров в запрос. */
   selectQuery.Filters = selectFilters;
   /* Сериализация экземпляра класса запроса на чтение в JSON-строку. */
   var json = new JavaScriptSerializer().Serialize(selectQuery);
   

   Коллекция содержит единственный фильтр с ключом FilterYear. Поскольку из коллекции записей необходимо выбрать только те, у которых год рождения контакта равен 1992, то тип фильтра устанавливается как фильтр сравнения, а тип сравнения — равенство значений. В качестве выражения, подлежащего проверке, устанавливается значение колонки Дата рождения (Birthday), а в качестве выражения, с которым сравнивается проверяемое выражение — функция-макрос.

   В данном случае использовать макрос удобно потому, что дата рождения хранится в базе данных в формате ГГГГ-ММ-ДД. Макрос автоматически определяет год из этого значения, следовательно, разработчику нет необходимости самостоятельно писать дополнительный программный код.

   Поскольку макрос EntitySchemaQueryMacrosType.Year является параметрическим, то необходимо инициализировать свойство FunctionArgument, которому присваивается ссылка на экземпляр класса BaseExpression. В нем и определяется целочисленный параметр со значением "1992".

Реализовать фильтры по источнику вхождения пользователя в роль 

Для использования свойства adminUnitRoleSources необходимо добавить директиву using Terrasoft.Common;.

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

Результат реализации экземпляра класса запроса на чтение записей в сокращенной форме представлен ниже.

// Экземпляр класса запроса.
var selectQuery = new SelectQuery()
{
    // Название корневой схемы.
    RootSchemaName = "Contact",
    // Добавление колонок в запрос.
    Columns = new SelectQueryColumns()
    {
        // Коллекция колонок.
        Items = new Dictionary<string, SelectQueryColumn>()
        {
            // Колонка [ФИО].
            {
                // Ключ.
                "Name",
                // Значение.
                new SelectQueryColumn()
                {
                    // Выражение, задающее тип колонки.
                    Expression = new ColumnExpression()
                    {
                        // Тип выражения — колонка схемы.
                        ExpressionType = EntitySchemaQueryExpressionType.SchemaColumn,
                        // Путь к колонке.
                        ColumnPath = "Name"
                    }
                }
            },
        }
    }
};

Чтобы реализовать фильтры по источнику вхождения пользователя в роль:

Заполните значение свойства adminUnitRoleSources с помощью перечисления констант из JS-класса Terrasoft.AdminUnitRoleSources через побитовое ИЛИ ("|").

// Фильтр по источникам вхождения в роль.
selectQuery.adminUnitRoleSources = Terrasoft.AdminUnitRoleSources.ExplicitEntry 
    | Terrasoft.AdminUnitRoleSources.Delegated 
    | Terrasoft.AdminUnitRoleSources.FuncRoleFromOrgRole 
    | Terrasoft.AdminUnitRoleSources.UpHierarchy;

// Сериализация экземпляра класса запроса на чтение в JSON-строку.
var json = new JavaScriptSerializer().Serialize(selectQuery);

1. Создать и настроить проект консольного приложения C# 

Предварительно выполните пример чтения записей в стороннем приложении, описанный в статье Добавить кнопку для чтения записей раздела [Контакты].

Чтобы создать и настроить проект консольного приложения C#:

1. Используя среду разработки Microsoft Visual Studio (версии не ниже 2017), создайте проект консольного приложения Visual C#.

   Работа в Microsoft Visual Studio подробно описана в статье Разработать C# код в пользовательском проекте.

2. Укажите в качестве названия проекта, например, DataServiceUpdateExample.
3. Свойству проекта Target framework установите значение ".NET Framework 4.7".
4. В секцию References проекта добавьте зависимости от библиотек:
   • System.Web.Extensions.dll — библиотека классов, входящая в .NET Framework.
   • Terrasoft.Core.dll — библиотека основных классов серверного ядра приложения. Находится по пути ...\Terrasoft.WebApp\bin\Terrasoft.Core.dll.
   • Terrasoft.Nui.ServiceModel.dll — библиотека классов служб приложения. Находится по пути ...\Terrasoft.WebApp\bin\Terrasoft.Nui.ServiceModel.dll.
   • Terrasoft.Common.dll — библиотека основных классов серверного ядра приложения. Находится по пути ...\Terrasoft.WebApp\bin\Terrasoft.Common.dll.
5. В файл исходного кода приложения добавьте директивы using.
   Добавление директив using

   using System;
   using System.Text;
   using System.IO;
   using System.Net;
   using System.Collections.Generic;
   using Terrasoft.Nui.ServiceModel.DataContract;
   using Terrasoft.Core.Entities;
   using System.Web.Script.Serialization;
   using Terrasoft.Common;
   

2. Добавить объявление полей и констант 

Добавление полей и констант в исходный код приложения необходимо выполнить для доступа к возможностям сервиса работы с данными DataService.

/* Основной URL приложения Creatio. Необходимо заменить на пользовательский. */
private const string baseUri = @"http://example.creatio.com";
/* Строка запроса к методу Login сервиса AuthService.svc. */
private const string authServiceUri = baseUri + @"/ServiceModel/AuthService.svc/Login";
/* Строка пути запроса UpdateQuery. */
private const string updateQueryUri = baseUri + @"/0/DataService/json/reply/UpdateQuery";
/* Cookie аутентификации Creatio. */
private static CookieContainer AuthCookie = new CookieContainer();

Здесь объявлены три строковых константных поля, с помощью которых формируются пути выполнения запросов на аутентификацию и запросов на чтение данных. Данные об аутентификации будут сохранены в поле AuthCookie.

3. Добавить метод, выполняющий аутентификацию 

Для доступа создаваемого приложения к сервису работы с данными DataService необходимо выполнить аутентификацию.

4. Реализовать запрос на добавление записи 

Поскольку объявленная ранее константа updateQueryUri содержит путь для отправки данных в формате JSON, то отправляемые данные необходимо предварительно сконфигурировать в виде строки, содержащей описание JSON-объекта, соответствующего контракту данных UpdateQuery. Это можно сделать непосредственно в строчной переменной, однако намного удобнее и безопаснее с точки зрения возможности возникновения ошибок создать экземпляр класса UpdateQuery, заполнить его свойства, а затем сериализовать его в строку.

/* Экземпляр класса запроса. */
 var updateQuery = new UpdateQuery()
 {
     /* Название корневой схемы. */
     RootSchemaName = "Contact",
     /* Новые значения колонок. */
     ColumnValues = new ColumnValues()
     {
         /* Коллекция ключ-значение. */
         Items = new Dictionary<string, ColumnExpression>()
         {
             /* Колонка Email. */
             {
                 /* Ключ. */
                 "Email",
                 /* Значение — экземпляр класса выражения запроса к схеме объекта.
                 Конфигурирование колонки [Email]. */
                 new ColumnExpression()
                 {
                     /* Тип выражения запроса к схеме объекта — параметр. */
                     ExpressionType = EntitySchemaQueryExpressionType.Parameter,
                     /* Параметр выражения запроса. */
                     Parameter = new Parameter()
                     {
                         /* Значение параметра. */
                         Value = "i.ivanov@creatio.com",
                         /* Тип данных параметра — строка. */
                         DataValueType = DataValueType.Text
                     }
                 }
             }
         }
     },
     /* Фильтры запроса. */
     Filters = new Filters()
     {
         /* Тип фильтра — группа. */
         FilterType = Terrasoft.Nui.ServiceModel.DataContract.FilterType.FilterGroup,
         /* Коллекция фильтров. */
         Items = new Dictionary<string, Filter>()
         {
              /* Фильтрация по имени. */
             {
                 /* Ключ. */
                 "FilterByName",
                 /* Значение. */
                 new Filter
                 {
                     /* Тип фильтра — фильтр сравнения. */
                     FilterType = Terrasoft.Nui.ServiceModel.DataContract.FilterType.CompareFilter,
                     /* Тип сравнения — начинается выражением. */
                     ComparisonType = FilterComparisonType.Equal,
                     /* Выражение, подлежащее проверке. */
                     LeftExpression = new BaseExpression()
                     {
                         /* Тип выражения — колонка схемы. */
                         ExpressionType = EntitySchemaQueryExpressionType.SchemaColumn,
                         /* Путь к колонке. */
                         ColumnPath = "Name"
                     },
                     /* Выражение фильтрации. */
                     RightExpression = new BaseExpression()
                     {
                         /* Тип выражения — параметр. */
                         ExpressionType = EntitySchemaQueryExpressionType.Parameter,
                         /* Параметр выражения. */
                         Parameter = new Parameter()
                         {
                             /* Тип данных параметра — текст. */
                             DataValueType = DataValueType.Text,
                             /* Значение параметра. */
                             Value = "Иванов Иван Иванович"
                         }
                     }
                 }
             }
         }
     }
 };
 /* Сериализация экземпляра класса запроса на добавление в JSON-строку. */
 var json = new JavaScriptSerializer().Serialize(updateQuery);

Здесь создается экземпляр класса UpdateQuery, в свойстве ColumnValues которого устанавливается значение "i.ivanov@creatio.com" для колонки Email. Чтобы это значение было применено только для определенной записи или группы записей, необходимо свойству Filters присвоить значение ссылки на корректно инициализированный экземпляр класса Filters. В данном случае в коллекцию фильтров добавлен единственный фильтр, который отбирает только те записи, у которых значение колонки ФИО (Name) равно "Иванов Иван Иванович".

5. Выполнить POST-запрос к DataService 

1. Создайте экземпляр класса HttpWebRequest.
2. Заполните свойства экземпляра.
3. Присоедините к запросу созданную ранее строку с JSON-объектом.
4. Выполните и обработайте результат запроса к сервису работы с данными DataService.
   Реализация POST-запроса

   /* Преобразование строки JSON-объекта в массив байтов. */
   byte[] jsonArray = Encoding.UTF8.GetBytes(json);
   /* Создание экземпляра HTTP-запроса. */
   var updateRequest = HttpWebRequest.Create(updateQueryUri) as HttpWebRequest;
   /* Определение метода запроса. */
   updateRequest.Method = "POST";
   /* Определение типа содержимого запроса. */
   updateRequest.ContentType = "application/json";
   /* Добавление полученных ранее аутентификационных cookie в запрос на получение данных. */
   updateRequest.CookieContainer = AuthCookie;
   /* Установить длину содержимого запроса. */
   updateRequest.ContentLength = jsonArray.Length;
   
   /* Добавление CSRF токена в заголовок запроса. */
   CookieCollection cookieCollection = AuthCookie.GetCookies(new Uri(authServiceUri));
   string csrfToken = cookieCollection["BPMCSRF"].Value;
   updateRequest.Headers.Add("BPMCSRF", csrfToken);
   
   /* Помещение JSON-объекта в содержимое запроса. */
   using (var requestStream = updateRequest.GetRequestStream())
   {
       requestStream.Write(jsonArray, 0, jsonArray.Length);
   }
   /* Выполнение HTTP-запроса и получение ответа от сервера. */
   using (var response = (HttpWebResponse)updateRequest.GetResponse())
   {
       /* Вывод ответа в консоль. */
       using (StreamReader reader = new StreamReader(response.GetResponseStream()))
       {
           Console.WriteLine(reader.ReadToEnd());
       }
   }
   

1. Создать и настроить проект консольного приложения C# 

Предварительно выполните пример чтения записей в стороннем приложении, описанный в статье Добавить кнопку для чтения записей раздела [Контакты].

Чтобы создать и настроить проект консольного приложения C#:

1. Используя среду разработки Microsoft Visual Studio (версии не ниже 2017), создайте проект консольного приложения Visual C#.

   Работа в Microsoft Visual Studio подробно описана в статье Разработать C# код в пользовательском проекте.

2. Укажите в качестве названия проекта, например, DataServiceDeleteExample.
3. Свойству проекта Target framework установите значение ".NET Framework 4.7".
4. В секцию References проекта добавьте зависимости от библиотек:
   • System.Web.Extensions.dll — библиотека классов, входящая в .NET Framework.
   • Terrasoft.Core.dll — библиотека основных классов серверного ядра приложения. Находится по пути ...\Terrasoft.WebApp\bin\Terrasoft.Core.dll.
   • Terrasoft.Nui.ServiceModel.dll — библиотека классов служб приложения. Находится по пути ...\Terrasoft.WebApp\bin\Terrasoft.Nui.ServiceModel.dll.
   • Terrasoft.Common.dll — библиотека основных классов серверного ядра приложения. Находится по пути ...\Terrasoft.WebApp\bin\Terrasoft.Common.dll.
5. В файл исходного кода приложения добавьте директивы using.
   Добавление директив using

   using System;
   using System.Text;
   using System.IO;
   using System.Net;
   using System.Collections.Generic;
   using Terrasoft.Nui.ServiceModel.DataContract;
   using Terrasoft.Core.Entities;
   using System.Web.Script.Serialization;
   using Terrasoft.Common;
   

2. Добавить объявление полей и констант 

Добавление полей и констант в исходный код приложения необходимо выполнить для доступа к возможностям сервиса работы с данными DataService.

/* Основной URL приложения Creatio. Необходимо заменить на пользовательский. */
private const string baseUri = @"http://example.creatio.com";
/* Строка запроса к методу Login сервиса AuthService.svc. */
private const string authServiceUri = baseUri + @"/ServiceModel/AuthService.svc/Login";
/* Строка пути запроса DeleteQuery. */
private const string deleteQueryUri = baseUri + @"/0/DataService/json/reply/DeleteQuery";
/* Cookie аутентификации Creatio. */
private static CookieContainer AuthCookie = new CookieContainer();

Здесь объявлены три строковых константных поля, с помощью которых формируются пути выполнения запросов на аутентификацию и запросов на удаление данных. Данные об аутентификации будут сохранены в поле AuthCookie.

3. Добавить метод, выполняющий аутентификацию 

Для доступа создаваемого приложения к сервису работы с данными DataService необходимо выполнить аутентификацию.

4. Реализовать запрос на удаление записи 

Поскольку объявленная ранее константа deleteQueryUri содержит путь для отправки данных в формате JSON, то отправляемые данные необходимо предварительно сконфигурировать в виде строки, содержащей описание JSON-объекта, соответствующего контракту данных DeleteQuery. Это можно сделать непосредственно в строчной переменной, однако намного удобнее и безопаснее с точки зрения возможности возникновения ошибок создать экземпляр класса DeleteQuery, заполнить его свойства, а затем сериализовать его в строку.

/* Экземпляр класса запроса. */
var deleteQuery = new DeleteQuery()
{
    /* Название корневой схемы. */
    RootSchemaName = "Contact",
    /* Фильтры запроса. */
    Filters = new Filters()
    {
        /* Тип фильтра — группа. */
        FilterType = Terrasoft.Nui.ServiceModel.DataContract.FilterType.FilterGroup,
        /* Коллекция фильтров. */
        Items = new Dictionary<string, Filter>()
        {
             /* Фильтрация по имени. */
            {
                /* Ключ. */
                "FilterByName",
                /* Значение. */
                new Filter
                {
                    /* Тип фильтра — фильтр сравнения. */
                    FilterType = Terrasoft.Nui.ServiceModel.DataContract.FilterType.CompareFilter,
                    /* Тип сравнения — начинается выражением. */
                    ComparisonType = FilterComparisonType.Equal,
                    /* Выражение, подлежащее проверке. */
                    LeftExpression = new BaseExpression()
                    {
                        /* Тип выражения — колонка схемы. */
                        ExpressionType = EntitySchemaQueryExpressionType.SchemaColumn,
                        /* Путь к колонке. */
                        ColumnPath = "Name"
                    },
                    /* Выражение фильтрации. */
                    RightExpression = new BaseExpression()
                    {
                        /* Тип выражения — параметр. */
                        ExpressionType = EntitySchemaQueryExpressionType.Parameter,
                        /* Параметр выражения. */
                        Parameter = new Parameter()
                        {
                            /* Тип данных параметра — текст. */
                            DataValueType = DataValueType.Text,
                            /* Значение параметра. */
                            Value = "Иванов Иван Иванович"
                        }
                    }
                }
            }
        }
    }
};
/* Сериализация экземпляра класса запроса на добавление в JSON-строку. */
var json = new JavaScriptSerializer().Serialize(updateQuery);

Здесь создается экземпляр класса DeleteQuery, в свойстве RootSchemaName которого устанавливается значение Contact. Для того чтобы удалена была только определенная запись или группа записей, необходимо свойству Filters присвоить значение ссылки на корректно инициализированный экземпляр класса Filters. В данном случае в коллекцию фильтров добавлен единственный фильтр, который отбирает только те записи, у которых значение колонки ФИО (Name) равно "Иванов Иван Иванович".

5. Выполнить POST-запрос к DataService 

1. Создайте экземпляр класса HttpWebRequest.
2. Заполните свойства экземпляра.
3. Присоедините к запросу созданную ранее строку с JSON-объектом.
4. Выполните и обработайте результат запроса к сервису работы с данными DataService.
   Реализация POST-запроса

   /* Преобразование строки JSON-объекта в массив байтов. */
   byte[] jsonArray = Encoding.UTF8.GetBytes(json);
   /* Создание экземпляра HTTP-запроса. */
   var updateRequest = HttpWebRequest.Create(updateQueryUri) as HttpWebRequest;
   /* Определение метода запроса. */
   updateRequest.Method = "POST";
   /* Определение типа содержимого запроса. */
   updateRequest.ContentType = "application/json";
   /* Добавление полученных ранее аутентификационных cookie в запрос на получение данных. */
   updateRequest.CookieContainer = AuthCookie;
   /* Установить длину содержимого запроса. */
   updateRequest.ContentLength = jsonArray.Length;
   
   /* Добавление CSRF токена в заголовок запроса. */
   CookieCollection cookieCollection = AuthCookie.GetCookies(new Uri(authServiceUri));
   string csrfToken = cookieCollection["BPMCSRF"].Value;
   updateRequest.Headers.Add("BPMCSRF", csrfToken);
   
   /* Помещение JSON-объекта в содержимое запроса. */
   using (var requestStream = updateRequest.GetRequestStream())
   {
       requestStream.Write(jsonArray, 0, jsonArray.Length);
   }
   /* Выполнение HTTP-запроса и получение ответа от сервера. */
   using (var response = (HttpWebResponse)updateRequest.GetResponse())
   {
       /* Вывод ответа в консоль. */
       using (StreamReader reader = new StreamReader(response.GetResponseStream()))
       {
           Console.WriteLine(reader.ReadToEnd());
       }
   }
   

1. Создать и настроить проект консольного приложения C# 

1. Используя среду разработки Microsoft Visual Studio (версии не ниже 2017), создайте проект консольного приложения Visual C#.

   Работа в Microsoft Visual Studio подробно описана в статье Разработать C# код в пользовательском проекте.

2. Укажите в качестве названия проекта, например, DataServiceDeleteExample.
3. Свойству проекта Target framework установите значение ".NET Framework 4.7".
4. В секцию References проекта добавьте зависимости от библиотек:
   • System.Web.Extensions.dll — библиотека классов, входящая в .NET Framework.
   • Terrasoft.Core.dll — библиотека основных классов серверного ядра приложения. Находится по пути ...\Terrasoft.WebApp\bin\Terrasoft.Core.dll.
   • Terrasoft.Nui.ServiceModel.dll — библиотека классов служб приложения. Находится по пути ...\Terrasoft.WebApp\bin\Terrasoft.Nui.ServiceModel.dll.
   • Terrasoft.Common.dll — библиотека основных классов серверного ядра приложения. Находится по пути ...\Terrasoft.WebApp\bin\Terrasoft.Common.dll.
5. В файл исходного кода приложения добавьте директивы using.
   Добавление директив using

   using System;
   using System.Text;
   using System.IO;
   using System.Net;
   using System.Collections.Generic;
   using Terrasoft.Nui.ServiceModel.DataContract;
   using Terrasoft.Core.Entities;
   using System.Web.Script.Serialization;
   using Terrasoft.Common;
   

2. Добавить объявление полей и констант 

Добавление полей и констант в исходный код приложения необходимо выполнить для доступа к возможностям сервиса работы с данными DataService.

/* Основной URL приложения Creatio. Необходимо заменить на пользовательский. */
private const string baseUri = @"http://example.creatio.com";
/* Строка запроса к методу Login сервиса AuthService.svc. */
private const string authServiceUri = baseUri + @"/ServiceModel/AuthService.svc/Login";
/* Строка пути запроса BatchQuery. */
private const string batchQueryUri = baseUri + @"/0/DataService/json/reply/BatchQuery";
/* Cookie аутентификации Creatio. */
private static CookieContainer AuthCookie = new CookieContainer();

Здесь объявлены три строковых константных поля, с помощью которых формируются пути выполнения запросов на аутентификацию и запросов на чтение данных. Данные об аутентификации будут сохранены в поле AuthCookie.

3. Добавить метод, выполняющий аутентификацию 

Для доступа создаваемого приложения к сервису работы с данными DataService необходимо выполнить аутентификацию.

4. Реализовать запрос на добавление записи 

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

/* Запрос на добавление данных. */
var insertQuery = new InsertQuery()
{
    RootSchemaName = "Contact",
    ColumnValues = new ColumnValues()
    {
        Items = new Dictionary<string, ColumnExpression>()
        {
            {
                "Name",
                new ColumnExpression()
                {
                    ExpressionType = EntitySchemaQueryExpressionType.Parameter,
                    Parameter = new Parameter
                    {
                        Value = "Петров Петр Петрович",
                        DataValueType = DataValueType.Text
                    }
                }
            }
        }
    }
};

5. Реализовать запрос на изменение записи 

Измените значение колонки Рабочий телефон на "012 345 67 89" для всех записей раздела Контакты (Contacts), которые в колонке ФИО (Name) содержат значение "Петров Петр Петрович".

/* Запрос на обновление данных. */
var updateQuery = new UpdateQuery()
{
    RootSchemaName = "Contact",
    ColumnValues = new ColumnValues()
    {
        Items = new Dictionary<string, ColumnExpression>()
        {
            {
                "Phone",
                new ColumnExpression()
                {
                    ExpressionType = EntitySchemaQueryExpressionType.Parameter,
                    Parameter = new Parameter()
                    {
                        Value = "0123456789",
                        DataValueType = DataValueType.Text
                    }
                }
            }
        }
    },
    Filters = new Filters()
    {
        FilterType = Terrasoft.Nui.ServiceModel.DataContract.FilterType.FilterGroup,
        Items = new Dictionary<string, Filter>()
        {
            {
                "FilterByName",
                new Filter
                {
                    FilterType = Terrasoft.Nui.ServiceModel.DataContract.FilterType.CompareFilter,
                    ComparisonType = FilterComparisonType.Equal,
                    LeftExpression = new BaseExpression()
                    {
                        ExpressionType = EntitySchemaQueryExpressionType.SchemaColumn,
                        ColumnPath = "Name"
                    },
                    RightExpression = new BaseExpression()
                    {
                        ExpressionType = EntitySchemaQueryExpressionType.Parameter,
                        Parameter = new Parameter()
                        {
                            DataValueType = DataValueType.Text,
                            Value = "Петров Петр Петрович"
                        }
                    }
                }
            }
        }
    }
};

6. Реализовать пакетный запрос 

1. После сериализации созданных экземпляров классов запросов, в строки с JSON-объектами добавьте сведения о полном квалифицированном имени типа соответствующего контракта данных.
2. Сформируйте строку, содержащую пакетный запрос.
   Пакетный запрос

   /* Сериализация экземпляра класса запроса на добавление в JSON-строку. */
   var jsonInsert = new JavaScriptSerializer().Serialize(insertQuery);
   /* Вставка типа запроса в в JSON-строку. */
   jsonInsert = jsonInsert.Insert(1, @"""__type"": ""Terrasoft.Nui.ServiceModel.DataContract.InsertQuery"",");
   /* Сериализация экземпляра класса запроса на обновление в JSON-строку. */
   var jsonUpdate = new JavaScriptSerializer().Serialize(updateQuery);
   /* Вставка типа запроса в в JSON-строку. */
   jsonUpdate = jsonUpdate.Insert(1, @"""__type"": ""Terrasoft.Nui.ServiceModel.DataContract.UpdateQuery"",");
   /* Формирование пакетного запроса. */
   var json = @"{""items"": [" + jsonInsert + "," + jsonUpdate + "]}";
   

7. Реализовать пакетный запрос 

1. Создайте экземпляр класса HttpWebRequest.
2. Заполните свойства экземпляра.
3. Присоедините к запросу созданную ранее строку с JSON-объектом.
4. Выполните и обработайте результат запроса к сервису работы с данными DataService.
   Реализация POST-запроса

   /* Преобразование строки JSON-объекта в массив байтов. */
   byte[] jsonArray = Encoding.UTF8.GetBytes(json);
   /* Создание экземпляра HTTP-запроса. */
   var batchRequest = HttpWebRequest.Create(deleteQueryUri) as HttpWebRequest;
   /* Определение метода запроса. */
   batchRequest.Method = "POST";
   /* Определение типа содержимого запроса. */
   batchRequest.ContentType = "application/json";
   /* Добавление полученных ранее аутентификационных cookie в запрос на получение данных. */
   batchRequest.CookieContainer = AuthCookie;
   /* Установить свойство ContentLength запроса. */
   batchRequest.ContentLength = jsonArray.Length;
   
   /* Добавление токена BPMCSRF в запрос. */
   CookieCollection cookieCollection = AuthCookie.GetCookies(new Uri(authServiceUri));
   string csrfToken = cookieCollection["BPMCSRF"].Value;
   batchRequest.Headers.Add("BPMCSRF", csrfToken);
               
   /* Помещение в содержимое запроса JSON-объекта. */
   using (var requestStream = batchRequest.GetRequestStream())
   {
       requestStream.Write(jsonArray, 0, jsonArray.Length);
   }
   /* Выполнение HTTP-запроса и получение ответа от сервера. */
   using (var response = (HttpWebResponse)batchRequest.GetResponse())
   {
       /* Вывод ответа в консоль. */
       using (StreamReader reader = new StreamReader(response.GetResponseStream()))
       {
           Console.WriteLine(reader.ReadToEnd());
       }
   }
   /* Задержка выполнения приложения. */
   Console.ReadKey();