コードを使用してモデル駆動型アプリを作成、管理、公開する

[アーティクル]
02/23/2023

Power Apps アプリデザイナーを使用してモデル駆動型アプリを作成することに加えて、モデル駆動型アプリをプログラムで作成、管理することができます。

重要

必要でない限り、モデル駆動型アプリを構築するコードを記述する必要はありません。アプリデザイナーには、タイルベースの情報構造、およびさらに単純なインターフェイスを提供することにより、コードを記述する必要なしにモデル駆動型アプリを構築するための非常に単純で直観的なエクスペリエンスが用意されています。確認: アプリデザイナーを使用して、モデル駆動型アプリを設計

モデル駆動型アプリの作成には以下の手順が含まれます。

AppModule テーブルインスタンスを作成してご利用のアプリとそのプロパティを定義します。
AddAppComponents と RemoveAppComponents アクションを使用するカスタムアプリのテーブル、サイトマップ、および他のコンポーネントなどの、コンポーネントをアプリに追加または削除します。
ValidateApp 関数を使用することにより、欠落している必須コンポーネントのアプリを確認します。
アプリを公開します。
適切なセキュリティロールをモデル駆動型アプリに関連付けて、ユーザーにアクセスを提供します。

モデル駆動型アプリを作成およびプロパティを定義する

アプリを作成するには、システム管理者またはシステムカスタマイザーのセキュリティロール、または同等のアクセス許可が必要です。

アプリを作成するには、少なくとも以下のプロパティを指定する必要があります。

name: アプリに対して一意です。
uniquename: これはユーザーのアプリの名前とは異なる場合があり、英文字および数字のみで構成されます。このアプリを作成するとき、ソリューション発行者の接頭辞 (たとえば 'new_') が名前に自動的に付きます。
webresourceid: アプリのイメージアイコンとして設定する Web リソースの ID です。システムにはデフォルトのWebリソース (ID: 953b9fac-1e5e-e611-80d6-00155ded156f) が用意されており、アプリケーションのアイコンとして使用できます。

次の Web API 要求はアプリの統合インターフェイスの種類を作成します。

POST [Organization URI]/api/data/v9.0/appmodules HTTP/1.1
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0
Accept: application/json

{
    "name": "SDKTestApp",
    "uniquename":"SDKTestApp",
    "webresourceid":"953b9fac-1e5e-e611-80d6-00155ded156f"    
}

応答 OData-EntityId ヘッダーには、作成したアプリの URI が含まれています。

HTTP/1.1 204 No Content
OData-Version: 4.0
OData-EntityId: [Organization URI]/api/data/v9.0/appmodules(dd621d4a-d898-e711-80e7-00155db763be)

モデル駆動型アプリからコンポーネントを追加または削除する

モデル駆動型アプリに含める、サイトマップ、テーブル、ダッシュボード、ビジネスプロセスフロー、ビュー、フォームなどの、アプリ内のコンポーネントを追加または削除することができます。モデル駆動型アプリに追加可能なコンポーネントの詳細については、アプリデザイナーでアプリコンポーネントを追加または編集を参照してください。

AddAppComponents アクションまたは AddAppComponentsRequest メッセージを使用してコンポーネントをモデル駆動型アプリに追加します。そのアクションでは以下の内容を指定する必要があります。

AppId: コンポーネントを追加するアプリケーションの ID です。
コンポーネント追加するコンポーネントのコレクションです。追加するコンポーネントの ID とテーブルの種類を指定する必要があります。 Microsoft Dataverse Web API におけるテーブルの種別のリストについては、Web API Entity Type Reference を参照してください。

次の Web API 要求は、ビュー (savedquery) およびフォーム (systemform) をアプリに追加します。

POST [Organization URI]/api/data/v9.0/AddAppComponents HTTP/1.1
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0
Accept: application/json

{
   "AppId":"dd621d4a-d898-e711-80e7-00155db763be",
   "Components":[
      {
         "savedqueryid":"00000000-0000-0000-00aa-000000666000",
         "@odata.type":"Microsoft.Dynamics.CRM.savedquery"
      },
      {
         "formid":"c9e7ec2d-efca-4e4c-b3e3-f63c4bba5e4b",
         "@odata.type":"Microsoft.Dynamics.CRM.systemform"
      }
   ]
}

アプリからコンポーネントを削除するには、RemoveAppComponents アクションまたは RemoveAppComponentsRequest メッセージを使用します。このアクションは、AddAppComponents アクションと同じパラメーターのセットを使用します。

次の Web API 要求はビュー (savedquery) をアプリから削除します。

POST [Organization URI]/api/data/v9.0/RemoveAppComponents HTTP/1.1
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0
Accept: application/json

{
   "AppId":"dd621d4a-d898-e711-80e7-00155db763be",
   "Components":[
      {
         "savedqueryid":"00000000-0000-0000-00aa-000000666000",
         "@odata.type":"Microsoft.Dynamics.CRM.savedquery"
      }
   ]
}

モデル駆動型アプリを検証する

アプリの検証には、アプリが適切に動作することを確認するための、モデル駆動型アプリ内に追加済みのコンポーネントの依存関係のチェックが含まれます。これはアプリデザイナーで検証を選択することと同じです。詳細: アプリケーションを検証する

ValidateApp 関数または ValidateAppRequest メッセージを使用してアプリを検証します。以下の Web API 要求は、次に示す ID を使用してモデル駆動型アプリケーションを検証する方法を説明しています: dd621d4a-d898-e711-80e7-00155db763be:

GET [Organization URI]/api/data/v9.0/ValidateApp(AppModuleId=dd621d4a-d898-e711-80e7-00155db763be)

検証エラーが発生しなければ、応答は次のいずれかになります。

HTTP/1.1 200 OK
OData-Version: 4.0

{
    "@odata.context": "[Organization URI]/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.ValidateAppResponse",
    "AppValidationResponse": {
        "ValidationSuccess": true,
        "ValidationIssueList": []
    }
}

アプリに検証の問題がある場合、応答により ValidationIssueList コレクション内にエラー/警告が表示されます。

HTTP/1.1 200 OK
OData-Version: 4.0

{
    "@odata.context": "[Organization URI]/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.ValidateAppResponse",
    "AppValidationResponse": {
        "ValidationSuccess": false,
        "ValidationIssueList": [
            {
                "ErrorType": "Error",
                "Message": "App does not contain Site Map",
                "DisplayName": null,
                "ComponentId": "00000000-0000-0000-0000-000000000000",
                "ComponentType": 0,
                "ComponentSubType": 0,
                "ParentEntityId": "00000000-0000-0000-0000-000000000000",
                "ParentEntityName": null,
                "CRMErrorCode": -2147155684,
                "RequiredComponents": []
            },
            {
                "ErrorType": "Warning",
                "Message": "Account doesn't reference a form or view. App users will see all forms and views.",
                "DisplayName": null,
                "ComponentId": "00000000-0000-0000-0000-000000000000",
                "ComponentType": 0,
                "ComponentSubType": 0,
                "ParentEntityId": "00000000-0000-0000-0000-000000000000",
                "ParentEntityName": null,
                "CRMErrorCode": -2147155691,
                "RequiredComponents": []
            }
        ]
    }
}

モデル駆動型アプリを公開する

必須コンポーネントをモデル駆動型アプリに追加して検証したら、ユーザーが使用できるように公開する必要があります。

PublishXml アクションまたは PublishXmlRequest メッセージを使用してモデル駆動型アプリを公開します。以下の要求は、次に示す ID を使用してモデル駆動型アプリケーションを公開する方法を説明しています: dd621d4a-d898-e711-80e7-00155db763be:

POST [Organization URI]/api/data/v9.0/PublishXml HTTP/1.1
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0
Accept: application/json

{  
  "ParameterXml":"<importexportxml><appmodules><appmodule>dd621d4a-d898-e711-80e7-00155db763be</appmodule></appmodules></importexportxml>"
}

セキュリティロールを使用してモデル駆動型アプリへのアクセスを管理する

ユーザーがホームページの設定 > マイアプリ領域からアクセスすることができるように、アプリへのアクセス権限をユーザーに提供するため、セキュリティロールをモデル駆動型アプリに関連付けることができます。関連するセキュリティロールに割り当てられたユーザーは、Dataverse にモデル駆動型アプリを表示して、使用できます。

AppModule テーブルエンティティの appmoduleroles_association ナビゲーションプロパティを使用して、モデル駆動型アプリをセキュリティロールに関連付けます。次の要求はモデル駆動型アプリをセキュリティロールと関連付ける方法を示しています。

POST [Organization URI]/api/data/v9.0/appmodules(dd621d4a-d898-e711-80e7-00155db763be)appmoduleroles_association/$ref HTTP/1.1
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0
Accept: application/json

{  
  "@odata.id":"[Organization URI]/api/data/v9.0/roles(<roleId>)"
}

モデル駆動型アプリからセキュリティロールの関連付けを解除するには、同じナビゲーションプロパティで DELETE 要求を使用します。たとえば、次のようになります。

DELETE   [Organization URI]/api/data/v9.0/appmodules(dd621d4a-d898-e711-80e7-00155db763be)/appmoduleroles_association/$ref?$id=[Organization URI]/api/data/v9.0/roles(<roleId)

モデル駆動型アプリとそのコンポーネントの管理

このセクションでは、アプリの取得、アプリのプロパティの更新、アプリのコンポーネントの取得、およびアプリの削除に関する情報を提供します。

公開済みアプリの取得

公開済みアプリを取得するには、以下の要求を使用します。

GET [Organization URI]/api/data/v9.0/appmodules?$select=name,clienttype

未公開のアプリの取得

未公開アプリを取得するには、RetrieveUnpublishedMultiple 関数を使用します。たとえば、次のようになります。

GET [Organization URI]/api/data/v9.0/appmodules/Microsoft.Dynamics.CRM.RetrieveUnpublishedMultiple()?$select=name,clienttype

公開済みモデル駆動型アプリ内のコンポーネントの取得

モデル駆動型アプリのアプリコンポーネントを取得するには、RetrieveAppComponents 関数または RetrieveAppComponentsRequest メッセージを使用します。たとえば、次のようなものです。

GET [Organization URI]/api/data/v9.0/RetrieveAppComponents(AppModuleId=dd621d4a-d898-e711-80e7-00155db763be)

公開済みモデル駆動型アプリに関連付けられたセキュリティロールの取得

ユーザーのモデル駆動型アプリに関連付けられたセキュリティロールを取得するには、$expand システムクエリオプションを appmoduleroles_association ナビゲーションプロパティと共に使用します。たとえば、ID: dd621d4a-d898-e711-80e7-00155db763be のモデル駆動型アプリに関連付けられたすべてのセキュリティロールを取得する要求は次のとおりです。

GET [Organization URI]/api/data/v9.0/appmodules(dd621d4a-d898-e711-80e7-00155db763be)?$expand=appmoduleroles_association&$select=name,appmoduleroles_association

モデル駆動型アプリを削除する

DELETE 要求を使用してモデル駆動型アプリを削除します。たとえば、次のようなものです。

DELETE [Organization URI]/api/data/v9.0/appmodules(dd621d4a-d898-e711-80e7-00155db763be)

モデル駆動型アプリのクライアント API サポート

以下のクライアント API を使用してモデル駆動型アプリの作業をすることができます。

次の方法で共有

コードを使用してモデル駆動型アプリを作成、管理、公開する

モデル駆動型アプリを作成およびプロパティを定義する

モデル駆動型アプリからコンポーネントを追加または削除する

モデル駆動型アプリを検証する

モデル駆動型アプリを公開する

セキュリティロールを使用してモデル駆動型アプリへのアクセスを管理する

モデル駆動型アプリとそのコンポーネントの管理

公開済みアプリの取得

未公開のアプリの取得

公開済みモデル駆動型アプリ内のコンポーネントの取得

公開済みモデル駆動型アプリに関連付けられたセキュリティロールの取得

モデル駆動型アプリを削除する

モデル駆動型アプリのクライアント API サポート

関連項目

フィードバック

その他のリソース

次の方法で共有

コードを使用してモデル駆動型アプリを作成、管理、公開する

モデル駆動型アプリを作成およびプロパティを定義する

モデル駆動型アプリからコンポーネントを追加または削除する

モデル駆動型アプリを検証する

モデル駆動型アプリを公開する

セキュリティ ロールを使用してモデル駆動型アプリへのアクセスを管理する

モデル駆動型アプリとそのコンポーネントの管理

公開済みアプリの取得

未公開のアプリの取得

公開済みモデル駆動型アプリ内のコンポーネントの取得

公開済みモデル駆動型アプリに関連付けられたセキュリティ ロールの取得

モデル駆動型アプリを削除する

モデル駆動型アプリのクライアント API サポート

関連項目

フィードバック

その他のリソース

セキュリティロールを使用してモデル駆動型アプリへのアクセスを管理する

公開済みモデル駆動型アプリに関連付けられたセキュリティロールの取得