アクセス・グループ拡張ルールの作成
post
/crmRestApi/resources/11.13.18.05/accessGroupExtensionRules
リクエスト
ヘッダー・パラメータ
- 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
-
accessGroupExtensionRuleDetails: array Access Group Extension Rule Details
タイトル:
Access Group Extension Rule Details
アクセス拡張ルール詳細リソースは、アクセス拡張ルールの詳細を表示、作成、更新および削除するために使用されます。 アクセス拡張ルール詳細を使用して、オブジェクト共有ルール内のオブジェクトに定義されているアクセスを関連オブジェクトに拡張します。 -
AccExtRuleId: integer (int64)
タイトル:
Access Extension Rule ID
アクセス拡張ルールの一意の識別子。 -
AccExtRuleNumber: string
タイトル:
Access Extension Rule Number
最大長:30
アクセス拡張ルールの代替キー識別子。 システム生成の一意の連番です。 -
ActiveFlag: boolean
タイトル:
Active
最大長:1
デフォルト値:true
アクセス拡張ルールがアクティブかどうかを示します。 -
Description: string
タイトル:
Description
最大長:255
アクセス拡張ルールの説明。 -
ExtendAllRulesFlag: boolean
タイトル:
Extend All Rules Indicator
最大長:1
デフォルト値:true
ソース・オブジェクトからターゲット・オブジェクトに拡張するルールを識別するために使用するメソッドを示します。 -
Name(required): string
タイトル:
Name
最大長:200
アクセス拡張ルールの名前。 -
RelationshipId(required): integer (int64)
タイトル:
Related Object
ソース・オブジェクトとターゲット・オブジェクト間の関係の一意の識別子。 -
RelationshipName: string
タイトル:
Relationship Name
ソース・オブジェクトとターゲット・オブジェクト間の関係の名前。 -
RelationshipTypeCode: string
タイトル:
Relationship Type Code
ソース・オブジェクトとターゲット・オブジェクト間の関係のタイプ。
ネストされたスキーマ : アクセス・グループ拡張ルール詳細
タイプ:
array
タイトル:
Access Group Extension Rule Details
アクセス拡張ルール詳細リソースは、アクセス拡張ルールの詳細を表示、作成、更新および削除するために使用されます。 アクセス拡張ルール詳細を使用して、オブジェクト共有ルール内のオブジェクトに定義されているアクセスを関連オブジェクトに拡張します。
ソースを表示
ネストされたスキーマ : accessGroupExtensionRules-accessGroupExtensionRuleDetails-item-post-request
タイプ:
ソースを表示
object
-
AccessGroupNumber: string
タイトル:
Group Number
ソース・オブジェクトのルールに関連付けられているアクセス・グループの代替キー識別子。 -
AccExtRuleDetailId: integer (int64)
タイトル:
Access Extension Rule Detail ID
アクセス拡張ルール詳細の一意の識別子。 -
AccExtRuleId: integer (int64)
タイトル:
Access Extension Rule ID
アクセス拡張ルールの一意の識別子。 -
DeleteAccessPermissionFlag: boolean
タイトル:
Delete Access Permission Indicator
最大長:1
デフォルト値:false
削除アクセス権が付与されているかどうかを示します。 -
ReadAccessPermissionFlag: boolean
タイトル:
Read Access Permission Indicator
最大長:1
デフォルト値:false
読取りアクセス権が付与されているかどうかを示します。 -
SrcObjAccessGroupId: integer (int64)
タイトル:
Source Object Access Group ID
ソース・オブジェクトのルールに関連付けられているアクセス・グループの一意の識別子。 -
SrcObjectRuleGuid: string
タイトル:
Source Object Rule GUID
最大長:64
ソース・オブジェクトのルールの一意の識別子。 -
SrcObjectRuleNumber: string
タイトル:
Source Object Rule Number
ソース・オブジェクトのルールの代替キー識別子。 -
UpdateAccessPermissionFlag: boolean
タイトル:
Update Access Permission Indicator
最大長:1
デフォルト値:false
更新アクセス権が付与されているかどうかを示します。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : accessGroupExtensionRules-item-response
タイプ:
ソースを表示
object
-
accessGroupExtensionRuleDetails: array Access Group Extension Rule Details
タイトル:
Access Group Extension Rule Details
アクセス拡張ルール詳細リソースは、アクセス拡張ルールの詳細を表示、作成、更新および削除するために使用されます。 アクセス拡張ルール詳細を使用して、オブジェクト共有ルール内のオブジェクトに定義されているアクセスを関連オブジェクトに拡張します。 -
AccExtRuleId: integer (int64)
タイトル:
Access Extension Rule ID
アクセス拡張ルールの一意の識別子。 -
AccExtRuleNumber: string
タイトル:
Access Extension Rule Number
最大長:30
アクセス拡張ルールの代替キー識別子。 システム生成の一意の連番です。 -
ActiveFlag: boolean
タイトル:
Active
最大長:1
デフォルト値:true
アクセス拡張ルールがアクティブかどうかを示します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
アクセス拡張ルールを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
アクセス拡張ルールが作成された日付。 -
DeleteFlag: boolean
タイトル:
Delete
読取り専用:true
レコードを削除できるかどうかを示します。 -
Description: string
タイトル:
Description
最大長:255
アクセス拡張ルールの説明。 -
ExtendAllRulesFlag: boolean
タイトル:
Extend All Rules Indicator
最大長:1
デフォルト値:true
ソース・オブジェクトからターゲット・オブジェクトに拡張するルールを識別するために使用するメソッドを示します。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
Name: string
タイトル:
Name
最大長:200
アクセス拡張ルールの名前。 -
PredefinedFlag: boolean
タイトル:
Predefined Indicator
読取り専用:true
最大長:255
アクセス拡張ルールが事前定義されているかどうかを示します。 -
RelationshipDisplayName: string
タイトル:
Relationship Display Name
読取り専用:true
ソース・オブジェクトとターゲット・オブジェクト間の関係の表示名。 -
RelationshipId: integer (int64)
タイトル:
Related Object
ソース・オブジェクトとターゲット・オブジェクト間の関係の一意の識別子。 -
RelationshipName: string
タイトル:
Relationship Name
ソース・オブジェクトとターゲット・オブジェクト間の関係の名前。 -
RelationshipTypeCode: string
タイトル:
Relationship Type Code
ソース・オブジェクトとターゲット・オブジェクト間の関係のタイプ。 -
SourceObjectCode: string
タイトル:
Source Object Code
読取り専用:true
アクセス拡張ルールで使用されるソース・オブジェクトのコード。 -
SourceObjectName: string
タイトル:
Source Object Name
読取り専用:true
アクセス拡張ルールで使用されるソース・オブジェクトの名前。 -
TargetObjectCode: string
タイトル:
Target Object Code
読取り専用:true
アクセス拡張ルールで使用されるターゲット・オブジェクトのコード。 -
TargetObjectName: string
タイトル:
Target Object Name
読取り専用:true
アクセス拡張ルールで使用されるターゲット・オブジェクトの名前。 -
UpdateFlag: boolean
タイトル:
Update
読取り専用:true
レコードを更新できるかどうかを示します。
ネストされたスキーマ : アクセス・グループ拡張ルール詳細
タイプ:
array
タイトル:
Access Group Extension Rule Details
アクセス拡張ルール詳細リソースは、アクセス拡張ルールの詳細を表示、作成、更新および削除するために使用されます。 アクセス拡張ルール詳細を使用して、オブジェクト共有ルール内のオブジェクトに定義されているアクセスを関連オブジェクトに拡張します。
ソースを表示
ネストされたスキーマ : accessGroupExtensionRules-accessGroupExtensionRuleDetails-item-response
タイプ:
ソースを表示
object
-
AccessGroupNumber: string
タイトル:
Group Number
ソース・オブジェクトのルールに関連付けられているアクセス・グループの代替キー識別子。 -
AccExtRuleDetailId: integer (int64)
タイトル:
Access Extension Rule Detail ID
アクセス拡張ルール詳細の一意の識別子。 -
AccExtRuleId: integer (int64)
タイトル:
Access Extension Rule ID
アクセス拡張ルールの一意の識別子。 -
AccExtRuleNumber: string
タイトル:
Access Extension Rule Number
読取り専用:true
最大長:30
アクセス拡張ルールの代替キー識別子。 システム生成の一意の連番です。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
アクセス拡張ルールを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
アクセス拡張ルールが作成された日付。 -
DeleteAccessPermissionFlag: boolean
タイトル:
Delete Access Permission Indicator
最大長:1
デフォルト値:false
削除アクセス権が付与されているかどうかを示します。 -
DeleteFlag: boolean
タイトル:
Delete
読取り専用:true
レコードを削除できるかどうかを示します。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
ReadAccessPermissionFlag: boolean
タイトル:
Read Access Permission Indicator
最大長:1
デフォルト値:false
読取りアクセス権が付与されているかどうかを示します。 -
SrcObjAccessGroupId: integer (int64)
タイトル:
Source Object Access Group ID
ソース・オブジェクトのルールに関連付けられているアクセス・グループの一意の識別子。 -
SrcObjectRuleGuid: string
タイトル:
Source Object Rule GUID
最大長:64
ソース・オブジェクトのルールの一意の識別子。 -
SrcObjectRuleNumber: string
タイトル:
Source Object Rule Number
ソース・オブジェクトのルールの代替キー識別子。 -
UpdateAccessPermissionFlag: boolean
タイトル:
Update Access Permission Indicator
最大長:1
デフォルト値:false
更新アクセス権が付与されているかどうかを示します。 -
UpdateFlag: boolean
タイトル:
Update
読取り専用:true
レコードを更新できるかどうかを示します。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
リンク
- AccessGroupRelationshipsVO
-
ソース・オブジェクトとターゲット・オブジェクト間の関係のリスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: RelationshipId;ターゲット属性: RelationshipId
- 表示属性: RelationshipDisplayCalcName
- accessGroupExtensionRuleDetails
-
パラメータ:
- AccExtRuleNumber:
$request.path.AccExtRuleNumber
アクセス拡張ルール詳細リソースは、アクセス拡張ルールの詳細を表示、作成、更新および削除するために使用されます。 アクセス拡張ルール詳細を使用して、オブジェクト共有ルール内のオブジェクトに定義されているアクセスを関連オブジェクトに拡張します。 - AccExtRuleNumber: