機械翻訳について

オブジェクト・タイプの作成

post

/crmRestApi/resources/11.13.18.05/userContextObjectTypes

リクエスト

ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
  • 次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
リクエスト本文 - application/json ()
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ: object
ソースを表示
  • タイトル: Enabled
    最大長: 1
    デフォルト値: Y
    オブジェクト・タイプがユーザー・コンテキストに対して使用可能かどうかを示します。 デフォルト値は'Y'です。
  • Object Configurations
    タイトル: Object Configurations
    オブジェクト構成リソースは、オブジェクト構成の表示および更新に使用されます。
  • Object Criteria
    タイトル: Object Criteria
    オブジェクト基準リソースは、構成およびマッピングの表示、作成、更新および削除に使用されます。 エラスティック・データ・ストアおよびワークスペースの保存済検索を問い合せる基準を決定するために使用されます。
  • タイトル: Object Type Code
    最大長: 30
    特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。 たとえば、取引先、担当者、見込み客などです。
  • タイトル: Object Version Number
    オブジェクト・バージョン番号は、オプティミスティック・ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
  • Related Objects
    タイトル: Related Objects
    関連オブジェクト・リソースは、関連オブジェクトを表示および更新するために使用されます。
ネストされたスキーマ : オブジェクト構成
タイプ: array
タイトル: Object Configurations
オブジェクト構成リソースは、オブジェクト構成の表示および更新に使用されます。
ソースを表示
ネストされたスキーマ : オブジェクト基準
タイプ: array
タイトル: Object Criteria
オブジェクト基準リソースは、構成およびマッピングの表示、作成、更新および削除に使用されます。 エラスティック・データ・ストアおよびワークスペースの保存済検索を問い合せる基準を決定するために使用されます。
ソースを表示
ネストされたスキーマ : 関連オブジェクト
タイプ: array
タイトル: Related Objects
関連オブジェクト・リソースは、関連オブジェクトを表示および更新するために使用されます。
ソースを表示
ネストされたスキーマ : スキーマ
タイプ: object
ソースを表示
  • タイトル: Data Source Code
    最大長: 30
    ユーザー・コンテキスト情報が取得および格納されるソースのデータ・ソース・コード。
  • タイトル: Enabled
    最大長: 1
    デフォルト値: Y
    データ・ソースのオブジェクトがユーザー・コンテキストに対して使用可能かどうかを示します。
  • Object Configuration Details
    タイトル: Object Configuration Details
    オブジェクト構成詳細リソースは、オブジェクト構成の表示および更新に使用されます。
  • タイトル: Object Type Code
    最大長: 30
    特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。 たとえば、取引先、担当者、見込み客などです。
  • タイトル: Object Version Number
    オブジェクト・バージョン番号は、オプティミスティック・ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
  • タイトル: Object Weight
    データ・ソースの重みまたは関連性。 これは、関連スコアの計算に使用されます。
  • タイトル: Score
    関連アイテムのスコア。
ネストされたスキーマ : オブジェクト構成詳細
タイプ: array
タイトル: Object Configuration Details
オブジェクト構成詳細リソースは、オブジェクト構成の表示および更新に使用されます。
ソースを表示
ネストされたスキーマ : スキーマ
タイプ: object
ソースを表示
  • タイトル: Data Source Code
    最大長: 30
    ユーザー・コンテキスト情報が取得および格納されるソースのデータ・ソース・コード。
  • タイトル: Enabled
    最大長: 1
    デフォルト値: Y
    保存済検索がユーザー・コンテキストに対して使用可能かどうかを示します。
  • タイトル: Maximum Fetch Size
    デフォルト値: 5
    ユーザー・コンテキストに追加できる一致オブジェクトの最大数を示します。
  • タイトル: Object Configuration Details Identifier
    最大長: 512
    オブジェクト構成詳細の一意の識別子。
  • タイトル: Object Type Code
    最大長: 30
    オブジェクトのタイプのコードを示します。
  • タイトル: Object Version Number
    デフォルト値: 1
    この属性は、オプティミスティック・ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
  • タイトル: Saved Search JSON
    保存済検索基準パラメータをJSON形式で格納します。
  • タイトル: Score
    デフォルト値: 0
    保存済検索基準に定義されているベース・スコアを示します。
ネストされたスキーマ : userContextObjectTypes-objectCriteria-item-post-request
タイプ: object
ソースを表示
  • タイトル: Enabled
    最大長: 1
    デフォルト値: Y
    保存済検索がユーザー・コンテキストに対して使用可能かどうかを示します。
  • タイトル: Maximum Fetch Size
    デフォルト値: 5
    ユーザー・コンテキストに追加できる一致オブジェクトの最大数。
  • タイトル: Object Type Code
    最大長: 30
    特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。 たとえば、取引先、担当者、見込み客などです。
  • タイトル: Object Version Number
    デフォルト値: 1
    オプティミスティック・ロックの実装に使用される属性。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
  • タイトル: Saved Search JSON
    JSON形式の保存済検索基準パラメータ。
  • タイトル: Saved Search GUID
    最大長: 512
    ワークスペースで定義された保存済Search(zca_es_saved_searches)のSavedSearchUUIDへの外部キー参照。
  • タイトル: Score
    デフォルト値: 0
    保存検索条件に定義されたベース・スコア。
ネストされたスキーマ : スキーマ
タイプ: object
ソースを表示
  • タイトル: Enabled
    最大長: 1
    デフォルト値: Y
    ソース・オブジェクトの関連オブジェクトがユーザー・コンテキストに対して使用可能かどうかを示します。
  • タイトル: Object Version Number
    オブジェクト・バージョン番号は、オプティミスティック・ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
  • タイトル: Source Object Type Code
    最大長: 30
    ソース・ビジネス・オブジェクトのオブジェクト・タイプ・コード。
  • タイトル: Target Object Id
    最大長: 30
    ユーザー・コンテキストの導出に使用されるカスタム・オブジェクト・フィールド・マッピング。
  • タイトル: Related Object Type Code
    最大長: 30
    関連オブジェクトのオブジェクト・タイプ・コード。 関連するオブジェクト・マッピングは、ユーザー・コンテキストの導出に使用されます。
トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : userContextObjectTypes-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日付。
  • タイトル: Enabled
    最大長: 1
    デフォルト値: Y
    オブジェクト・タイプがユーザー・コンテキストに対して使用可能かどうかを示します。 デフォルト値は'Y'です。
  • タイトル: Last Update Date
    読取り専用: true
    レコードが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • Object Configurations
    タイトル: Object Configurations
    オブジェクト構成リソースは、オブジェクト構成の表示および更新に使用されます。
  • Object Criteria
    タイトル: Object Criteria
    オブジェクト基準リソースは、構成およびマッピングの表示、作成、更新および削除に使用されます。 エラスティック・データ・ストアおよびワークスペースの保存済検索を問い合せる基準を決定するために使用されます。
  • タイトル: Object Type Code
    最大長: 30
    特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。 たとえば、取引先、担当者、見込み客などです。
  • タイトル: Object Version Number
    オブジェクト・バージョン番号は、オプティミスティック・ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
  • Related Objects
    タイトル: Related Objects
    関連オブジェクト・リソースは、関連オブジェクトを表示および更新するために使用されます。
ネストされたスキーマ : オブジェクト構成
タイプ: array
タイトル: Object Configurations
オブジェクト構成リソースは、オブジェクト構成の表示および更新に使用されます。
ソースを表示
ネストされたスキーマ : オブジェクト基準
タイプ: array
タイトル: Object Criteria
オブジェクト基準リソースは、構成およびマッピングの表示、作成、更新および削除に使用されます。 エラスティック・データ・ストアおよびワークスペースの保存済検索を問い合せる基準を決定するために使用されます。
ソースを表示
ネストされたスキーマ : 関連オブジェクト
タイプ: array
タイトル: Related Objects
関連オブジェクト・リソースは、関連オブジェクトを表示および更新するために使用されます。
ソースを表示
ネストされたスキーマ : userContextObjectTypes-objectConfigs-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日付。
  • タイトル: Data Source Code
    最大長: 30
    ユーザー・コンテキスト情報が取得および格納されるソースのデータ・ソース・コード。
  • タイトル: Enabled
    最大長: 1
    デフォルト値: Y
    データ・ソースのオブジェクトがユーザー・コンテキストに対して使用可能かどうかを示します。
  • タイトル: Last Update Date
    読取り専用: true
    レコードが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • Object Configuration Details
    タイトル: Object Configuration Details
    オブジェクト構成詳細リソースは、オブジェクト構成の表示および更新に使用されます。
  • タイトル: Object Mapping Code
    読取り専用: true
    最大長: 30
    データ・ソースに使用されるオブジェクト・タイプの名前。
  • タイトル: Object Type Code
    最大長: 30
    特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。 たとえば、取引先、担当者、見込み客などです。
  • タイトル: Object Version Number
    オブジェクト・バージョン番号は、オプティミスティック・ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
  • タイトル: Object Weight
    データ・ソースの重みまたは関連性。 これは、関連スコアの計算に使用されます。
  • タイトル: Score
    関連アイテムのスコア。
ネストされたスキーマ : オブジェクト構成詳細
タイプ: array
タイトル: Object Configuration Details
オブジェクト構成詳細リソースは、オブジェクト構成の表示および更新に使用されます。
ソースを表示
ネストされたスキーマ : userContextObjectTypes-objectConfigs-objectConfigDetails-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    行を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    行が作成された日時。
  • タイトル: Data Source Code
    最大長: 30
    ユーザー・コンテキスト情報が取得および格納されるソースのデータ・ソース・コード。
  • タイトル: Enabled
    最大長: 1
    デフォルト値: Y
    保存済検索がユーザー・コンテキストに対して使用可能かどうかを示します。
  • タイトル: Last Update Date
    読取り専用: true
    行が最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    行を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    行を最後に更新したユーザーのログイン。
  • Links
  • タイトル: Maximum Fetch Size
    デフォルト値: 5
    ユーザー・コンテキストに追加できる一致オブジェクトの最大数を示します。
  • タイトル: Object Configuration Details Identifier
    最大長: 512
    オブジェクト構成詳細の一意の識別子。
  • タイトル: Object Type Code
    最大長: 30
    オブジェクトのタイプのコードを示します。
  • タイトル: Object Version Number
    デフォルト値: 1
    この属性は、オプティミスティック・ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
  • タイトル: Saved Search JSON
    保存済検索基準パラメータをJSON形式で格納します。
  • タイトル: Score
    デフォルト値: 0
    保存済検索基準に定義されているベース・スコアを示します。
ネストされたスキーマ : userContextObjectTypes-objectCriteria-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    行を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    行が作成された日時。
  • タイトル: Enabled
    最大長: 1
    デフォルト値: Y
    保存済検索がユーザー・コンテキストに対して使用可能かどうかを示します。
  • タイトル: Last Update Date
    読取り専用: true
    行が最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    行を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Maximum Fetch Size
    デフォルト値: 5
    ユーザー・コンテキストに追加できる一致オブジェクトの最大数。
  • タイトル: Object Type Code
    最大長: 30
    特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。 たとえば、取引先、担当者、見込み客などです。
  • タイトル: Object Version Number
    デフォルト値: 1
    オプティミスティック・ロックの実装に使用される属性。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
  • タイトル: Saved Search JSON
    JSON形式の保存済検索基準パラメータ。
  • タイトル: Saved Search GUID
    最大長: 512
    ワークスペースで定義された保存済Search(zca_es_saved_searches)のSavedSearchUUIDへの外部キー参照。
  • タイトル: Score
    デフォルト値: 0
    保存検索条件に定義されたベース・スコア。
ネストされたスキーマ : userContextObjectTypes-relatedObjects-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日付。
  • タイトル: Enabled
    最大長: 1
    デフォルト値: Y
    ソース・オブジェクトの関連オブジェクトがユーザー・コンテキストに対して使用可能かどうかを示します。
  • タイトル: Last Update Date
    読取り専用: true
    レコードが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Object Version Number
    オブジェクト・バージョン番号は、オプティミスティック・ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
  • タイトル: Source Object Type Code
    最大長: 30
    ソース・ビジネス・オブジェクトのオブジェクト・タイプ・コード。
  • タイトル: Target Object Id
    最大長: 30
    ユーザー・コンテキストの導出に使用されるカスタム・オブジェクト・フィールド・マッピング。
  • タイトル: Related Object Type Code
    最大長: 30
    関連オブジェクトのオブジェクト・タイプ・コード。 関連するオブジェクト・マッピングは、ユーザー・コンテキストの導出に使用されます。
「トップに戻る」