Create a Group for Host Company or Partner Organization
post
/rest/v16/companies/{companyLoginName}/groups
This endpoint create a group for the host company and partner organization based on logged in users.
Request
Supported Media Types
- application/json
Path Parameters
-
companyLoginName(required): string
Company login 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
Type:
object
Title:
Group
User group information
Show Source
-
label:
string
Title:
Group Name
Group name -
type:
string
Title:
Group Type
Type of the group -
variableName:
string
Title:
Group Variable Name
Variable name of the group
Examples
The following example creates a group for the host company or partner organization based on logged in users by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Content-type: application/json" -H "Accept: application/json" https://sitename.oracle.com/rest/v16/companies/visionServices/groups
Request Body Sample
{ "label": "Midwest Test Group", "variableName": "midwestTestGroup", "description": "Midwest Test Group", "type": { "value": 1, "displayValue": "Administrator" }, "users": { "items": [{ "login": "superuser" }, { "login": "jsanchez" } ] }, "segments": { "items": [{ "variableName": "_commerceAndDocuments", "checked": false, "segments": { "items": [{ "variableName": "_processDefinition", "checked": true }, { "variableName": "_processInvocation", "checked": true }, { "variableName": "_commerceSettings", "checked": true }, { "variableName": "_documents", "checked": true } ] } }, { "variableName": "_developerTools", "segments": { "items": [{ "variableName": "_dataTables", "checked": false, "segments": { "items": [{ "variableName": "_default", "checked": true }, { "variableName": "aBOTables", "checked": true } ] } } ] } }, { "variableName": "_general", "checked": true }, { "variableName": "_products", "segments": { "items": [{ "variableName": "_catalogDefinition", "segments": { "items": [{ "variableName": "integration", "checked": false } ] } } ] } } ] } }
Response Body Sample
{ "label": "Midwest Test Group", "variableName": "midwestTestGroup", "description": "Midwest Test Group", "company": { "name": "Vision Services", "login": "_host" }, "status": { "value": 1, "displayValue": "Active" }, "type": { "value": 1, "displayValue": "Administrator" }, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/companies/visionServices/groups/midwestTestGroup" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/companies/visionServices/groups/midwestTestGroup/segments" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/companies/visionServices/groups/midwestTestGroup/users" } ] }