---
title: "Руководство по подключению к REST Metadata веб-сервисам Microsoft Dynamics 365 for Operations"
canonical: https://ontargit.com/kz/rukovodtvo-po-podklyucheniyu-k-rest-metadata/
date: 2021-04-16 18:27:22
description: "Руководство по подключению к REST Metadata веб-сервисам Microsoft Dynamics 365 for Operations, которые позволяют просмотреть метаданные."
keywords: "REST Metadata"
categories: [ERP]
---

# Описание

Клиентские приложения имеют возможность получать доступ к развернутым в 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»](https://ontargit.com/registratsia-prilozheniya-v-azure/).**

- __

3. Добавить ссылку на проект JsonRequestSender, который описан в статье **[«Создание вспомогательных классов JsonRequestSender для отправки запросов JSON».](https://ontargit.com/sozdanie-jsonrequestsender/)**

- __

4. Добавить ссылку на пакет System.Runtime.Serialization, как описано в статье **[«Добавление пакета System.Runtime.Serialization». ](https://ontargit.com/dobavlenie-paketa-system-runtime-serialization/)**

# Основной код

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

Copy to Clipboard
Syntax HighlighterRequestSender_OAuth jsonRequestSender = new RequestSender_OAuth();

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

Copy to Clipboard
Syntax HighlighterLabelOutputContract labelOutputContract = requestSender.sendGETRequest(

 string.Format(

 “metadata/Labels(Id='{0}’,Language='{1}’)”,

 labelId,

 labelLanguage));

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

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

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

# Пример

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

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

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

_

Copy to Clipboard
Syntax Highlighterusing 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(

 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(“metadata/DataEntities”);

 }

 private DataEntityOutputContract callServiceForSingleDataEntity(string dataEntityName)

 {

 RequestSender_OAuth requestSender = new RequestSender_OAuth();

 return requestSender.sendGETRequest(

 string.Format(

 “metadata/DataEntities(Name='{0}’)”,

 dataEntityName));

 }

 }

}

_

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

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

Senior Software Developer, OntargIT

[](https://www.linkedin.com/in/borys-dykukha-59a7a2a9)