カスタム API を作成するときは、ソリューションを使用する必要があります。 ソリューションに慣れていない場合は、まずソリューションの 作成に関するページを参照してください。
ソリューションは発行元に関連付けられている必要があります。 パブリッシャーには、特定のカスタマイズ プレフィックスが関連付けられています。 カスタム API を作成するときはカスタマイズ プレフィックスを使用する必要があります。このプレフィックスは、ソリューションの発行元が使用するプレフィックスと同じである必要があります。 次の手順では、 sample 値をカスタマイズ プレフィックスとして使用します。これはパブリッシャーに設定されているためです。
Important
- これで、カスタム API を作成するエクスペリエンスが向上しました。 プラグイン登録ツール内でデザイナーを使用できます。 詳細情報: プラグイン登録ツールを使用してカスタム API を作成する
- カスタム API の作成に関連する多くのフィールドは、作成後は変更できません。 開始する前に、カスタム API の設計を慎重に計画する必要があります。 カスタム API の作成後に変更が必要であると後で判断した場合は、既存のレコードを削除し、カスタム API を再作成することが必要になる場合があります。 ここで変更できない列に関する情報を確認する: CustomAPI テーブル
カスタム API レコードを作成する
ソリューションで、ドロップダウンから [新規>詳細>その他>custom API を選択します。
フィールドを編集して、カスタム API のプロパティを設定します。 次のフィールドの値を設定する必要があります。 詳細については、「カスタム API テーブルの列」を参照してください。
プラグインを作成する前 に、プラグインの種類 の値を設定することはできません。 これは後で変更できます。
保存 を選択します。 フォームは次のようになります:
要求パラメーターを作成してください
カスタム API にはパラメーターは必要ありません。 ロジックに必要なデータを渡すために必要な数のパラメーターを作成します。
ソリューションで、ドロップダウンから [新規>詳細>その他>Custom API 要求パラメーター を選択します。
フィールドを編集して、カスタム API 要求パラメーターのプロパティを設定します。 詳細については、「CustomAPIRequestParameter テーブル列」を参照してください。
保存 を選択します。 フォームは次のようになります。
任意の応答プロパティを作成する
アクションを表すカスタム API では、応答プロパティは必要ありません。 関数には少なくとも 1 つ必要です。 操作が成功すると、成功応答が返されます。 失敗した場合は、エラーが返されます。 API から返されるすべてのデータの応答プロパティを定義する必要があります。
Entity または EntityCollection 応答プロパティが 1 つだけ定義されている場合、応答はその型になります。 複数のプロパティがある場合、または単純型の 1 つ以上のプロパティがある場合、API は複合型を返します。各応答プロパティはその複合型のプロパティです。
たとえば、カスタム API の一意の名前が sample_CustomAPIExampleされている場合、定義した各応答プロパティのプロパティを持つ sample_CustomAPIExampleResponse という名前の複合型が返されます。
ソリューションで、ドロップダウンから New>More>Other>Custom API Response プロパティ を選択します。
フィールドを編集して、カスタム API Response プロパティのプロパティを設定します。 詳細については、「CustomAPIResponseProperty テーブル列」を参照してください。
保存 を選択します。 フォームは次のようになります。
サービス ドキュメントの結果を確認する
カスタム API の IsPrivate プロパティを設定していない場合は、ブラウザーからでも、要求を使用して GETからサービス定義を取得できるようになりました。 環境の URL が https://yourorg.crm.dynamics.comされている場合は、ブラウザーのアドレス フィールドにこの URL を入力して、$metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadataを取得できます。
結果を検索して、カスタム API の名前を見つけます。 たとえば、上記の手順を使用して定義された API は次のようになります。
<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 を作成したら、試すことができます。 メイン操作を定義するプラグインの種類を設定していない場合でも、ここでテストして、正しく呼び出すことができることを確認できます。 応答プロパティは、既定値 (null など) を返します。 詳細: カスタム API の呼び出し。
カスタム API プラグインの種類を更新する
カスタム API のプラグインを記述する方法については、「カスタム API のプラグインを記述する」 を参照してください。
アセンブリを登録したら、作成したカスタム API の プラグインの種類 の値を設定する必要があります。 これはルックアップ プロパティであるため、アセンブリの登録時に作成された型を表すプラグイン型を見つけるだけで済みます。
プラグインの種類を設定したら、カスタム API をテストして、正しい結果が返されたことを確認できます。
カスタム API を作成するその他の方法
プラグイン登録ツールは、カスタム API デザイナーを提供します。 詳細情報: プラグイン登録ツールを使用してカスタム API を作成する
デザイナーの外部でカスタム API を作成できるクライアント アプリケーションを作成する必要がある場合があります。 カスタム API のデータはテーブルに格納されるため、コードを使用して作成できます。 詳細情報: コードを使用してカスタム API を作成する。
ALM プロセスは、ソリューション ファイルを編集してカスタム API を作成することで、より適切に処理できる場合があります。 詳細: ソリューション ファイルを使用したカスタム API を作成する。
こちらも参照ください
カスタム API の作成と使用
プラグイン登録ツールを使用してカスタム API を作成する
コードを使用したカスタム API の作成
ソリューション ファイルを使用したカスタム API の作成
独自のメッセージを作成する