機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

商談リードの更新

patch

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityLead/{OptyLeadId}

リクエスト

パス・パラメータ

• OptyLeadId(required): integer(int64)
  商談のリードの一意の識別子。
• OptyNumber(required): string
  商談の一意の代替識別子。

ヘッダー・パラメータ

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

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

• application/json

リクエスト本文 - application/json ()

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

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

タイプ: object

ソースを表示

• ConflictId: integer (int64)
  タイトル: Conflict ID

  デフォルト値: 0

  モバイル・データベースやサーバーなどの切断されたモバイルの場合に、異なるデータベースに重複が作成される場合に、行の一意性を保証するために使用される値。
• DealEstimatedCloseDate: 文字列(日付)
  タイトル: Deal Registration Estimated Close Date

  商談の取引交渉登録がクローズされると予想される日付。
• DealExpirationDate: 文字列(日付)
  タイトル: Deal Expiration Date

  リード登録が失効する日付。
• DealPartProgramId: integer (int64)
  タイトル: Partner Program ID

  リード登録に関連付けられたパートナ・プログラムの一意の識別子。
• DealType: string
  タイトル: Lead Registration Type

  最大長: 30

  商談のディールまたはリード登録タイプ。
• LeadNumber: string
  タイトル: Lead Number

  最大長: 64

  リードの代替キー識別子。
• ObjectUsage: string
  タイトル: Object Usage

  最大長: 30

  現在のレコードがリードまたはディールのどちらを表すかを示します。
• OptyId: integer (int64)
  タイトル: Opportunity ID

  商談の一意の識別子。
• PartnerTypeCd: string
  タイトル: Partner Type

  最大長: 250

  リード登録のパートナのタイプを示すコード。
• PrDealPartOrgPartyId: integer (int64)
  タイトル: Partner Organization Party ID

  リード登録のパートナの一意の識別子。
• PrDealPartResourcePartyId: integer (int64)
  タイトル: Primary Partner Resource ID

  リード登録のプライマリ・パートナ・リソースの一意の識別子。
• RegistrationNumber: string
  タイトル: Registration Number

  最大長: 120

  商談のリードの一意の登録番号。
• UserLastUpdateDate: string (date-time)
  タイトル: User Last Update Date

  商談リードがモバイルから最後に更新された日時。

{
    "type":"object",
    "properties":{
        "DealType":{
            "title":"Lead Registration Type",
            "maxLength":30,
            "type":"string",
            "description":"The deal or lead registration type for the opportunity.",
            "nullable":true,
            "x-queryable":false
        },
        "DealEstimatedCloseDate":{
            "title":"Deal Registration Estimated Close Date",
            "type":"string",
            "description":"The date when the deal registration for the opportunity is estimated to be closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate key identifier of the lead.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "SmartPickerEntityName":"Lead"
            }
        },
        "UserLastUpdateDate":{
            "title":"User Last Update Date",
            "type":"string",
            "description":"The date and time when the opportunity lead was last updated from mobile.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "PrDealPartResourcePartyId":{
            "title":"Primary Partner Resource ID",
            "type":"integer",
            "description":"The unique identifier for the primary partner resource on the lead registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DealExpirationDate":{
            "title":"Deal Expiration Date",
            "type":"string",
            "description":"The date when the lead registration will expire.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-queryable":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
            }
        },
        "PrDealPartOrgPartyId":{
            "title":"Partner Organization Party ID",
            "type":"integer",
            "description":"The unique identifier for the partner on the lead registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DealPartProgramId":{
            "title":"Partner Program ID",
            "type":"integer",
            "description":"The unique identifier of the partner program associated with the lead registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectUsage":{
            "title":"Object Usage",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the current record represents a lead or a deal.",
            "nullable":true,
            "x-queryable":false
        },
        "RegistrationNumber":{
            "title":"Registration Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique registration number of the lead for the opportunity.",
            "nullable":true,
            "x-queryable":false
        },
        "PartnerTypeCd":{
            "title":"Partner Type",
            "maxLength":250,
            "type":"string",
            "description":"The code indicating the type of the partner for the lead registration.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• ConflictId: integer (int64)
  タイトル: Conflict ID

  デフォルト値: 0

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

  読取り専用: true

  最大長: 450

  プライマリ・リード担当者の名前。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreatedByModule: string
  タイトル: Created by Module

  読取り専用: true

  最大長: 30

  レコードの作成に使用されたモジュール。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日時。
• CustomerId: integer (int64)
  タイトル: Customer Identifier

  読取り専用: true

  TCAスキーマの顧客レコードの一意の識別子。
• CustomerName: string
  タイトル: Customer

  読取り専用: true

  最大長: 360

  顧客の名前。
• DealEstimatedCloseDate: 文字列(日付)
  タイトル: Deal Registration Estimated Close Date

  商談の取引交渉登録がクローズされると予想される日付。
• DealExpirationDate: 文字列(日付)
  タイトル: Deal Expiration Date

  リード登録が失効する日付。
• DealPartProgramId: integer (int64)
  タイトル: Partner Program ID

  リード登録に関連付けられたパートナ・プログラムの一意の識別子。
• DealSize: number
  タイトル: Deal Size

  読取り専用: true

  商談に関連付けられている取引の取引サイズ。
• DealType: string
  タイトル: Lead Registration Type

  最大長: 30

  商談のディールまたはリード登録タイプ。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
• LeadAging: integer
  タイトル: Age in Days

  読取り専用: true

  リードが作成されてから経過した日数。
• LeadId: integer (int64)
  タイトル: Lead Identifier

  読取り専用: true

  商談のリードの一意の識別子。
• LeadName: string
  タイトル: Lead Name

  読取り専用: true

  最大長: 250

  商談に関連付けられている見込み客の名前。
• LeadNumber: string
  タイトル: Lead Number

  最大長: 64

  リードの代替キー識別子。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectUsage: string
  タイトル: Object Usage

  最大長: 30

  現在のレコードがリードまたはディールのどちらを表すかを示します。
• OptyId: integer (int64)
  タイトル: Opportunity ID

  商談の一意の識別子。
• OptyLeadId: integer (int64)
  タイトル: Opportunity Lead ID

  商談のリードの一意の識別子。
• OptyNumber: string
  タイトル: Opportunity Number

  最大長: 30

  商談の一意の公開識別子である商談の番号。
• PartnerTypeCd: string
  タイトル: Partner Type

  最大長: 250

  リード登録のパートナのタイプを示すコード。
• PrDealPartOrgPartyId: integer (int64)
  タイトル: Partner Organization Party ID

  リード登録のパートナの一意の識別子。
• PrDealPartResourcePartyId: integer (int64)
  タイトル: Primary Partner Resource ID

  リード登録のプライマリ・パートナ・リソースの一意の識別子。
• PrimaryContactId: integer (int64)
  タイトル: Primary Contact Identifier

  読取り専用: true

  プライマリ・リード担当者としてマークされた営業リード担当の一意の識別子。
• Rank: string
  タイトル: Rank

  読取り専用: true

  最大長: 30

  商談に関連付けられているリードのランク。
• RankMeaning: string
  タイトル: Rank

  読取り専用: true

  関連付けられたリードのランク・コードの意味。
• RegistrationNumber: string
  タイトル: Registration Number

  最大長: 120

  商談のリードの一意の登録番号。
• StatusCode: string
  タイトル: Status

  読取り専用: true

  最大長: 30

  商談リードのステータスを示すコード。
• StatusCodeMeaning: string
  タイトル: Status

  読取り専用: true

  関連リードのステータス・コードの意味。
• UserLastUpdateDate: string (date-time)
  タイトル: User Last Update Date

  商談リードがモバイルから最後に更新された日時。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryContactId":{
            "title":"Primary Contact Identifier",
            "type":"integer",
            "description":"The unique identifier of the sales lead contact marked as a primary lead contact.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UserLastUpdateDate":{
            "title":"User Last Update Date",
            "type":"string",
            "description":"The date and time when the opportunity lead was last updated from mobile.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the opportunity lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "PrDealPartOrgPartyId":{
            "title":"Partner Organization Party ID",
            "type":"integer",
            "description":"The unique identifier for the partner on the lead registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DealPartProgramId":{
            "title":"Partner Program ID",
            "type":"integer",
            "description":"The unique identifier of the partner program associated with the lead registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadId":{
            "title":"Lead Identifier",
            "type":"integer",
            "description":"The unique identifier of the lead for the opportunity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"leads"
            },
            "x-queryable":true
        },
        "RegistrationNumber":{
            "title":"Registration Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique registration number of the lead for the opportunity.",
            "nullable":true,
            "x-queryable":false
        },
        "PartnerTypeCd":{
            "title":"Partner Type",
            "maxLength":250,
            "type":"string",
            "description":"The code indicating the type of the partner for the lead registration.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerName":{
            "title":"Customer",
            "maxLength":360,
            "type":"string",
            "description":"The name of the customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedByModule":{
            "title":"Created by Module",
            "maxLength":30,
            "type":"string",
            "description":"The module through which the record was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyLeadId":{
            "title":"Opportunity Lead ID",
            "type":"integer",
            "description":"The unique identifier of the lead for the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "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
        },
        "DealType":{
            "title":"Lead Registration Type",
            "maxLength":30,
            "type":"string",
            "description":"The deal or lead registration type for the opportunity.",
            "nullable":true,
            "x-queryable":false
        },
        "DealEstimatedCloseDate":{
            "title":"Deal Registration Estimated Close Date",
            "type":"string",
            "description":"The date when the deal registration for the opportunity is estimated to be closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "DealSize":{
            "title":"Deal Size",
            "type":"number",
            "description":"The deal size of the deal associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate key identifier of the lead.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "SmartPickerEntityName":"Lead"
            },
            "x-queryable":true
        },
        "Rank":{
            "title":"Rank",
            "maxLength":30,
            "type":"string",
            "description":"The rank of the lead associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CustomerId":{
            "title":"Customer Identifier",
            "type":"integer",
            "description":"The unique identifier of the customer record in the TCA schema.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LeadAging":{
            "title":"Age in Days",
            "type":"integer",
            "description":"The number of days elapsed since the lead was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LeadCreationDate"
                ]
            }
        },
        "PrDealPartResourcePartyId":{
            "title":"Primary Partner Resource ID",
            "type":"integer",
            "description":"The unique identifier for the primary partner resource on the lead registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DealExpirationDate":{
            "title":"Deal Expiration Date",
            "type":"string",
            "description":"The date when the lead registration will expire.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RankMeaning":{
            "title":"Rank",
            "type":"string",
            "description":"The meaning of the rank code for the associated lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatusCodeMeaning":{
            "title":"Status",
            "type":"string",
            "description":"The meaning of the status code for the associated lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ObjectUsage":{
            "title":"Object Usage",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the current record represents a lead or a deal.",
            "nullable":true,
            "x-queryable":false
        },
        "LeadName":{
            "title":"Lead Name",
            "maxLength":250,
            "type":"string",
            "description":"The name of the lead associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactName":{
            "title":"Contact",
            "maxLength":450,
            "type":"string",
            "description":"The name of the primary lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "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."
        }
    }
}

トップに戻る

例:

次の例は、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_332708/child/OpportunityLead/300100111705721

リクエスト本文の例

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

{                   
  "LeadNumber": "104"               
}

レスポンス本文の例

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

{
OptyLeadId: 300100111705721
OptyId: 300100111705686
LeadNumber: "104"
}

「トップに戻る」