フィールド・グループの作成
post
/crmRestApi/resources/11.13.18.05/fieldGroups
リクエスト
ヘッダー・パラメータ
- 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
-
AllFieldsFlag: boolean
タイトル:
All Fields
最大長:1
デフォルト値:false
フィールド・グループに、関連付けられたオブジェクトのすべてのフィールドが含まれていることを示します。 -
Description: string
タイトル:
Description
最大長:1000
フィールド・グループの摘要。 -
EnabledFlag: boolean
タイトル:
Enabled
最大長:1
デフォルト値:false
フィールド・グループが使用可能かどうかを示します。 -
FieldGroupName(required): string
タイトル:
Field Group Name
最大長:100
フィールド・グループの名前。 -
FieldGroupNumber: string
タイトル:
Field Group Number
最大長:64
フィールド・グループの公開一意識別子。 -
fields: array Field Group Fields
タイトル:
Field Group Fields
フィールド・グループ・フィールド・リソースは、フィールド・グループからのフィールドの表示、作成、更新および削除に使用されます。 フィールド・グループには、フィールド・グループの一部であるフィールドが含まれます。 -
ObjectType(required): string
タイトル:
Object Type
最大長:128
フィールド・グループに関連付けられたビジネス・オブジェクト・タイプ。 -
permissions: array Field Group Permissions
タイトル:
Field Group Permissions
フィールド・グループ権限リソースは、フィールド・グループ権限の表示、作成、更新および削除に使用されます。 フィールド・グループ権限には、フィールド・グループとアクセス・グループ間の関連付けが含まれます。 アクセス・グループが一連のオブジェクト・フィールドにアクセスできるメンバーを示します。
ネストされたスキーマ : フィールド・グループのフィールド
タイプ:
array
タイトル:
Field Group Fields
フィールド・グループ・フィールド・リソースは、フィールド・グループからのフィールドの表示、作成、更新および削除に使用されます。 フィールド・グループには、フィールド・グループの一部であるフィールドが含まれます。
ソースを表示
ネストされたスキーマ : フィールド・グループ権限
タイプ:
array
タイトル:
Field Group Permissions
フィールド・グループ権限リソースは、フィールド・グループ権限の表示、作成、更新および削除に使用されます。 フィールド・グループ権限には、フィールド・グループとアクセス・グループ間の関連付けが含まれます。 アクセス・グループが一連のオブジェクト・フィールドにアクセスできるメンバーを示します。
ソースを表示
ネストされたスキーマ : fieldGroups-fields-item-post-request
タイプ:
ソースを表示
object
-
FieldGroupId: integer (int64)
タイトル:
Field Group ID
フィールド・グループの一意の識別子。 -
FieldGroupNumber: string
タイトル:
Field Group Number
最大長:64
フィールド・グループの公開一意識別子。 -
FieldName: string
タイトル:
Field Name
最大長:100
フィールド・グループの一部であるフィールドの名前。 -
FieldNumber: string
タイトル:
Field Number
最大長:64
フィールド・グループ・フィールドの公開一意識別子。
ネストされたスキーマ : fieldGroups-permissions-item-post-request
タイプ:
ソースを表示
object
-
AccessGroupId: integer (int64)
タイトル:
Access Group ID
アクセス・グループの一意の識別子。 -
AccessGroupNumber: string
最大長:
4000
アクセス・グループの公開一意識別子。 -
AccessLevelCd: string
タイトル:
Access Level
最大長:30
デフォルト値:ORA_SVC_FS_READ
ORA_SVC_FS_READやORA_SVC_FS_UPDATEなど、アクセス・グループ・メンバーがフィールドに対して持つアクセス・レベルを示すコード。 -
FieldGroupId: integer (int64)
タイトル:
Field Group ID
フィールド・グループの一意の識別子。 -
FieldGroupNumber: string
タイトル:
Field Group Number
最大長:64
フィールド・グループの公開一意識別子。 -
PermissionNumber: string
タイトル:
Permission Number
最大長:64
フィールド・グループ権限の公開一意識別子。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : fieldGroups-item-response
タイプ:
ソースを表示
object
-
AllFieldsFlag: boolean
タイトル:
All Fields
最大長:1
デフォルト値:false
フィールド・グループに、関連付けられたオブジェクトのすべてのフィールドが含まれていることを示します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードの作成日。 -
Description: string
タイトル:
Description
最大長:1000
フィールド・グループの摘要。 -
EnabledFlag: boolean
タイトル:
Enabled
最大長:1
デフォルト値:false
フィールド・グループが使用可能かどうかを示します。 -
FieldGroupId: integer (int64)
タイトル:
Field Group ID
読取り専用:true
フィールド・グループの一意の識別子。 -
FieldGroupName: string
タイトル:
Field Group Name
最大長:100
フィールド・グループの名前。 -
FieldGroupNumber: string
タイトル:
Field Group Number
最大長:64
フィールド・グループの公開一意識別子。 -
fields: array Field Group Fields
タイトル:
Field Group Fields
フィールド・グループ・フィールド・リソースは、フィールド・グループからのフィールドの表示、作成、更新および削除に使用されます。 フィールド・グループには、フィールド・グループの一部であるフィールドが含まれます。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードの最終更新日。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectType: string
タイトル:
Object Type
最大長:128
フィールド・グループに関連付けられたビジネス・オブジェクト・タイプ。 -
permissions: array Field Group Permissions
タイトル:
Field Group Permissions
フィールド・グループ権限リソースは、フィールド・グループ権限の表示、作成、更新および削除に使用されます。 フィールド・グループ権限には、フィールド・グループとアクセス・グループ間の関連付けが含まれます。 アクセス・グループが一連のオブジェクト・フィールドにアクセスできるメンバーを示します。
ネストされたスキーマ : フィールド・グループのフィールド
タイプ:
array
タイトル:
Field Group Fields
フィールド・グループ・フィールド・リソースは、フィールド・グループからのフィールドの表示、作成、更新および削除に使用されます。 フィールド・グループには、フィールド・グループの一部であるフィールドが含まれます。
ソースを表示
ネストされたスキーマ : フィールド・グループ権限
タイプ:
array
タイトル:
Field Group Permissions
フィールド・グループ権限リソースは、フィールド・グループ権限の表示、作成、更新および削除に使用されます。 フィールド・グループ権限には、フィールド・グループとアクセス・グループ間の関連付けが含まれます。 アクセス・グループが一連のオブジェクト・フィールドにアクセスできるメンバーを示します。
ソースを表示
ネストされたスキーマ : fieldGroups-fields-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードの作成日。 -
FieldGroupId: integer (int64)
タイトル:
Field Group ID
フィールド・グループの一意の識別子。 -
FieldGroupNumber: string
タイトル:
Field Group Number
最大長:64
フィールド・グループの公開一意識別子。 -
FieldId: integer (int64)
タイトル:
Field ID
読取り専用:true
フィールド・グループ・フィールドの一意の識別子。 -
FieldName: string
タイトル:
Field Name
最大長:100
フィールド・グループの一部であるフィールドの名前。 -
FieldNumber: string
タイトル:
Field Number
最大長:64
フィールド・グループ・フィールドの公開一意識別子。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードの最終更新日。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : fieldGroups-permissions-item-response
タイプ:
ソースを表示
object
-
AccessGroupId: integer (int64)
タイトル:
Access Group ID
アクセス・グループの一意の識別子。 -
AccessGroupNumber: string
最大長:
4000
アクセス・グループの公開一意識別子。 -
AccessLevelCd: string
タイトル:
Access Level
最大長:30
デフォルト値:ORA_SVC_FS_READ
ORA_SVC_FS_READやORA_SVC_FS_UPDATEなど、アクセス・グループ・メンバーがフィールドに対して持つアクセス・レベルを示すコード。 -
AccessLevelCdMeaning: string
タイトル:
Access Level Value
読取り専用:true
最大長:255
アクセス・グループ・メンバーがフィールドに対して持つアクセス・レベル(読取り、更新など)。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードの作成日。 -
FieldGroupId: integer (int64)
タイトル:
Field Group ID
フィールド・グループの一意の識別子。 -
FieldGroupNumber: string
タイトル:
Field Group Number
最大長:64
フィールド・グループの公開一意識別子。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードの最終更新日。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PermissionId: integer (int64)
タイトル:
Permission ID
読取り専用:true
フィールド・グループ権限の一意の識別子。 -
PermissionNumber: string
タイトル:
Permission Number
最大長:64
フィールド・グループ権限の公開一意識別子。
リンク
- YesNoLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DYES_NO
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: EnabledFlag;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- フィールド
-
パラメータ:
- FieldGroupNumber:
$request.path.FieldGroupNumber
フィールド・グループ・フィールド・リソースは、フィールド・グループからのフィールドの表示、作成、更新および削除に使用されます。 フィールド・グループには、フィールド・グループの一部であるフィールドが含まれます。 - FieldGroupNumber:
- 権限
-
パラメータ:
- FieldGroupNumber:
$request.path.FieldGroupNumber
フィールド・グループ権限リソースは、フィールド・グループ権限の表示、作成、更新および削除に使用されます。 フィールド・グループ権限には、フィールド・グループとアクセス・グループ間の関連付けが含まれます。 アクセス・グループが一連のオブジェクト・フィールドにアクセスできるメンバーを示します。 - FieldGroupNumber: