Update a field group

patch

/crmRestApi/resources/11.13.18.05/fieldGroups/{FieldGroupNumber}

Request

Path Parameters
  • 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
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: All Fields
    Maximum Length: 1
    Default Value: false
    Indicates that the field group includes all the fields of the associated object.
  • Title: Description
    Maximum Length: 1000
    The description of the field group.
  • Title: Enabled
    Maximum Length: 1
    Default Value: false
    Indicates if the field group is enabled.
  • Title: Field Group Name
    Maximum Length: 100
    The name of the field group.
  • Field Group Fields
    Title: Field Group Fields
    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.
  • Field Group Permissions
    Title: Field Group Permissions
    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.
Nested Schema : Field Group Fields
Type: array
Title: Field Group Fields
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.
Show Source
Nested Schema : Field Group Permissions
Type: array
Title: Field Group Permissions
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.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : fieldGroups-permissions-item-patch-request
Type: object
Show Source
  • Maximum Length: 4000
    The public unique identifier of the access group.
  • Title: Access Level
    Maximum Length: 30
    Default Value: ORA_SVC_FS_READ
    The 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.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : fieldGroups-item-response
Type: object
Show Source
  • Title: All Fields
    Maximum Length: 1
    Default Value: false
    Indicates that the field group includes all the fields of the associated object.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The person who created the record.
  • Title: Creation Date
    Read Only: true
    The creation date of the record.
  • Title: Description
    Maximum Length: 1000
    The description of the field group.
  • Title: Enabled
    Maximum Length: 1
    Default Value: false
    Indicates if the field group is enabled.
  • Title: Field Group ID
    Read Only: true
    The unique identifier of the field group.
  • Title: Field Group Name
    Maximum Length: 100
    The name of the field group.
  • Title: Field Group Number
    Maximum Length: 64
    The public unique identifier of the field group.
  • Field Group Fields
    Title: Field Group Fields
    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.
  • Title: Last Updated Date
    Read Only: true
    The last updated date of the record.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The person who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Object Type
    Maximum Length: 128
    The business object type associated with the field group.
  • Field Group Permissions
    Title: Field Group Permissions
    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.
Nested Schema : Field Group Fields
Type: array
Title: Field Group Fields
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.
Show Source
Nested Schema : Field Group Permissions
Type: array
Title: Field Group Permissions
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.
Show Source
Nested Schema : fieldGroups-fields-item-response
Type: object
Show Source
Nested Schema : fieldGroups-permissions-item-response
Type: object
Show Source
Back to Top