Руководство по подключению к REST Metadata веб-сервисам Microsoft Dynamics 365 for Operations

Описание

Клиентские приложения имеют возможность получать доступ к развернутым в D365O по умолчанию сервисам типа REST Metadata, которых не было в AX2012. Эти веб-сервисы позволяют просмотреть метаданные по имеющимся в D365O меткам и data entity, передавая их в формате JSON.

Для просмотра метаданных по меткам нужно сформировать URL запрос вида «АДРЕС D365O»/metadata/Labels(Id=’«КОД МЕТКИ»’,Language=’«ЯЗЫК МЕТКИ»’). Например, https://oit-adm-boryseda2b5401719f08ddevaos.cloudax.dynamics.com/metadata/Labels(Id=’@SYS1′,Language=’en-us’). При этом возвращается следующая информация:

1. id – код метки.
2. language – язык метки.
3. value – текст метки.
4. @odata.context –адрес источника данных.

То есть, такой запрос позволяет получить текст метки, код и язык которой мы ввели.

Для вывода информации по конкретной data entity, нужно сформировать запрос следующим образом: «АДРЕС D365O»/metadata/DataEntities(Name=’«ИМЯ DATA ENTITY»’). Например: https://ualoc- boryseda2b5401719f08ddevaos.cloudax.dynamics.com/metadata/DataEntities(Name=’ACOJournalNameEntity’). При этом возвращается следующая информация:

1. Name – название data entity в AOT.
2. PublicEntityName – название класса, который используется со стороны клиента в качестве контракта данных отдельной записи data entity.
3. PublicCollectionName – название data entity, используемое со стороны клиента.
4. LabelId – код метки названия.
5. dataServiceEnabled – показатель того, доступна ли data entity из веб-сервисов.
6. dataManagementEnabled – показатель того, доступна ли data entity из Data management воркспейса D365O.
7. entityCategory – категория data entity.
8. isReadOnly – boolean значение, которое определяет возможность модификации данных (важно при использовании OData веб-сервисов).
9. @odata.context –адрес источника данных.

Для просмотра метаданных по всем data entity нужно сформировать URL запрос вида «АДРЕС D365O»/metadata/DataEntities. Например, boryseda2b5401719f08ddevaos.cloudax.dynamics.com/metadata/DataEntities. При этом возвращается следующая информация:

1. value – массив, содержащий информацию по каждой data entity системы в том же виде, как при запросе для отдельной data entity, но без их @odata.context.
2. @odata.context –адрес источника данных.

Полученная информация может быть использована для помощи в создании клиентских приложений, вызывающих веб-сервисы OData, так как содержит используемые со стороны клинта названия data entity, а также позволяет понять, возможно ли только считывать данные data entity, или же можно их модифицировать.

Вызов веб-сервиса D365O из Desktop приложения

Подготовительный этап

1. value – массив, содержащий информацию о каждой возвращенной записи data entity. Данные в массиве содержат все public поля data entity, а также хеш код записи @odata.etag.
2. @odata.context –адрес источника данных.

Вызов только считывающего данные веб-сервиса D365O из Desktop приложения

Подготовительный этап

1. Создать новый C# проект.
2. Если нет зарегистрированного приложения в Azure, зарегистрировать его, как описано в статье «Регистрация приложения в Azure».
3. Добавить ссылку на проект JsonRequestSender, который описан в статье «Создание вспомогательных классов JsonRequestSender для отправки запросов JSON».
4. Добавить ссылку на пакет System.Runtime.Serialization, как описано в статье «Добавление пакета System.Runtime.Serialization».

Основной код

При использовании вспомогательного проекта JsonRequestSender, вызов веб-сервиса сводится к одной команде. Для этого сначала нужно создать объект класса RequestSender_OAuth, так как в вебсервисах D365O используется аутентификация OAuth.

Copy to Clipboard

Далее, так как REST Metadata веб-сервисы D365O используют GET запросы, отправляем GET запрос, по правилам запросов REST Metadata.

Copy to Clipboard

В метод sendGETRequest() передаются один дженерик класс и один аргумент.

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

Аргумент определяет относительный адрес вызываемого метода вебсервиса в ресурсе. В данном случае относительный адрес показывает, что нужно вернуть метку с ID равным значению переменной labelId и языком равным значению переменной labelLanguage.

Пример

В качестве примера приведено приложение Microsoft forms для получения значений меток и информации о data entity системы.

Для получения значения метки нужно в двух верхних полях ввести ID и код языка метки, после чего нажать кнопку Get label value.

Для получения информации о data entity нужно нажать кнопку Get data entity information, при желании указав AOT-название конкретной data entity над кнопкой.

Copy to Clipboard

using System;
using System.Windows.Forms;

namespace LabelsAndDataEntitiesListServiceConnector
{
    public partial class ServiceConnectorForm : Form
    {
        public ServiceConnectorForm()
        {
            InitializeComponent();
        }

private void getLabelValueButton_Click(
            object sender,
            EventArgs e)
        {
            LabelsListServiceConnector serviceConnector = new LabelsListServiceConnector();

try
            {
                LabelOutputContract outputContract = serviceConnector.callService(
                    labelIdTextBox.Text,
                    labelLanguageComboBox.Text);

labelValueTextBox.Text = outputContract.value;
            }
            catch (Exception ex)
            {
                labelValueTextBox.Text = ex.Message;
            }
        }

private void getDataEntityInfoButton_Click(
            object sender,
            EventArgs e)
        {
            DataEntitiesListServiceConnector serviceConnector = new DataEntitiesListServiceConnector();

try
            {
                dataEntityInfoTextBox.Text = serviceConnector.callService(dataEntityNameTextBox.Text).ToString();
            }
            catch (Exception ex)
            {
                dataEntityInfoTextBox.Text = ex.Message;
            }
        }
    }
}

using System.Runtime.Serialization;

namespace LabelsAndDataEntitiesListServiceConnector
{
    [DataContract]
    public class LabelOutputContract
    {
        [DataMember]
        public string id {get; set;}

[DataMember]
        public string language {get; set;}

[DataMember]
        public string value {get; set;}

[DataMember(Name = "@odata.context")]
        public string context {get; set;}
    }
}

using System.Runtime.Serialization;

namespace LabelsAndDataEntitiesListServiceConnector
{
    [DataContract]
    class DataEntitiesOutputContract
    {
        [DataMember]
        public DataEntityOutputContract[] value {get; set;}

[DataMember(Name = "@odata.context")]
        public string context {get; set;}

public override string ToString()
        {
            string text = "";

foreach (DataEntityOutputContract outputContract in this.value)
            {
                text += string.Format(
                    "{0}\r\n",
                    outputContract.ToString());
            }

return text;
        }
    }
}

using System.Runtime.Serialization;

namespace LabelsAndDataEntitiesListServiceConnector
{
    [DataContract]
    class DataEntityOutputContract
    {
        [DataMember]
        public string name {get; set;}

[DataMember]
        public string publicEntityName {get; set;}

[DataMember]
        public string publicCollectionName {get; set;}

[DataMember]
        public string labelId {get; set;}

[DataMember]
        public bool dataServiceEnabled {get; set;}

[DataMember]
        public bool dataManagementEnabled {get; set;}

[DataMember]
        public string entityCategory {get; set;}

[DataMember]
        public bool isReadOnly  {get; set;}

[DataMember(Name = "@odata.context")]
        public string context {get; set;}

public override string ToString()
        {
            return string.Format(
                "Name: '{0}'; Public entity name: '{1}'; Public collection name: '{2}'; Label Id: '{3}'; Data service enabled: '{4}'; Data management enabled: '{5}'; Entity category: '{6}'; Read only: '{7}'\r\n",
                this.name,
                this.publicEntityName,
                this.publicCollectionName,
                this.labelId,
                this.dataServiceEnabled,
                this.dataManagementEnabled,
                this.entityCategory,
                this.isReadOnly);
        }
    }
}

using JsonRequestSender;

namespace LabelsAndDataEntitiesListServiceConnector
{
    class LabelsListServiceConnector
    {
        public LabelOutputContract callService(
            string labelId,
            string labelLanguage)
        {
            RequestSender_OAuth requestSender = new RequestSender_OAuth();

return requestSender.sendGETRequest<LabelOutputContract>(
                string.Format(
                    "metadata/Labels(Id='{0}',Language='{1}')",
                    labelId,
                    labelLanguage));
        }
    }
}

using System;
using JsonRequestSender;

namespace LabelsAndDataEntitiesListServiceConnector
{
    class DataEntitiesListServiceConnector
    {
        public Object callService(string dataEntityName)
        {
            Object outputContract = null;

if (dataEntityName == "")
            {
                outputContract = this.callServiceForAllDataEntities();
            }
            else
            {
                outputContract = this.callServiceForSingleDataEntity(dataEntityName);
            }

return outputContract;
        }

private DataEntitiesOutputContract callServiceForAllDataEntities()
        {
            RequestSender_OAuth requestSender = new RequestSender_OAuth();

return requestSender.sendGETRequest<DataEntitiesOutputContract>("metadata/DataEntities");
        }

private DataEntityOutputContract callServiceForSingleDataEntity(string dataEntityName)
        {
            RequestSender_OAuth requestSender = new RequestSender_OAuth();

return requestSender.sendGETRequest<DataEntityOutputContract>(
                string.Format(
                    "metadata/DataEntities(Name='{0}')",
                    dataEntityName));
        }
    }
}

Подготовил статью:

ДыкухаБорис Александрович

Senior Software Developer, OntargIT

Published On: 16 апреля, 2021 / Рубрики: ERP /

Развивайте бизнес с нами!

OntargIT является официальным партнером Microsoft по внедрению технологий Dynamics 365. С нашим опытом в различных отраслях, мы обеспечим индивидуальный подход и эффективные решения, которые будут идеально соответствовать потребностям вашей компании. Оставьте заявку сейчас, и наша команда экспертов поможет вам воспользоваться всеми преимуществами Dynamics 365.

Отправляя свои данные, я даю согласие на то, чтобы со мной связались

Развивайте бизнес с нами!

Отправляя свои данные, я даю согласие на то, чтобы со мной связались

Индустрии

Услуги

Партнеры

Описание

Вызов веб-сервиса D365O из Desktop приложения

Подготовительный этап

Вызов только считывающего данные веб-сервиса D365O из Desktop приложения

Подготовительный этап

Основной код

Пример

Подготовил статью:

Развивайте бизнес с нами!

Развивайте бизнес с нами!

Статус Microsoft Solutions Partner с бизнес-приложений, опыт внедрения и поддержки решений Microsoft Dynamics 365, Power Platform и AI.

Статус Microsoft Solutions Partner с бизнес-приложений, опыт внедрения и поддержки решений Microsoft Dynamics 365, Power Platform и AI.

Индустрии

Услуги

Партнеры

Руководство по подключению к REST Metadata веб-сервисам Microsoft Dynamics 365 for Operations

Описание

Вызов веб-сервиса D365O из Desktop приложения

Подготовительный этап

Вызов только считывающего данные веб-сервиса D365O из Desktop приложения

Подготовительный этап

Основной код

Пример

Подготовил статью:

Related Posts

Цифровая трансформация с Microsoft Dynamics 365

7 шагов для построения плана миграции на SaaS

Как достичь большей эффективности, а не объема данных в 2024 году

Развивайте бизнес с нами!

Развивайте бизнес с нами!

Статус Microsoft Solutions Partner с бизнес-приложений, опыт внедрения и поддержки решений Microsoft Dynamics 365, Power Platform и AI.

Статус Microsoft Solutions Partner с бизнес-приложений, опыт внедрения и поддержки решений Microsoft Dynamics 365, Power Platform и AI.