機械翻訳について

Oracle CXレコードの管理

Oracle CX REST APIは、サード・パーティ・アプリケーションとの統合を容易にします。 「REST APIエンドポイント」をチェックして、各Oracle CX APIで使用可能なメソッドを確認します。 これらのAPIの操作方法を理解するには、次のタスクを実行します:
  1. Oracle CXのバージョンの取得
  2. リソースのリストの取得
  3. レコードの作成
  4. レコードの取得
  5. 検索を使用したレコードの取得
  6. レコードの更新

Oracle CXのバージョンの取得

まず、Oracle CXのインスタンスでサポートされるREST APIバージョンを入手しましょう。

サポートされているバージョンのリストについて、次のURLを使用してGETリクエストを送信します。

URLの例

メソッド: GET

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/

レスポンスの例

JSON形式のレスポンス本文の例を次に示します。

{
"items": [
  	{
"version": "11.13.18.05",
"isLatest": true,
"adf:extension": {
...
},
"links": [],
},
  {
"version": "11.13.17.11",
"adf:extension": {
...
},
"links": [],
},
  {
"version": "11.13.17.08",
"adf:extension": {
...
},
"links": [],
},
...
	}

次のサンプル・タスク・セットでは、バージョンとして11.13.18.05を使用します。

リソースのリストの取得

次に、使用しているバージョンのOracle CXサービスで使用可能なリソースのリストをプログラムで取得します。 リストを取得するには、次のURLを使用してGETリクエストを送信します。

URLの例

メソッド: GET

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/describe

Oracle CXに関連付けられているcrmRestApiコンテナのリソースのリストが表示されることに注意してください。

レスポンスの例

アクセス可能なリソースのリストを含むレスポンスの例を次に示します:

{
"Resources": {
"competitors": {
...
},
"wrapUps": {
...
},
"presentationSessions": {
...
},
"activities": {
...
},
"opportunities": {
...
},
...
	}

操作するリソースに注意してください。 次のサンプル・タスク・セットについては、Opportunitiesリソースを使用します。

レコードの作成

商談リソースを使用して商談を作成することから始めましょう。

POSTメソッドを使用して、Big Data Analytics Serversという名前の商談を作成します。

その他のリソースについては、それぞれの作成セクションを参照して、作成に必要な属性を確認してください。 このセクションには、サンプル・リクエストおよびレスポンスもあります。

URLの例

このリソースURL形式を使用します。

メソッド: POST

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities

リクエストの例

JSON形式のリクエスト本文の例を次に示します。

{
"Name" : "Big Data Analytics Servers"
}

レスポンスの例

JSON形式のレスポンス本文の例を次に示します。

{
"items": [
  {
"BudgetAvailableDate": null,
"BudgetedFlag": false,
"PrimaryOrganizationId": 204,
"ChampionFlag": false,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2018-01-08T12:00:24.972+00:00",
"CurrencyCode": "USD",
"SalesMethodId": 300100073102472,
"SalesStageId": 300100073102473,
"CustomerAccountId": null,
"DealHorizonCode": null,
"DecisionLevelCode": null,
"Description": null,
"LastUpdateDate": "2018-01-08T12:24:05.310+00:00",
"LastUpdatedBy": "SALES_ADMIN",
"LastUpdateLogin": "6242B5ED93BE3EC9E0539EBDF20ABB8B",
"Name": "Big Data Analytics Servers",
"OptyId": 300100125332293,
"OptyNumber": "CDRM_93472",
"OwnerResourcePartyId": 100010025532672,
"PrimaryCompetitorId": null,
"KeyContactId": null,
"ReasonWonLostCode": null,
"RiskLevelCode": null,
"StatusCode": "OPEN",
"StrategicLevelCode": null,
"PrimaryRevenueId": 300100125332294,
"TargetPartyId": 300100125332282,
"TargetPartyName": "Vision Corporation",
"SalesMethod": "Sales Process",
"SalesStage": "Stage1",
"DescriptionText": "Stage1",
"AverageDaysAtStage": null,
"MaximumDaysInStage": null,
"PhaseCd": "QUALIFICATION",
"QuotaFactor": 0,
...
}

また、レコードが作成されたことを示すレスポンス・コード201も取得します。

レコードの取得

ここで、作成した商談レコードを取得します。

レコードを取得する前に、そのレコードの一意の識別子を知っておく必要があります。 これは、リソースのすべてのレコードをリストすることで取得できます。

このURLとともにGETメソッドを使用して、すべての商談レコードをリストします。

URLの例

このリソースURL形式を使用します。

メソッド: GET

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities

レスポンスの例

JSON形式のレスポンス本文の例を、アクセスできる商談のリストとともに次に示します:

{
"items": [
  {
"BudgetAvailableDate": null,
"BudgetedFlag": false,
"PrimaryOrganizationId": 204,
"ChampionFlag": false,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2018-01-08T12:00:24.972+00:00",
"CurrencyCode": "USD",
"SalesMethodId": 300100073102472,
"SalesStageId": 300100073102473,
"CustomerAccountId": null,
"DealHorizonCode": null,
"DecisionLevelCode": null,
"Description": null,
"LastUpdateDate": "2018-01-08T12:24:05.310+00:00",
"LastUpdatedBy": "SALES_ADMIN",
"LastUpdateLogin": "6242B5ED93BE3EC9E0539EBDF20ABB8B",
"Name": "Big Data Analytics Servers",
"OptyId": 300100125332293,
"OptyNumber": "CDRM_93472",
"OwnerResourcePartyId": 100010025532672,
"PrimaryCompetitorId": null,
"KeyContactId": null,
"ReasonWonLostCode": null,
"RiskLevelCode": null,
"StatusCode": "OPEN",
"StrategicLevelCode": null,
"PrimaryRevenueId": 300100125332294,
"TargetPartyId": 300100125332282,
"TargetPartyName": "Vision Corporation",
"SalesMethod": "Sales Process",
"SalesStage": "Stage1",
"DescriptionText": "Accelerated sales process - stage 1",
"AverageDaysAtStage": null,
"MaximumDaysInStage": null,
"PhaseCd": "QUALIFICATION",
"QuotaFactor": 0,
...,
},
 {
"BudgetAvailableDate": null,
"BudgetedFlag": false,
"PrimaryOrganizationId": 204,
"ChampionFlag": false,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2018-01-03T04:02:30.801+00:00",
"CurrencyCode": "USD",
"SalesMethodId": 300100073102472,
"SalesStageId": 300100073102473,
"CustomerAccountId": null,
"DealHorizonCode": null,
"DecisionLevelCode": null,
"Description": null,
"LastUpdateDate": "2018-01-03T04:04:37.956+00:00",
"LastUpdatedBy": "SALES_ADMIN",
"LastUpdateLogin": "61D4E597C30B4BA8E0539EBDF20A589F",
"Name": "SaSS Application Suite",
"OptyId": 300100125073393,
"OptyNumber": "CDRM_91468",
"OwnerResourcePartyId": 100010025532672,
"PrimaryCompetitorId": null,
"KeyContactId": null,
"ReasonWonLostCode": null,
"RiskLevelCode": null,
"StatusCode": "OPEN",
"StrategicLevelCode": null,
"PrimaryRevenueId": 300100125073394,
"TargetPartyId": 300100124384171,
"TargetPartyName": "Pinnacle Technologies",
"SalesMethod": "Sales Process",
"SalesStage": "Stage4",
"DescriptionText": "Awaiting closure.",
"AverageDaysAtStage": null,
"MaximumDaysInStage": null,
"PhaseCd": "QUALIFICATION",
"QuotaFactor": 0,
...,
},
...

商談のリストをスクロールして、使用する商談を検索し、パス・パラメータ値をノートにとる必要があります。 パス・パラメータは、レコードの一意の識別子です。 これを使用して、get、updateまたは削除メソッドを実行するレコードを指定します。 ここで、パス・パラメータは商談番号(OptyNumber)です。 リソースのパス・パラメータの詳細は、「すべてのRESTエンドポイント」を参照してください。

その後、リソースの使用可能なすべてのレコードを表示できます。 使用するレコードを識別し、そのパス・パラメータ値を書き留める必要があります。 この例では、パス・パラメータは商談番号(OptyNumber)です。 リソースのパス・パラメータの詳細は、「すべてのRESTエンドポイント」を参照してください。

検索を使用したレコードの取得

特定のレコードを検索する簡単な方法は、ファインダおよびファインダ変数を使用して問い合せることです。 いずれかのファインダを使用し、ファインダ変数に基準を入力するだけです。 ここでは、ファインダMyOpportunitiesFinderおよびファインダ変数nameを使用して、特定の名前(Big Data Analytics Server)の商談を取得します。

URLの例

このリソースURL形式を使用します。

メソッド: GET

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities?finder=MyOpportunitiesFinder;Name=Big Data Analytics Servers

詳細は、各リソースのGet Allメソッド・ドキュメントのFindersセクションを参照してください。

レスポンスの例

JSON形式のレスポンス本文の例を次に示します。

{
"items": [
  {
"BudgetAvailableDate": null,
"BudgetedFlag": false,
"PrimaryOrganizationId": 204,
"ChampionFlag": false,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2018-01-08T12:00:24.972+00:00",
"CurrencyCode": "USD",
"SalesMethodId": 300100073102472,
"SalesStageId": 300100073102473,
"CustomerAccountId": null,
"DealHorizonCode": null,
"DecisionLevelCode": null,
"Description": null,
"LastUpdateDate": "2018-01-08T12:24:05.310+00:00",
"LastUpdatedBy": "SALES_ADMIN",
"LastUpdateLogin": "6242B5ED93BE3EC9E0539EBDF20ABB8B",
"Name": "Big Data Analytics Servers",
"OptyId": 300100125332293,
"OptyNumber": "CDRM_93472",
"OwnerResourcePartyId": 100010025532672,
"PrimaryCompetitorId": null,
"KeyContactId": null,
"ReasonWonLostCode": null,
"RiskLevelCode": null,
"StatusCode": "OPEN",
"StrategicLevelCode": null,
"PrimaryRevenueId": 300100125332294,
"TargetPartyId": 300100125332282,
"TargetPartyName": "Vision Corporation",
"SalesMethod": "Sales Process",
"SalesStage": "Stage1",
"DescriptionText": "Stage1",
"AverageDaysAtStage": null,
"MaximumDaysInStage": null,
"PhaseCd": "QUALIFICATION",
"QuotaFactor": 0,
...
}

レコードの検索の詳細は、「回収の管理」を参照してください。

レコードの更新

前に作成したレコードを更新してみましょう。 OptyNumberを使用してレコードを識別し、PATCHメソッドを使用してレコードを更新します。

リクエストの例

このリソースURL形式を使用します。

メソッド: PUT

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_93472

レコードを更新するには、リクエスト本文に追加するフィールドを指定します。 商談のsales stageを更新するリクエスト本文を次に示します。

リクエスト本文の例

JSON形式のリクエスト本文の例を次に示します。

{
 "SalesStage": "Stage2",
 "DescriptionText": "The Opportunity is in the discovery stage."
}

レスポンスの例

JSON形式のレスポンス本文の例を次に示します。

{
"BudgetAvailableDate": null,
"BudgetedFlag": false,
"PrimaryOrganizationId": 204,
"ChampionFlag": false,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2018-01-08T12:00:24.972+00:00",
"CurrencyCode": "USD",
"SalesMethodId": 300100073102472,
"SalesStageId": 300100073102473,
"CustomerAccountId": null,
"DealHorizonCode": null,
"DecisionLevelCode": null,
"Description": null,
"LastUpdateDate": "2018-01-16T15:03:59.677+00:00",
"LastUpdatedBy": "SALES_ADMIN",
"LastUpdateLogin": "62E62B8DB84D16B5E0539EBDF20A5B9D",
"Name": "Big Data Analytics Servers",
"OptyId": 300100125332293,
"OptyNumber": "CDRM_93472",
"OwnerResourcePartyId": 100010025532672,
"PrimaryCompetitorId": null,
"KeyContactId": null,
"ReasonWonLostCode": null,
"RiskLevelCode": null,
"StatusCode": "OPEN",
"StrategicLevelCode": null,
"PrimaryRevenueId": 300100125332294,
"TargetPartyId": 300100125332282,
"TargetPartyName": "Vision Corporation",
"SalesMethod": "Sales Process",
"SalesStage": "Stage2",
"DescriptionText": "The Opportunity is in the discovery stage.",
"AverageDaysAtStage": null,
"MaximumDaysInStage": null,
"PhaseCd": "QUALIFICATION",
"QuotaFactor": 0,
...
}

レコードが更新されたかどうかを確認するには、前のセクションで行ったようにレコードを取得します。

おめでとうございます! Oracle REST APIを使用してレコードを正常に作成、更新および検証しました。