アクセス・グループの更新
patch
/crmRestApi/resources/11.13.18.05/accessGroups/{AccessGroupNumber}
リクエスト
パス・パラメータ
- AccessGroupNumber(required): string
アクセス・グループの代替キー識別子。 システム生成の一意の連番です。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
AccessGroupMembers: array Access Group Members
タイトル:
Access Group Members
アクセス・グループ・メンバー・リソースは、グループのメンバーを表示、作成および削除するために使用されます。 グループ・メンバーは、グループの一部であるリソースです。 -
ActiveFlag: boolean
タイトル:
Active
最大長:1
デフォルト値:false
アクセス・グループがアクティブかどうかを示します。 -
Description: string
タイトル:
Description
最大長:4000
アクセス・グループの説明。 -
Name: string
タイトル:
Name
最大長:4000
アクセス・グループの名前。
ネストされたスキーマ : アクセス・グループ・メンバー
タイプ:
array
タイトル:
Access Group Members
アクセス・グループ・メンバー・リソースは、グループのメンバーを表示、作成および削除するために使用されます。 グループ・メンバーは、グループの一部であるリソースです。
ソースを表示
ネストされたスキーマ : accessGroups-AccessGroupMembers-item-patch-request
タイプ:
ソースを表示
object
-
AccessGroupId: integer (int64)
タイトル:
Access Group ID
アクセス・グループの一意の識別子。 -
AccessGroupMemberId: integer (int64)
タイトル:
Access Group Member ID
アクセス・グループ・メンバーの一意の識別子。 -
PartyId: integer (int64)
タイトル:
Party ID
アクセス・グループ・メンバーの一意の識別子。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : accessGroups-item-response
タイプ:
ソースを表示
object
-
AccessGroupId: integer (int64)
タイトル:
Access Group ID
アクセス・グループの一意の識別子。 -
AccessGroupMembers: array Access Group Members
タイトル:
Access Group Members
アクセス・グループ・メンバー・リソースは、グループのメンバーを表示、作成および削除するために使用されます。 グループ・メンバーは、グループの一部であるリソースです。 -
AccessGroupNumber: string
タイトル:
Number
最大長:4000
アクセス・グループの代替キー識別子。 システム生成の一意の連番です。 -
ActiveFlag: boolean
タイトル:
Active
最大長:1
デフォルト値:false
アクセス・グループがアクティブかどうかを示します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
アクセス・グループを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
アクセス・グループが作成された日付。 -
DeleteFlag: boolean
タイトル:
Delete
読取り専用:true
デフォルト値:true
レコードを削除できるかどうかを示します。 -
Description: string
タイトル:
Description
最大長:4000
アクセス・グループの説明。 -
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
最大長:4000
アクセス・グループの名前。 -
TypeCode: string
タイトル:
Type
最大長:30
デフォルト値:ORA_ZCA_CUSTOM
アクセス・グループのタイプを示すコード。 -
TypeCodeMeaning: string
タイトル:
Type
読取り専用:true
最大長:80
アクセス・グループのタイプ。 -
UpdateFlag: boolean
タイトル:
Update
読取り専用:true
デフォルト値:true
レコードを更新できるかどうかを示します。
ネストされたスキーマ : アクセス・グループ・メンバー
タイプ:
array
タイトル:
Access Group Members
アクセス・グループ・メンバー・リソースは、グループのメンバーを表示、作成および削除するために使用されます。 グループ・メンバーは、グループの一部であるリソースです。
ソースを表示
ネストされたスキーマ : accessGroups-AccessGroupMembers-item-response
タイプ:
ソースを表示
object
-
AccessGroupId: integer (int64)
タイトル:
Access Group ID
アクセス・グループの一意の識別子。 -
AccessGroupMemberId: integer (int64)
タイトル:
Access Group Member ID
アクセス・グループ・メンバーの一意の識別子。 -
AccessGroupNumber: string
タイトル:
Group Number
読取り専用:true
最大長:4000
アクセス・グループ・メンバーが属するアクセス・グループの代替キー識別子。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
アクセス・グループ・メンバーを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
アクセス・グループ・メンバーが作成された日付。 -
EmailAddress: string
タイトル:
E-Mail
読取り専用:true
最大長:320
アクセス・グループ・メンバーの電子メール・アドレス。 -
FormattedPhoneNumber: string
タイトル:
Phone
読取り専用: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
リソース・インスタンスに関連付けられたリンク関係。 -
ManualAssignFlag: boolean
タイトル:
Member Type
最大長:1
デフォルト値:true
メンバーが手動でグループに追加されたかどうかを示します。 -
Name: string
タイトル:
Group Name
読取り専用:true
最大長:4000
アクセス・グループ・メンバーが属するアクセス・グループの名前。 -
PartyId: integer (int64)
タイトル:
Party ID
アクセス・グループ・メンバーの一意の識別子。 -
PartyName: string
タイトル:
Resource Name
読取り専用:true
最大長:255
アクセス・グループ・メンバーの名前。 -
PartyNumber: string
タイトル:
Resource Registry ID
読取り専用:true
最大長:30
リソースの代替キー識別子。 -
RoleName: string
タイトル:
Resource Role
読取り専用:true
アクセス・グループ・メンバーに関連付けられたリソースのロール。 -
TypeCode: string
タイトル:
Type Code
最大長:30
デフォルト値:ORA_ZCA_CUSTOM
アクセス・グループ・メンバーの親アクセス・グループ・タイプを示すコード。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
リンク
- AccessGroupMembers
-
パラメータ:
- AccessGroupNumber:
$request.path.AccessGroupNumber
アクセス・グループ・メンバー・リソースは、グループのメンバーを表示、作成および削除するために使用されます。 グループ・メンバーは、グループの一部であるリソースです。 - AccessGroupNumber: