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

プラグイン登録ツール (PRT) でデザイナーを使用してカスタム API を作成します。 この記事では、カスタム API の定義、要求パラメーターと応答プロパティの追加、およびそれらを表示、更新、または削除する方法について説明します。 PRT は、NuGet からダウンロードできる開発者ツールの一部であるWindows クライアント アプリケーションです。 これらのツールのダウンロードについては、 Dataverse 開発ツールを参照してください。

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

  1. PAC CLI pac tool prt コマンドを実行して、プラグイン登録ツールを開きます。

  2. [+ 新しい接続の作成] を選択して、Dataverse 環境に接続します。

  3. Office 365 がオンになっていることを確認します。

  4. 現在使用している Microsoft アカウント以外の Microsoft アカウントを使用して接続する場合は、[ 詳細の表示 ] を選択して資格情報を入力します。 それ以外の場合は、[サインイン] を 現在のユーザーとして 選択したままにします。

    Note

    ユーザー アカウントで多要素認証 (MFA) が使用されている場合は、[ 詳細の表示 ] チェック ボックスがオフになっていることを確認します。

  5. Microsoft アカウントが複数の環境にアクセスできる場合は、[ 使用可能な組織の一覧を表示] を選択します。

    プラグイン登録ツールを使用してログインします。

  6. ログインを選択します。

  7. [使用可能な組織の一覧を表示] を選択した場合は、接続先の組織を選択し、[ログイン] を選択します。

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

    カスタム ワークフロー アクティビティの既存のプラグインを表示します。

カスタム API の作成

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

プラグイン登録ツールでカスタム API を作成するフォームのスクリーンショット。

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

Important

カスタム API を保存した後は、一部のオプションを変更できません。 変更できない各設定の目的を理解してください。 後でこの設定を変更する必要がある場合は、カスタム API を削除して再作成する必要があります。 このアクションでは、それに関連付けられている要求パラメーターまたは応答プロパティも削除されます。

Label 説明 変更可能
表示名 ローカライズ可能な名前。 あり
氏名 わかりやすいローカライズ不可能な名前。 あり
ソリューション 新しいソリューションを作成するか、既存のソリューションを選択します。 この値を設定すると、一意の名前 フィールドに適切なカスタマイズ プレフィックスが設定されます。 あり
一意の名前 カスタム API の名前。 この値には英数字のみを含める必要があり、スペースは含めてはなりません。
完全な名前には、ソリューションを選択することによって決定されるカスタマイズ プレフィックスが含まれます。		 いいえ
説明 ローカライズ可能な説明。 メッセージがアプリで呼び出し可能な状態にある場合に使用します。 たとえば、 ツールヒントなどです。 あり
組み立て このフィールドは省略可能です。 カスタム API の動作を定義するプラグイン型を含むアセンブリを選択します。 あり
プラグイン このフィールドは省略可能です。 選択したアセンブリ内のプラグインの種類を選択します。 この値は後で設定できます。 あり
許可されるカスタム処理ステップの種類 許可される処理ステップの種類。 詳細情報: カスタム処理ステップの種類の選択 いいえ
バインドの種類 エンティティ バインドの種類。 詳細情報: バインドの種類の選択 いいえ
バインドされたエンティティの論理名 [バインドの種類エンティティ] または [EntityCollection] を選択した場合は、その型を表すテーブルの論理名を入力します。 いいえ
実行権限の名称 誰かが API を使用できるかどうかを制御する特権の名前。 この名前は、Privilege テーブルの有効な Name 値である必要があります。 詳細情報: 特権を要求してカスタム API をセキュリティで保護する あり
職務 関数を作成するかどうか。 詳細情報: 関数を作成するタイミング いいえ
プライベート カスタム API をプライベートにする必要があるかどうか。 詳細情報: カスタム API をプライベートにするタイミング あり

Note

  • PRT カスタム API デザイナーでは、 Enabled For Workflow (WorkflowSdkStepEnabled) プロパティは公開されません。 Workflows で動作するカスタム API を作成したい場合は、別のメソッドを使用します。
  • PRT カスタム API デザイナーでは、 カスタマイズ可能な 管理プロパティは公開されません。 このプロパティは、Power Appsで設定できます。 詳細については、「カスタム API のカスタマイズ」を参照してください。

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

カスタム API 要求パラメーターを作成する

カスタム API には要求パラメーターは必要ありません。 カスタム API の作成中または編集中に、[+ 要求パラメーターの追加] を選択して要求パラメーターを追加できます。 この選択で パラメーター フォームが開きます。

カスタム API 要求パラメーターの作成に使用される [パラメーター] フォームのスクリーンショット。

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

Label 説明 変更可能
表示名 ローカライズ可能な表示名。 あり
氏名 カスタム API 要求パラメーターのプライマリ名。 この名前付け規則を使用して、このパラメーターを共通の 一意の名前を共有する他のパラメーターと区別します。 {Custom API Unique Name}.{Parameter UniqueName} あり
一意の名前 カスタム API を呼び出すときのパラメーターの名前。 いいえ
タイプ パラメーターの型を選択します。
ブール値
日時
実数
エンティティ
EntityCollection
EntityReference
Float
整数
通貨
候補リスト
String
StringArray
GUID
 いいえ
論理エンティティ名 Entity、EntityCollection、または EntityReference を Type として選択する場合は、テーブルを指定します。 いいえ
説明 ローカライズ可能な説明。 あり
省略可能 呼び出し元がパラメーターの値を指定する必要があるかどうか。 いいえ

カスタム API 応答プロパティを作成する

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

カスタム API 応答プロパティの作成に使用される [パラメーター] フォームのスクリーンショット。

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

Label 説明 変更可能
表示名 ローカライズ可能な表示名。 あり
氏名 カスタム API 応答プロパティのプライマリ名。 この名前付け規則を使用して、このパラメーターを共通の一意の名前を共有する他のパラメーターと区別します。 {Custom API Unique Name}.{Property UniqueName} あり
一意の名前 この名前は、カスタム API を呼び出すときに返されるプロパティです。 いいえ
タイプ プロパティの種類を選択します。
ブール値
日時
実数
エンティティ
EntityCollection
EntityReference
Float
整数
通貨
候補リスト
String
StringArray
GUID
 いいえ
論理エンティティ名 Type として Entity または EntityReference を選択する場合は、テーブルを指定します。 種類として EntityCollection を選択した場合、論理エンティティ名を指定することはできません。 いいえ
説明 ローカライズ可能な説明。 あり

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

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

カスタム API を示す [表示] メニューの [メッセージ別に表示] コマンドのスクリーンショット。

カスタム API として作成したメッセージには、プレフィックス (カスタム 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 テーブルの列

  • 最終更新: