贸易合作伙伴管理对象模型:REST 终结点

更新时间: 2015年8月

用于 TPM OM API 的 REST 终结点。

设置 BizTalk 服务(按照 http://go.microsoft.com/fwlink/p/?LinkId=299821 中的步骤)后,将为你的环境创建部署 URL。你可以使用该 URL 来访问用于 TPM OM API 的 REST 终结点。

本主题内容:

发现 TPM OM 实体

TPM OM API:在哪里执行哪些操作?

连接到 TPM OM API REST 终结点

使用 TPM OM API 创建 .NET 应用程序

TPM OM API 使用 $metadata 操作来使实体可发现。用于检索元数据的 URI 为:

<base_URL>/default/$PartnerManagement/$metadata

此处,<base_URL> 表示 BizTalk 服务环境的部署 URL。例如,如果部署 URL 为 https://mybiztalkservice.biztalk.windows.net,则用于检索元数据的 URL 应为 https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/$metadata

使用此 URL 可以检索所有有效的实体类型、实体属性、关联等。还可以通过点击浏览器中的终结点来查看元数据。

用户可以使用 TPM OM API 来编写应用程序,用于创建和管理企业到企业消息传送所需的实体。尽管对象模型的目标是与门户中提供的操作保持完全相同的功能,但是,仍有一些任务不能使用对象模型来完成。本部分说明可以使用对象模型执行的任务、可以使用 用于管理 BizTalk 服务的 PowerShell Cmdlet 执行的任务,以及可以使用 BizTalk Services 门户执行的任务。

 

  使用对象模型 使用 PowerShell Cmdlet 使用门户

创建合作伙伴

--- 创建配置文件

--- 添加标识

--- 上载证书

创建 X12 协议

--- 设置 Partner1 和 Partner2

--- 添加标识

--- 上载架构

--- 创建批

部署 X12 桥接s

--- 添加路由设置

--- 上载转换

创建 AS2 协议

--- 设置 Partner1 和 Partner2

部署 AS2 桥接s

--- 添加路由设置

创建 EDIFACT 协议

--- 设置 Partner1 和 Partner2

--- 添加标识

--- 上载架构

--- 创建批

部署 EDIFACT 桥接s

--- 添加路由设置

--- 上载转换

若要检索有关 TPM OM 实体的元数据,只需点击浏览器中的终结点。但是,如果想要对实体执行任何 CRUD 操作,则必须请求包含必需标头值以及消息负载的消息(如果需要)。

  • 必须包含用于调用 REST 终结点的必需标头。

    通过 TPM OM API,用户可以发送基于 OData 的 HTTP 请求,以创建 TPM OM 实体,并接收采用详细 JSON、atom+pub 或直接 XML 格式的响应。由于 TPM OM API 遵循 Azure 设计指导,因此每个客户端在连接到 TPM OM API REST 终结点时必须使用一组必需的 HTTP 标头,另外还可以使用一组可选的标头。以下部分介绍了可与 TPM OM API 结合使用的标头和 HTTP 谓词。

    有关必需和可选标头的列表,请参阅(本主题中的)“HTTP 请求”、“HTTP 响应”和“HTTP 谓词”部分。

  • 如果适用,必须包含具有正确值的必需属性名称。有关实体及其属性的列表,请参阅 TPM OM API:公开的实体和属性

每次调用 TPM OM API REST 终结点都必须包含一组必需的标头,如果需要,还可以包含一组可选标头。下表列出了必需的标头:

必需的标头

 

标头 类型

授权

WRAP 访问控制 令牌

该值必须包含 Microsoft Azure Active Directory 访问控制(也称为访问控制服务或 ACS)提供的访问令牌。若要使用 WRAP 协议检索 访问控制 令牌,请参阅 http://msdn.microsoft.com/library/windowsazure/hh674475.aspx

Host

String

指定目标资源的主机和端口号。

DataServiceVersion

小数

1.0

MaxDataServiceVersion

小数

3.0

x-ms-version

小数

1.0

If-Match

实体标记

指定仅当请求标头中的实体标记与对象的实体标记匹配时,才执行某个操作。

note备注
仅当执行更新或删除操作时,才需要此标头。

note备注
由于 TPM OM API 使用 OData 通过 REST API 公开其基础资产元数据存储库,因此应该在任何请求中包含 DataServiceVersionMaxDataServiceVersion 标头。如果不包含这些标头,TPM OM API 当前会假定使用的 DataServiceVersion 值为 1.0。

可选标头

 

标头 类型

日期

RFC 1123 日期

请求的时间戳

Accept

内容类型

响应的请求内容类型,例如:

  • application/xml

  • application/json;odata=verbose

  • application/atom+xml

Accept-Encoding

Gzip、deflate

GZIP 和 DEFLATE 编码(如果适用)。

Accept-Language

“en”、“es”等

指定响应的首选语言。

Accept-Charset

UTF-8 等字符集类型

默认值为 UTF-8

X-HTTP-Method

HTTP 方法

允许不支持 HTTP 方法(例如 PUT 或 DELETE)的客户端或防火墙使用这些通过 GET 调用隧道化的方法。

Content-Type

内容类型

POST 和 PUT 请求中请求正文的内容类型。

下面是可以根据你请求的资源以及要执行的操作返回给你的一组标头。

 

标头 类型

日期

RFC 1123 日期

处理请求的日期

Content-Type

多种多样

响应正文的内容类型

Content-Encoding

多种多样

Gzip 或 deflate(如果适用)

Cache-Control

-

指定从服务器到客户端的缓存机制是否可以缓存对象。

Content-Length

内容类型

响应正文的长度

Server

-

服务器名称。

X-Content-Type-Options

内容类型

唯一的可能值“nonsniff”会阻止浏览器针对声明的 content-type 中的响应进行 MIME 探查。

下面是 TPM OM API 支持的可在发出 HTTP 请求时使用的 HTTP 谓词的完整列表:

 

谓词 说明

GET

返回实体的当前值

POST

基于提供的数据创建对象(或提交命令)

PUT

替换对象,或创建新对象(如果适用)

删除

删除对象

MERGE

使用指定的属性更改更新现有对象。

由于 TPM OM API 基于 OData 协议,因此你可以使用 WCF 数据服务来构建可对实体执行 CRUD 操作的 .NET 应用程序。有关如何使用 TPM OM API 创建 .NET 应用程序的详细信息,请参阅使用 TPM OM REST API 创建 .NET 应用程序

另请参阅

显示: