从 ServiceNow Rest API 访问 C# 中的 JSON 密钥答案

【问题标题】：Access JSON keys in C# from ServiceNow Rest API从 ServiceNow Rest API 访问 C# 中的 JSON 密钥
【发布时间】：2020-12-21 18:05:12
【问题描述】：

我正在调用 ServiceNow Incidents 表并撤回一个这样的事件。 https://mydevInstance.service-now.com/api/now/v1/table/incident?sysparm_limit=1

var client = new RestClient("https://mydevInstance.service-now.com/api/now/v1/table/incident?sysparm_limit=1");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic myAuthKey");
IRestResponse response = client.Execute(request);

它在 RESTSharp 中返回的 JSON 如下所示。

{
    "result": [
        {
            "parent": "",
            "made_sla": "true",
            "caused_by": "",
            "watch_list": "",
            "upon_reject": "cancel",
            "resolved_by": {
                "link": "https://mydevInstance.service-now.com/api/now/v1/table/sys_user/5137153cc611227c000bbd1bd8cd2007",
                "value": "5137153cc611227c000bbd1bd8cd2007"
            },
            "approval_history": "",
            "number": "INC0000060"
        }
    ]
}

如何在 result 下创建一个包含所有键的 C# 列表或数组？我无法使用 JSON.Net 序列化对象，因为随着时间的推移会添加其他键。

【问题讨论】：

根据您使用的 Visual Studio 版本，您应该有一个“粘贴”选项，允许您将一些 JSON（或 XML）“粘贴”为 C# 类。此功能也可能在“选择性粘贴”下...检查您的“编辑”菜单
这在这种情况下不起作用，因为当向事件添加额外的列时类会发生变化，这会导致向 JSON 添加额外的键。我需要钥匙列表。
当服务中的表现在更改时，您需要对类进行适当的更改。
我不想/不需要上课。我只需要 JSON 中所有键的列表、字符串或数组。

标签： c# json servicenow servicenow-rest-api

【解决方案1】：

您需要获取 JSON 内容的示例，然后使用我描述的“选择性粘贴”选项创建一个 C# 类。

然后您可以使用JsonConvert.DeserializeObject<T>（在 Newtonsoft 的 nuget 包中）在 C# 对象实例中反序列化您的 Web 服务响应。

以下是我在未更改 JSON 对象的情况下生成的 C# 类：

public class Rootobject
{
    public Result[] result { get; set; }
}

public class Result
{ 
    public string parent { get; set; }
    public string made_sla { get; set; }
    public string caused_by { get; set; }
    public string watch_list { get; set; }
    public string upon_reject { get; set; }
    public Resolved_By resolved_by { get; set; }
    public string approval_history { get; set; }
    public string number { get; set; }
}

public class Resolved_By
{
    public string link { get; set; }
    public string value { get; set; }
}

你像这样使用这种类型：

var json = "t-b-d"; // From Web Service call
Rootobject response = JsonConvert.DeserializeObject<Rootobject>(json);
// use the response object.

** 已更新 **

如果你需要更灵活的模型，所有的JSON都会反序列化成Dictionary<string, string>，但是我发现模型一致的情况下，序列化/反序列化结果更可靠

var response = JsonConvert.DeserializeObject<Dictionary<string,string>>(json);

【讨论】：

这在这种情况下不起作用，因为当向事件添加额外的列时类会发生变化，这会导致向 JSON 添加额外的键。我需要钥匙列表。
键列表将取决于您的 service now 表。通常我会在 Chrome 中访问该站点以获取所有字段并基于该字段创建一个类
每个使用它的公司的列表都会有所不同。我需要以编程方式的键列表。
@Glenn 仍然无法正常工作，因为它会抛出错误解析值时遇到意外字符：[。路径“结果”，第 1 行，位置 11。

【解决方案2】：

这是使用 System.Text.Json 的工作原理

var incidentFields = new List<string>();

var doc = JsonDocument.Parse(json);
foreach (var o in doc.RootElement.GetProperty("result").EnumerateArray())
{
    foreach (var p in o.EnumerateObject())
    {
        incidentFields.Add(p.Name.ToString());
    }
}

【讨论】：

【解决方案3】：

我创建了一个默认处理该问题的库。（您也可以添加自定义类型）

https://emersonbottero.github.io/ServiceNow.Core/

【讨论】：