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

機械翻訳について

オブジェクト基準の更新

patch

/crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectCriteria/{SavedSearchUuid}

リクエスト

パス・パラメータ

ObjectTypeCode(required): string

特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。たとえば、取引先、担当者、見込み客などです。
SavedSearchUuid(required): string

ワークスペースで定義された保存済Search(zca_es_saved_searches)のSavedSearchUUIDへの外部キー参照。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

Enabled: string

タイトル: Enabled

最大長: 1

デフォルト値: Y

保存済検索がユーザー・コンテキストに対して使用可能かどうかを示します。
MaximumFetchSize: 整数(int32)

タイトル: Maximum Fetch Size

デフォルト値: 5

ユーザー・コンテキストに追加できる一致オブジェクトの最大数。
ObjectVersionNumber: 整数(int32)

タイトル: Object Version Number

デフォルト値: 1

オプティミスティック・ロックの実装に使用される属性。この番号は、行を更新するたびに増分されます。問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
SavedSearchJson: 文字列(バイト)

タイトル: Saved Search JSON

JSON形式の保存済検索基準パラメータ。
スコア: 整数(int32)

タイトル: Score

デフォルト値: 0

保存検索条件に定義されたベース・スコア。

{
    "type":"object",
    "properties":{
        "Enabled":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the Saved Search is enabled for user context or not.",
            "nullable":false,
            "default":"Y"
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"The base score defined for the Saved Search Criteria.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":9
            }
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The attribute used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":9
            }
        },
        "SavedSearchJson":{
            "title":"Saved Search JSON",
            "type":"string",
            "description":"The saved search criteria parameters in JSON format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MaximumFetchSize":{
            "title":"Maximum Fetch Size",
            "type":"integer",
            "description":"The maximum number of matching objects that can be added to the user context.",
            "format":"int32",
            "nullable":false,
            "default":5,
            "x-hints":{
                "precision":9
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : userContextObjectTypes-objectCriteria-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

行が作成された日時。
Enabled: string

タイトル: Enabled

最大長: 1

デフォルト値: Y

保存済検索がユーザー・コンテキストに対して使用可能かどうかを示します。
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

リソース・インスタンスに関連付けられたリンク関係。
MaximumFetchSize: 整数(int32)

タイトル: Maximum Fetch Size

デフォルト値: 5

ユーザー・コンテキストに追加できる一致オブジェクトの最大数。
ObjectTypeCode: string

タイトル: Object Type Code

最大長: 30

特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。たとえば、取引先、担当者、見込み客などです。
ObjectVersionNumber: 整数(int32)

タイトル: Object Version Number

デフォルト値: 1

オプティミスティック・ロックの実装に使用される属性。この番号は、行を更新するたびに増分されます。問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
SavedSearchJson: 文字列(バイト)

タイトル: Saved Search JSON

JSON形式の保存済検索基準パラメータ。
SavedSearchUuid: string

タイトル: Saved Search GUID

最大長: 512

ワークスペースで定義された保存済Search(zca_es_saved_searches)のSavedSearchUUIDへの外部キー参照。
スコア: 整数(int32)

タイトル: Score

デフォルト値: 0

保存検索条件に定義されたベース・スコア。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row 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 row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SavedSearchJson":{
            "title":"Saved Search JSON",
            "type":"string",
            "description":"The saved search criteria parameters in JSON format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the Object type or category that is relevant in a given user context. For example Account, Contact, Lead, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the Saved Search is enabled for user context or not.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "MaximumFetchSize":{
            "title":"Maximum Fetch Size",
            "type":"integer",
            "description":"The maximum number of matching objects that can be added to the user context.",
            "format":"int32",
            "nullable":false,
            "default":5,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"The base score defined for the Saved Search Criteria.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The attribute used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SavedSearchUuid":{
            "title":"Saved Search GUID",
            "maxLength":512,
            "type":"string",
            "description":"The foreign key reference to the SavedSearchUUID of the Saved Search(zca_es_saved_searches) defined in Workspace.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the row 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":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"
    }
}

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

タイプ: 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リソースに対してPATCHリクエストを発行することによって、オブジェクト基準を更新する方法を示しています。

cURLコマンド

curl --user sales_cloud_user -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/userContextObjectTypes/Activity/child/objectCriteria/UC_SVSearch_Activity_01

リクエスト本文

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

{
"MaximumFetchSize": 10
}

レスポンス本文

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

{
    "SavedSearchUuid": "UC_SVSearch_Activity_01",
    "ObjectTypeCode": "Activity",
    "Score": 500,
    "MaximumFetchSize": 10,
    "CreatedBy": "SEED_DATA_FROM_APPLICATION",
    "CreationDate": "2020-08-29T22:40:19+00:00",
    "Enabled": "Y",
    "LastUpdateDate": "2020-08-29T22:40:19.053+00:00",
    "LastUpdateLogin": "-1",
    "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
    "ObjectVersionNumber": 2,
...
}

「トップに戻る」