Company REST API

Oracle CPQ 24B Company REST API adds support for partner organizations and enhances support for host company including support for company style sheets and translations.

The following new REST API web services are supported:

Get Host Company and All Partner Organizations

Use this endpoint to retrieve a list including the host company and all partner organizations.

• Endpoint:  /rest/v16/companies
• Method:  GET

Create Partner Organization

Use this endpoint to create partner organization with information provided in the request.

• Endpoint:  /rest/v16/companies
• Method:  POST

Get Host Company or Partner Organization Details

Use this endpoint to retrieve details for the host company and partner organization.

• Endpoint:  /rest/v16/companies/{companyLoginName}
• Method:  GET

Update All Host Company or Partner Organization Details

Use this endpoint to replace all host company or partner organization details with that specified in the request.

• Endpoint:  /rest/v16/companies/{companyLoginName}
• Method:  PUT

Update Specific Host Company or Partner Organization Details

Use this endpoint to replace specific host company or partner organization details with that specified in the web services request.

• Endpoint:  /rest/v16/companies/{companyLoginName}
• Method:  PATCH

Bulk Update Partner Organization and/or Host Company Details

Use this endpoint update company details for multiple partner organizations, include host company, in one web services request.

• Endpoint:  /rest/v16/companies
• Method:  PATCH

Export Details for Multiple Partner Organizations

Use this endpoint to export details for multiple partner organizations. This operation triggers a task to return a list of partner organizations as a zip file.

• Endpoint:  /rest/v16/companies/actions/bulkExport
• Method:  POST

Import Details for Multiple Partner Organizations

Use this endpoint to add or update details for multiple partner organizations.

• Endpoint:  /rest/v16/companies/actions/bulkImport
• Method: POST

Company Style Sheet Web Services

Get All Style Sheets for a Partner Organization

Use this endpoint to retrieve all style sheets for a partner organization.

• Endpoint:  /rest/v16/companies/{companyLoginName}/styleSheets
• Method:  GET

Get a Style Sheet for a Partner Organization

Use this endpoint to download a style sheet for a partner organization.

• Endpoint:  /rest/v16/companies/{companyLoginName}/styleSheets/{name}
• Method:  GET

Create a Partner Organization Style Sheet

Use this endpoint to create a JET or alternate style sheet for a partner organization.

• Endpoint:  /rest/v16/companies/{companyLoginName}/styleSheets
• Method:  POST

Update Partner Organization Style Sheet

Use this endpoint to replace the entire partner organization style sheet with the style sheet values specified in the web services request.

• Endpoint:  /rest/v16/companies/{companyLoginName}/styleSheets/{name}
• Method:  PUT

Delete a Style Sheet for a Partner Organization

Use this endpoint to delete a style sheet for a partner organization.

• Endpoint:  /rest/v16/companies/{companyLoginName}/styleSheets/{name}
• Method:  DELETE

Company Translation Web Services

Get All Translation Details for Host Company or a Partner Organization

Use this endpoint to retrieve all host company or partner organization translated company names in the supported language.

• Endpoint:  /rest/v16/companies/{companyLoginName}/translations
• Method:  GET

Get Specified Translation Details for a Host Company or Partner Organization

Use this endpoint to retrieve translation details for a host company or partner organization.

• Endpoint:  /rest/v16/companies/{companyLoginName}/translations/{languageCode}
• Method:  GET

Add Translations for Host Company or Partner Organization

Use this endpoint to add translations to a host company or partner organization.

• Endpoint:  /rest/v16/companies/{companyLoginName}/translations
• Method:  POST

Update Host Company or Partner Organization Translations

Use this endpoint to replace (add, remove, or replace) the entire host company or partner organization translations with the translation values specified in the web services request.

• Endpoint:  /rest/v16/companies/{companyLoginName}/translations
• Method:  PATCH

Delete a Translation for a Host Company or Partner Organization

Use this endpoint to delete a translation for a specific language for a host company or partner organization.

• Endpoint:  /rest/v16/companies/{companyLoginName}/translations/{languageCode}
• Method: DELETE

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.

Tips And Considerations

The User Management REST APIs support company user creation, activation, revocation, and password management. Refer to User Management REST APIs in the Oracle CPQ Administration Online Help for more information.