Czy ta strona była przydatna?
Twoja opinia na temat zawartości jest dla nas bardzo ważna. Powiedz nam co myślisz.
Dodatkowe opinie?
Pozostało znaków: 1500
Baza Wiedzy MSDN
Ta zawartość nie jest dostępna w wymaganym języku. Wersja w języku angielskim znajduje się tutaj.

Trading Partner Management Object Model: REST Endpoint

Updated: August 31, 2015

REST endpoint used for the TPM OM APIs.

After you have provisioned your BizTalk Service (steps at, a deployment URL is created for your environment. You can use that URL to arrive at the REST endpoint used for the TPM OM APIs.

In this topic:

Discovering the TPM OM Entities

TPM OM API: What to do Where?

Connecting to the TPM OM API REST Endpoint

Creating .NET Applications Using the TPM OM API

TPM OM API uses the $metadata operation to make the entities discoverable. The URI to retrieve the metadata is:


Here, <base_URL> refers to the deployment URL of the BizTalk Services environment. For example, if the deployment URL is, the URL to retrieve the metadata should be$PartnerManagement/$metadata.

This URL allows you to retrieve all valid entity types, entity properties, associations, and so on. You can also view the metadata by hitting the endpoint in a browser.

The TPM OM API enables users to write applications to create and manage the entities required in business-to-business messaging. While the object model aims to have complete parity with the operations available through the portal, there are some tasks that are done outside the use of the object model. This section provides information on the tasks that can be performed using the object model, the tasks that can be performed using the PowerShell CmdLets to manage the BizTalk Service, and the tasks that can be performed using the BizTalk Services Portal.


  Using the Object Model Using the PowerShell Cmdlets Using the Portal

Create Partner

--- Create Profile

--- Add Identities

--- Upload Certificate

Create X12 Agreement

--- Set Partner1, Partner2

--- Add Identities

--- Upload Schema

--- Create Batch

Deploy X12 bridges

--- Add Route Settings

--- Upload Transform

Create AS2 Agreement

--- Set Partner1, Partner2

Deploy AS2 bridges

--- Add Route Settings

Create EDIFACT Agreement

--- Set Partner1, Partner2

--- Add Identities

--- Upload Schema

--- Create Batch

Deploy EDIFACT bridges

--- Add Route Settings

--- Upload Transform

To retrieve the metadata about TPM OM entities, you can simply hit the endpoint in a browser. However, if you want to perform any CRUD operations on the entities, you must request messages that include the required header values as well as message payload (if required).

  • You must include the required headers for invoking the REST endpoint.

    TPM OM API enables users to send OData-based HTTP requests to create TPM OM entities and receive responses in verbose JSON, atom+pub, or straight XML. Because the TPM OM API conforms to Azure design guidelines, there is a set of required HTTP headers that each client must use when connecting to the TPM OM API REST endpoint, as well as a set of optional headers that can be used. The following sections describe the headers and HTTP verbs you can use with the TPM OM API.

    For a list of required and optional headers, see the HTTP Request, HTTP Response, and HTTP Verbs sections (in this topic).

  • Wherever applicable, you must include the required property names with appropriate values. For a list of entities and their properties, see TPM OM API: Exposed Entities and Properties.

Every call made to the TPM OM API REST endpoints must include a set of required headers and also a set of optional headers, if you want to. The following table lists the required headers:

Required Headers


Header Type Value


WRAP Access Control tokens

The value must include the access token provided by the Microsoft Azure Active Directory Access Control (also known as Access Control Service or ACS). To retrieve an Access Control token using the WRAP protocol, see



Specifies the host and the port number of the resource being targeted.











Entity tag

Specifies that an operation is performed only if the entity tag specified in the request header matches with the entity tag of the object.

This header is required only when performing update or delete operations.

Because the TPM OM API uses OData to expose its underlying asset metadata repository through REST APIs, the DataServiceVersion and MaxDataServiceVersion headers should be included in any request. If they are not included, then currently the TPM OM API assumes the DataServiceVersion value in use is 1.0.

Optional Headers


Header Type Value


RFC 1123 date

Timestamp of the request


Content type

The requested content type for the response such as the following:

  • application/xml

  • application/json;odata=verbose

  • application/atom+xml


Gzip, deflate

GZIP and DEFLATE encoding, when applicable.


"en", "es", and so on

Specifies the preferred language of the response.


Charset type like UTF-8

Default is UTF-8


HTTP Method

Allows clients or firewalls that do not support HTTP methods like PUT or DELETE to use these methods, tunneled via a GET call.


Content type

Content type of the request body in POST and PUT requests.

The following is a set of headers that may be returned to you depending on the resource you were requesting and the action you intended to perform.


Header Type Value


RFC 1123 date

The date that the request was processed



The content type of the response body



Gzip or deflate, as appropriate



Specifies whether caching mechanisms, from server to client, may cache the object.


Content type

The length of the response body



A server name.


Content type

The only possible value “nonsniff” prevents browsers from MIME-sniffing a response from the declared content-type.

The following is a complete list of HTTP verbs that are supported by the TPM OM API and can be used when making HTTP requests:


VERB Description


Returns the current value for an entity


Creates an object (or submits a command) based on the provided data


Replaces an object, or creates a new object (when applicable)


Deletes an object


Updates an existing object with named property changes.

Because the TPM OM API is based on the OData protocol, you can use the WCF Data Services to build .NET applications that perform CRUD operations on the entities. For more information on how create .NET applications using the TPM OM API, see Creating .NET Applications Using TPM OM REST API.

See Also

© 2015 Microsoft