Update a field group
patch
/crmRestApi/resources/11.13.18.05/fieldGroups/{FieldGroupNumber}
Request
Path Parameters
-
FieldGroupNumber(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AllFieldsFlag: boolean
Title:
All FieldsMaximum Length:1Default Value:falseIndicates that the field group includes all the fields of the associated object. -
Description: string
Title:
DescriptionMaximum Length:1000The description of the field group. -
EnabledFlag: boolean
Title:
EnabledMaximum Length:1Default Value:falseIndicates if the field group is enabled. -
FieldGroupName: string
Title:
Field Group NameMaximum Length:100The name of the field group. -
fields: array
Field Group Fields
Title:
Field Group FieldsThe field group fields resource is used to view, create, update, and delete fields from a field group. The field groups contain the fields that are part of the field group. -
permissions: array
Field Group Permissions
Title:
Field Group PermissionsThe field group permissions resource is used to view, create, update, and delete field group permissions. Field group permissions contain the association between field groups and access groups. It indicates members of which access group have access to a set of object fields.
Nested Schema : Field Group Fields
Type:
arrayTitle:
Field Group FieldsThe field group fields resource is used to view, create, update, and delete fields from a field group. The field groups contain the fields that are part of the field group.
Show Source
Nested Schema : Field Group Permissions
Type:
arrayTitle:
Field Group PermissionsThe field group permissions resource is used to view, create, update, and delete field group permissions. Field group permissions contain the association between field groups and access groups. It indicates members of which access group have access to a set of object fields.
Show Source
Nested Schema : fieldGroups-permissions-item-patch-request
Type:
Show Source
object-
AccessGroupNumber: string
Maximum Length:
4000The public unique identifier of the access group. -
AccessLevelCd: string
Title:
Access LevelMaximum Length:30Default Value:ORA_SVC_FS_READThe code indicating the level of access that the access group members have to the field such as, ORA_SVC_FS_READ and ORA_SVC_FS_UPDATE.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : fieldGroups-item-response
Type:
Show Source
object-
AllFieldsFlag: boolean
Title:
All FieldsMaximum Length:1Default Value:falseIndicates that the field group includes all the fields of the associated object. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The person who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe creation date of the record. -
Description: string
Title:
DescriptionMaximum Length:1000The description of the field group. -
EnabledFlag: boolean
Title:
EnabledMaximum Length:1Default Value:falseIndicates if the field group is enabled. -
FieldGroupId: integer
(int64)
Title:
Field Group IDRead Only:trueThe unique identifier of the field group. -
FieldGroupName: string
Title:
Field Group NameMaximum Length:100The name of the field group. -
FieldGroupNumber: string
Title:
Field Group NumberMaximum Length:64The public unique identifier of the field group. -
fields: array
Field Group Fields
Title:
Field Group FieldsThe field group fields resource is used to view, create, update, and delete fields from a field group. The field groups contain the fields that are part of the field group. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe last updated date of the record. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The person who last updated the record. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectType: string
Title:
Object TypeMaximum Length:128The business object type associated with the field group. -
permissions: array
Field Group Permissions
Title:
Field Group PermissionsThe field group permissions resource is used to view, create, update, and delete field group permissions. Field group permissions contain the association between field groups and access groups. It indicates members of which access group have access to a set of object fields.
Nested Schema : Field Group Fields
Type:
arrayTitle:
Field Group FieldsThe field group fields resource is used to view, create, update, and delete fields from a field group. The field groups contain the fields that are part of the field group.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Field Group Permissions
Type:
arrayTitle:
Field Group PermissionsThe field group permissions resource is used to view, create, update, and delete field group permissions. Field group permissions contain the association between field groups and access groups. It indicates members of which access group have access to a set of object fields.
Show Source
Nested Schema : fieldGroups-fields-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The person who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe creation date of the record. -
FieldGroupId: integer
(int64)
Title:
Field Group IDThe unique identifier of the field group. -
FieldGroupNumber: string
Title:
Field Group NumberMaximum Length:64The public unique identifier of the field group. -
FieldId: integer
(int64)
Title:
Field IDRead Only:trueThe unique identifier of the field group field. -
FieldName: string
Title:
Field NameMaximum Length:100The name of the field that's part of the field group. -
FieldNumber: string
Title:
Field NumberMaximum Length:64The public unique identifier of the field group field. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe last updated date of the record. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The person who last updated the record. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : fieldGroups-permissions-item-response
Type:
Show Source
object-
AccessGroupId: integer
(int64)
Title:
Access Group IDThe unique identifier of the access group. -
AccessGroupNumber: string
Maximum Length:
4000The public unique identifier of the access group. -
AccessLevelCd: string
Title:
Access LevelMaximum Length:30Default Value:ORA_SVC_FS_READThe code indicating the level of access that the access group members have to the field such as, ORA_SVC_FS_READ and ORA_SVC_FS_UPDATE. -
AccessLevelCdMeaning: string
Title:
Access Level ValueRead Only:trueMaximum Length:255The level of access that the access group members have to the field such as, Read, Update. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The person who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe creation date of the record. -
FieldGroupId: integer
(int64)
Title:
Field Group IDThe unique identifier of the field group. -
FieldGroupNumber: string
Title:
Field Group NumberMaximum Length:64The public unique identifier of the field group. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe last updated date of the record. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The person who last updated the record. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PermissionId: integer
(int64)
Title:
Permission IDRead Only:trueThe unique identifier of the field group permission. -
PermissionNumber: string
Title:
Permission NumberMaximum Length:64The public unique identifier of the field group permission.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- YesNoLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The following properties are defined on the LOV link relation:- Source Attribute: EnabledFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- fields
-
Parameters:
- FieldGroupNumber:
$request.path.FieldGroupNumber
The field group fields resource is used to view, create, update, and delete fields from a field group. The field groups contain the fields that are part of the field group. - FieldGroupNumber:
- permissions
-
Parameters:
- FieldGroupNumber:
$request.path.FieldGroupNumber
The field group permissions resource is used to view, create, update, and delete field group permissions. Field group permissions contain the association between field groups and access groups. It indicates members of which access group have access to a set of object fields. - FieldGroupNumber: