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

機械翻訳について

商談競合相手の更新

patch

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCompetitor2/{OptyCompetitorId}

リクエスト

パス・パラメータ

OptyCompetitorId(required): integer(int64)

商談の競合相手の一意の識別子。
OptyNumber(required): string

商談の一意の代替識別子。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

CmptPartyId: integer (int64)

タイトル: Party ID

競合相手パーティの一意の識別子。
Comments: string

タイトル: Comments

最大長: 2000

商談の競合相手に関するユーザー指定のコメント。
ConflictId: integer (int64)

タイトル: Conflict ID

デフォルト値: 0

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

タイトル: Opportunity Competitor ID

商談の競合相手の一意の識別子。
OptyId: integer (int64)

タイトル: Opportunity ID

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

タイトル: Competitor

最大長: 360

パーティの名前。
PrimaryFlg: string

タイトル: Primary

競合相手が商談のプライマリ競合相手かどうかを示します。 Trueの場合、競合相手はプライマリ競合相手です。デフォルト値は「False」です。
ThreatLevelCode: string

タイトル: Threat Level

最大長: 30

競合相手からの脅威またはリスクのレベルを示すコード。有効な値のリストは、低、中および高です。受け入れられる値のリストは、競合相手脅威レベル参照で定義されます。「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。

{
    "type":"object",
    "properties":{
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The user-provided comments about the opportunity's competitor.",
            "nullable":true,
            "x-queryable":false
        },
        "OptyCompetitorId":{
            "title":"Opportunity Competitor ID",
            "type":"integer",
            "description":"The unique identifier for the competitor of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartyName":{
            "title":"Competitor",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PrimaryFlg":{
            "title":"Primary",
            "type":"string",
            "description":"Indicates if the competitor is the primary competitor for the opportunity. If True, then the competitor is the primary competitor. The default value is False.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CmptPartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier for the competitor party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"Competitor",
                "RecentItemEntityName":"competitors"
            }
        },
        "ThreatLevelCode":{
            "title":"Threat Level",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the level of threat or risk from the competitor. The list of valid values are Low, Medium, and High. A list of accepted values is defined in the lookup Competitor Threat Level. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier for the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

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

タイプ: object

ソースを表示

CmptPartyId: integer (int64)

タイトル: Party ID

競合相手パーティの一意の識別子。
Comments: string

タイトル: Comments

最大長: 2000

商談の競合相手に関するユーザー指定のコメント。
CompetitorPartyNumber: string

タイトル: Competitor Party Number

読取り専用: true

最大長: 30

競合相手パーティの代替キー識別子。
ConflictId: integer (int64)

タイトル: Conflict ID

デフォルト値: 0

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

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

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

タイトル: Last Updated Date

読取り専用: true

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

タイトル: Last Updated By

読取り専用: true

最大長: 64

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

タイトル: Last Update Login

読取り専用: true

最大長: 32

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

タイトル: Links

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

タイトル: Opportunity Name

読取り専用: true

最大長: 275

商談の名前。
OptyCompetitorId: integer (int64)

タイトル: Opportunity Competitor ID

商談の競合相手の一意の識別子。
OptyId: integer (int64)

タイトル: Opportunity ID

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

タイトル: Opportunity Number

最大長: 30

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

タイトル: Competitor

最大長: 360

パーティの名前。
PrimaryFlg: string

タイトル: Primary

競合相手が商談のプライマリ競合相手かどうかを示します。 Trueの場合、競合相手はプライマリ競合相手です。デフォルト値は「False」です。
ThreatLevelCode: string

タイトル: Threat Level

最大長: 30

競合相手からの脅威またはリスクのレベルを示すコード。有効な値のリストは、低、中および高です。受け入れられる値のリストは、競合相手脅威レベル参照で定義されます。「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the contact record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The user-provided comments about the opportunity's competitor.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyName":{
            "title":"Competitor",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryFlg":{
            "title":"Primary",
            "type":"string",
            "description":"Indicates if the competitor is the primary competitor for the opportunity. If True, then the competitor is the primary competitor. The default value is False.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier for the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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
        },
        "Name":{
            "title":"Opportunity Name",
            "maxLength":275,
            "type":"string",
            "description":"The name of the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CompetitorPartyNumber":{
            "title":"Competitor Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the competitor party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyCompetitorId":{
            "title":"Opportunity Competitor ID",
            "type":"integer",
            "description":"The unique identifier for the competitor of the opportunity.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "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":false
        },
        "CmptPartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier for the competitor party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"Competitor",
                "RecentItemEntityName":"competitors"
            },
            "x-queryable":true
        },
        "ThreatLevelCode":{
            "title":"Threat Level",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the level of threat or risk from the competitor. The list of valid values are Low, Medium, and High. A list of accepted values is defined in the lookup Competitor Threat Level. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "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."
        }
    }
}

リンク

CompetitorVO1

操作: /crmRestApi/resources/11.13.18.05/competitors

パラメータ:

ファインダ: ActiveCompetitorsFinder

競合相手は、販売状況において当該組織と競合する組織です。このオブジェクトには、SWOT、競合他社で販売された製品、および当該組織の製品へのマッピング、受注/失注事由の詳細、競合他社文学への関連付けなど、追加の競合相手属性が格納されます。

CompttrThrtLvlLookup

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZBS_SALES_COMPTTR_THRT_LVL%2CBindLookupCode%3D{ThreatLevelCode}

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

YesNoLookup

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeFinder%3BBindLookupType%3DYES_NO

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

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するパッチ・リクエストを発行することによって、商談競合相手を更新する方法を示しています。

cURLコマンド

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

リクエスト本文の例

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

{
"ThreatLevelCode": "HIGH"
}

レスポンス本文の例

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

{
PartyName: "Aberdeen LLC",
ThreatLevelCode: "HIGH",
Comments: null,
OptyCompetitorId: 300100092629553,
CmptPartyId: 100000012057022,
PrimaryFlg: "N",
Name: "Pinnacle Green Server Opportunity",
CreatedBy: "MHoope",
CreationDate: "2016-11-16T05:02:42-08:00",
LastUpdateDate: "2016-11-17T05:46:53-08:00",
OptyId: 300100092516122,
LastUpdateLogin: "415C6A46FCB04D77E05354C0F20A8390",
LastUpdatedBy: "MHoope",
...
}

「トップに戻る」