17370845950

本文档旨在指导开发者如何使用 Microsoft Graph API 正确地为 SharePoint 文件添加元数据。避免常见的 "invalidRequest" 错误，理解 `FieldValueSet` 的使用方式，并提供代码示例，助你轻松完成元数据更新。核心在于仅发送需要更新的元数据字段，而非整个 `FieldValueSet`。

在使用 Microsoft Graph API 为 SharePoint 文件添加元数据时，开发者经常会遇到 "invalidRequest" 错误。这通常是由于不正确地使用了 FieldValueSet 对象导致的。 本文将详细介绍如何避免此类错误，并提供正确的代码示例。

问题根源：

错误通常源于尝试使用 PUT 或 PATCH 方法更新 SharePoint 文件的 listItem/fields 时，发送了包含只读字段（如 id）的完整 FieldValueSet 对象。 SharePoint API 期望仅接收需要更新的字段，而不是整个对象。

解决方案：仅发送需要更新的字段

正确的做法是，创建一个新的 FieldValueSet 对象，仅包含需要更新的元数据字段。 不要包含任何只读字段或不需要更改的字段。

代码示例 (Groovy):

以下代码示例展示了如何正确地为 SharePoint 文件添加元数据：

import com.microsoft.graph.models.FieldValueSet
import com.google.gson.JsonPrimitive

private void addMetadataToFile(PlatformOidcUser platformOidcUser, String itemPath, Map metaData) {
    // 创建一个新的 FieldValueSet 对象，仅包含需要更新的字段
    FieldValueSet fieldValueSet = new FieldValueSet()
    metaData.each { data ->
        fieldValueSet.additionalDataManager().put(data.key, new JsonPrimitive(data.value))
    }

    // 使用 PATCH 方法更新 SharePoint 文件的元数据
    graphServiceClient.groups(platformOidcUser.defaultGroupId)
            .drive()
            .root()
            .itemWithPath(itemPath)
            .listItem()
            .fields()
            .buildRequest()
            .patch(fieldValueSet)
}

代码解释：

1. 创建新的 FieldValueSet 对象： FieldValueSet fieldValueSet = new FieldValueSet() 创建了一个空的 FieldValueSet 对象。
2. 添加需要更新的字段： metaData.each { data -> ... } 遍历 metaData Map，并将需要更新的字段添加到 fieldValueSet 中。 关键是只添加需要更新的字段，不要包含任何只读字段或不需要更改的字段。
3. 使用 PATCH 方法： 使用 patch(fieldValueSet) 方法更新 SharePoint 文件的元数据。 PATCH 方法仅更新指定的字段，而不会影响其他字段。

注意事项：

• 使用 PATCH 而不是 PUT： PATCH 方法是更新部分资源的正确方法。 PUT 方法会替换整个资源，因此不适合更新 SharePoint 文件的元数据。
• 确保字段名称正确： metaData Map 中的键必须与 SharePoint 中定义的列的内部名称完全匹配。 否则，更新将失败。
• 处理数据类型： 根据 SharePoint 中定义的列的数据类型，正确地格式化 metaData Map 中的值。 例如，如果列是数字类型，则需要将值转换为数字。

总结：

要成功地为 SharePoint 文件添加元数据，请记住以下几点：

1. 创建一个新的 FieldValueSet 对象，仅包含需要更新的字段。
2. 使用 PATCH 方法更新 SharePoint 文件的元数据。
3. 确保字段名称和数据类型正确。

遵循这些步骤，你就可以避免 "invalidRequest" 错误，并轻松地为 SharePoint 文件添加元数据。