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

機械翻訳について

商談の更新

patch

/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseOpportunities/{CaseOpportunityId}

リクエスト

パス・パラメータ

CaseNumber(required): string

ケースの代替キー識別子。
CaseOpportunityId(required): integer(int64)

ケースに関連付けられている商談の一意の識別子。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

OptyId: integer (int64)

タイトル: Opportunity ID

ケース商談の一意の識別子。
OptyName: string

タイトル: Opportunity Name

最大長: 275

ケース商談の商談名。
OptyNumber: string

タイトル: Opportunity Number

最大長: 30

ケース商談の代替一意識別子。

{
    "type":"object",
    "properties":{
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the case opportunity.",
            "nullable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the case opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OptyName":{
            "title":"Opportunity Name",
            "maxLength":275,
            "type":"string",
            "description":"The opportunity name of the case opportunity.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : cases-caseOpportunities-item-response

タイプ: object

ソースを表示

CaseId: integer (int64)

タイトル: Case ID

ケースの一意の識別子。
CaseNumber: string

タイトル: Case Number

読取り専用: true

最大長: 30

ケースの代替一意識別子。
CaseOpportunityId: integer (int64)

タイトル: Case Opportunity ID

読取り専用: true

ケースに関連付けられている商談の一意の識別子。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

レコードが作成された日付。
DeleteFlag: boolean

タイトル: Delete

読取り専用: true

レコードを現在のユーザーが削除できるかどうかを示します。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

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

タイトル: Last Updated By

読取り専用: true

最大長: 64

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

タイトル: Last Update Login

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

タイトル: Opportunity ID

ケース商談の一意の識別子。
OptyName: string

タイトル: Opportunity Name

最大長: 275

ケース商談の商談名。
OptyNumber: string

タイトル: Opportunity Number

最大長: 30

ケース商談の代替一意識別子。
UpdateFlag: boolean

タイトル: Update

読取り専用: true

レコードを現在のユーザーが更新できるかどうかを示します。

{
    "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":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyName":{
            "title":"Opportunity Name",
            "maxLength":275,
            "type":"string",
            "description":"The opportunity name of the case opportunity.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted by the current user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the case opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated by the current user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CaseOpportunityId":{
            "title":"Case Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity associated with the case.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CaseNumber":{
            "title":"Case Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the case.",
            "nullable":false,
            "readOnly":true,
            "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 alternate unique identifier of the case opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: 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."
        }
    }
}

リンク

OpportunityPVO: 操作: /crmRestApi/resources/11.13.18.05/opportunities

商談は、販売アカウント、主要担当者、製品関心、潜在的売上などの潜在的な販売に関する情報を追跡するために、販売組織によって使用されます。

トップに戻る

例:

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

cURLコマンド

curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/caseOpportunities/{CaseOpportunityId}

リクエスト本文の例

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

  {
    "CaseId": 300100215793299,
    "CaseOpportunityId": 300100215772592,
    "CreatedBy": "AUTOUICASE1",
    "CreationDate": "2021-08-23T06:29:11+00:00",
    "LastUpdateDate": "2021-08-23T06:29:11.693+00:00",
    "LastUpdateLogin": "C9E509EDE53709B9E05322EAF40AB3B4",
    "LastUpdatedBy": "AUTOUICASE1",
    "OptyId": 300100215793283,
    "OptyNumber": "CDRM_151766",
    "CaseNumber": "CDRM_4003",
    "OptyName": "JET_Opty_202170_232847761",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseOpportunities/300100215772592",
            "name": "Opportunities",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseOpportunities/300100215772592",
            "name": "Opportunities",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003",
            "name": "cases",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseOpportunities/300100215772592/lov/OpportunityPVO",
            "name": "OpportunityPVO",
            "kind": "collection"
        }
    ]
}

レスポンス本文の例

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

  {
    "CaseId": 300100215793299,
    "CaseOpportunityId": 300100215772592,
    "CreatedBy": "AUTOUICASE1",
    "CreationDate": "2021-08-23T06:29:11+00:00",
    "LastUpdateDate": "2021-08-26T13:39:34.067+00:00",
    "LastUpdateLogin": "CA5F9855E136CF7CE05322EAF40ADA31",
    "LastUpdatedBy": "SALES_ADMIN",
    "OptyId": 300100215793283,
    "OptyNumber": "CDRM_151754",
    "CaseNumber": "CDRM_4003",
    "OptyName": "JET_Opty_202170_232847761",
    "UpdateFlag": true,
    "DeleteFlag": true,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseOpportunities/300100215772592",
            "name": "caseOpportunities",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseOpportunities/300100215772592",
            "name": "caseOpportunities",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003",
            "name": "cases",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/cases/CDRM_4003/child/caseOpportunities/300100215772592/lov/OpportunityPVO",
            "name": "OpportunityPVO",
            "kind": "collection"
        }
    ]
}

「トップに戻る」