HTTP 头字段和通用 URI 参数
IBM® Business Process Manager REST 资源的 URI 支持某些 HTTP 头字段和通用 URI 参数。
所有 REST 资源都支持以下 HTTP 头字段。
| 字段名 | Description |
|---|---|
| Accept | 用于请求消息中,以指定响应消息中可接受的介质类型。 如果服务器无法以请求的内容类型予以响应,那么会返回 406
Not Acceptable HTTP 状态码。 如果您的请求适合于 BPD 相关资源,那么您可以使用等效的 URI 参数代替 HTTP 头字段。 |
| Accept-Encoding | 用于请求消息中,以限制响应消息中可接受的内容编码。 如果未指定值,那么缺省情况下响应消息的编码将设置为 identity(无编码)。 如果服务器无法以任何列出的内容编码予以响应,那么会返回 406 Not Acceptable HTTP 状态码。 如果您的请求适合于 BPD 相关资源,那么您可以使用等效的 URI 参数代替 HTTP 头字段。 |
| Accept-Language | 用于请求消息中,以发送响应消息可接受的语言列表。 例如,"Accept-Language: da, en-gb" 表示首选语言为丹麦语,但是也可以接受英式英语。 如果您的请求适合于 BPD 相关资源,那么您可以使用等效的 URI 参数代替 HTTP 头字段。 |
| Content-Encoding | 描述实体主体中使用的内容编码。 如果指定了不受支持的内容编码,那么会返回 415 Unsupported Media Type HTTP 状态码。 |
| Content-Language | 识别返回至接收方的响应消息的语言。 |
| Content-Type | 指示发送至接收方的实体主体的介质类型。 |
X-Method-Override |
指示通过当前请求传输的 HTTP 操作。 如果您的请求适合于 BPD 相关资源,那么您可以使用等效的 URI 参数代替 HTTP 头字段。 |
所有 IBM Business
Process Manager REST 资源都支持 federationMode 参数。
| URI 参数 | Description |
|---|---|
| federationMode | 对于由 BPD 相关资源公开的方法,此 URI 参数可用于指定响应数据的格式。 缺省情况下,响应消息的 root 结构中包含方法“status”属性和“data”属性,并带有特定于方法的响应数据。 如果指定了“federationMode=true”,那么禁止包装器结构,并且仅返回特定于方法的响应数据。 对于由 BPEL 相关资源和联合资源公开的方法,“federationMode=true”是唯一支持的值。 如果指定“federationMode=false”,那么会返回 400 Bad Request HTTP 状态码。 |
如果 REST 资源是 BPD 相关资源,那么您可以使用以下 URI 参数代替 HTTP 头字段。
如果 HTTP 头字段和等效的 URI 参数均可用,那么 URI 参数的值优先于 HTTP 头的值。
| URI 参数 | Description |
|---|---|
| accept | 用于请求消息中,以指定响应消息中可接受的介质类型。 此参数与 HTTP 字段 Accept 等效。 |
| accept-encoding | 用于请求消息中,以限制响应消息中可接受的内容编码。 此参数与 HTTP 字段 Accept-Encoding 等效。 |
| accept-language | 用于请求消息中,以发送响应消息可接受的语言列表。 此参数与 HTTP 字段 Accept-Language 等效。 |
| callback | JSONP 响应中使用的 JavaScript 回调函数的名称。 |
| parts | 用于请求消息中,以指定响应消息中要返回的一个或多个部分的列表。 使用垂直线 (|) 来分隔此列表中的项。 您还可以将 all 或 none 指定为 parts 参数的值;all 为缺省值。 例如:
|
x-method-override |
指示通过当前请求传输的 HTTP 操作。 这些参数等效于 HTTP 字段 X-Method-Override 和 X-HTTP-Method-Override。 |