機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのOracle CX SalesおよびB2B Service REST API for Sales and Fusion ServiceのREST API
  2. さらに学ぶ
  3. RESTクライアントの操作

RESTクライアントの操作

REST APIはHTTPメソッドを使用してコンテンツを送受信するため、HTTPメッセージの送受信をサポートする任意のプログラミング言語またはツールを使用して、REST APIをテストできます。 まず、HTTPリクエストを作成するためのツールを選択します。

ノート:

Oracle REST APIは、OData (Open Data Protocol)に準拠していません。

RESTクライアントの選択に関する考慮事項

Fusion Applicationsと対話する多数のクライアントから、次のようなクライアントを選択できます:
クライアントを使用して、次のタスクを実行できます:
  • REST APIアカウントのユーザー名、パスワードおよびリクエストURLをテストします。
  • RESTリソース、属性およびパラメータについてさらに学習するには、viewおよびdescribeアクションを実行します。
  • 収集された情報を使用して、様々なタイプのHTTPリクエスト(レコードの作成、更新または削除など)を構成および送信します。

cURLを使用してHTTPリクエストを送信する方法

この例では、URL構文を使用してデータを転送する一般的なコマンドライン・ユーティリティであるcURLを使用して、RESTサービスにリクエストを送信します。ほとんどのUNIX、WindowsおよびMacintosh環境では、cURLを使用できます。 詳細は、「WindowsへのcURLコマンドライン・ツールのインストール」を参照してください。

次の表に、RESTサービスに使用できる、一般的に使用されるcURLオプションを示します。

オプション 摘要

-user

username:password

サーバー認証のユーザー名とパスワードを指定します。

-d

指定したデータ(JSONリクエスト本文)をサーバーに送信します。 データを@記号で開始する場合、データの読取り元のファイル名を@の後に付ける必要があります。

-H

リクエストに追加のHTTPヘッダーを指定します。 複数のヘッダーを指定するには、各ヘッダーの前に-Hオプションを付けます。

次に例を示します。
  • Content-Type: リクエスト本文の形式(POSTなど)
  • 受入: レスポンス本文の形式
  • X-Auth-Token: 認証トークン

-output

<file>

stdoutではなくファイルに出力を書き込みます。

-X

HTTPサーバーとの通信時に使用するリクエスト・メソッドを指定します。 デフォルトのメソッドはGETです。

次の表に、cURLを使用したGET、PATCHおよびPOST操作のOracle Applications Cloudの例を示します。

操作 cURLコマンドの例

GETを使用してすべての商談を取得 

curl  -u username:password \
-X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/<version>/opportunities \
-H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'

PATCHを使用して商談を更新 

curl -u username:password \
-X PATCH -d @request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/<version>/opportunities/{OptyNumber} \
-H "Content-Type: application/vnd.oracle.adf.resourceitem+json"

POSTを使用して商談を作成 

curl  -u username:password \
 -X POST -d @request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/<version>/opportunities \
 -H "Content-Type: application/vnd.oracle.adf.resourceitem+json"

クライアントを使用したHTTPリクエストの送信方法

スタンドアロン・クライアント、サードパーティのブラウザ拡張機能、または拡張RESTクライアントなどのアドオンを使用して、HTTPリクエストを送信できます。 次の表に、クライアントを使用したGET、POSTおよびPATCH操作の例を示します。

操作 レスポンス/ペイロードの例

GET: 商談を取得します。

リクエストURL : https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/<version>/opportunities/{OptyNumber}

 
{
  "PrimaryOrganizationId" : 204,
  "CurrencyCode" : "USD",
  "SalesMethodId" : 100000012430001,
  "SalesStageId" : 100000012430007,
  "Name" : "Major Server Upgrade",
  "OptyId" : 300100111705686,
  "OptyNumber" : "CDRM_332708",
  "OwnerResourcePartyId" : 3807,
  "KeyContactId" : 100000016105039,
  "PrimaryRevenueId" : 300100111705687,
  "SalesMethod" : "Standard Sales Process",
  "SalesStage" : "01 - Qualification",
  "DescriptionText" : "Looking for the Right Contacts, Characteristics, Determining the Need, Budget and Sponsor",
  "AverageDaysAtStage" : 30,
  "MaximumDaysInStage" : 800,
  "PhaseCd" : "QUALIFICATION-DISCOVERY",
  "ForecastOverrideCode" : "CRITERIA",
  "SalesChannelCd" : "ZPM_DIRECT_CHANNEL_TYPES",
...
}

POST: 新しい商談を作成します。

リクエストURL : https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/<version>/opportunities

 
{
BudgetAvailableDate: null
BudgetedFlag: false
PrimaryOrganizationId: 204
ChampionFlag: false
CreatedBy: "SALES_ADMIN"
CreationDate: "2015-06-04T03:08:27-07:00"
CurrencyCode: "USD"
SalesMethodId: 100000012430001
SalesStageId: 100000012430007
Name: "Major Application Upgrade"
OptyId: 300100111705686
OptyNumber: "CDRM_332708"
OwnerResourcePartyId: 3807
StatusCode: "OPEN"
PrimaryRevenueId: 300100111705687
SalesMethod: "Standard Sales Process"
SalesStage: "01 - Qualification"
DescriptionText: "Looking for the Right Contacts, Characteristics, Determining the Need, Budget and Sponsor"
AverageDaysAtStage: 30
MaximumDaysInStage: 800
PhaseCd: "QUALIFICATION-DISCOVERY"
QuotaFactor: 3
RcmndWinProb: 0
StageStatusCd: "OPEN"
StgOrder: 1
EffectiveDate: "2015-06-24"
Revenue: 0
WinProb: 0
PartyName1: "Charles Taylor"
DownsideAmount: 0
UpsideAmount: 0
EmailAddress: "firstname_lastname@orcl.com"
ExpectAmount: 0
ForecastOverrideCode: "CRITERIA"
SalesChannelCd: "ZPM_DIRECT_CHANNEL_TYPES"
...
}

ノート:

NULL値を渡すにはNullを使用します。 ""を渡すとエラーがスローされます。

PATCH: 商談の担当者を更新します。

リクエストURL : https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/<version>/opportunities/{Optynumber}/child/OpportunityContact/{OptyConId}

 
{
OptyConId: 300100092629555,
CreatedBy: "MHoope",
ContactedFlg: "N",
CreationDate: "2016-11-17T05:54:14-08:00",
OptyId: 300100092516122,
PERPartyId: 100000016934214,
PrimaryFlg: "N",
PartyName: "Matt Baird",
OptyConId: 300100092629899,
EmailAddress: "mbaird@oracle.com",
ContactPointId: 300100026717170,
FormattedAddress: "South Avenue,MANHATTAN, NY 10005",
FormattedPhoneNumber: "+1 (640) 345-3456 x6567",
DoNotContactFlag: false,
ContactPartyNumber: 100000016934213,
RoleCd: "SECONDARY_DECISION_MAKER",
...
}

クライアントの動作を理解し、次に、レコードに関する情報を作成、更新、検証および取得する方法を示すサンプル・ワークフローについて「販売レコードの管理」を確認できます。