OData V4

ABAP RESTful 应用程序编程模型 › 学习 › 业务对象 › 消息 › OData 中的消息 › OData V4

本主题介绍如何在 OData V4 中对消息进行建模。

OData V4 中的消息

OData V4 中的绑定消息建模为名为 sap__messages 的复杂类型,未绑定消息(分配到 %other 的消息)通过响应标头 进行传输。

未绑定消息

未绑定消息通过具有以下结构的响应标头属性 sap__messages 进行传输:

  • 消息代码:机器可读代码

  • 消息文本:在消息类中定义的消息文本。

  • 数字严重性:数字严重性对应于使用 语句 SEVERITY = IF_ABAP_BEHV_MESSAGE=>SEVERITY-SEVERITY 在 %msg 组件中定义的严重性。映射如下所示:

    • 成功:1(成功 - 无需操作)

    • 信息:2(信息 - 无需操作)

    • 警告:3(警告 - 可能需要操作)

    • 错误:4(错误 - 需要操作)

  • 可选 longtextUrl:如果在消息类中使用长文本定义消息,则包含长文本的 URL。

  • 可选目标:目标将详细消息与 OData 资源或相关 OData 资源相关。验证产生的错误需要此链接,以在消息和受影响字段之间建立可视链接。可以定义一个或多个目标。

  • 消息目标:使用 %element 组件定义消息目标。消息可以有一个或多个目标。如果定义了多个目标,则会将其建模为 additionalTargets 数组。在这种情况下,此数组中的每个项目都是与目标具有相同语法的字符串。

sap-messages 标头的内容使用 JSON,并根据 HTTP 标头字段的规则进行编码。

sap-messages: [
  {
    "code": "DMO_BUSINESSOBJECT_MESSAGES/002",
    "message": "Message text as defined in message class",
    "numericSeverity": 2,
    "longtextUrl": "..."
    "target": "to_Target"
  }
]

代码由消息源自的消息类和消息标识符组成。此消息示例具有严重性信息 (2),并使用长文本定义,目标为 _Target。

请求成功(http 响应 2xx):绑定消息

如果请求(http 响应 2xx)成功,则绑定消息包含在显式建模的集合值消息容器属性中,以避免标头大小问题。此复杂类型具有以下属性:

  • 消息代码:机器可读代码

  • 消息文本:在消息类中定义的消息文本。

  • 消息目标:使用 %element 组件定义消息目标。消息可以有一个或多个目标。如果定义了多个目标,则会将其建模为 additionalTargets 数组。在这种情况下,此数组中的每个项目都是与目标具有相同语法的字符串。

  • 数字严重性:数字严重性对应于使用 语句 SEVERITY = IF_ABAP_BEHV_MESSAGE=>SEVERITY-SEVERITY 在 %msg 组件中定义的严重性。映射如下所示:

    • 成功:1(成功 - 无需操作)

    • 信息:2(信息 - 无需操作)

    • 警告:3(警告 - 可能需要操作)

    • 错误:4(错误 - 需要操作)

  • 转换标识:可选转换标识 - 在从一个后端状态转换到另一个后端状态(例如,在执行操作期间)期间转换消息。转换消息标记为 transition:true,状态消息标记为 transition:false。

  • 可选 longtextUrl:如果在消息类中使用长文本定义消息,则包含长文本的 URL。

sap__messages 的结构如下:

sap-messages: {
  "code": "DMO_BUSINESSOBJECT_MESSAGES/002",
  "message": "Message text as defined in message class",
  "target": "to_Target"
  "numericSeverity": "3",
  "transition": true,
  "longtextUrl": "..."
}

代码由消息源自的消息类和消息标识符组成。此消息示例的严重性为警告 (3),并定义为具有目标 _Target 的转换消息。此外,已使用长文本定义消息。

不成功(Http 响应代码 4xx [客户端错误]/ 5xx [服务器错误]):绑定消息

如果请求(http 响应 2xx)代码 4xx [客户端错误]/ 5xx [服务器错误]),则错误响应具有以下结构:

  • 消息代码:机器可读代码

  • 消息文本:在消息类中定义的消息文本。

  • 消息目标:使用 %element 组件定义消息目标。消息可以有一个或多个目标。如果定义了多个目标,则会将其建模为 additionalTargets 数组。在这种情况下,此数组中的每个项目都是与目标具有相同语法的字符串。

  • 详细信息:零个或更多详细信息,每个详细信息都有代码、消息和目标。

错误响应通过实例注释进行扩展,以将严重性添加到详细消息、additionalTargets 数组或长文本 URL:

{
  "error": {
    "code": "UF0",
    "message": " "Message text as defined in message class"",
    "target": "",
    "@Common.additionalTargets": [],
    "@Common.longtextUrl": "...",
    "details": [
      {
        "code": "UF1",
        "message": "Message text as defined in message class",
        "target": "$_Target",
        "@Common.additionalTargets": [],
        "@Common.numericSeverity": 4,
        "@Common.longtextUrl": "..."
      },
	 ...
	]
  }
}

代码由消息源自的消息类和消息标识符组成。没有为此消息定义目标。第二个示例使用长文本、目标 _Target 和严重性 4(错误)定义。

来源:SAP Help Portal · 2025 FPS02 (Oct 2026) · 中文为 SAP 官方机器翻译

← OData V2 · 查询 →