从 CRM Web api 中的 OData 查询获取选项集文本答案

【问题标题】：Get optionset text from OData query in CRM web api从 CRM Web api 中的 OData 查询获取选项集文本
【发布时间】：2017-11-09 09:24:49
【问题描述】：

https://example.com/crm/api/data/v8.2/accounts?$select=custom_optionset

上述查询选择 CRM 中选项集字段中的所有值。返回数据如下所示：

{
    {
        "@odata.etag":"W/\"112607639\"","custom_optionset":285960000,"accountid":"a08f0bd1-e2c4-e111-8c9a-00155d0aa573"
    },
    {
        "@odata.etag":"W/\"112615384\"","custom_optionset":285960010,"accountid":"a18f0bd1-e2c4-e111-8c9a-00155d0aa573"
    }
}

我不想要选项集的值。我想要相关的文本标签。我怎么得到这个？

【问题讨论】：

标签： javascript odata dynamics-crm dynamics-crm-2016 dynamics-crm-webapi

【解决方案1】：

要使用 webapi 获取选项集文本，请在请求标头中使用下面的 sn-p。

req.setRequestHeader("Prefer", "odata.include-annotations=OData.Community.Display.V1.FormattedValue");

这将返回类似于查找 FormattedValue 的选项列表文本。

整个代码示例：

function retrieveEntity(entityName, Id, columnSet) {
    var serverURL = Xrm.Page.context.getClientUrl();
    var Query = entityName + "(" + Id + ")" + columnSet;
    var req = new XMLHttpRequest();
    req.open("GET", serverURL + "/api/data/v8.2/" + Query, true);
    req.setRequestHeader("Accept", "application/json");
    req.setRequestHeader("Content-Type", "application/json; charset=utf-8");
    req.setRequestHeader("OData-MaxVersion", "4.0");
    req.setRequestHeader("OData-Version", "4.0");
    req.setRequestHeader("Prefer", "odata.include-annotations=OData.Community.Display.V1.FormattedValue");
    req.onreadystatechange = function() {
        if (this.readyState == 4 /* complete */ ) {
            req.onreadystatechange = null;
            if (this.status == 200) {
                var data = JSON.parse(this.response);
                if (data != null {
                        alert(data["_primarycontactid_value@OData.Community.Display.V1.FormattedValue"]); //for lookup text
                        alert(data["paymenttermscode@OData.Community.Display.V1.FormattedValue"]); //for optionset text
                    }
                } else {
                    var error = JSON.parse(this.response).error;
                    alert(error.message);
                }
            }
        };
        req.send();
    }

Reference.

【讨论】：

【解决方案2】：

如果您使用 Jason Lattimer 的 CRM RESTBuilder 解决方案，它会创建一个类似这样的查询，其中包括标题 req.setRequestHeader("Prefer", "odata.include-annotations=\"*\"");：

var req = new XMLHttpRequest();
req.open("GET", Xrm.Page.context.getClientUrl() + "/api/data/v8.2/accounts(674D7FDC-47AE-E711-8108-5065F38A3BA1)?$select=accountid,industrycode", true);
req.setRequestHeader("OData-MaxVersion", "4.0");
req.setRequestHeader("OData-Version", "4.0");
req.setRequestHeader("Accept", "application/json");
req.setRequestHeader("Content-Type", "application/json; charset=utf-8");
req.setRequestHeader("Prefer", "odata.include-annotations=\"*\"");
req.onreadystatechange = function() {
    if (this.readyState === 4) {
        req.onreadystatechange = null;
        if (this.status === 200) {
            var result = JSON.parse(this.response);
            var accountid = result["accountid"];
            var industrycode = result["industrycode"];
            var industrycode_formatted = result["industrycode@OData.Community.Display.V1.FormattedValue"];
        } else {
            Xrm.Utility.alertDialog(this.statusText);
        }
    }
};
req.send();

结果包括选项集标签：

{
@odata.context:"https://myorg.crm.dynamics.com/api/data/v8.2/$metadata#accounts(accountid,industrycode)/$entity",
@odata.etag:"W/"1959756"",
accountid:"674d7fdc-47ae-e711-8108-5065f38a3ba1",
industrycode@OData.Community.Display.V1.FormattedValue:"Accounting",
industrycode:1
}

【讨论】：

这个有官方参考吗？

【解决方案3】：

我发现使用XrmQuery 调用 CRM 中的 Web API 是最简单的方法（完全披露：我为开发此功能的公司工作）。无需手动修改标头和 XMLHttpRequest，您可以在自己的 CRM 中获得对实体和字段的完全强类型支持。

例如，检索特定帐户并选择 industrycode 字段如下所示：

    XrmQuery.retrieve(a => a.accounts, "5B86C6EB-DE6D-E611-80DF-C4346BADF080")
        .select(a => [a.industrycode])
        .includeFormattedValues()
        .execute(a => {
            console.log("Industry is: " + a.industrycode_formatted);
        });

添加.includeFormattedValues() 会自动让您访问一个名为industrycode_formatted 的字段。

对于具有以下选项集值的帐户：

上面的代码会返回：

行业为：广播印刷出版

【讨论】：