Update Specific Group Details for the Host Company or Partner Organization
patch
/rest/v19/companies/{companyLoginName}/groups/{groupVarName}
This endpoint updates an existing group but does not require sending the entire body with the request.
Request
Supported Media Types
- application/json
Path Parameters
-
companyLoginName(required): string
Company login name.
-
groupVarName(required): string
Group variable name.
Root Schema : Group Details
Type:
object
Title:
Show Source
Group Details
-
description:
string
Title:
Description
Description of the group. -
label(required):
string
Title:
Label
Name of the group. -
segments:
object Segments
Title:
Segments
Access Segments for the group. -
status:
object Status
Title:
Status
Preferred status format of the group. -
type(required):
object Type
Title:
Type
Preferred type format of the group. -
users:
object Selected Users
Title:
Selected Users
The users list part of the group. -
variableName(required):
string
Title:
VariableName
Variable name of the group.
Nested Schema : Status
Type:
object
Title:
Status
Preferred status format of the group.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value(required):
number
Title:
Value
Value.
Nested Schema : Type
Type:
object
Title:
Type
Preferred type format of the group.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value(required):
number
Title:
Value
Value.
Nested Schema : Selected Users
Type:
object
Title:
Selected Users
The users list part of the group.
Show Source
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Segment Details
Title:
Segment Details
Nested Schema : Segment Details
Type:
object
Title:
Show Source
Segment Details
-
checked:
boolean
Title:
Checked
Is segment enabled. -
icon:
string
Title:
Icon
Path of the icon image file. This field is only applicable if uiMetadata is set as true. -
segments:
object Sub Segments
Title:
Sub Segments
Sub access segments for the segment. -
status:
integer
Title:
Status
Specifies if the segment is enabled, partially selected or unselected. Possible values are 0[UNCHECKED], 1[PARTIALCHECKED],2[CHECKED]. This field is only applicable if uiMetadata is set as true. -
variableName(required):
string
Title:
VariableName
Segment variable name.
Nested Schema : Sub Segments
Type:
object
Title:
Sub Segments
Sub access segments for the segment.
Show Source
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Sub Segment Details
Title:
Sub Segment Details
Nested Schema : Sub Segment Details
Type:
object
Title:
Show Source
Sub Segment Details
-
checked:
boolean
Title:
Checked
Is segment enabled. -
icon:
string
Title:
Icon
Path of the icon image file. This field is only applicable if uiMetadata is set as true. -
status:
integer
Title:
Status
Specifies if the segment is enabled, partially selected or unselected. Possible values are 0[UNCHECKED], 1[PARTIALCHECKED],2[CHECKED]. This field is only applicable if uiMetadata is set as true. -
title:
string
Title:
title
Segment label. -
variableName(required):
string
Title:
VariableName
Segment variable name.
Nested Schema : User Details
Type:
object
Title:
Show Source
User Details
-
login(required):
string
Title:
Login
User login name.
Response
Supported Media Types
- application/json
Default Response
Group details.
Root Schema : Group Details
Type:
object
Title:
Show Source
Group Details
-
company:
object Company Details
Title:
Company Details
Company details to which the group belongs. -
description:
string
Title:
Description
Description of the group. -
label:
string
Title:
Label
Label of the group. -
links:
array Links to the related objects
Title:
Links to the related objects
Links to the related objects -
readOnly:
boolean
Title:
ReadOnly
Is read only group? -
segments:
object Segments
Title:
Segments
Access Segments for a group -
status:
object Status
Title:
Status
Status of the group. -
type:
object Type
Title:
Type
Type of the group. -
users:
object Users
Title:
Users
All users of a group -
variableName:
string
Title:
VariableName
Group variable name.
Nested Schema : Company Details
Type:
object
Title:
Company Details
Company details to which the group belongs.
Show Source
-
loginName:
string
Title:
Company Login Name
Company login name. -
name:
string
Title:
Company Name
Company name.
Nested Schema : Links to the related objects
Type:
array
Title:
Links to the related objects
Links to the related objects
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : Segments
Type:
object
Title:
Segments
Access Segments for a group
Show Source
-
items:
array items
-
links:
array Links to the related objects
Title:
Links to the related objects
Links to the related objects
Nested Schema : Status
Type:
object
Title:
Status
Status of the group.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value.
Nested Schema : Type
Type:
object
Title:
Type
Type of the group.
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value.
Nested Schema : Users
Type:
object
Title:
Users
All users of a group
Show Source
-
items:
array items
-
links:
array Links
Title:
Links
Links to the related objects.
Nested Schema : reference links
Type:
object
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
URL to the related object
URL to the related object -
name:
string
-
rel:
string
Title:
Link Relationship to the current object
Default Value:self
Link Relationship to the current object
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Segment Details
Title:
Segment Details
Nested Schema : Links to the related objects
Type:
array
Title:
Links to the related objects
Links to the related objects
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : Segment Details
Type:
object
Title:
Show Source
Segment Details
-
checked:
boolean
Title:
Checked
Is segment enabled. -
icon:
string
Title:
Icon
Path of the icon image file. This field is only applicable if uiMetadata is set as true. -
segments:
object Sub Segments
Title:
Sub Segments
Sub access segments for the segment. -
status:
integer
Title:
Status
Specifies if the segment is enabled, partially selected or unselected. Possible values are 0[UNCHECKED], 1[PARTIALCHECKED],2[CHECKED]. This field is only applicable if uiMetadata is set as true. -
variableName(required):
string
Title:
VariableName
Segment variable name.
Nested Schema : Sub Segments
Type:
object
Title:
Sub Segments
Sub access segments for the segment.
Show Source
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Sub Segment Details
Title:
Sub Segment Details
Nested Schema : Sub Segment Details
Type:
object
Title:
Show Source
Sub Segment Details
-
checked:
boolean
Title:
Checked
Is segment enabled. -
icon:
string
Title:
Icon
Path of the icon image file. This field is only applicable if uiMetadata is set as true. -
status:
integer
Title:
Status
Specifies if the segment is enabled, partially selected or unselected. Possible values are 0[UNCHECKED], 1[PARTIALCHECKED],2[CHECKED]. This field is only applicable if uiMetadata is set as true. -
title:
string
Title:
title
Segment label. -
variableName(required):
string
Title:
VariableName
Segment variable name.
Nested Schema : items
Type:
Show Source
array
-
Array of:
object User Details
Title:
User Details
User details of group.
Nested Schema : Links
Type:
array
Title:
Links
Links to the related objects.
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : User Details
Type:
object
Title:
User Details
User details of group.
Show Source
-
firstName:
string
Title:
User First Name
First name of the user. -
lastName:
string
Title:
User Last Name
Last name of the user. -
login:
string
Title:
User Login Id
Login Id of the user.
Examples
The following example updates specific group details for a host company or partner organization with that specified in the web services request by submitting a PATCH request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X PATCH -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json" https://sitename.oracle.com/rest/v19/companies/visionServices/groups/midwestTestGroup
Request Body Sample
{ "description": "Midwest Test Project", "status": { "value": 0 }, "users": [{ "login": "ljones" }, { "login": "msmith" }, { "login": "jsanchez" } ], "segments": { "items": [{ "variableName": "_developerTools", "segments": { "items": [{ "variableName": "_dataTables", "checked": false, "segments": { "items": [{ "variableName": "aBOTables", "checked": false } ] } } ] } } ] } }
Response Body Sample
{ "label": "Midwest Test Group", "variableName": "midwestTestGroup", "description": "Midwest Test Project", "company": { "value": "_host", "displayValue": "visionServices" }, "type": { "value": 1, "displayValue": "Administrator" }, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/companies/visionServices/groups/a100kparts" }, { "rel": "users", "href": "https://sitename.oracle.com/rest/v19/companies/visionServices/groups/a100kparts/users" }, { "name": "segments", "rel": "child", "href": "https://sitename.oracle.com/rest/v19/companies/visionServices/groups/a100kparts/users" } ] }