転送を作成するCreate a transfer

適用対象:Applies to:

  • パートナー センターPartner Center

前提条件Prerequisites

  • パートナー センターの認証に関するページで説明している資格情報。Credentials as described in Partner Center authentication. このシナリオでは、スタンドアロンアプリとアプリ + ユーザー資格情報の両方を使用した認証がサポートされています。This scenario supports authentication with both standalone App and App+User credentials.

  • 顧客 ID です (customer-tenant-id)。A customer ID (customer-tenant-id). お客様の ID がわからない場合は、パートナー センターのダッシュボードで検索できます。If you don't know the customer's ID, you can look it up in the Partner Center dashboard. パートナー センター メニューの [CSP] を選択し、 [顧客] を選択します。Select CSP from the Partner Center menu, followed by Customers. 顧客一覧からお客様を選び、 [アカウント] を選択します。Select the customer from the customer list, then select Account. お客様のアカウント ページで、 [顧客のアカウント情報] セクションの Microsoft ID を探します。On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。The Microsoft ID is the same as the customer ID (customer-tenant-id).

REST 要求REST request

要求の構文Request syntax

認証方法Method 要求 URIRequest URI
POSTPOST {baseURL}/v1/customers/{customer-id}/transfers HTTP/1.1{baseURL}/v1/customers/{customer-id}/transfers HTTP/1.1

URI パラメーターURI parameter

次のパス パラメーターを使用して顧客を指定します。Use the following path parameter to identify the customer.

名前Name TypeType 必須Required 説明Description
顧客 idcustomer-id stringstring はいYes 顧客を識別する GUID 形式の顧客 id。A GUID formatted customer-id that identifies the customer.

要求ヘッダーRequest headers

詳細については、「パートナー センター REST ヘッダー」を参照してください。For more information, see Partner Center REST headers.

[要求本文]Request body

次の表では、要求本文のTransferentityプロパティについて説明します。This table describes the TransferEntity properties in the request body.

プロパティProperty TypeType 必須Required 説明Description
idid 文字列string いいえNo TransferEntity が正常に作成されたときに提供される transferEntity 識別子。A transferEntity identifier that is supplied upon successful creation of the transferEntity.
createdTimecreatedTime DateTimeDateTime いいえNo TransferEntity が作成された日付 (日付/時刻形式)。The date the transferEntity was created, in date-time format. TransferEntity の作成が正常に完了したときに適用されます。Applied upon successful creation of the transferEntity.
lastModifiedTimelastModifiedTime DateTimeDateTime いいえNo TransferEntity が最後に更新された日付 (日付/時刻形式)。The date the transferEntity was last updated, in date-time format. TransferEntity の作成が正常に完了したときに適用されます。Applied upon successful creation of the transferEntity.
lastModifiedUserlastModifiedUser 文字列string いいえNo TransferEntity を最後に更新したユーザー。The user who last updated the transferEntity. TransferEntity の作成が正常に完了したときに適用されます。Applied upon successful creation of transferEntity.
customerNamecustomerName 文字列string いいえNo 省略可能。Optional. サブスクリプションを転送する顧客の名前。The name of the customer whose subscriptions are being transferred.
顧客 TenantidcustomerTenantId 文字列string いいえNo 顧客を識別する GUID 形式の顧客 id。A GUID formatted customer-id that identifies the customer. TransferEntity の作成が正常に完了したときに適用されます。Applied upon successful creation of the transferEntity.
partnertenantidpartnertenantid 文字列string いいえNo パートナーを識別する GUID 形式のパートナー id。A GUID formatted partner-id that identifies the partner.
sourcePartnerNamesourcePartnerName 文字列string いいえNo 省略可能。Optional. 譲渡を開始するパートナー組織の名前。The name of the partner's organization who is initiating the transfer.
sourcePartnerTenantIdsourcePartnerTenantId stringstring はいYes 転送を開始するパートナーを識別する GUID 形式のパートナー id。A GUID formatted partner-id that identifies the partner initiating the transfer.
targetPartnerNametargetPartnerName 文字列string いいえNo 省略可能。Optional. 譲渡の対象となるパートナーの組織の名前。The name of the partner's organization to whom the transfer is targeted.
targetPartnerTenantIdtargetPartnerTenantId stringstring はいYes 転送の対象となるパートナーを識別する GUID 形式のパートナー id。A GUID formatted partner-id that identifies the partner to whom the transfer is targeted.
lineItemslineItems オブジェクトの配列Array of objects はいYes Transferlineitemリソースの配列。An Array of TransferLineItem resources.
状態status stringstring いいえNo TransferEntity の状態。The status of the transferEntity. 有効な値は、"アクティブ" (削除/送信可能) および "完了" (既に完了している) です。Possible values are "Active" (can be deleted/submitted) and "Completed" (has already been completed). TransferEntity の作成が正常に完了したときに適用されます。Applied upon successful creation of the transferEntity.

次の表では、要求本文のTransferlineitemプロパティについて説明します。This table describes the TransferLineItem properties in the request body.

プロパティProperty TypeType 必須Required 説明Description
idid 文字列string NoNo 転送明細項目の一意の識別子。A unique identifier for a transfer line item. TransferEntity の作成が正常に完了したときに適用されます。Applied upon successful creation of the transferEntity.
subscriptionIdsubscriptionId stringstring はいYes サブスクリプションの識別子です。The subscription identifier.
数量quantity INTint いいえNo ライセンスまたはインスタンスの数。The number of licenses or instances.
billingCyclebillingCycle ObjectObject いいえNo 現在の期間に設定されている請求サイクルの種類。The type of billing cycle set for the current period.
friendlyNamefriendlyName 文字列string いいえNo 省略可能。Optional. 明確に区別できるように、パートナーによって定義された項目のフレンドリ名。The friendly name for the item defined by the partner to help disambiguate.
partnerIdOnRecordpartnerIdOnRecord 文字列string NoNo 転送が受け入れられたときに発生する、購入時の PartnerId (MPNID)。PartnerId on Record (MPNID) on the purchase that happens when the transfer is accepted.
offerIdofferId 文字列string NoNo プラン ID。The offer identifier.
addonItemsaddonItems Transferlineitemオブジェクトの一覧List of TransferLineItem objects いいえNo 転送されるベースサブスクリプションと共に転送されるアドオンの transferEntity 行項目のコレクション。A collection of transferEntity line items for addons that will be transferred along with the base subscription that is being transferred. TransferEntity の作成が正常に完了したときに適用されます。Applied upon successful creation of the transferEntity.
transferErrortransferError 文字列string NoNo エラーが発生した場合に transferEntity が受け入れられた後に適用されます。Applied after transferEntity is accepted in case of an error.
状態status 文字列string NoNo TransferEntity 内の lineitem の状態。The status of the lineitem in the transferEntity.

要求の例Request example

POST /v1/customers/d6bf25b7-e0a8-4f2d-a31b-97b55cfc774d/transfers HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 4fa6dad6-a89f-4875-8247-7294a10ae1cf
MS-CorrelationId: 0e93c70c-977c-4a88-9580-7cf084c73286
X-Locale: en-US
Content-Type: application/json
Host: api.partnercenter.microsoft.com
Expect: 100-continue

{
    "sourcePartnerTenantId": "da6c51b5-1246-4a42-b4ab-cbf38df54537",
    "targetPartnerTenantId": "656218b1-80c9-40b2-83ae-3a2703b55271",
    "lineItems": [
        {
            "subscriptionId": "7291BFBF-1772-4C5B-A624-18B6152CD8CB",
            "partnerIdOnRecord": "517285"
        },
        {
            "subscriptionId": "6C0B221B-8DF9-4F4A-A5BB-4C9CBB7B27B0",
            "partnerIdOnRecord": "517285"
        }
    ]
}

REST 応答REST response

成功した場合、このメソッドは、応答本文で設定された転送リソースを返します。If successful, this method returns the populated TransferEnity resource in the response body.

応答の成功とエラーのコードResponse success and error codes

各応答には、成功または失敗を示す HTTP ステータス コードと、追加のデバッグ情報が付属しています。Each response comes with an HTTP status code that indicates success or failure and additional debugging information. このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワーク トレース ツールを使用します。Use a network trace tool to read this code, error type, and additional parameters. 完全な一覧については、エラー コードに関するページを参照してください。For the full list, see Error Codes.

応答の例Response example

HTTP/1.1 201 Created
Content-Length: 138
Content-Type: application/json; charset=utf-8
MS-RequestId: 4fa6dad6-a89f-4875-8247-7294a10ae1cf
MS-CorrelationId: 0e93c70c-977c-4a88-9580-7cf084c73286
X-Locale: en-US,en-US
{
    "id": "67c5b05b-09b5-47ba-9047-5056fe2afa4f",
    "status": "Active",
    "createdTime": "2020-03-24T20:44:14.9602781Z",
    "lastModifiedTime": "2020-03-24T20:44:15Z",
    "customerTenantId": "823c6c3f-9259-4d51-bae2-5dd06743177f",
    "partnertenantid": "da6c51b5-1246-4a42-b4ab-cbf38df54537",
    "sourcePartnerTenantId": "da6c51b5-1246-4a42-b4ab-cbf38df54537",
    "targetPartnerTenantId": "656218b1-80c9-40b2-83ae-3a2703b55271",
    "lastModifiedUser": "d0648481-b615-45c9-8cd1-ff87940dbdc4",
    "lineItems": [
        {
            "id": 0,
            "subscriptionId": "7291BFBF-1772-4C5B-A624-18B6152CD8CB",
            "offerId": "50E9A47A-7B4D-4970-9D90-CAE927F53753",
            "billingCycle": "annual",
            "friendlyName": "Dynamics 365 for Sales Enterprise Attach to Qualifying Dynamics 365 Base Offer",
            "quantity": 1,
            "addonItems": [
                {
                    "id": 0,
                    "subscriptionId": "D738C6C9-DDBD-46E9-B316-65F9D9B3ECB4",
                    "offerId": "2BCF9FE8-8B65-4FCF-9240-419203FB8CF4",
                    "billingCycle": "annual",
                    "friendlyName": "Dynamics 365 - Additional Production Instance (Qualified Offer)",
                    "quantity": 4
                }
            ]
        },
        {
            "id": 0,
            "subscriptionId": "6C0B221B-8DF9-4F4A-A5BB-4C9CBB7B27B0",
            "offerId": "455DDD41-32ED-4E2D-B3A2-BBCB22CAA467",
            "billingCycle": "annual",
            "friendlyName": "Dynamics 365 Customer Engagement Plan Patch",
            "quantity": 8,
            "addonItems": []
        }
    ],
    "links": {
        "self": {
            "uri": "/customers/823c6c3f-9259-4d51-bae2-5dd06743177f/transfers/67c5b05b-09b5-47ba-9047-5056fe2afa4f",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "TransferEntity"
    }
}