Groups REST API

Overview

The Groups REST API adds group support for partner organizations and the host company via REST API services.

Note the following access permissions for Groups REST API:

FullAccess host company users with access administrator or user administrator permission can access or modify groups of the host company and partner organization(s) provided they have the Groups/Partner Organizations segment access.
FullAccess partner organization users can access and modify the sales groups of their own company.

Administration

Get All Groups
Description	This endpoint retrieves a list of groups across companies.
URI Endpoint	/rest/v17/groups
Endpoint Query Parameters	This endpoint supports the following query specifications. For more information, see Manage Collections. q - Declares a query specification expression. excludeLinks - Exclude links from the response. expand – Allows expansion of relationships. Allowed value is `users`. fields - A list of fields to be returned. limit – Specifies the pagination size to limit the number of elements the collection returns at a maximum. offset – The offset of the page. By default, offset is 0, which means first page will be returned. orderby - Specifies a comma-separated list of fields to order the response by. totalResults - Specifies that the total count of records that should be included in the response when doing pagination. Only effective when limit or offset are specified.
Endpoint Parameters	None
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data containing the groups for the host company and partner organizations.

URI Endpoint Sample

https://site.oracle.com/rest/v17/groups?limit=2&totalResults=true

Sample Response Body

{ "items": [{ "label": "100k Parts", "variableName": "a100kparts", "company": { "name": "visionServices", "loginName": "_host" }, "status": { "value": 1, "displayValue": "Active" }, "type": { "value": 0, "displayValue": "Sales" }, "readOnly": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/companies/visionServices/groups/a100kparts" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/companies/visionServices/groups/a100kparts/users" } ] }, { "label": "No Longer Used 07", "variableName": "excludeMDBParts", "company": { "name": "visionServices", "loginName": "_host" }, "status": { "value": 1, "displayValue": "Active" }, "type": { "value": 0, "displayValue": "Sales" }, "readOnly": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/companies/visionServices/groups/excludeMDBParts" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/companies/visionServices/groups/excludeMDBParts/users" } ] } ], "offset": 0, "limit": 2, "count": 2, "totalResults": 101, "hasMore": true, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/groups" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/groups?offset=0&limit=2&totalResults=true" }, { "rel": "next", "href": "https://sitename.oracle.com/rest/v17/groups?offset=2&limit=2&totalResults=true" } ] }

Get Groups for the Host Company or for a Partner Organization

Get Groups for the Host Company or a Partner Organization
Description	This endpoint retrieves a list of groups for the host company or for a partner organization.
URI Endpoint	/rest/v17/companies/{companyLoginName}/groups
Endpoint Parameters	companyLoginName	The host company or partner organization login name
Endpoint Parameters	This endpoint supports the following query specification. For more information, see Manage Collections. q - Declares a query specification expression. excludeLinks - Exclude links from the response. expand – Allows expansion of relationships. Allowed value is `users`. fields - A list of fields to be returned. limit – Specifies the pagination size to limit the number of elements the collection returns at a maximum. offset – The offset of the page. By default, offset is 0, which means first page will be returned. orderby - Specifies a comma-separated list of fields to order the response by. totalResults - Specifies that the total count of records that should be included in the response when doing pagination. Only effective when limit or offset are specified.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data for the groups for the host company or partner organization.

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/visionServices/groups

Sample Response Body

{ "items": [{ "label": "General", "variableName": "general", "company": { "name": "visionServices", "loginName": "_host" }, "status": { "value": 1, "displayValue": "Active" }, "type": { "value": 1, "displayValue": "Administrator" }, "readOnly": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/companies/_host/groups/general" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/companies/_host/groups/general/users" } ] }, { "label": "No Longer Used 15", "variableName": "iragroup", "company": { "name": "visionServices", "loginName": "_host" }, "status": { "value": 1, "displayValue": "Active" }, "type": { "value": 0, "displayValue": "Sales" }, "readOnly": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/companies/_host/groups/iragroup" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/companies/_host/groups/iragroup/users" } ] } ], "offset": 0, "limit": 2, "count": 2, "hasMore": false, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/groups" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/groups?offset=0&limit=1000" } ] }

Get a Group for Host Company or Partner Organization

Get a Group for Host Company or Partner Organization
Description	This endpoint retrieves a group resource for a host company or partner organization.
URI Endpoint	/rest/v17/companies/{companyLoginName}/groups/{groupVarName}
Endpoint Parameters	companyLoginName	The host company or partner organization login name
	groupVarName	The variable name of the group
	This endpoint supports the following query specification. For more information, see Manage Collections. expand – Allows expansion of relationships. Allowed values: `all`, `users`, and `segments`.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data for the group resources for a host company or partner organization.

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/visionServices/groups/midwestTestGroup

Sample Response Body

{ "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/v17/companies/visionServices/groups/midwestTestGroup" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/companies/visionServices/groups/midwestTestGroup/segments" }, { "rel": "users", "href": "https://sitename.oracle.com/rest/v17/companies/visionServices/groups/miswestTestGroup/users" } ] }

Create a Group for Host Company or Partner Organization

Create a Group for Host Company or Partner Organization
Description	This endpoint creates a group for the host company or partner organization based on logged in users.
URI Endpoint	/rest/v17/companies/{companyLoginName}/groups
Endpoint Parameters	companyLoginName	The host company or partner organization login name
HTTP Method	POST
Request Body Parameters	label	(Required) The name of the group
	type	(Required) The preferred type of group
	variableName	(Required) The variable name of the group
	description	(Optional) The description of the group
	segments	(Required) The access segments for the group
	users	(Required for sales group and Optional for administrator group) The users of the group
	status	(Optional) The preferred status of the group
Response Body Parameters	companyLoginName	The name of the host company or partner organization
	name	The company name
	label	The name of the group
	links	Links to the related objects
	readOnly	Is this a read-only group? Allowed values: `true` or `false`.
	type	The type of group
	variableName	The variable name of the group
	description	The description of the group
	segments	The access segments for the group
	status	The status of the group
	users	The users of the group

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/visionServices/groups

Sample Request Body

{ "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 } ] } } ] } } ] } }

Sample Response Body

{ "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/v17/companies/visionServices/groups/midwestTestGroup" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/companies/visionServices/groups/midwestTestGroup/segments" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/companies/visionServices/groups/midwestTestGroup/users" } ] }

Update a Group for Host Company or Partner Organization

Update a Group for Host Company or Partner Organization
Description	This endpoint updates a group for a host company or partner organization.
URI Endpoint	/rest/v17/companies/{companyLoginName}/groups/{groupVarName}
Endpoint Parameters	companyLoginName	The host company or partner organization login name
Endpoint Parameters	groupVarName	The variable name of the group
HTTP Method	PUT
Request Body Parameters	label	(Required) The name of the group
	type	(Required) The preferred type format of the group
	variableName	(Required) The variable name of the group
	description	(Optional) The description of the group
	segments	(Optional) The access segments for the group
	status	(Optional) The preferred status of the group
	users	(Optional) The users of the group
Response Body Parameters	companyLoginName	The name of the host company or partner organization
	name	The company name
	label	The name of the group
	links	Links to the related objects
	readOnly	Is this a read-only group? Allowed values: `true` or `false`.
	type	The type of group
	variableName	The variable name of the group
	description	The description of the group
	segments	The access segments for the group
	status	The status of the group
	users	The users of the group

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/visionServices/groups/midwestTestGroup

Sample Request Body

{ "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 } ] } } ] } } ] } }

Sample Response Body

{ "label": "Midwest Test Group", "variableName": "midwestTestGroup", "description": "Midwest Test Group", "company": { "name": "visionServices", "loginName": "_host" }, "status": { "value": 1, "displayValue": "Active" }, "type": { "value": 1, "displayValue": "Administrator" }, "readOnly": false, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/groups/midwestTestGroup" }, { "rel": "child", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/groups/midwestTestGroup/segments" }, { "rel": "child", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/groups/midwestTestGroup/users" } ] }

Update Specific Group Details for the Host Company and Partner Organization

Update Specific Group Details for the Host Company and Partner Organization
Description	This endpoint updates specific group details for a host company or partner organization with that specified in the web services request.
URI Endpoint	/rest/v17/companies/{companyLoginName}/groups/{groupVarName}
Endpoint Parameters	companyLoginName	The host company or partner organization login name
Endpoint Parameters	groupVarName	The variable name of the group
HTTP Method	PATCH
Request Body Parameters	label	(Required) The name of the group
	type	(Required) The preferred type format of the group
	variableName	(Required) The variable name of the group
	description	(Optional) The description of the group
	segments	(Optional) The access segments for the group
	status	(Optional) The preferred status of the group
	users	(Optional) The users of the group
Response Body Parameters	companyLoginName	The name of the host company or partner organization
	name	The company name
	label	The name of the group
	links	Links to the related objects
	readOnly	Is this a read-only group? Allowed values: `true` or `false`.
	type	The type of group
	variableName	The variable name of the group
	description	The description of the group
	segments	The access segments for the group
	status	The status of the group
	users	The users of the group

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/visionServices/groups/midwestTestGroup

Sample Request Body

{ "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 } ] } } ] } } ] } }

Sample Response Body

{ "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/v17/companies/visionServices/groups/a100kparts" }, { "rel": "users", "href": "https://sitename.oracle.com/rest/v17/companies/visionServices/groups/a100kparts/users" }, { "name": "segments", "rel": "child", "href": "https://sitename.oracle.com/rest/v17/companies/visionServices/groups/a100kparts/users" } ] }

Get All Access Segments for a Group

Get All Access Segments for a Group
Description	This endpoint retrieves all group access segments for the host company group.
URI Endpoint	/rest/v17/companies/{companyLoginName}/groups/{groupVarName}/segments
Endpoint Parameters	companyLoginName	The partner organization login name
	groupVarName	The variable name of the group
	This endpoint supports the following query specification. For more information, see Manage Collections. uiMetadata – Specifies how to show the status and/or icon UI fields. Allowed values: `true` or `false`.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data for the segment details and associated links.

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/visionServices/groups/midwestTestGroup/segments

Sample Response Body

{ "items": [{ "variableName": "_commerceAndDocuments", "title": "Commerce and Documents", "checked": false, "segments": { "items": [{ "variableName": "_processDefinition", "title": "Process Definition", "checked": true }, { "variableName": "_processInvocation", "title": "Process Invocation", "checked": true }, { "variableName": "_commerceSettings", "title": "Commerce Settings", "checked": true }, { "variableName": "_documents", "title": "Documents", "checked": true }, { "variableName": "_documentDesigner", "title": "Document Designer", "checked": true }, { "variableName": "_emailDesigner", "title": "Email Designer", "checked": true } ] } }, { "variableName": "_developerTools", "title": "Developer Tools", "segments": { "items": [{ "variableName": "_bmlLibrary", "title": "BML Library", "checked": false }, { "variableName": "_dataTables", "title": "Data Tables", "checked": false, "segments": { "items": [{ "variableName": "_default", "title": "[Default]", "checked": true }, { "variableName": "aBOTables", "title": "ABO Tables", "checked": false }, { "variableName": "accessRestrictedFolder", "title": "Access Restricted Folder", "checked": false }, { "variableName": "bMQL", "title": "BMQL", "checked": false } ] } }, { "variableName": "_globalSearchOnBML", "title": "Global Search on BML", "checked": false }, { "variableName": "_devToolKit", "title": "Developer Toolkit CLI", "checked": false }, { "variableName": "_logs", "title": "Logs", "checked": false } ] }, "checked": false }, { "variableName": "_integrationPlatform", "title": "Integration Platform", "segments": { "items": [{ "variableName": "_accounts", "title": "Accounts", "checked": false }, { "variableName": "_integrationSettings", "title": "Integration Settings", "checked": false }, { "variableName": "_singleSignOn", "title": "Single Sign-On", "checked": false } ] }, "checked": false }, { "variableName": "_general", "title": "General", "segments": { "items": [{ "variableName": "_uiDesigner", "title": "UI Designer", "checked": false }, { "variableName": "_countriesAndStates", "title": "Countries and States", "checked": false }, { "variableName": "_emailSignature", "title": "Email Signature", "checked": false }, { "variableName": "_favoritesList", "title": "Favorites List", "checked": true }, { "variableName": "_generalSiteOptions", "title": "General Site Options", "checked": false }, { "variableName": "_hostCompany", "title": "Host Company", "checked": false } ] }, "checked": false }, { "variableName": "_products", "title": "Products", "segments": { "items": [{ "variableName": "_productDefinition", "title": "Product Definition", "segments": { "items": [{ "title": "System Configuration Product Family", "variableName": "systemConfigurationProductFamily", "checked": false }, { "title": "Integration", "variableName": "integration", "checked": false } ] }, "checked": false }, { "variableName": "_catalogDefinition", "title": "Catalog Definition", "segments": { "items": [{ "title": "System Configuration Product Family", "variableName": "systemConfigurationProductFamily", "checked": false }, { "title": "Integration", "variableName": "integration", "checked": false } ] }, "checked": false }, { "variableName": "_configurationSettings", "title": "Configuration Settings", "checked": false }, { "variableName": "_parts", "title": "Parts", "checked": false }, { "variableName": "_eligibilityRules", "title": "Eligibility Rules", "checked": false }, { "variableName": "_pricing", "title": "Pricing Portal", "checked": false } ] }, "checked": false } ] } }

Update Group Access Segments for a Group

Update Group Access Segments for a Group
Description	This endpoint updates access segments for an existing group with information provided in the web services request.
URI Endpoint	/rest/v17/companies/{companyLoginName}/groups/{groupVarName}/segments
Endpoint Parameters	companyLoginName	The partner organization login name
Endpoint Parameters	groupVarName	The variable name of the group
HTTP Method	PATCH
Request Body Parameters	variableName	(Required) The variable name of the segment
	checked	(Optional) Is segment enabled? Allowed values: `true` or `false`.
	icon	(Optional) Path of the icon image file. This field is only applicable if `uiMetadata` is set to `true`.
	segments	(Optional) The sub access segments for the segments
	status	(Optional) Specifies if the segment is enabled, partially selected or unselected. Possible values are: `0[UNCHECKED]`, `1[PARTIALCHECKED`], or `2[CHECKED`]. This field is only applicable if `uiMetadata` is set to `true`.
	users	The users of the group
Request Body Parameters	JSON data containing the group access segment details.

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/visionServices/groups/midwestTestGroup/segments

Sample Request Body

{ "items": [{ "variableName": "_developerTools", "segments": { "items": [{ "variableName": "_dataTables", "checked": false, "segments": { "items": [{ "variableName": "aBOTables", "checked": false } ] } } ] } } ] }

Sample Response Body

{ { "items": [{ "variableName": "_commerceAndDocuments", "title": "Commerce and Documents", "checked": false, "segments": { "items": [{ "variableName": "_processDefinition", "title": "Process Definition", "checked": true }, { "variableName": "_processInvocation", "title": "Process Invocation", "checked": true }, { "variableName": "_commerceSettings", "title": "Commerce Settings", "checked": true }, { "variableName": "_documents", "title": "Documents", "checked": true }, { "variableName": "_documentDesigner", "title": "Document Designer", "checked": false }, { "variableName": "_emailDesigner", "title": "Email Designer", "checked": false } ] } }, { "variableName": "_developerTools", "title": "Developer Tools", "checked": false, "segments": { "items": [{ "variableName": "_bmlLibrary", "title": "BML Library", "checked": false }, { "variableName": "_dataTables", "title": "Data Tables", "checked": false, "segments": { "items": [{ "variableName": "_default", "title": "[Default]", "checked": true }, { "variableName": "aBOTables", "title": "ABO Tables", "checked": false }, { "variableName": "accessRestrictedFolder", "title": "Access Restricted Folder", "checked": false }, { "variableName": "bMQL", "title": "BMQL", "checked": false }, { "variableName": "bOMTables", "title": "BOM Tables", "checked": false }, { "variableName": "commerce", "title": "Commerce", "checked": false }, { "variableName": "configuration", "title": "Configuration", "checked": false }, { "variableName": "dataTables", "title": "Data Tables", "checked": false }, { "variableName": "formulaManagement", "title": "Formula Management", "checked": false }, { "variableName": "integration", "title": "Integration", "checked": false }, { "variableName": "sOAP", "title": "SOAP", "checked": false } ] } }, { "variableName": "_globalSearchOnBML", "title": "Global Search on BML", "checked": false }, { "variableName": "_devToolKit", "title": "Developer Toolkit CLI", "checked": false }, { "variableName": "_logs", "title": "Logs", "checked": false } ] } }, { "variableName": "_integrationPlatform", "title": "Integration Platform", "checked": false, "segments": { "items": [{ "variableName": "_accounts", "title": "Accounts", "checked": false }, { "variableName": "_integrationSettings", "title": "Integration Settings", "checked": false }, { "variableName": "_singleSignOn", "title": "Single Sign-On", "checked": false }, { "variableName": "_webServices", "title": "Web Services", "checked": false }, { "variableName": "_interfaceCatalogs", "title": "Interface Catalogs", "checked": false }, { "variableName": "_integrationCenter", "title": "Integration Center", "checked": false } ] } }, { "variableName": "_general", "title": "General", "checked": true, "segments": { "items": [{ "variableName": "_uiDesigner", "title": "UI Designer", "checked": true }, { "variableName": "_countriesAndStates", "title": "Countries and States", "checked": true }, { "variableName": "_emailSignature", "title": "Email Signature", "checked": true }, { "variableName": "_favoritesList", "title": "Favorites List", "checked": true }, { "variableName": "_generalSiteOptions", "title": "General Site Options", "checked": true }, { "variableName": "_hostCompany", "title": "Host Company", "checked": true } ] } }, { "variableName": "_products", "title": "Products", "checked": false, "segments": { "items": [{ "variableName": "_productDefinition", "title": "Product Definition", "checked": false, "segments": { "items": [{ "variableName": "visionVehicles", "title": "Vision Vehicles", "checked": false }, { "variableName": "systemConfigurationProductFamily", "title": "System Configuration Product Family", "checked": false }, { "variableName": "integration", "title": "Integration", "checked": false }, { "variableName": "admin", "title": "Admin", "checked": false }, { "variableName": "test5", "title": "Test 5", "checked": false }, { "variableName": "test4", "title": "Test 4", "checked": false }, { "variableName": "test3", "title": "Test 3", "checked": false }, { "variableName": "test2", "title": "Test 2", "checked": false }, { "variableName": "test1", "title": "Test 1", "checked": false }, { "variableName": "unsupported", "title": "Unsupported", "checked": false }, { "variableName": "testbed", "title": "Testbed", "checked": false } ] } }, { "variableName": "_catalogDefinition", "title": "Catalog Definition", "checked": false, "segments": { "items": [{ "variableName": "admin", "title": "Admin", "checked": false }, { "variableName": "integration", "title": "Integration", "checked": false }, { "variableName": "systemConfigurationProductFamily", "title": "System Configuration Product Family", "checked": false }, { "variableName": "test1", "title": "Test 1", "checked": false }, { "variableName": "test2", "title": "Test 2", "checked": false }, { "variableName": "test3", "title": "Test 3", "checked": false }, { "variableName": "test4", "title": "Test 4", "checked": false }, { "variableName": "test5", "title": "Test 5", "checked": false }, { "variableName": "testbed", "title": "Testbed", "checked": false }, { "variableName": "visionVehicles", "title": "Vision Vehicles", "checked": false } ] } }, { "variableName": "_configurationSettings", "title": "Configuration Settings", "checked": false }, { "variableName": "_parts", "title": "Parts", "checked": false }, { "variableName": "_eligibilityRules", "title": "Eligibility Rules", "checked": false }, { "variableName": "_pricing", "title": "Pricing Portal", "checked": false }, { "variableName": "_bOM", "title": "BOM", "checked": false }, { "variableName": "_assets", "title": "Assets", "checked": false }, { "variableName": "_productSetups", "title": "Product Launch", "checked": false } ] } }, { "variableName": "_styleAndTemplates", "title": "Style and Templates", "checked": false, "segments": { "items": [{ "variableName": "_headerFooter", "title": "Header & Footer", "checked": false }, { "variableName": "_homePage", "title": "Home Page", "checked": false }, { "variableName": "_homePageFlows", "title": "Home Page Flows", "checked": false }, { "variableName": "_pageTemplates", "title": "Page Templates", "checked": false }, { "variableName": "_stylesheet", "title": "Stylesheet", "checked": false } ] } }, { "variableName": "_users", "title": "Users", "checked": false, "segments": { "items": [{ "variableName": "_internalUsers", "title": "Internal Users", "checked": false }, { "variableName": "_groups", "title": "Groups", "checked": false }, { "variableName": "_partnerOrganizations", "title": "Partner Organizations", "checked": false } ] } }, { "variableName": "_utilities", "title": "Utilities", "checked": false, "segments": { "items": [{ "variableName": "_broadcastEmail", "title": "Broadcast Email", "checked": false }, { "variableName": "_migration", "title": "Migration", "checked": false }, { "variableName": "_bulkDataServices", "title": "Bulk Data Services", "checked": false }, { "variableName": "_fileManager", "title": "File Manager", "checked": false }, { "variableName": "_textAdministration", "title": "Text Administration", "checked": false } ] } } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/companies/_host/groups/midwestTestGroup/segments" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/companies/_host/groups/midwestTestGroup" } ] }

Get Data Table Access Rights

Get Data Table Access Rights
Description	This endpoint retrieves the access rights of data tables within a data table folder.
URI Endpoint	/rest/v17/companies/{companyLoginName}/groups/{groupVarName}/segments/_dataTables/folders/{folderVarName}/accessRights
Endpoint Parameters	companyLoginName	The name of the host company or partner organization
	groupVarName	The variable name of the group
	folderVarName	The variable name of the folder
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data containing data table access rights.

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/visionServices/groups/midwestTestGroup/segments/_dataTables/folders/_default/accessRights

Sample Response Body

{ "folderVarName": "_default", "items": [{ "accessType": "READ", "name": "DataTable1" }, { "accessType": "FULL", "name": "dn_sample_wtpSegmnts" }, { "accessType": "EDIT", "name": "LiveTable" }, { "accessType": "NONE", "name": "Status" }, { "accessType": "READ", "name": "table_100columns" } ] }

Update Data Table Access Rights for a Group

Update Data Table Access Rights for a Group
Description	This endpoint updates the data table access rights for a group.
URI Endpoint	/rest/v17/companies/{companyLoginName}/groups/{groupVarName}/segments/dataTables/actions/updateaccessRights
Endpoint Parameters	companyLoginName	The name of the host company or partner organization
Endpoint Parameters	groupVarName	The variable name of the group
HTTP Method	POST
Request Body Parameters	folderVarName	(Required) The name of the folder
	accessType	(Required) The access type for the data table. Allowed values are: `FULL`, `READ`, `EDIT`, and `NONE`.
	name	The name of the table
Response Body Parameters	HTTP Status Code 204

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/visionServices/groups/midwestTestGroup/segments/_dataTables/actions/updateaccessRights

Sample Response Body

{ "items": [{ "folderVarName": "_default", "items": [{ "name": "DataTable1", "accessType": "READ" }, { "name": "dn_sample_wtpSegmnts", "accessType": "FULL" }, { "name": "LiveTable", "accessType": "EDIT" }, { "name": "Status", "accessType": "NONE" }, { "name": "table_100columns", "accessType": "READ" } ] }, { "folderVarName": "aBOTables", "items": [{ "name": "Oracle_aboPart2Model", "accessType": "FULL" } ] }, { "folderVarName": "bMQL", "items": [{ "name": "BMQL_TestCases", "accessType": "FULL" }, { "name": "BMQLTest_Indexed", "accessType": "READ" }, { "name": "BMQLTest_NotIndexed", "accessType": "EDIT" }, { "name": "BMQLTest_Small", "accessType": "NONE" } ] } ] }

Get All Users of a Group

Get All Users of a Group
Description	This endpoint retrieves a list of all users of a group.
URI Endpoint	/rest/v17/companies/{companyLoginName}/groups/{groupVarName}/users
Endpoint Parameters	companyLoginName	The host company or partner organization login name
	groupVarName	The variable name of the group
	This endpoint supports the following query specification. For more information, see Manage Collections. q - Declares a query specification expression. excludeLinks – Exclude links from the response. fields - A list of fields to be returned. limit – Specifies the pagination size to limit the number of elements the collection returns at a maximum. offset – The offset of the page. By default, offset is 0, which means first page will be returned. orderby - Specifies a comma-separated list of fields to order the response by. totalResults - Specifies that the total count of records that should be included in the response when doing pagination. Only effective when limit or offset are specified..
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data containing users of a group and associated links.

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/visionServices/groups/midwestTestGroup/users

Sample Response Body

"items": [{ "login": "amayor", "firstName": "Alex", "lastName": "Mayor" }, { "login": "msmith", "firstName": "Matt", "lastName": "Smith" }, { "login": "ljones", "firstName": "Lisa", "lastName": "Jones" } ], "offset": 0, "limit": 1000, "count": 3, "hasMore": false, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/companies/_host/groups/midwestTestGroup/users" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/companies/_host/groups/midwestTestGroup/users?offset=0&limit=1000" } ] }

Bulk Update Users within Groups

Bulk Update Users within Groups
Description	This endpoint updates users within groups via one web services request.
URI Endpoint	/rest/v17/companies/{companyLoginName}/groups/{groupVarName}/users
Endpoint Parameters	companyLoginName	The host company or partner organization login name
Endpoint Parameters	groupVarName	The variable name of the group
HTTP Method	PATCH
Request Body Parameters	The array of patch operations
	op	(Required) The operation to be performed. Allowed values: `add` or `remove`
	path	(Required) The JSON pointer string for `path` property
	value	The target value
	login	The user login name
Request Body Parameters	JSON data containing the users within the group and associated links.

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/visionServices/groups/midwestTestGroup/users

Sample Request Body

{ "operations": [{ "op": "remove", "path": "/superuser" }, { "op": "add", "path": "/", "value": { "login": "msmith" } }, { "op": "add", "path": "/", "value": { "login": "ljones" } } ] }

Sample Response Body

{ "items": [{ "login": "amayor", "firstName": "Alex", "lastName": "Mayor" }, { "login": "msmith", "firstName": "Mary", "lastName": "Smith" }, { "login": "ljones", "firstName": "Lisa", "lastName": "Jones" } ], "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/companies/_host/groups/midwestTestGroup/users" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/companies/_host/groups/midwestTestGroup/users?offset=0&limit=1000" } ] }

Groups REST API

Overview

Administration

Related Topics