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

機械翻訳について

商談売上パートナを取得

get

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/RevenuePartnerPrimary/{RevnPartOrgPartyId}

リクエスト

パス・パラメータ

OptyNumber(required): string

商談の一意の代替識別子。
RevnPartOrgPartyId(required): integer(int64)

商談に関連付けられているパートナ・パーティの一意の識別子。

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : opportunities-RevenuePartnerPrimary-item-response

タイプ: object

ソースを表示

ConflictId: integer (int64)

タイトル: Conflict ID

デフォルト値: 0

モバイル・データベースやサーバーなどの切断されたモバイルの場合に、異なるデータベースに重複が作成される場合に、行の一意性を保証するために使用される値。
CreatedBy: string

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

担当者レコードが作成された日時。
DealEstCloseDate: string (date-time)

タイトル: Deal Registration Estimated Close Date

取引交渉登録がクローズと見積もられる日付。
DealExpirationDate: string (date-time)

タイトル: Expiration Date

取引交渉登録が失効する日付。
DealType: string

タイトル: Type

最大長: 30

取引交渉登録のタイプ。
LastUpdateDate: string (date-time)

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
OptyId: integer (int64)

タイトル: Opportunity ID

商談の一意の識別子。
OptyNumber: string

タイトル: Opportunity Number

最大長: 30

商談の一意の公開識別子である商談の番号。
PartnerCompanyNumber: string

タイトル: Partner Company Number

最大長: 30

パートナの会社の代替キー識別子。
PartnerPartyNumber: string

読取り専用: true

最大長: 30

商談に関連付けられているパートナ・パーティの代替キー識別子。
PartOrgEmailAddress: string

タイトル: Email

読取り専用: true

最大長: 320

この売上のプライマリ・パートナ組織の電子メール・アドレス。
PartOrgFormattedPhoneNumber: string

タイトル: Phone

読取り専用: true

この売上のプライマリ・パートナ組織の電話番号。
PartOrgPartyId: integer (int64)

タイトル: Name

売上に関連付けられているパートナ組織の一意の識別子。
PartProgramId: integer (int64)

タイトル: Program

売上に関連付けられたパートナ・プログラムの一意の識別子。
PartTypeCd: string

タイトル: Type

最大長: 30

商談の要約またはプライマリ売上に関連付けられているパーティのタイプを示すコード。有効な値のリストは、参照PARTNER_PROFILEで定義されます。
PartyId: integer (int64)

読取り専用: true

パートナ・パーティの一意の識別子が商談に関連付けられます。
PartyName: string

タイトル: Partner

最大長: 360

商談に関連付けられているパートナ・パーティの名前。
PartyName1: string

タイトル: Primary Resource

最大長: 360

商談に関連付けられているプライマリ・パートナ・リソースの名前。
PreferredContactEmail: string

タイトル: Contact Email

読取り専用: true

パートナのプライマリ担当者の優先Eメール・アドレス。
PreferredContactName: string

タイトル: Primary Contact

読取り専用: true

パートナのプライマリ担当者の優先名。
PreferredContactPhone: string

タイトル: Contact Phone

読取り専用: true

パートナのプライマリ担当者の優先電話番号。
PrimaryFlg: string

タイトル: Primary

売上パートナが商談のプライマリ売上パートナであるかどうかを示します。
PrPartResourcePartyId: integer (int64)

タイトル: Primary Resource

プライマリ・パートナ・リソースの一意の識別子。
RegistrationNumber: string

タイトル: Registration Number

最大長: 120

取引交渉登録の登録番号。
RegistrationStatus: string

タイトル: Registration Status

最大長: 30

商談または取引を作成したパートナの登録ステータス。
RevnId: integer (int64)

商談の要約またはプライマリ売上の一意の識別子。
RevnPartnerNumber: string

タイトル: Opportunity Partner Number

最大長: 30

パートナ・レコードのパーティ番号。
RevnPartOrgPartyId: integer (int64)

商談に関連付けられているパートナ・パーティの一意の識別子。

{
    "type":"object",
    "properties":{
        "PartTypeCd":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the party associated with the summary or primary revenue of the opportunity. A list of valid values is defined in the lookup PARTNER_PROFILE.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "Dependencies":"PartyName"
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the contact record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartOrgEmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the primary partner organization for this revenue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "PreferredContactEmail":{
            "title":"Contact Email",
            "type":"string",
            "description":"The preferred e-mail address of the partner???s primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyName":{
            "title":"Partner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the partner party associated with the opportunity.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "PreferredContactName":{
            "title":"Primary Contact",
            "type":"string",
            "description":"The preferred name of the partner???s primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryFlg":{
            "title":"Primary",
            "type":"string",
            "description":"Indicates whether the Revenue Partner is the primary Revenue Partner for the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartOrgPartyId"
                ]
            }
        },
        "PartnerPartyNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the partner party associated with the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName1":{
            "title":"Primary Resource",
            "maxLength":360,
            "type":"string",
            "description":"The name of the primary partner resource associated with the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RegistrationNumber":{
            "title":"Registration Number",
            "maxLength":120,
            "type":"string",
            "description":"The registration number of the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredContactPhone":{
            "title":"Contact Phone",
            "type":"string",
            "description":"The preferred phone number of the partner???s primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the opportunity which is the unique public identifier of the opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DealEstCloseDate":{
            "title":"Deal Registration Estimated Close Date",
            "type":"string",
            "description":"The date when the deal registration is estimated to close.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DealType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RegistrationStatus":{
            "title":"Registration Status",
            "maxLength":30,
            "type":"string",
            "description":"The registration status of the partner who create the opportunity or deal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartOrgFormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the primary partner organization for this revenue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DealExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the deal registration will expire.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevnPartnerNumber":{
            "title":"Opportunity Partner Number",
            "maxLength":30,
            "type":"string",
            "description":"The party number of the partner record.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PartOrgPartyId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of the partner organization associated with the revenue.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"Partner",
                "RecentItemEntityName":"partners"
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the partner party is associated with the opportunity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RevnId":{
            "type":"integer",
            "description":"The unique identifier of the summary or primary revenue for the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PrPartResourcePartyId":{
            "title":"Primary Resource",
            "type":"integer",
            "description":"The unique identifier of the primary partner resource.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartProgramId":{
            "title":"Program",
            "type":"integer",
            "description":"The unique identifier of the partner program associated with the revenue.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "Dependencies":"PartyName"
            }
        },
        "PartnerCompanyNumber":{
            "title":"Partner Company Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the partner's company.",
            "nullable":false,
            "x-queryable":true
        },
        "RevnPartOrgPartyId":{
            "type":"integer",
            "description":"The unique identifier of the partner party associated with the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

リンク

DealTypeVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKL_DEAL_TYPE%2CBindLookupCode%3D{DealType}

参照リソースは、標準参照コードの表示に使用されます。

PartnerDimensionMemberVA

操作: /crmRestApi/resources/11.13.18.05/partnerTypesLOV

パラメータ:

ファインダ: PartnerTypesFinder%3BOwnerId%3D{PartOrgPartyId}

パートナと共有されるビジネス関係のリスト。

PartnerEnrolledProgramsVA

操作: /crmRestApi/resources/11.13.18.05/partnerEnrolledProgramsLOV

パラメータ:

ファインダ: PartnerEnrolledProgramsFinderByPartner%3BPartnerPartyId%3D{PartOrgPartyId}

パートナが登録されているパートナ・プログラムのリストを表示するために、パートナ登録済プログラム値リスト・リソースが使用されます。

PartnerPickerVA

操作: /crmRestApi/resources/11.13.18.05/partnersLOV

パラメータ:

ファインダ: ActivePartnersFinder%3BBindDefaultStatus%3DACTIVE%2CBindExtraStatus%3DACTIVE

パートナ値リスト・リソースは、パートナのリストを表示するために使用されます。

PartnerRegistrationStatusLookupPVO

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DPARTNER_REGISTRATION_TYPE%2CBindLookupCode%3D{RegistrationStatus}

参照リソースは、標準参照コードの表示に使用されます。

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、商談パートナを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_341580/child/RevenuePartnerPrimary/300100092629562

レスポンス本文の例

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

 {
   "PartyName" : "Venus Solutions",
   "CreatedBy": "MHoope",
   "CreationDate": "2016-11-16T05:02:42-08:00",
   "LastUpdateDate": "2016-11-16T05:03:04-08:00",
   "LastUpdateLogin": "415B9500195B1E30E05354C0F20ADDA7",
   "OptyId" : 300100092516122,
   "LastUpdatedBy": "MHoope",									
   "PartOrgPartyId": 300100031667753,						
   "RevnId": 300100092516123,									
   "RevnPartOrgPartyId": 300100092629562,
   "DealType": null,												
   "PartTypeCd": "BPO",												 
   "DealExpirationDate": null,											
   "PartProgramId": null,												
   "DealEstCloseDate": null,												
   "PrPartResourcePartyId": null,											
   "RegistrationNumber": null,												
   "PartyId": 300100031667753,											
   "PartyName1": null,												  
   "RevnPartnerNumber": "CDRM_80101",										
   "PartOrgEmailAddress": null,				
   "PartOrgFormattedPhoneNumber": "+91 (9999)9999",								
   "RegistrationStatus": null,					
   "PreferredContactName": "Venus Solutons",									
   "PreferredContactEmail": "venus@oracle.com",										
   "PreferredContactPhone": "+91 (999)999 x999",										
   "PartnerPartyNumber": "CDRM_70962" }

「トップに戻る」