Web API サービス ドキュメント

OData エンドポイントには、サービスの機能を説明するサービス ドキュメントが含まれます。 これらのサービス ドキュメントを理解すると、使用している環境で利用可能なリソースを使用するのが簡単になります。

サービス ドキュメント

Web API エンドポイントで GET 要求を実行すると、ご使用の環境のサービス ドキュメントを確認できます。

Web API エンドポイントは、https://yourorg.api.crm.dynamics.com/api/data/v9.2/ のようになります。 この部分: yourorg.api.crm は環境によって異なります。 検索方法については、開発者向けリソースを表示 をご覧ください。

Postman を使用する

推奨された環境設定を持つ Postman を使用している場合は、{{webapiurl}} 環境変数を使用します。

Visual Studio Code で PowerShell を使う

PowerShell と Visual Studio Code のクイックスタート Web API に 前提条件 がインストールされている場合は、Visual Studio Code のサービスドキュメントをこの PowerShell スクリプトを使って、$environmentUrl 変数を編集したとに表示できます。

$environmentUrl = 'https://yourorg.crm.dynamics.com/' # change this
## <a name="login-if-not-already-logged-in"></a>Login if not already logged in
if ($null -eq (Get-AzTenant -ErrorAction SilentlyContinue)) {
   Connect-AzAccount | Out-Null
}
# <a name="get-an-access-token"></a>Get an access token
$token = (Get-AzAccessToken -ResourceUrl $environmentUrl).Token
# <a name="common-headers"></a>Common headers
$baseHeaders = @{
   'Authorization'    = 'Bearer ' + $token
   'Accept'           = 'application/json'
   'OData-MaxVersion' = '4.0'
   'OData-Version'    = '4.0'
}
# <a name="view-service-document"></a>View service document
Invoke-RestMethod -Uri ($environmentUrl + 'api/data/v9.2/') -Method 'Get' -Headers $baseHeaders
| ConvertTo-Json | Out-File -FilePath "service-document.json"
code "service-document.json"

これが機能しない場合は、Quick Start Web API with PowerShell と Visual Studio Code でのクイックスタート Web API の トラブルシューティング ステップ

ブラウザーを使用する

ブラウザを使用して GET リクエストを送信します。 ブラウザのアドレス バーに Web API エンドポイント URL を入力します。

ヒント

簡単に読めるように返された JSON をフォーマットするブラウザ拡張子をインストールし、その後 Microsoft Edge を使用している場合は、JSON フォーマッター を使った拡張子を検索します。

次のような結果が表示されます。

{
    "@odata.context": "https://yourorg.api.crm.dynamics.com/api/data/v9.2/$metadata",
    "value": [
        {
            "name": "accountleadscollection",
            "kind": "EntitySet",
            "url": "accountleadscollection"
        },
        {
            "name": "accounts",
            "kind": "EntitySet",
            "url": "accounts"
        },
    ...

サービス ドキュメントには、ご使用中の環境で使用可能なすべての EntitySets の一覧が含まれます。 EntitySet は、Dataverse でテーブルを参照するリソースの名前です。 URL のエンティティ セット名を使用して、特定のテーブルのデータに対して操作を実行します。

ヒント

このドキュメントで Ctrl+F を使用して、正しいエンティティ セット名を検索します。

エンティティ セット名

論理コレクション名ではなく、常にエンティティ セット名を使用してください。 デフォルトでは、エンティティ セット名はテーブル EntityMetadata.LogicalCollectionName プロパティ値と一致しますが、これに依存しないでください。

エンティティ セット名の変更

異なるエンティティ セット名を使用して対応したいユーザー定義エンティティがある場合、異なる名前を使用するようにテーブル EntityMetadata.EntitySetName プロパティの値を更新できます。 変更できるテーブルのプロパティについて学ぶ

重要

作成するとき、およびテーブルを使用してコードが作成される前に、テーブルの EntitySetName のみを変更します。 古い名前を使用していたコードはすべて壊れます。

CSDL $metadata ドキュメント

$metadata を Web API エンドポイントに追加して、一般スキーマ定義言語 (CSDL) $metadata ドキュメントを取得します。

例: https://yourorg.api.crm.dynamics.com/api/data/v9.2/$metadata

この XML ドキュメントでは、環境で使用できるすべてのテーブルと操作について説明します。

これらの手順 を使用して、Visual Studio Code と Powershell を使用した CSDL $metadata ドキュメントをダウンロードできます。

重要

このドキュメントは、Web API に関連するすべての情報源です。 頻繁に参照することをお勧めします。 このドキュメントに Ctrl+F を使用して、必要となる特定の EntityType、Action、Function、ComplexType、または EnumType を検索します。 名前は大文字と小文字が区別されます。

メタデータの注釈

$metadata から他の情報を取得するには、?annotations=true を URL に追加します。

例: https://yourorg.api.crm.dynamics.com/api/data/v9.2/$metadata?annotations=true

このパラメーターの設定には、役に立つさまざまな注釈が含まれます。 ほとんどの注釈は、ドキュメントの合計サイズが大きくなるため、既定では含まれていません。

Prefer: odata.include-annotations="*" 要求ヘッダーを追加することで、これらの注釈を返すこともできます。 この要求ヘッダーは、他のタイプの要求でも機能します。 annotations=true クエリ パラメーターは、$metadata ドキュメントに対してのみ機能します。

サービス名前空間

$metadata の上部近くに、次の XML 要素があります。

    <edmx:DataServices>
        <Schema Namespace="Microsoft.Dynamics.CRM" Alias="mscrm" xmlns="http://docs.oasis-open.org/odata/ns/edm">

この要素により、サービス内のすべての項目が、Microsoft.Dynamics.CRM 名前空間内にあり、mscrm は名前空間のエイリアスであることがわかります。 状況によっては、オブジェクトの完全修飾名を使用する必要があるため、名前空間の値を使用する必要があります。

次の手順

エンティティ型について説明します。

エンティティ型

参照

Web API の種類および操作
Web API エンティティの種類
Web API プロパティ
Web API ナビゲーション プロパティ
Web API アクション
Web API 関数
Web API の複合型および列挙の種類
Dataverse Web API を使用する

注意

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

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