ID でリードまたは営業案件を取得する

2024-09-30

この記事では、リードまたは共同販売の機会を ID で取得する方法について説明します。

Note

Microsoft コマーシャルマーケットプレース (Azure Marketplace および AppSource) から受信したリードはサポートされていません。

前提条件

Referrals API 認証で説明されている資格情報。このシナリオでは、アプリとユーザーの資格情報を使用した認証がサポートされます。
現在、この API では、パートナーが紹介管理者または紹介ユーザーのいずれかのロールに含まれている必要があるユーザーアクセスのみがサポートされています。

REST 要求

要求の構文

認証方法	要求 URI
GET	`https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID}`

URI パラメーター

名前	タイプ	Required	内容
id	string	はい	潜在顧客または共同販売機会の一意識別子

要求ヘッダー

詳細については、「 Partner REST ヘッダー」を参照してください。

要求本文

なし。

要求の例

GET https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID} HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json

REST 応答

成功した場合、応答本文には ID と一致するリードまたは営業案件が含まれます。

応答の成功とエラーのコード

各応答には、成功または失敗とデバッグの情報を示す HTTP 状態コードが付属しています。ネットワークトレースツールを使用して、このコード、エラーの種類、およびパラメーターを読み取ります。

応答の例

HTTP/1.1 200 OK
Request-ID: 9f8bed52-e4df-4d0c-9ca6-929a187b0731
Content-Type: application/json

{
    "@odata.context": "https://api.partner.microsoft.com/v1.0/engagments/referrals/$metadata#Referrals/$entity",
    "id": "c5fbb3b6-be74-4795-9fb5-4324c73fed37",
    "engagementId": "65edc0b5-3485-41b7-a17e-dfa9ef4706e2",
    "organizationId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
    "organizationName": "Contoso Company",
    "createdDateTime": "2020-10-30T21:03:00.0000000Z",
    "updatedDateTime": "2020-10-30T21:03:00.0000000Z",
    "status": "New",
    "substatus": "Pending",
    "qualification": "Direct",
    "type": "Independent",
    "direction": "Incoming",
    "customerProfile": {
      "name": "Fabrikam Customer Inc",
      "address": {
        "addressLine1": "One Microsoft Way",
        "addressLine2": "",
        "city": "Redmond",
        "state": "WA",
        "postalCode": "98052",
        "country": "US"
      }
    },
    "details": {
      "notes": "We are interested in deploying Microsoft 365 and are looking for support in training our employees. Can you help?",
      "dealValue": 10000,
      "currency": "USD",
      "closingDateTime": "2020-12-01T00:00:00Z",
      "requirements": {
          "industries": [ { "id": "Education" } ],
          "products": [ { "id": "Microsoft365" } ],
          "services": [ { "id": "LearningAndCertification" } ],
          "solutions": [ { "id": "SOL-Microsoft365", "name": "Microsoft365" }
        ]
      }
    },
    "links": {
      "relatedReferrals": {
        "uri": "https://api.partner.microsoft.com/v1.0/engagements/referrals$filter=engagementId eq '65edc0b5-3485-41b7-a17e-dfa9ef4706e2'",
        "method": "GET"
      },
      "self": {
        "uri": "https://api.partner.microsoft.com/v1.0/engagements/referralsc5fbb3b6-be74-4795-9fb5-4324c73fed37",
        "method": "GET"
      }
    },
    "eTag": "\"2500ec5a-0000-0000-0000-5bf4967d0000\""
}

Note

この応答例のフィールドは完全ではありません。実際の API 応答には、顧客チームやパートナーチームなど、より多くのフィールドが含まれています。サポートされているフィールドの完全な一覧については、参照リソースを参照してください。

紹介を作成する