CustomAPI テーブル

カスタム API を定義するデータは、次のテーブル/エンティティにあります。

この記事のセクションでは、最も使用する列の値に関する詳細情報を提供します。

カスタム API テーブル列
CustomAPIRequestParameter テーブルカラム
CustomAPIResponseProperty テーブル列

次の図は、テーブルがこれらのテーブルとどのように関連しているかを示しています。

テーブル間のリレーションシップを示す図。

CatalogAssignment テーブルとのリレーションシップにより、Microsoft Dataverse ビジネスイベントでカスタム API を使用できます。詳細情報: Catalog テーブルと CatalogAssignment テーブル。

カスタム API に関するデータを取得する

次のクエリを使用して、カスタム API に関するデータを取得できます。

詳細情報: Web API を使用したデータのクエリ

GET [Organization URI]/api/data/v9.1/customapis?$select=
    uniquename,
    allowedcustomprocessingsteptype,
    bindingtype,
    boundentitylogicalname,
    description,
    displayname,
    executeprivilegename,
    iscustomizable,
    isfunction,
    isprivate,
    workflowsdkstepenabled
  &$expand=
  CustomAPIRequestParameters($select=
    uniquename,
    name,
    description,
    displayname,
    type,
    logicalentityname,
    iscustomizable,
    isoptional),
  CustomAPIResponseProperties($select=
    uniquename,
    name,
    description,
    displayname,
    iscustomizable,
    type,
    logicalentityname),
  PluginTypeId($select=
    plugintypeid,
    typename,
    version,
    name,
    assemblyname)

詳細情報: QueryExpression を使用してクエリを構築する

string conn = $@"
    Url = {url};
    AuthType = OAuth;
    UserName = {userName};
    Password = {password};
    AppId = 51f81489-12ee-4a9e-aaae-a2591f45987d;
    RedirectUri = app://58145B91-0C36-4500-8554-080854F2AC97;
    LoginPrompt=Auto;
    RequireNewInstance = True";

// using (var svc = new ServiceClient(conn))
using (var svc = new CrmServiceClient(conn))
{

    // Instantiate QueryExpression query
    var query = new QueryExpression("customapi");

    // Add columns to query.ColumnSet
    query.ColumnSet.AddColumns("isprivate",
    "description",
    "displayname",
    "executeprivilegename",
    "iscustomizable",
    "isfunction",
    "allowedcustomprocessingsteptype",
    "boundentitylogicalname",
    "bindingtype",
    "uniquename",
    "workflowsdkstepenabled");

    // Add link-entity req
    var req = query.AddLink("customapirequestparameter",
    "customapiid",
    "customapiid",
    JoinOperator.LeftOuter);
    req.EntityAlias = "req";

    // Add columns to req.Columns
    req.Columns.AddColumns("description",
    "displayname",
    "iscustomizable",
    "logicalentityname",
    "name",
    "uniquename",
    "type",
    "isoptional");

    // Add link-entity query_customapiresponseproperty
    var query_customapiresponseproperty = query
        .AddLink("customapiresponseproperty",
    "customapiid",
    "customapiid",
    JoinOperator.LeftOuter);

    // Add columns to query_customapiresponseproperty.Columns
    query_customapiresponseproperty.Columns
        .AddColumns("description",
    "displayname",
    "iscustomizable",
    "logicalentityname",
    "name",
    "uniquename",
    "type");

    // Add link-entity plugintype
    var plugintype = query.AddLink("plugintype",
    "plugintypeid",
    "plugintypeid",
    JoinOperator.LeftOuter);

    plugintype.EntityAlias = "plugintype";

    // Add columns to plugintype.Columns
    plugintype.Columns.AddColumns("name",
    "assemblyname",
    "version",
    "plugintypeid",
    "typename");

    EntityCollection results = svc.RetrieveMultiple(query);

    Console.WriteLine("Press any key to exit.");
    Console.ReadLine();
}

詳細情報: FetchXML を使用してデータをクエリする

<fetch>
  <entity name='customapi' >
    <attribute name='isprivate' />
    <attribute name='description' />
    <attribute name='displayname' />
    <attribute name='executeprivilegename' />
    <attribute name='iscustomizable' />
    <attribute name='isfunction' />
    <attribute name='allowedcustomprocessingsteptype' />
    <attribute name='boundentitylogicalname' />
    <attribute name='bindingtype' />
    <attribute name='uniquename' />
    <attribute name='workflowsdkstepenabled' />
    <link-entity name='customapirequestparameter' from='customapiid' to='customapiid' link-type='outer' alias='req' >
      <attribute name='description' />
      <attribute name='displayname' />
      <attribute name='iscustomizable' />
      <attribute name='logicalentityname' />
      <attribute name='name' />
      <attribute name='uniquename' />
      <attribute name='type' />
      <attribute name='isoptional' />
    </link-entity>
    <link-entity name='customapiresponseproperty' from='customapiid' to='customapiid' link-type='outer' >
      <attribute name='description' />
      <attribute name='displayname' />
      <attribute name='iscustomizable' />
      <attribute name='logicalentityname' />
      <attribute name='name' />
      <attribute name='uniquename' />
      <attribute name='type' />
    </link-entity>
    <link-entity name='plugintype' from='plugintypeid' to='plugintypeid' link-type='outer' alias='plugintype' >
      <attribute name='name' />
      <attribute name='assemblyname' />
      <attribute name='version' />
      <attribute name='plugintypeid' />
      <attribute name='typename' />
    </link-entity>
  </entity>
</fetch>

詳細: SQL を使用してデータを照会する (プレビュー)

SELECT api.customapiid,
       api.uniquename,
       api.allowedcustomprocessingsteptype,
       api.bindingtype,
       api.boundentitylogicalname,
       api.description,
       api.displayname,
       api.executeprivilegename,
       api.iscustomizable,
       api.isfunction,
       api.isprivate,
       api.workflowsdkstepenabled,
       req.customapirequestparameterid,
       req.uniquename,
       req.name,
       req.description,
       req.displayname,
       req.type,
       req.logicalentityname,
       req.iscustomizable,
       req.isoptional,
       resp.customapiresponsepropertyid,
       resp.uniquename,
       resp.name,
       resp.description,
       resp.iscustomizable,
       resp.type,
       resp.logicalentityname,
       type.plugintypeid,
       type.typename,
       type.version,
       type.name,
       type.assemblyname
FROM   customapi AS api
       LEFT JOIN
       customapirequestparameter AS req
       ON api.customapiid = req.customapiid
       LEFT JOIN
       customapiresponseproperty AS resp
       ON api.customapiid = resp.customapiid
       LEFT JOIN
       plugintype AS type
       ON api.plugintypeid = type.plugintypeid

カスタム API テーブルの列

次の表には、設定できるカスタム API テーブルの選択された列が含まれています。

表示される名前 Schema Name 論理名	タイプ	Description
許可されるカスタム処理ステップの種類 `AllowedCustomProcessingStepType` `allowedcustomprocessingsteptype`	選択肢ピックリスト	値: 0 ラベル: なし意味: カスタム処理ステップは許可されません。値: 1 ラベル: 非同期のみ意味: 許可される非同期カスタム処理ステップのみ値: 2 ラベル: 同期と非同期意味: 制限はありません。サードパーティ製プラグインは、同期ロジックを追加してメッセージの動作を変更できます。「カスタム処理ステップの種類の選択」を参照してください保存後に変更できません。
バインドの種類 `BindingType` `bindingtype`	選択肢ピックリスト	値: 0 ラベル: グローバル値: 1 ラベル: エンティティ値: 2 ラベル: EntityCollection バインドの種類の選択を参照してください保存後に変更できません。
バインド済みエンティティの論理名 `BoundEntityLogicalName` `boundentitylogicalname`	テキスト String	グローバルでない場合は、カスタム API にバインドされたテーブルの論理名。保存後に変更できません。
カスタム API `CustomAPIId` `customapiid`	一意識別子 Guid	カスタム API インスタンスの一意識別子保存後に変更できません。
説明 `Description` `description`	テキスト String	このカスタム API のローカライズされた説明。メッセージがアプリに表示されている場合は、この値を使用します。たとえば、ツールヒントなどです。
表示名 `DisplayName` `displayname`	テキスト String	このカスタム API のローカライズされた表示名。メッセージがアプリに表示されている場合は、この値を使用します。
実行権限の名称 `ExecutePrivilegeName` `executeprivilegename`	テキスト String	(省略可能)カスタム API の実行を許可する特権の名前。参照: 特権を使用してカスタム API をセキュリティで保護する
カスタマイズ可能 `IsCustomizable` `iscustomizable`	ManagedProperty	マネージドソリューションの一部としてカスタム API をカスタマイズまたは削除できるかどうか。
Is 関数 `IsFunction` `isfunction`	はい/いいえブール値	値: 0 ラベル: いいえ値: 1 ラベル: はい関数を作成するタイミングを確認する保存後に変更できません。
非公開 `IsPrivate` `isprivate`	はい/いいえブール値	値: 0 ラベル: いいえ値: 1 ラベル: はいカスタム API をプライベートにするタイミングを確認する
名前 `Name` `name`	テキスト String	カスタム API のプライマリ名。この値は、ソリューションで表示されるときにカスタム API の一覧に表示されます。
Owner `OwnerId` `ownerid`	オーナー	API を所有するユーザーまたはチームへの参照。
プラグインの種類 `PluginTypeId` `plugintypeid`	検索	このカスタム API のメイン操作を提供するプラグイン型への参照。参照: プラグインを使用してカスタム API にロジックを含める
一意の名前 `UniqueName` `uniquename`	テキスト String	カスタム API の一意の名前。この値は、作成されたメッセージの名前です。この値には、ソリューション発行元のプレフィックスセットに一致するカスタマイズプレフィックスを含める必要があります。この値には特殊文字を含めることはできません。保存後に変更できません。
ワークフローに対して有効 `WorkflowSdkStepEnabled` `workflowsdkstepenabled`	はい/いいえブール値	カスタム API がワークフローアクションとして有効になっているかどうかを示します。参照: ワークフローでカスタム API を使用する保存後に変更できません。

CustomAPIRequestParameter のテーブル列

カスタム API にはパラメーターは必要ありません。パラメーターの順序は指定されません。名前で識別されます。

パラメーターは、1 つのカスタム API に関連しています。同じパラメーター定義を使用する複数のカスタム API を定義することはできません。異なるカスタム API で使用されている場合は、同じ UniqueName 値を持つ複数の要求パラメーターを定義できます。

注

カスタム API のバインドテーブルを定義すると、要求パラメーターが自動的に生成されます。カスタム API がテーブルにバインドされている場合は、テーブルの入力パラメーターを作成する必要はありません。詳細情報: バインドの種類の選択

次の表には、設定できるカスタム API 要求パラメーターテーブルの列 (属性) が含まれています。

表示される名前 Schema Name 論理名	タイプ	Description
カスタム API 要求パラメーター `CustomAPIRequestParameterId` `customapirequestparameterid`	一意識別子 Guid	カスタム API リクエストパラメーターインスタンスの一意の識別子。保存後に変更できません。
カスタム API `CustomAPIId` `customapiid`	検索	このカスタム API 要求パラメーターが関連付けられているカスタム API に対する一意の識別子です。保存後に変更できません。
説明 `Description` `description`	テキスト String	カスタム API 要求パラメーターインスタンスのローカライズされた説明。メッセージパラメーターがアプリに表示されている場合は、この値を使用します。たとえば、ツールヒントなどです。
表示名 `DisplayName` `displayname`	テキスト String	カスタム API 要求パラメーターインスタンスのローカライズされた表示名。メッセージパラメーターがアプリに表示されている場合は、この値を使用します。
カスタマイズ可能 `IsCustomizable` `iscustomizable`	ManagedProperty	マネージドソリューションの一部としてカスタム API 要求パラメーターをカスタマイズまたは削除できるかどうか。カスタム API のカスタマイズを参照してください
省略可能 `IsOptional` `isoptional`	はい/いいえブール値	カスタム API 要求パラメーターが省略可能かどうかを示します。省略可能でない場合は、メッセージを使用するときにこのパラメーターの値を渡す必要があります。値: 0 ラベル: いいえ値: 1 ラベル: はい保存後に変更できません。
論理エンティティ名 `LogicalEntityName` `logicalentityname`	テキスト String	カスタム API 要求パラメーターにバインドされているテーブルの論理名。保存後に変更できません。
名前 `Name` `name`	テキスト String	カスタム API 要求パラメーターのプライマリ名。この値は、ソリューションで表示されるときに、カスタム API 要求パラメーターの一覧に表示されます。この値を使用して、このパラメーターを共通の一意の名前を共有する他のパラメーターと区別します。この名前付け規則をお勧めします。 `{custom API Unique Name}.{Parameter UniqueName}`
Owner `OwnerId` `ownerid`	オーナー	API を所有するユーザーまたはチームへの参照。
タイプ `Type` `type`	選択肢ピックリスト	カスタム API 要求パラメーターのデータ型。値: 0 ラベル: ブール値値: 1 ラベル: DateTime 値: 2 ラベル: Decimal 値: 3 ラベル: エンティティ値: 4 ラベル: EntityCollection 値: 5 ラベル: EntityReference 値: 6 ラベル: Float 値: 7 ラベル: 整数値: 8 ラベル: Money 値: 9 ラベル: 候補リスト値: 10 ラベル: 文字列値: 11 ラベル: StringArray 値: 12 ラベル: Guid 保存後に変更できません。
一意の名前 `UniqueName` `uniquename`	テキスト String	カスタム API 要求パラメーターの一意の名前。この値は、カスタム API を呼び出すときのパラメーターの名前です。この値には特殊文字を含めることはできません。保存後に変更できません。

CustomAPIResponseProperty のテーブル列

カスタム API メッセージに対して返されるオブジェクトには、定義した応答プロパティが含まれます。カスタム API アクションで値を返す必要はありませんが、関数として定義されている場合は値を返す必要があります。

Entity または EntityCollection 応答プロパティが 1 つだけ定義されている場合、応答はその型になります。複数のパラメーターまたは単純型の 1 つ以上のパラメーターがある場合、API は複合型を返します。各応答プロパティはその複合型のプロパティです。

たとえば、カスタム API の一意の名前が sample_CustomAPIExampleされている場合、定義した各応答プロパティのプロパティを持つ sample_CustomAPIExampleResponse という名前の複合型が返されます。

次の表には、設定できるカスタム API 応答プロパティテーブルの列 (属性) が含まれています。

表示される名前 Schema Name 論理名	タイプ	Description
カスタム API 応答プロパティ `CustomAPIResponsePropertyId` `customapiresponsepropertyid`	一意識別子 Guid	カスタム API 応答プロパティインスタンスの一意識別子。保存後に変更できません。
カスタム API `CustomAPIId` `customapiid`	検索	このカスタム API 応答プロパティが紐付けられているカスタム API のユニーク識別子。保存後に変更できません。
説明 `Description` `description`	テキスト String	カスタム API 応答プロパティインスタンスのローカライズされた説明。メッセージパラメーターがアプリに表示されている場合は、この値を使用します。たとえば、ツールヒントなどです。
表示名 `DisplayName` `displayname`	テキスト String	カスタム API 応答プロパティインスタンスのローカライズされた表示名。メッセージパラメーターがアプリに表示されている場合は、この値を使用します。
カスタマイズ可能 `IsCustomizable` `iscustomizable`	ManagedProperty	マネージドソリューションの一部としてカスタム API 応答プロパティをカスタマイズまたは削除できるかどうか。
論理エンティティ名 `LogicalEntityName` `logicalentityname`	テキスト String	種類として Entity または EntityReference が選択されている場合は、カスタム API 応答プロパティにバインドされたテーブルの論理名を指定できます。種類として EntityCollection を選択した場合、論理エンティティ名を指定することはできません。保存後に変更できません。
名前 `Name` `name`	String	カスタム API 応答プロパティのプライマリ名。この値は、ソリューションで表示されるときに、カスタム API 要求パラメーターの一覧に表示されます。この値を使用して、このパラメーターを共通の一意の名前を共有する他のパラメーターと区別します。この名前付け規則をお勧めします。 `{custom API Unique Name}.{Property UniqueName}`
Owner `OwnerId` `ownerid`	オーナー	API を所有するユーザーまたはチームへの参照。
タイプ `Type` `type`	ピックリスト	カスタム API 応答プロパティのデータ型値: 0 ラベル: ブール値値: 1 ラベル: DateTime 値: 2 ラベル: Decimal 値: 3 ラベル: エンティティ値: 4 ラベル: EntityCollection 値: 5 ラベル: EntityReference 値: 6 ラベル: Float 値: 7 ラベル: 整数値: 8 ラベル: Money 値: 9 ラベル: 候補リスト値: 10 ラベル: 文字列値: 11 ラベル: StringArray 値: 12 ラベル: Guid 保存後に変更できません。
一意の名前 `UniqueName` `uniquename`	テキスト String	カスタム API 応答プロパティの一意の名前。この値は、カスタム API を呼び出すときのパラメーターの名前です。この値には特殊文字を含めることはできません。保存後に変更できません。

こちらも参照ください

カスタム API の作成と使用
 プラグイン登録ツールを使用してカスタム API を作成する
 Power Apps でのカスタム API の作成
 コードを使用したカスタム API の作成
 ソリューションファイルを使用したカスタム API の作成
 独自のメッセージを作成する

フィードバック

このページはお役に立ちましたか?

Last updated on 2025-10-04