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

機械翻訳について

販売提案の更新

patch

/crmRestApi/resources/11.13.18.05/salesSuggestions/{SuggestionRecipientId}

リクエスト

パス・パラメータ

SuggestionRecipientId(required): integer(int64)

このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。例: products?q=InventoryItemId=

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

ActiveFlag: boolean

最大長: 1

デフォルト値: true

販売提案がアクティブかどうかを示します。値はYおよびNです。
EffectiveEndDate: 文字列(日付)

提案の有効性が終了する日付。
EffectiveStartDate: 文字列(日付)

提案の有効性が開始される日付。
ParentObjectId: integer (int64)

親オブジェクトの一意の識別子。
ParentObjectType: string

最大長: 64

提案の親オブジェクトのタイプ。
RecipientResponseCode: string

最大長: 30

デフォルト値: NEW

ユーザーが提案に応答した方法を示します。
SourceObjectId: integer (int64)

ソース・オブジェクトの一意の識別子。
SourceObjectType: string

最大長: 64

提案の導出に使用されるソース・オブジェクトのタイプ。
提案: 文字列(バイト)

Java Script Object Notationの提案。
SuggestionContext: 文字列(バイト)

Java Script Object Notationの提案コンテキスト。
SuggestionReason: 文字列(バイト)

Java Script Object Notationの推奨理由。
SuggestionRelatedObjects: array Suggestion Related Objects

タイトル: Suggestion Related Objects

提案関連オブジェクト・リソースは、販売提案に関連付けられた関連オブジェクトを表示するために使用されます。
SuggestionSource: string

最大長: 64

提案のソース。
SuggestionType: string

最大長: 64

デフォルト値: SUGGESTION

提案のタイプ。

{
    "type":"object",
    "properties":{
        "SuggestionReason":{
            "type":"string",
            "description":"The suggestion reason in Java Script Object Notation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The date when the validity of the suggestion ends.",
            "format":"date",
            "nullable":true
        },
        "SuggestionSource":{
            "maxLength":64,
            "type":"string",
            "description":"The source of the suggestion.",
            "nullable":false
        },
        "SuggestionType":{
            "maxLength":64,
            "type":"string",
            "description":"The type of the suggestion.",
            "nullable":false,
            "default":"SUGGESTION"
        },
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the sales suggestion is active. The values are Y and N.",
            "nullable":false,
            "default":true
        },
        "SourceObjectType":{
            "maxLength":64,
            "type":"string",
            "description":"The type of the Source Object used to derive the suggestion.",
            "nullable":true
        },
        "ParentObjectType":{
            "maxLength":64,
            "type":"string",
            "description":"The type of the parent object of the suggestion.",
            "nullable":true
        },
        "Suggestion":{
            "type":"string",
            "description":"The suggestion in Java Script Object Notation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "type":"integer",
            "description":"The unique identifier of the source object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SuggestionContext":{
            "type":"string",
            "description":"The suggestion Context in Java Script Object Notation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "RecipientResponseCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indication of how the user responded to the suggestion.",
            "nullable":false,
            "default":"NEW",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SuggestionRelatedObjects":{
            "title":"Suggestion Related Objects",
            "type":"array",
            "description":"The suggestion related objects resource is used to view the related objects associated to sales suggestion.",
            "items":{
                "$ref":"#/components/schemas/salesSuggestions-SuggestionRelatedObjects-item-patch-request"
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The date when the validity of the suggestion starts.",
            "format":"date",
            "nullable":true
        },
        "ParentObjectId":{
            "type":"integer",
            "description":"The unique identifier of the parent object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

ネストされたスキーマ : 提案関連オブジェクト

タイプ: array

タイトル: Suggestion Related Objects

提案関連オブジェクト・リソースは、販売提案に関連付けられた関連オブジェクトを表示するために使用されます。

ソースを表示

Array of: object salesSuggestions-SuggestionRelatedObjects-item-patch-request

{
    "title":"Suggestion Related Objects",
    "type":"array",
    "description":"The suggestion related objects resource is used to view the related objects associated to sales suggestion.",
    "items":{
        "$ref":"#/components/schemas/salesSuggestions-SuggestionRelatedObjects-item-patch-request"
    }
}

ネストされたスキーマ : salesSuggestions-SuggestionRelatedObjects-item-patch-request

タイプ: object

ソースを表示

RelatedObjectId: integer (int64)

販売提案に関連するオブジェクトの一意の識別子。
RelatedObjectType: string

最大長: 64

販売提案に関連するオブジェクトのタイプ。

{
    "type":"object",
    "properties":{
        "RelatedObjectId":{
            "type":"integer",
            "description":"The unique identifier of the object related to sales suggestion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RelatedObjectType":{
            "maxLength":64,
            "type":"string",
            "description":"The type of object related to sales suggestion.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : salesSuggestions-item-response

タイプ: object

ソースを表示

ActiveFlag: boolean

最大長: 1

デフォルト値: true

販売提案がアクティブかどうかを示します。値はYおよびNです。
EffectiveEndDate: 文字列(日付)

提案の有効性が終了する日付。
EffectiveStartDate: 文字列(日付)

提案の有効性が開始される日付。
links: array Links

タイトル: Links

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

親オブジェクトの一意の識別子。
ParentObjectType: string

最大長: 64

提案の親オブジェクトのタイプ。
RecipientCreatedBy: string

読取り専用: true

最大長: 64

分析テキストを作成したユーザー。
RecipientCreationDate: string (date-time)

読取り専用: true

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

読取り専用: true

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

読取り専用: true

最大長: 64

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

読取り専用: true

最大長: 32

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

最大長: 30

デフォルト値: NEW

ユーザーが提案に応答した方法を示します。
SalesSuggestionId: integer (int64)

読取り専用: true

販売提案の一意の識別子。
SourceObjectId: integer (int64)

ソース・オブジェクトの一意の識別子。
SourceObjectType: string

最大長: 64

提案の導出に使用されるソース・オブジェクトのタイプ。
提案: 文字列(バイト)

Java Script Object Notationの提案。
SuggestionContext: 文字列(バイト)

Java Script Object Notationの提案コンテキスト。
SuggestionReason: 文字列(バイト)

Java Script Object Notationの推奨理由。
SuggestionRecipientId: integer (int64)

提案の受信者。
SuggestionRelatedObjects: array Suggestion Related Objects

タイトル: Suggestion Related Objects

提案関連オブジェクト・リソースは、販売提案に関連付けられた関連オブジェクトを表示するために使用されます。
SuggestionSource: string

最大長: 64

提案のソース。
SuggestionType: string

最大長: 64

デフォルト値: SUGGESTION

提案のタイプ。

{
    "type":"object",
    "properties":{
        "SalesSuggestionId":{
            "type":"integer",
            "description":"The unique identifier of the sales suggestion.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SuggestionReason":{
            "type":"string",
            "description":"The suggestion reason in Java Script Object Notation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The date when the validity of the suggestion ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RecipientCreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestionRecipientId":{
            "type":"integer",
            "description":"The intended recipient of the suggestion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SuggestionSource":{
            "maxLength":64,
            "type":"string",
            "description":"The source of the suggestion.",
            "nullable":false,
            "x-queryable":true
        },
        "SuggestionType":{
            "maxLength":64,
            "type":"string",
            "description":"The type of the suggestion.",
            "nullable":false,
            "default":"SUGGESTION",
            "x-queryable":true
        },
        "RecipientCreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created analyzed text.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the sales suggestion is active. The values are Y and N.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "SourceObjectType":{
            "maxLength":64,
            "type":"string",
            "description":"The type of the Source Object used to derive the suggestion.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentObjectType":{
            "maxLength":64,
            "type":"string",
            "description":"The type of the parent object of the suggestion.",
            "nullable":true,
            "x-queryable":true
        },
        "Suggestion":{
            "type":"string",
            "description":"The suggestion in Java Script Object Notation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "type":"integer",
            "description":"The unique identifier of the source object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecipientLastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestionContext":{
            "type":"string",
            "description":"The suggestion Context in Java Script Object Notation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "RecipientLastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecipientResponseCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indication of how the user responded to the suggestion.",
            "nullable":false,
            "default":"NEW",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SuggestionRelatedObjects":{
            "title":"Suggestion Related Objects",
            "type":"array",
            "description":"The suggestion related objects resource is used to view the related objects associated to sales suggestion.",
            "items":{
                "$ref":"#/components/schemas/salesSuggestions-SuggestionRelatedObjects-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The date when the validity of the suggestion starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ParentObjectId":{
            "type":"integer",
            "description":"The unique identifier of the parent object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecipientLastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "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"
    }
}

ネストされたスキーマ : 提案関連オブジェクト

タイプ: array

タイトル: Suggestion Related Objects

提案関連オブジェクト・リソースは、販売提案に関連付けられた関連オブジェクトを表示するために使用されます。

ソースを表示

Array of: object salesSuggestions-SuggestionRelatedObjects-item-response

{
    "title":"Suggestion Related Objects",
    "type":"array",
    "description":"The suggestion related objects resource is used to view the related objects associated to sales suggestion.",
    "items":{
        "$ref":"#/components/schemas/salesSuggestions-SuggestionRelatedObjects-item-response"
    }
}

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

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

ネストされたスキーマ : salesSuggestions-SuggestionRelatedObjects-item-response

タイプ: object

ソースを表示

links: array Links

タイトル: Links

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

販売提案に関連するオブジェクトの一意の識別子。
RelatedObjectType: string

最大長: 64

販売提案に関連するオブジェクトのタイプ。
SuggestionRelatedObjectId: integer (int64)

提案関連オブジェクトの一意の識別子。

{
    "type":"object",
    "properties":{
        "SuggestionRelatedObjectId":{
            "type":"integer",
            "description":"The unique identifier of the suggestion related object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelatedObjectId":{
            "type":"integer",
            "description":"The unique identifier of the object related to sales suggestion.",
            "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"
            }
        },
        "RelatedObjectType":{
            "maxLength":64,
            "type":"string",
            "description":"The type of object related to sales suggestion.",
            "nullable":false,
            "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"
    }
}

リンク

SuggestionRelatedObjects

操作: /crmRestApi/resources/11.13.18.05/salesSuggestions/{SuggestionRecipientId}/child/SuggestionRelatedObjects

パラメータ:

SuggestionRecipientId: $request.path.SuggestionRecipientId

提案関連オブジェクト・リソースは、販売提案に関連付けられた関連オブジェクトを表示するために使用されます。

「トップに戻る」