Groups REST API

Oracle CPQ 24C Groups REST API adds group support for partner organizations and the host company via REST API services. The following new REST API web services are supported:

Get All Groups

Use this endpoint to retrieve a list of all groups.

• Endpoint:  /rest/v16/groups

• Method:  GET

Get Groups for the Host Company or for a Partner Organization

Use this endpoint to get a list of groups for the host company or for a partner organization.

• Endpoint:  /rest/v16/companies/{companyLoginName}/groups

• Method:  GET

Create a Group for Host Company or Partner Organization

Use this endpoint to create a group for the host company and partner organization based on logged in users.

• Endpoint:  /rest/v16/companies/{companyLoginName}/groups

• Method:  POST

Get a Group for Host Company or Partner Organization

Use this endpoint to get a group resource for a  host company or partner organization.

• Endpoint:  /rest/v16/companies/{companyLoginName}/groups/{groupVarName}

• Method:  GET

Update a Group for Host Company or Partner Organization

Use this endpoint to update a group for a host company or partner organization.

• Endpoint:  /rest/v16/companies/{companyLoginName}/groups/{groupVarName}

• Method:  PUT

Update Specific Group Details for the Host Company or Partner Organization

Use this endpoint to update specific group details with that specified in the web services request.

• Endpoint:  /rest/v16/companies/{companyLoginName}/groups/{groupVarName}

• Method:  PATCH

Get All Access Segments for a Group

Use this endpoint to retrieve all group access segments for the host company group.

• Endpoint:  /rest/v16/companies/{companyLoginName}/groups/{groupVarName}/segments

• Method:  GET

Update Group Access Segments for a Group

Use this endpoint to update access segments for an existing group with information provided in the web services request.

• Endpoint:  /rest/v16/companies/{companyLoginName}/groups/{groupVarName}/segments

• Method:  PATCH

Get Data Table Access Rights

Use this endpoint to retrieve the access rights of data tables within a data table folder.

• Endpoint:  /rest/v16/companies/{companyLoginName}/groups/{groupVarName}/segments/_dataTables/folders/{folderVarName}/accessRights

• Method:  GET

Update Data Table Access Rights for a Group

Use this endpoint to update the data table access rights for a group.

• Endpoint:  /rest/v16/companies/{companyLoginName}/groups/{groupVarName}/segments/_dataTables/actions/updateAccessRights

• Method:  POST

Get All Users of a Group

Use this endpoint to retrieve list of all users of a group.

• Endpoint:  /rest/v16/companies/{companyLoginName}/group/{groupVarName}/users

• Method:  GET

Bulk Update Users within Groups

Use this endpoint to update users within groups via one web services request.

• Endpoint:  /rest/v16/companies/{companyLoginName}/groups/{groupVarName}/users

• Method:  PATCH

Steps to Enable

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.