Get a Group for Host Company or Partner Organization
get
/rest/v16/companies/{companyLoginName}/groups/{groupVarName}
This endpoint retrieves a group resource for a host company or partner organization.
Request
Path Parameters
-
companyLoginName(required): string
Company login name.
-
groupVarName(required): string
Variable name of the group.
Query Parameters
-
expand: string
Allows expansion of relationships.Allowed Values:
[ "users", "segments" ]
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 retrieves a group resource for a host company or partner organization by submitting a GET 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/midwestTestGroup
Response Body Sample
{ "label": "Midwest Test Group", "variableName": "midwestTestGroup", "description": "Midwest Test Group", "company": { "value": "_host", "displayValue": "visionServices" }, "type": { "value": 1, "displayValue": "Administrator" }, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/groups/midwestTestGroup" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/groups/midwestTestGroup/segments" }, { "rel": "users", "href": "https://sitename.oracle.com/rest/v16/groups/miswestTestGroup/users" } ] }