オブジェクト構成の作成
post
/crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigs
リクエスト
パス・パラメータ
- ObjectTypeCode(required): string
特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。 たとえば、取引先、担当者、見込み客などです。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- Upsert-Mode:
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
DataSourceCode(required): string
タイトル:
Data Source Code
最大長:30
ユーザー・コンテキスト情報が取得および格納されるソースのデータ・ソース・コード。 -
Enabled: string
タイトル:
Enabled
最大長:1
デフォルト値:Y
データ・ソースのオブジェクトがユーザー・コンテキストに対して使用可能かどうかを示します。 -
objectConfigDetails: array Object Configuration Details
タイトル:
Object Configuration Details
オブジェクト構成詳細リソースは、オブジェクト構成の表示および更新に使用されます。 -
ObjectTypeCode(required): string
タイトル:
Object Type Code
最大長:30
特定のユーザー・コンテキストに関連するオブジェクト・タイプまたはカテゴリを指定します。 たとえば、取引先、担当者、見込み客などです。 -
ObjectVersionNumber: 整数(int32)
タイトル:
Object Version Number
オブジェクト・バージョン番号は、オプティミスティック・ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。 -
ObjectWeight: 整数(int32)
タイトル:
Object Weight
データ・ソースの重みまたは関連性。 これは、関連スコアの計算に使用されます。 -
Score(required): integer (int64)
タイトル:
Score
関連アイテムのスコア。
ネストされたスキーマ : オブジェクト構成詳細
タイプ:
array
タイトル:
Object Configuration Details
オブジェクト構成詳細リソースは、オブジェクト構成の表示および更新に使用されます。
ソースを表示
ネストされたスキーマ : userContextObjectTypes-objectConfigs-objectConfigDetails-item-post-request
タイプ:
ソースを表示
object
-
DataSourceCode: string
タイトル:
Data Source Code
最大長:30
ユーザー・コンテキスト情報が取得および格納されるソースのデータ・ソース・コード。 -
Enabled: string
タイトル:
Enabled
最大長:1
デフォルト値:Y
保存済検索がユーザー・コンテキストに対して使用可能かどうかを示します。 -
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
保存済検索基準に定義されているベース・スコアを示します。
応答
サポートされるメディア・タイプ
- 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
関連アイテムのスコア。
ネストされたスキーマ : オブジェクト構成詳細
タイプ:
array
タイトル:
Object Configuration Details
オブジェクト構成詳細リソースは、オブジェクト構成の表示および更新に使用されます。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : 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
保存済検索基準に定義されているベース・スコアを示します。
リンク
- objectConfigDetails
-
パラメータ:
- DataSourceCode:
$request.path.DataSourceCode
- ObjectTypeCode:
$request.path.ObjectTypeCode
(objectConfigDetailsのリソース) - DataSourceCode: