プラグイン登録ツールを使用してカスタム API を作成する

プラグイン登録ツール (PRT) には、カスタム API を作成するためのデザイナーが含まれています。 PRT は、NuGet からダウンロード可能な開発者ツールの一部である Windows クライアント アプリケーションです。 これらのツールのダウンロードについては Dataverse 開発ツール を参照してください。

プラグイン登録ツールを使用して接続する

1. プラグイン登録ツールをダウンロードした後、PluginRegistration.exe をクリックして開きます。

2. 新しい接続の作成をクリックして、使用するインスタンスに接続します。

3. Office 365 が選択されていることを確認します。

4. 現在使用しているアカウント以外の Microsoft アカウントを使用して接続している場合は、詳細の表示をクリックし、クレデンシャルを入力します。 それ以外の場合は、現在のユーザーとしてサインインを選択したままにしておきます。

5. Microsoft アカウントが複数の環境へのアクセスを提供する場合は、利用可能な組織の一覧を表示するを選択します。

   

6. ログインをクリックします。

7. 使用可能な組織の一覧を表示するを選択した場合、接続する組織を選択し、ログインをクリックします。

8. 接続すると、既存の登録済みプラグイン、カスタム ワークフロー活動、およびデータ プロバイダーが表示されます。

   

カスタム API の作成

登録メニューで、新しいカスタム API の登録コマンドを選択します。 これにより、カスタム API を作成するためのフォームが開きます。

次の表の情報を使用して、カスタム API を作成します。 詳細については、カスタム API テーブルの列 を参照する

引き続き要求パラメーターと応答プロパティを追加するか、またはカスタム API を保存して、後で追加することができます。

要求パラメーターの作成

カスタム API には、要求パラメーターは必要ではありません。 カスタム API を作成しているとき、または既存の API を編集しているときに、+ 要求パラメーターを追加をクリックして要求パラメーターを追加します。 これにより、パラメーター フォームが開きます。

次の表の情報を使用して、要求パラメーターを作成します。 詳細については、CustomAPIRequestParameter テーブル列 を参照する

応答プロパティを作成する

アクションのカスタム API には、応答プロパティは必要ありません。 カスタム API を作成しているとき、または既存の API を編集しているときに、+ 応答パラメーターを追加をクリックして新しい応答プロパティを作成できます。 これにより、パラメーター フォームが開きます。

次の表の情報を使用して、応答プロパティを作成します。 詳細については、CustomAPIResponseProperty テーブル列 を参照する

カスタム API の一覧を表示する

表示メニューからカスタム API の一覧を表示するには、メッセージで表示コマンドを選択します。

カスタム API として作成されたメッセージには、(カスタム API) による接頭辞がつけられます。

カスタム API を削除する

カスタム API の一覧を表示するときに、削除する API を選択し、登録解除コマンドをクリックします。

または項目を右クリックし、コンテキスト メニューから登録解除を選択します。

カスタム API の要求パラメーターまたは応答プロパティを更新する

要求パラメーターまたは応答プロパティの一覧で、次の列を選択して編集します。

カスタム API の要求パラメーターまたは応答プロパティを削除する

要求パラメーターまたは応答プロパティの一覧で、次の列を選択して削除します。

次の手順

カスタム API のために IsPrivate プロパティを設定していない場合、カスタム API を作成した後、ブラウザーからでも GET 要求を使用して、CSDL $metadata ドキュメントからサービス定義を取得できます。 ご使用の環境の URL が https://yourorg.crm.dynamics.com の場合、ブラウザーのアドレス フィールドにこの URL を入力して、$metadata https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata を取得できます。

結果を検索してカスタム API の名前を見つけると、戻り値を表す関連する ComplexType と一緒に作成されたアクションまたは関数が見つかります。 例:

<ComplexType Name="sample_CustomAPIExampleResponse">
    <Property Name="StringProperty"
        Type="Edm.String"
        Unicode="false"/>
</ComplexType>
<Action Name="sample_CustomAPIExample">
    <Parameter Name="StringParameter"
        Type="Edm.String"
        Nullable="false"
        Unicode="false"/>
    <ReturnType Type="mscrm.sample_CustomAPIExampleResponse"
        Nullable="false"/>
</Action>

プラグインをカスタム API に設定していなくても、テストして署名を検証することができます。 値を設定するプラグインがないため、応答プロパティは既定値を返します。 詳細: カスタム API の呼び出し

プラグインを追加する場合は、プラグインを記述してアセンブリを登録する必要があります。 次に、カスタム API を更新して、アセンブリとプラグインを設定し、カスタム API に応答して実行するコードを指定します。 詳細: カスタム API で使用するプラグインを記述する

参照

カスタム API の作成と使用
Power Apps でカスタム API を作成する
コードを使用したカスタム API の作成
ソリューション ファイルを使用したカスタム API の作成
独自のメッセージを作成する
カスタム API テーブルの列