Web API の複合型および列挙の種類

  • [アーティクル]

CSDL $metadata ドキュメント 内に、ComplexType および EnumType 要素があります。

複合型

複合型は、プロパティ セットで構成される、キーを持たない名前付き構造化の種類です。 複合型は、一般的にテーブル定義のプロパティの値や、パラメーター、操作の戻り値として使用されます。

たとえば、WhoAmI Function は、この WhoAmIResponse ComplexType を返します。

<ComplexType Name="WhoAmIResponse">  
  <Property Name="BusinessUnitId" Type="Edm.Guid" Nullable="false" />  
  <Property Name="UserId" Type="Edm.Guid" Nullable="false" />  
  <Property Name="OrganizationId" Type="Edm.Guid" Nullable="false" />  
</ComplexType>

列挙の種類

列挙の種類は、整数を基盤とする名前付き定数の値を持つ名前付きプリミティブの種類です。

たとえば、以下は AccessRights EnumType の定義です

<EnumType Name="AccessRights">  
  <Member Name="None" Value="0" />  
  <Member Name="ReadAccess" Value="1" />  
  <Member Name="WriteAccess" Value="2" />  
  <Member Name="AppendAccess" Value="4" />  
  <Member Name="AppendToAccess" Value="16" />  
  <Member Name="CreateAccess" Value="32" />  
  <Member Name="DeleteAccess" Value="65536" />  
  <Member Name="ShareAccess" Value="262144" />  
  <Member Name="AssignAccess" Value="524288" />  
</EnumType>

AccessRights 列挙型は、PrincipalAccess ComplexType の AccessMask プロパティに使用され、ModifyAccess Action の PrincipalAccess パラメーターを設定するために使用します。 これは、レコードを共有するときにアクセスを変更するために使用するアクションです。

以下の例では、ReadAccess、WriteAccess、DeleteAccess、AppendAccess、および AssignAccess へのアクセス権を、PrincipalAccess 複合型の Principal プロパティが指定した systemuser に対して Target パラメーターが特定した account レコードに許諾します。

要求:

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

{
    "Target": {
        "accountid": "cbcf8bbc-aa41-ec11-8c62-000d3a53893c",
        "@odata.type": "Microsoft.Dynamics.CRM.account"
    },
    "PrincipalAccess": {
        "Principal": {
            "systemuserid": "8061643d-ebf7-e811-a974-000d3a1e1c9a",
            "@odata.type": "Microsoft.Dynamics.CRM.systemuser"
        },
        "AccessMask": "ReadAccess,WriteAccess,DeleteAccess,AppendAccess,AssignAccess"
    }
}

応答:

HTTP/1.1 204 No Content

次の手順

Web API を使用して演算を実行します。

Web API を使用して演算を実行する

参照

Web API の種類および操作
Web API サービス ドキュメント
Web API EntityTypes
Web API プロパティ
Web API ナビゲーション プロパティ
Web API アクション
Web API 関数
Dataverse Web API を使用する
OData バージョン 4.0 複合型
OData バージョン 4.0 列挙の種類

注意

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

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