CustomAPI テーブル

[アーティクル]
2024/03/14

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

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

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

この図は、テーブルがこれらのテーブルや他のテーブルとどのように関連しているかを表しています:

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

CatalogAssignment テーブルへの関連付けにより、カスタム API と Microsoft Dataverse ビジネスイベントの使用が有効になります。詳細情報: 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 テーブルで設定可能な列の一部です。

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

CustomAPIRequestParameter テーブル列

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

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

注意

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

以下の表は、設定可能なカスタム API 要求パラメーターテーブルのカラム (属性) です。

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

CustomAPIResponseProperty テーブル列

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

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

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

以下の表は、設定可能な Custom API Response Property テーブルのカラム (属性) です。

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

参照

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

注意

ドキュメントの言語設定についてお聞かせください。簡単な調査を行います。 (この調査は英語です)

この調査には約 7 分かかります。個人データは収集されません (プライバシーステートメント)。

次の方法で共有