Trading Partner Management Object Model: REST Endpoint

REST endpoint used for the TPM OM APIs.

After you have provisioned your BizTalk Service (steps at https://go.microsoft.com/fwlink/p/?LinkId=299821), 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

Discovering the TPM OM Entities

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

<base_URL>/default/$PartnerManagement/$metadata

Here, <base_URL> refers to the deployment URL of the BizTalk Services environment. For example, if the deployment URL is https://mybiztalkservice.biztalk.windows.net, the URL to retrieve the metadata should be https://mybiztalkservice.biztalk.windows.net/default/$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.

TPM OM API: What to do Where?

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.

Connecting to the TPM OM API REST Endpoint

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.

Supported HTTP Request Headers

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

Optional Headers

Supported HTTP Response Headers

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.

Supported HTTP Verbs

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:

Creating .NET Applications Using the TPM OM API

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

Trading Partner Management Object Model (TPM OM): API Reference