Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

カスタムOracle CXオブジェクトの操作

このユース・ケースでは、REST APIを使用してカスタムOracle CXオブジェクトを表示する方法の例を見つけることができます。

例: トラブル・チケットおよび割当を表示

共通コンテナcrmRestApiで作成されたトラブル・チケットというカスタム・オブジェクト・リソースについて考えてみます。トラブル・チケット・カスタム・オブジェクトには、割当というカスタム子オブジェクトがあります。公開一意識別子(PUID)を使用してレコードをフェッチできます。この例では、PUIDであるRecordNumberを使用します。

トラブル・チケット

トラブル・チケットを使用して、様々なタイプの問題の検出、レポートおよび解決を追跡します。トラブル・チケット・オブジェクトを使用すると、トラブル・チケットを表示、作成、または変更できます。 PUIDとしてRecordNumberを使用して、特定のレコードを取得できます。ただし、qパラメータとともに使用する必要があります。

リソース複数ラベル	トラブル・チケット
リソース名	トラブル・チケット
API名	TroubleTicket_c

タスク

次の表に、このリソースでサポートされているタスクを示します。

タスク	リクエスト	URI
すべてのトラブル・チケットを取得	GET	/crmRestApi/resources/<version>/TroubleTicket_c/
トラブル・チケットを入手	GET	/crmRestApi/resources/<version>/TroubleTicket_c?q=RecordNumber=<recordnumber>
トラブル・チケットの作成	POST	/crmRestApi/resources/<version>/TroubleTicket_c/
トラブル・チケットを更新	PATCH	/crmRestApi/resources/<version>/TroubleTicket_c/TroubleTicket_c?q=RecordNumber=<recordnumber>
トラブル・チケットを削除	DELETE	/crmRestApi/resources/<version>/TroubleTicket_c/TroubleTicket_c?q=RecordNumber=<recordnumber>

URLの例

次に、リソースURLの形式を示します。

DESCRIBE

/crmRestApi/resources/<version>/TroubleTicket_c/

レスポンスの例

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

{
  "Resources" : 
   {
    "TroubleTicket_c" : 
     {
      "discrColumnType" : false,
      "title" : "TroubleTicket",
      "titlePlural" : "TroubleTicket",
      "attributes" : 
        [{
          "name" : "Id",
          "type" : "integer",
...
"item" : 
   {
          "links" : 
           [{
             "rel" : "child",
             "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/
                       resources/11.13.18.05/TroubleTicket_c/<id>/child/
                       AssignmentCollection_c",
             "name" : "AssignmentCollection_c",
             "kind" : "collection",
             "cardinality" : 
               {
               "value" : "1 to *",
               "sourceAttributes" : "Id",
               "destinationAttributes" : "TroubleTicket_Id_c"
               }
              ...
             }]
   ...
}

トラブル・チケット: 割当

割当子オブジェクトは、トラブル・チケットの割当情報を表示、作成または変更するために使用されます。

リソース複数ラベル	アサイメント
リソース名	アサイメント
API名	Assignment_c

タスク

次の表に、このリソースでサポートされているタスクを示します。

タスク	リクエスト	URI
すべての割当の取得	GET	/crmRestApi/resources/<version>/TroubleTicket_c/<id>/child/AssignmentCollection_c
割当の取得	GET	/crmRestApi/resources/<version>/TroubleTicket_c/<id>/child/AssignmentCollection_c/<id>
割当の作成	POST	/crmRestApi/resources/<version>/TroubleTicket_c/child/AssignmentCollection_c
アサイメントの更新	PATCH	/crmRestApi/resources/<version>/TroubleTicket_c/<id>/child/AssignmentCollection_c/<id>
割当の削除	DELETE	/crmRestApi/resources/<version>/TroubleTicket_c/<id>/child/AssignmentCollection_c/<id>

トラブル・チケットおよびパートナを表示

crmRestApiコンテナに作成された、パートナおよびトラブル・チケットの2つのオブジェクト・リソースについて考えてみます。 2つのオブジェクト間に1対多の参照関係が存在します。トラブル・チケット・オブジェクト・リソースに対するdescribe操作には、パートナ・オブジェクト・リソースへの外部キーPartnerProfile_Id_Partner_TTが含まれます。

URLの例

次に、リソースURLの形式を示します。

DESCRIBE

/crmRestApi/resources/<version>/TroubleTicket_c/<id>/child/AssignmentCollection_c

{
  "name" : "PartnerProfile_Id_Partner_TT",
  "type" : "integer",
  "updatable" : true,
  "mandatory" : false,
  "queryable" : false,
  "allowChanges" : "always",
  "precision" : 18,
  "properties" : 
    {
"ExtensibilityAnnotation" : "ViewAttribute added by Extensibility",
      "Indexed" : "Y",
      "AttributeType" : "ForeignKey",
      "ATTR_INTERNAL_USE" : "Y",
      "ExtensibilitySystemAttribute" : "ForeignKey",
      "ExtnCustom" : "Y"
     }
  ... 
}

トラブル・チケット・レスポンス・ペイロードの外部キー属性には、関連付けられているパートナの主キー属性値が含まれます。たとえば、ID 300100071287969のトラブル・チケットのレスポンス・ペイロードのPartnerProfile_Id_Partner_TT値は300010001256です。

{
  "Id" : 300100071287969,
  "RowType" : "TroubleTicket_1201_c",
  "RecordName" : "TT-000001-150814",
  "CurcyConvRateType" : "Corporate",
  "CorpCurrencyCode" : "USD",
  "SourceType" : "TROUBLETICKET_1201_C",
  "AttachmentEntityName" : "TroubleTicket_1201_c",
  "PKProxy" : "300100071287969",
  "Status_c" : "In-Progress",
  "PartnerProfile_Id_Partner_TT" : 300010001256,
...
}