retrieveRecord (справочник по клиентскому API)

Извлекает запись таблицы.

Синтаксис

Xrm.WebApi.retrieveRecord(entityLogicalName, id, options).then(successCallback, errorCallback);

Параметры

Options

Чтобы управлять возвращаемыми данными, используйте $select$expand параметры системного запроса OData.

$select Используйте параметр системного запроса, чтобы ограничить возвращаемые свойства, включив разделенный запятыми список имен свойств. Выбор определенных свойств является важной рекомендацией по повышению производительности. Если свойства не указаны с помощью $select, возвращаются все свойства.

Используйте параметр системного $expand запроса для управления возвращаемыми данными из связанных таблиц. Если вы просто включите имя свойства навигации, вы получите все свойства для связанных записей. Свойства, возвращаемые для связанных записей, можно ограничить с помощью параметра системного $select запроса в скобках после имени свойства навигации. Используйте его как для однозначных свойств, так и для свойств навигации с значением коллекции . В автономном режиме поддерживается только вложенный $select параметр внутри $expand.

Параметры запроса указываются, начиная с ?. Вы также можете указать несколько параметров запроса, разделив & параметры запроса. Рассмотрим пример.

?$select=name&$expand=primarycontactid($select=contactid,fullname)

Ознакомьтесь с примерами , чтобы узнать, как определить параметр параметров для различных сценариев извлечения.

Возвращаемое значение

При успешном выполнении возвращает обещание, содержащее объект JSON с извлеченными столбцами и их значениями. Если запрошенная запись не существует, возвращает ошибку.

Примеры

См. следующие примеры.

• Базовый извлекаемая
• Получение связанных таблиц для экземпляра таблицы путем расширения свойств навигации с одним значением

Базовый извлекаемая

Извлекает имя и доход записи учетной записи с идентификатором записи = 5531d753-95af-e711-a94e-000d3a1e605.

Xrm.WebApi.retrieveRecord("account", "a8a19cdd-88df-e311-b8e5-6c3be5a8b200", "?$select=name,revenue").then(
    function success(result) {
        console.log("Retrieved values: Name: " + result.name + ", Revenue: " + result.revenue);
        // perform operations on record retrieval
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

В приведенном выше примере отображается следующий текст в консоли; Другие значения могут отображаться в зависимости от данных:

Retrieved values: Name: Sample Account, Revenue: 5000000

Получение связанных таблиц для экземпляра таблицы путем расширения свойств навигации с одним значением

В следующем примере показано, как получить контакт для записи учетной записи с идентификатором записи = a8a19cd-88df-e311-b8e5-6c3be5a8b200. Для связанной записи контакта мы извлекаем только свойства contactid и fullname .

Xrm.WebApi.retrieveRecord("account", "a8a19cdd-88df-e311-b8e5-6c3be5a8b200", "?$select=name&$expand=primarycontactid($select=contactid,fullname)").then(
    function success(result) {
        console.log("Retrieved values: Name: " + result.name + ", Primary Contact ID: " + result.primarycontactid.contactid +
                ", Primary Contact Name: " + result.primarycontactid.fullname);
        // perform operations on record retrieval
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

В приведенном выше примере отображается следующий текст в консоли; Другие значения могут отображаться в зависимости от данных:

Retrieved values: Name: Adventure Works, Primary Contact ID: 49a0e5b9-88df-e311-b8e5-6c3be5a8b200, Primary Contact Name: Adrian Dumitrascu

Связанные статьи

Xrm.WebApi.retrieveMultipleRecords
Xrm.WebApi