このページは役に立ちましたか。
このページのコンテンツについての ご意見をお待ちしております
その他にご意見はありますか。
残り 1500 文字
エクスポート (0) 印刷
すべて展開

取引先管理オブジェクト モデル:REST エンドポイント

更新日: 2015年5月

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 コマンドレットを使用して実行できるタスク、および BizTalk サービス ポータルを使用して実行できるタスクについて説明します。

 

  オブジェクト モデルの使用 PowerShell コマンドレットの使用 ポータルの使用

パートナーの作成

--- プロファイルの作成

--- ID を追加する

--- 証明書のアップロード

X12 アグリーメントの作成

--- Partner1、Partner2 を設定する

--- ID を追加する

--- スキーマのアップロード

--- バッチの作成

X12 ブリッジのデプロイ

--- ルートの設定を追加する

--- 変換のアップロード

AS2 アグリーメントの作成

--- Partner1、Partner2 を設定する

AS2 ブリッジのデプロイ

--- ルートの設定を追加する

EDIFACT アグリーメントの作成

--- Partner1、Partner2 を設定する

--- ID を追加する

--- スキーマのアップロード

--- バッチの作成

EDIFACT ブリッジのデプロイ

--- ルートの設定を追加する

--- 変換のアップロード

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

文字列

対象であるリソースのホストとポート番号を指定します。

DataServiceVersion

小数点

1.0

MaxDataServiceVersion

小数点

3.0

x-ms-version

小数点

1.0

If-Match

エンティティ タグ

要求ヘッダーで指定されているエンティティ タグが、オブジェクトのエンティティ タグと一致する場合にのみ操作を実行することを指定します。

noteメモ
このヘッダーが必須であるのは、更新または削除操作を実行する場合のみです。

noteメモ
TPM OM API は OData を使用して REST API を介して基になっているアセット メタデータ リポジトリを公開するため、DataServiceVersion および MaxDataServiceVersion ヘッダーをすべての要求に含める必要があります。これらのヘッダーが含まれていない場合、現在の 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 メソッド

PUT や DELETE などの HTTP メソッドをサポートしないクライアントやファイアウォールが、GET 呼び出しを通じてトンネリングされたこれらのメソッドを使用できるようにします。

Content-Type

コンテンツの種類

POST および PUT 要求の要求本文のコンテンツの種類。

以下は、要求したリソースと、実行を意図した操作に応じて、返される可能性がある一連のヘッダーです。

 

ヘッダー

日付

RFC 1123 の日付

要求が処理された日付

Content-Type

異なる

応答本文のコンテンツの種類

Content-Encoding

異なる

Gzip または deflate (該当する場合)

Cache-Control

-

サーバーからクライアントへのキャッシュ メカニズムでオブジェクトをキャッシュできるかどうかを指定します。

Content-Length

コンテンツの種類

応答本文の長さ

サーバー

-

サーバー名。

X-Content-Type-Options

コンテンツの種類

可能な唯一の値 "nonsniff" により、宣言されているコンテンツの種類からの応答をブラウザーが MIME スニッフィングしないようにします。

以下は、TPM OM API によりサポートされ、HTTP 要求を行う際に使用できる HTTP 動詞の完全な一覧です。

 

動詞 説明

GET

エンティティの現在の値を返します。

POST

指定されたデータに基づいてオブジェクトを作成する (またはコマンドを送信する)

PUT

オブジェクトを置き換える、または新しいオブジェクトを作成する (該当する場合)

削除

オブジェクトを削除する

MERGE

名前付きのプロパティの変更で既存のオブジェクトを更新する。

TPM OM API は、OData プロトコルに基づいているため、エンティティに対して CRUD 操作を実行する .NET アプリケーションを、WCF Data Services を使用して作成できます。TPM OM API を使用して .NET アプリケーションを作成する方法の詳細については、「TPM OM REST API を使用した .NET アプリケーションの作成」を参照してください。

関連項目

表示:
© 2015 Microsoft