機械翻訳について

ジャンプ先

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

オブジェクト構成の更新

patch

/crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigs/{DataSourceCode}

リクエスト

パス・パラメータ

• DataSourceCode(required): string
  ユーザー・コンテキスト情報が取得および格納されるソースのデータ・ソース・コード。
• ObjectTypeCode(required): string
  特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。 たとえば、取引先、担当者、見込み客などです。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• Enabled: string
  タイトル: Enabled

  最大長: 1

  デフォルト値: Y

  データ・ソースのオブジェクトがユーザー・コンテキストに対して使用可能かどうかを示します。
• objectConfigDetails: array Object Configuration Details
  タイトル: Object Configuration Details

  オブジェクト構成詳細リソースは、オブジェクト構成の表示および更新に使用されます。
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  オブジェクト・バージョン番号は、オプティミスティック・ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
• ObjectWeight: 整数(int32)
  タイトル: Object Weight

  データ・ソースの重みまたは関連性。 これは、関連スコアの計算に使用されます。
• Score: integer (int64)
  タイトル: Score

  関連アイテムのスコア。

{
    "type":"object",
    "properties":{
        "Enabled":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the object for the data source is enabled for user context.",
            "nullable":false,
            "default":"Y"
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"The score of a relevant item.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":10
            }
        },
        "ObjectWeight":{
            "title":"Object Weight",
            "type":"integer",
            "description":"The weight or relevance of a data source. This is used to calculate the relevance score.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "objectConfigDetails":{
            "title":"Object Configuration Details",
            "type":"array",
            "description":"The object configuration details resource is used to view and update the object configuration.",
            "items":{
                "$ref":"#/components/schemas/userContextObjectTypes-objectConfigs-objectConfigDetails-item-patch-request"
            }
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The object version number is used to implement optimistic locking. This number is incremented every time that 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,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        }
    }
}

ネストされたスキーマ : オブジェクト構成詳細

タイプ: array

タイトル: Object Configuration Details

オブジェクト構成詳細リソースは、オブジェクト構成の表示および更新に使用されます。

ソースを表示

• Array of: object schema

{
    "title":"Object Configuration Details",
    "type":"array",
    "description":"The object configuration details resource is used to view and update the object configuration.",
    "items":{
        "$ref":"#/components/schemas/userContextObjectTypes-objectConfigs-objectConfigDetails-item-patch-request"
    }
}

ネストされたスキーマ : スキーマ

タイプ: object

ソースを表示

• DataSourceCode: string
  タイトル: Data Source Code

  最大長: 30

  ユーザー・コンテキスト情報が取得および格納されるソースのデータ・ソース・コード。
• 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":{
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"Indicates the base score defined for the Saved Search Criteria.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":9
            }
        },
        "DataSourceCode":{
            "title":"Data Source Code",
            "maxLength":30,
            "type":"string",
            "description":"The data source code for sources where user context information is captured and stored.",
            "nullable":true
        },
        "SavedSearchJson":{
            "title":"Saved Search JSON",
            "type":"string",
            "description":"Stores the saved search criteria parameters in JSON format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The attribute is 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
            }
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether Saved Search is enabled for the user context or not.",
            "nullable":false,
            "default":"Y"
        },
        "MaximumFetchSize":{
            "title":"Maximum Fetch Size",
            "type":"integer",
            "description":"Indicates 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-objectConfigs-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日付。
• DataSourceCode: string
  タイトル: Data Source Code

  最大長: 30

  ユーザー・コンテキスト情報が取得および格納されるソースのデータ・ソース・コード。
• 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

  リソース・インスタンスに関連付けられたリンク関係。
• objectConfigDetails: array Object Configuration Details
  タイトル: Object Configuration Details

  オブジェクト構成詳細リソースは、オブジェクト構成の表示および更新に使用されます。
• ObjectMappingCode: string
  タイトル: Object Mapping Code

  読取り専用: true

  最大長: 30

  データ・ソースに使用されるオブジェクト・タイプの名前。
• ObjectTypeCode: string
  タイトル: Object Type Code

  最大長: 30

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

  オブジェクト・バージョン番号は、オプティミスティック・ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
• ObjectWeight: 整数(int32)
  タイトル: Object Weight

  データ・ソースの重みまたは関連性。 これは、関連スコアの計算に使用されます。
• Score: integer (int64)
  タイトル: Score

  関連アイテムのスコア。

{
    "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 when the 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
        },
        "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 object for the data source is enabled for user context.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "objectConfigDetails":{
            "title":"Object Configuration Details",
            "type":"array",
            "description":"The object configuration details resource is used to view and update the object configuration.",
            "items":{
                "$ref":"#/components/schemas/userContextObjectTypes-objectConfigs-objectConfigDetails-item-response"
            }
        },
        "DataSourceCode":{
            "title":"Data Source Code",
            "maxLength":30,
            "type":"string",
            "description":"The data source code for sources where user context information is captured and stored.",
            "nullable":false,
            "x-queryable":true
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"The score of a relevant item.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":10
            }
        },
        "ObjectWeight":{
            "title":"Object Weight",
            "type":"integer",
            "description":"The weight or relevance of a data source. This is used to calculate the relevance score.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ObjectMappingCode":{
            "title":"Object Mapping Code",
            "maxLength":30,
            "type":"string",
            "description":"The name of the object type used for the data source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The object version number is used to implement optimistic locking. This number is incremented every time that 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,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when time 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 login of 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"
    }
}

ネストされたスキーマ : オブジェクト構成詳細

タイプ: array

タイトル: Object Configuration Details

オブジェクト構成詳細リソースは、オブジェクト構成の表示および更新に使用されます。

ソースを表示

• Array of: object userContextObjectTypes-objectConfigs-objectConfigDetails-item-response

{
    "title":"Object Configuration Details",
    "type":"array",
    "description":"The object configuration details resource is used to view and update the object configuration.",
    "items":{
        "$ref":"#/components/schemas/userContextObjectTypes-objectConfigs-objectConfigDetails-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."
        }
    }
}

ネストされたスキーマ : userContextObjectTypes-objectConfigs-objectConfigDetails-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  行を作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  行が作成された日時。
• DataSourceCode: string
  タイトル: Data Source Code

  最大長: 30

  ユーザー・コンテキスト情報が取得および格納されるソースのデータ・ソース・コード。
• 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

  ユーザー・コンテキストに追加できる一致オブジェクトの最大数を示します。
• ObjectConfigDetailsId: string
  タイトル: Object Configuration Details Identifier

  最大長: 512

  オブジェクト構成詳細の一意の識別子。
• ObjectTypeCode: string
  タイトル: Object Type Code

  最大長: 30

  オブジェクトのタイプのコードを示します。
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  デフォルト値: 1

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

  保存済検索基準パラメータをJSON形式で格納します。
• スコア: 整数(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":"Stores 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":"Indicates the code for the type of object.",
            "nullable":false,
            "x-queryable":true
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether Saved Search is enabled for the user context or not.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "MaximumFetchSize":{
            "title":"Maximum Fetch Size",
            "type":"integer",
            "description":"Indicates 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":"Indicates the base score defined for the Saved Search Criteria.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "DataSourceCode":{
            "title":"Data Source Code",
            "maxLength":30,
            "type":"string",
            "description":"The data source code for sources where user context information is captured and stored.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectConfigDetailsId":{
            "title":"Object Configuration Details Identifier",
            "maxLength":512,
            "type":"string",
            "description":"The unique identifier of the object configuration detail.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The attribute is 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"
            }
        },
        "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 row.",
            "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"
    }
}

リンク

objectConfigDetails

操作: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigs/{DataSourceCode}/child/objectConfigDetails

パラメータ:

• DataSourceCode: $request.path.DataSourceCode
• ObjectTypeCode: $request.path.ObjectTypeCode

(objectConfigDetailsのリソース)

トップに戻る

例:

次の例は、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/CRMProduct/child/objectConfigs/RI_PICKER

リクエスト本文

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

{
"Score": 10
}

レスポンス本文

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

{
    "DataSourceCode": "RI_PICKER",
    "ObjectTypeCode": "CRMProduct",
    "ObjectMappingCode": "ITEM",
    "Score": 10,
    "Enabled": "Y",
    "CreationDate": "2020-03-16T17:26:40.570+00:00",
    "CreatedBy": "SEED_DATA_FROM_APPLICATION",
    "LastUpdateDate": "2020-10-13T08:42:08+00:00",
    "LastUpdatedBy": "SALES_ADMIN",
    "LastUpdateLogin": "B188E46AAA0F0E5AE053D711F10AE5DF",
    "ObjectVersionNumber": 3,
    "ObjectWeight": 1,

...
}

「トップに戻る」