Company REST API

Overview

The Company REST API supports retrieving, adding, and updating host company and partner organization data including support for company style sheets and translations.

Full Access admin users with permission to the host company admin page can retrieve the requested information via this REST API.

Administration

The company endpoint is used to get company information, most especially supported languages and currencies, using REST API services.

Get Host Company and All Partner Organizations

Get Host Company and All Partner Organizations
Description	This endpoint retrieves a list that includes the host company and all partner organizations.
URI Endpoint	/rest/v17/companies
Endpoint Query Parameters	This endpoint supports the following query specifications. For more information, see Manage Collections. q - Declares a query specification expression. expand – Allows expansion of relationships. Allowed values: `users`, `styleSheets`, and `translations`. 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. 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 host company and partner organizations.

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies?limit=1&offset=0&totalResults=true&expand=all

Sample Response Body

{ "items": [{ "name": "system123", "login": "system123", "subscriptionPlan": "FullAccessWithESales", "baseLanguage": { "value": "en", "displayValue": "English" }, "units": { "value": 1, "displayValue": "English" }, "numberFormat": { "value": 0, "displayValue": "####.##" }, "dateTimeFormat": { "value": 0, "displayValue": "MM/dd/yyyy h:mm a" }, "timeZone": { "value": "America/Chicago", "displayValue": "(GMT-6:00 GMT-5:00) Chicago" }, "baseCurrency": { "value": "USD", "displayValue": "US Dollar" }, "country": "United States", "email": "system123@yourcompany.com", "supportedLanguages": { "items": [{ "languageCode": "ar_SA", "languageName": "Arabic [Saudi Arabia]", "iso2LanguageCode": "ar", "isBaseLanguage": false, "isEnabled": true } ] }, "supportedCurrencies": { "items": [{ "currencyCode": "ALL", "currencyName": "Lek", "precision": 2, "isBaseCurrency": false, "isEnabled": true }, { "currencyCode": "AUD", "currencyName": "Australian Dollar", "precision": 2, "isBaseCurrency": false, "isEnabled": false } ] }, "access": "Granted", "isEnabledSSO": true, "activeUserLicense": 10, "maximumUsers": 15, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/system123" }, { "rel": "child", "name": "styleSheets", "href": "http://sitename.oracle.com/rest/v17/companies/system123/styleSheets" }, { "rel": "child", "name": "users", "href": "http://sitename.oracle.com/rest/v17/companies/system123/users" } ] } ], "offset": 0, "limit": 1000, "count": 23, "hasMore": false, "links": [{ "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/companies" }, { "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies?offset=0&limit=1000" } ] }

Create Partner Organization

Create Partner Organization
Description	This endpoint creates a partner organization with information provided in the request.
URI Endpoint	/rest/v17/companies
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	name	(Required) The name of the partner organization
	login	(Required) The partner organization login name
	email	(Required) The email for the partner organization
	supportedCurrencies	(Required) The currencies supported by the partner organization
	supportedLanguages	(Required) The languages supported by the partner organization
	access	(Optional) The partner organization access status to login granted/denied
	activeLicensedUsers	(Optional) The number of active users
	address1	(Optional) The address of the partner organization
	address2	(Optional) Additional company address
	baseCurrency	(Optional) The base currency of the partner organization
	baseLanguage	(Optional) The base language of the partner organization
	city	(Optional) The city of the partner organization
	country	(Optional) The country of the partner organization
	dateTimeFormat	(Optional) The preferred date/time format of the partner organization
	eanbledForSSO	(Optional) Is the partner organization enabled for user login with SSO credentials? Yes = true No = false
	faxNumber	(Optional) The fax number of the partner organization
	maximumUsers	(Optional) The maximum number of active users that the partner organization allows access
	numberFormat	(Optional) The preferred number format for the partner organization
	phoneNumber	(Optional) The phone number of the partner organization
	state	(Optional) The state province of the partner organization
	timeZone	(Optional) The preferred time zone for the partner organization
	units	(Optional) The preferred units for the partner organization
	zip	(Optional) The zip code of the partner organization
Request Body Parameters	HTTP Code 201

URI Endpoint Sample

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

Sample Request Body

{ "name": "Vision Services", "login": "visionServices", "baseLanguage": { "value": "en", "displayValue": "English" }, "subscriptionPlan": "BuyAccess" "units": { "value": 1, "displayValue": "English" }, "numberFormat": { "value": 0, "displayValue": "####.##" }, "dateTimeFormat": { "value": 0, "displayValue": "MM/dd/yyyy h:mm a" }, "timeZone": { "value": "America/Chicago", "displayValue": "(GMT-6:00 GMT-5:00) Chicago" }, "baseCurrency": { "value": "USD", "displayValue": "US Dollar" }, "state": "California", "country": "United States", "phoneNumber": "9666665351", "email": "company123@yourcompany.com", "faxNumber": "1322-445-32", "address1": "Address 1", "address2": "Address 2", "city": "City", "zip": "32456", "maximumUsers": 15, "supportedCurrencies": { "items": [{ "currencyCode": "ALL", "isEnabled": true }, { "currencyCode": "AUD", "isEnabled": false }, { "currencyCode": "CAD", "isEnabled": false }, { "currencyCode": "CNY", "isEnabled": false }, { "currencyCode": "EUR", "isEnabled": true } ] }, "supportedLanguages": { "items": [{ "languageCode": "ar_SA", "languageName": "Arabic [Saudia Arabia]", "iso2LanguageCode": "ar", "isBaseLanguage": false, "isEnabled": true } ] } }

Get Host Company or Partner Organization Details

Get Host Company or Partner Organization Details
Description	This endpoint retrieves details for the host company or partner organization.
URI Endpoint	/rest/v17/{companyLoginName}
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. expand – Allows expansion of relationships. Allowed values: `users`, `styleSheets`, and `translations`.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data for the host company or partner organization object.

URI Endpoint Sample

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

Sample Request Body

{ "name": "Vision Services", "login": "visionServices", "subscriptionPlan": "FullAccessWithESales", "baseLanguage": { "value": "en", "displayValue": "English" }, "units": { "value": 1, "displayValue": "English" }, "numberFormat": { "value": 0, "displayValue": "####.##" }, "dateTimeFormat": { "value": 0, "displayValue": "MM/dd/yyyy h:mm a" }, "timeZone": { "value": "America/Chicago", "displayValue": "(GMT-6:00 GMT-5:00) Chicago" }, "baseCurrency": { "value": "USD", "displayValue": "US Dollar" }, "country": "United States", "email": "noreply@visionservices.com", "supportedLanguages": { "items": [{ "languageCode": "ar_SA", "languageName": "Arabic [Saudi Arabia]", "iso2LanguageCode": "ar", "isBaseLanguage": false, "isEnabled": true } ] }, "supportedCurrencies": { "items": [{ "currencyCode": "ALL", "currencyName": "Lek", "precision": 2, "isBaseCurrency": false, "isEnabled": true }, { "currencyCode": "AUD", "currencyName": "Australian Dollar", "precision": 2, "isBaseCurrency": false, "isEnabled": false } ] }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices" }, { "rel": "child", "name": "styleSheets", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/styleSheets" }, { "rel": "child", "name": "users", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/users" } ] }

Update All Host Company and Partner Organization Details

Update All Host Company and Partner Organization Details
Description	This endpoint replaces all host company or partner organization details with that specified in the request.
URI Endpoint	/rest/v17/companies/{companyLoginName}
Endpoint Parameters	companyLoginName	The host company or partner organization login name
HTTP Method	PUT
Request Body Parameters	name	(Required) The name of the host company or partner organization
	login	(Required) The host company or partner organization login name
	email	(Required) The email for the host company or partner organization
	supportedCurrencies	(Required) The currencies supported by the host company or partner organization
	supportedLanguages	(Required) The languages supported by the host company or partner organization
	activeLicensedUsers	(Optional) The number of active users
	address1	(Optional) The address of the host company or partner organization
	address2	(Optional) Additional company address
	baseCurrency	(Optional) The base currency of the host company or partner organization
	baseLanguage	(Optional) The base language of the host company or partner organization
	city	(Optional) The city of the host company or partner organization
	country	(Optional) The country of the host company or partner organization
	dateTimeFormat	(Optional) The preferred date/time format of the host company or partner organization
	eanbledForSSO	(Optional) Is the host company or partner organization enabled for user login with SSO credentials? Yes = true No = false
	faxNumber	(Optional) The fax number of the host company or partner organization
	maximumUsers	(Optional) The maximum number of active users that the host company or partner organization allows access
	numberFormat	(Optional) The preferred number format for the host company or partner organization
	phoneNumber	(Optional) The phone number of the host company orpartner organization
	state	(Optional) The state province of the host company or partner organization
	timeZone	(Optional) The preferred time zone for the host company or partner organization
	units	(Optional) The preferred units for the host company or partner organization
	zip	(Optional) The zip code of the host company or partner organization
Request Body Parameters	JSON data for the host company or partner organization object.

URI Endpoint Sample

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

Sample Request Body

} "supportedCurrencies": { "items": [{ "currencyCode": "ALL", "isEnabled": true }, { "currencyCode": "AUD", "isEnabled": false }, { "currencyCode": "CAD", "isEnabled": true }, { "currencyCode": "CNY", "isEnabled": true } ] }, "baseCurrency": { "value": "USD", "displayValue": "US Dollar" }, "maximumUsers": 11 }

Sample Response Body

{ "name": "Vision Services", "login": "visionServices", "baseLanguage": { "value": "en", "displayValue": "English" }, "units": { "value": 1, "displayValue": "English" }, "numberFormat": { "value": 0, "displayValue": "####.##" }, "dateTimeFormat": { "value": 0, "displayValue": "MM/dd/yyyy h:mm a" }, "timeZone": { "value": "America/Chicago", "displayValue": "(GMT-6:00 GMT-5:00) Chicago" }, "baseCurrency": { "value": "USD", "displayValue": "US Dollar" }, "country": "United States", "email": "noreply@yourcompany.com", "supportedLanguages": { "items": [{ "languageCode": "ar_SA", "languageName": "Arabic [Saudi Arabia]", "iso2LanguageCode": "ar", "isBaseLanguage": false, "isEnabled": true }, { "languageCode": "zh_CN", "languageName": "Chinese (Simplified) [China]", "iso2LanguageCode": "zh", "isBaseLanguage": false, "isEnabled": true }, { "languageCode": "zh_TW", "languageName": "Chinese (Traditional) [Taiwan]", "iso2LanguageCode": "zh", "isBaseLanguage": false, "isEnabled": true }, { "languageCode": "cs_CZ", "languageName": "Czech [Czech Republic]", "iso2LanguageCode": "cs", "isBaseLanguage": false, "isEnabled": true } ] }, "supportedCurrencies": { "items": [{ "currencyCode": "ALL", "currencyName": "Lek", "precision": 2, "isBaseCurrency": false, "isEnabled": true }, { "currencyCode": "AUD", "currencyName": "Australian Dollar", "precision": 2, "isBaseCurrency": false, "isEnabled": false } ]"maximumUsers": 11 }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices" }, { "rel": "child", "name": "styleSheets", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/styleSheets" }, { "rel": "child", "name": "users", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/users" } ] }

Update Specific Host Company and Partner Organization Details

Update Specific Host Company and Partner Organization Details
Description	This endpoint replaces specific host company or partner organization details with that specified in the web services request.
URI Endpoint	/rest/v17/companies/{companyLoginName}
Endpoint Parameters	companyLoginName	The host company or partner organization login name
HTTP Method	PATCH
Request Body Parameters	name	(Optional) The name of the host company or partner organization
	login	(Optional) The host company or partner organization login name
	email	(Optional) The email for the host company or partner organization
	supportedCurrencies	(Optional) The currencies supported by the host company or partner organization
	supportedLanguages	(Optional) The languages supported by the host company or partner organization
	address1	(Optional) The address of the host company or partner organization
	address2	(Optional) Additional company address
	baseCurrency	(Optional) The base currency of the host company or partner organization
	baseLanguage	(Optional) The base language of the host company or partner organization
	city	(Optional) The city of the host company or partner organization
	country	(Optional) The country of the host company or partner organization
	dateTimeFormat	(Optional) The preferred date/time format of the host company or partner organization
	eanbledForSSO	(Optional) Is the host company or partner organization enabled for user login with SSO credentials? Yes = true No = false
	faxNumber	(Optional) The fax number of the host company or partner organization
	maximumUsers	(Optional) The maximum number of active users that the host company or partner organization allows access
	numberFormat	(Optional) The preferred number format for the host company or partner organization
	phoneNumber	(Optional) The phone number of the host company orpartner organization
	state	(Optional) The state province of the host company or partner organization
	timeZone	(Optional) The preferred time zone for the host company or partner organization
	units	(Optional) The preferred units for the host company or partner organization
	zip	(Optional) The zip code of the host company or partner organization
Request Body Parameters	JSON data for the host company or partner organization object.

URI Endpoint Sample

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

Sample Request Body

{ "maximumUser": 20, "access": "denied" }

Sample Response Body

{ "name": "Vision Services", "login": "visionServices", "subscriptionPlan": "FullAccessWithESales", "baseLanguage": { "value": "en", "displayValue": "English" }, "units": { "value": 1, "displayValue": "English" }, "numberFormat": { "value": 0, "displayValue": "####.##" }, "dateTimeFormat": { "value": 0, "displayValue": "MM/dd/yyyy h:mm a" }, "timeZone": { "value": "America/Chicago", "displayValue": "(GMT-6:00 GMT-5:00) Chicago" }, "baseCurrency": { "value": "USD", "displayValue": "US Dollar" }, "country": "United States", "email": "noreply@visionservices.com", "maximumUser": 20, "access": "denied" "supportedLanguages": { "items": [{ "languageCode": "ar_SA", "languageName": "Arabic [Saudi Arabia]", "iso2LanguageCode": "ar", "isBaseLanguage": false, "isEnabled": true } ] }, "supportedCurrencies": { "items": [{ "currencyCode": "ALL", "currencyName": "Lek", "precision": 2, "isBaseCurrency": false, "isEnabled": true }, { "currencyCode": "AUD", "currencyName": "Australian Dollar", "precision": 2, "isBaseCurrency": false, "isEnabled": false } ] }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices" }, { "rel": "child", "name": "styleSheets", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/styleSheets" }, { "rel": "child", "name": "users", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/users" } ] }

Bulk Update Partner Organization and/or Host Company Details

Bulk Upload Partner Organization and/or Host Company Details
Description	This endpoint updates company details for multiple partner organizations, include host company, in one web services request.
URI Endpoint	/rest/v17/companies
Endpoint Parameters	None
HTTP Method	PATCH
Request Body Parameters	name	(Optional) The name of the host company or partner organization
	login	(Required) The host company or partner organization login name
	email	(Optional) The email for the host company or partner organization
	supportedCurrencies	(Optional) The currencies supported by the host company or partner organization
	supportedLanguages	(Optional) The languages supported by the host company or partner organization
	address1	(Optional) The address of the host company or partner organization
	address2	(Optional) Additional company address
	baseCurrency	(Optional) The base currency of the host company or partner organization
	baseLanguage	(Optional) The base language of the host company or partner organization
	city	(Optional) The city of the host company or partner organization
	country	(Optional) The country of the host company or partner organization
	dateTimeFormat	(Optional) The preferred date/time format of the host company or partner organization
	eanbledForSSO	(Optional) Is the host company or partner organization enabled for user login with SSO credentials? Yes = true No = false
	faxNumber	(Optional) The fax number of the host company or partner organization
	maximumUsers	(Optional) The maximum number of active users that the host company or partner organization allows access
	numberFormat	(Optional) The preferred number format for the host company or partner organization
	phoneNumber	(Optional) The phone number of the host company orpartner organization
	state	(Optional) The state province of the host company or partner organization
	timeZone	(Optional) The preferred time zone for the host company or partner organization
	units	(Optional) The preferred units for the host company or partner organization
	zip	(Optional) The zip code of the host company or partner organization
Request Body Parameters	JSON data for list of companies.

URI Endpoint Sample

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

Sample Request Body

{ "companies": [{ "login": "a_Co1BM", "maximumUser": 20, "access": "denied" }, { "maximumUser": 10, "login": "a_Co2BM" "enableSSO": false } ] }

Sample Response Body

{ "items": [{ "name": "a_Co1BM", "login": "A1BM", "subscriptionPlan": "FullAccessWithESales", "baseLanguage": { "value": "en", "displayValue": "English" }, "units": { "value": 1, "displayValue": "English" }, "numberFormat": { "value": 0, "displayValue": "####.##" }, "dateTimeFormat": { "value": 0, "displayValue": "MM/dd/yyyy h:mm a" }, "timeZone": { "value": "America/Chicago", "displayValue": "(GMT-6:00 GMT-5:00) Chicago" }, "baseCurrency": { "value": "USD", "displayValue": "US Dollar" }, "country": "United States", "email": "noreply@bigmachines.com", "enabledForSSO": true, "activeLicensedUsers": 145, "access": "Denied", "maximumUsers": 18 }, { "name": "po5", "login": "po5", "subscriptionPlan": "BuyAccess", "baseLanguage": { "value": "en", "displayValue": "English" }, "units": { "value": 2, "displayValue": "Metric" }, "numberFormat": { "value": 0, "displayValue": "####.##" }, "dateTimeFormat": { "value": 2, "displayValue": "dd/MM/yyyy HH:mm" }, "timeZone": { "value": "America/Los_Angeles", "displayValue": "(GMT-8:00 GMT-7:00) Los Angeles" }, "baseCurrency": { "value": "CNY", "displayValue": "Chinese Yuan Renminbi" }, "state": "CA", "phoneNumber": "650-403-6325", "email": "junk@bigmachines.com", "faxNumber": "650-403-6325", "address1": "5 Waters Park Dr", "address2": "Po5 suite 240-5", "city": "SanMateo", "zip": "94403", "access": "Granted", "maximumUsers": 18, "enabledForSSO": false, .... } ] }

Export Details for Multiple Partner Organizations

Export Details for Multiple Partner Organizations
Description	This endpoint exports details for multiple partner organizations. This operation triggers a task to return a list of partner organizations as a zip file.
URI Endpoint	/rest/v17/companies/actions/bulkExport
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	fileFormat	(Optional) The download file format. Allowed values: `CSV` or `XML`
	scheduledTime	(Optional) The time to schedule the export task
	This endpoint supports the query specifications. For more information, see Manage Collections.
Response Body Parameters	taskId	The status log task ID
Response Body Parameters	links	Links to the related objects

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/actions/bulkExport

Sample Request Body

{ "fileFormat": "csv", "scheduledTime": "2023-12-11T05:50:00Z", "criteria": { "q": "{'login' :{'$like':'%po%'}}" } }

Sample Response Body

{ "taskId": 3022163950, "links": [{ "rel": "related", "href": "https://sitename.oracle.com/rest/v17/tasks/3022163950" } ] }

Import Details for Multiple Partner Organizations

Import Details for Multiple Partner Organizations
Description	This endpoint adds or updates details for multiple partner organizations. This operation triggers a task to import a list of partner organizations as a zip file.
URI Endpoint	/rest/v17/companies/actions/bulkImport
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	file	The file to import
Request Body Parameters	scheduledTime	(Optional) The time to schedule the import task
Response Body Parameters	taskId	(Optional)The status log task ID
Response Body Parameters	links	(Optional) Links to the related objects

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/actions/bulkImport

Sample Response Body

{ "taskId": 3022163950, "links": [{ "rel": "related", "href": "https://sitename.oracle.com/rest/v17/tasks/3022163950" } ] }

Company Style Sheet Web Services

Get All Style Sheets for a Partner Organization

Get All Style Sheets for a Partner Organization
Description	This endpoint retrieves all style sheets for a partner organization.
URI Endpoint	/rest/v17/companies/{companyLoginName}/styleSheets
Endpoint Parameters	companyLoginName	The partner organization login name
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data containing the style sheet details and associated links.

URI Endpoint Sample

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

Sample Response Body

{ "items": [{ "name": "alternate", "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/styleSheets/alternate" } ] }, { "name": "jet", "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/styleSheets/jet" } ] } ], "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/styleSheets" } ] }

Get a Style Sheet for a Partner Organization

Get a Style Sheets for a Partner Organization
Description	This endpoint retrieves a specific style sheets for a partner organization.
URI Endpoint	/rest/v17/companies/{companyLoginName}/styleSheets/{name}
Endpoint Parameters	companyLoginName	The partner organization login name
Endpoint Parameters	name	The name of the style sheet
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data containing the style sheet details and associated links.

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/visionServices/styleSheets/alternate

Create a Partner Organization Style Sheet

Create a Partner Organization Style Sheet
Description	This endpoint creates a JET or alternate style sheet for a partner organization.
URI Endpoint	/rest/v17/companies/{companyLoginName}/styleSheets
Endpoint Parameters	companyLoginName	The partner organization login name
HTTP Method	POST
Request Form Parameters	file	The CSS file for the new style sheet
Request Form Parameters	name	The name to assign the new style sheet. Allowed values: `alternate` or `jet`
Request Body Parameters	None
Response Body Parameters	JSON data containing the style sheet details and associated links.

URI Endpoint Sample

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

Sample Response Body

{ "name": "alternate", "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/styleSheets/alternate" } ]

Update Partner Organization Style Sheet

Update Partner Organization Style Sheet
Description	This endpoint replaces the entire partner organization style sheet with the style sheet values specified in the web services request.
URI Endpoint	/rest/v17/companies/{companyLoginName}/styleSheets/{name}
Endpoint Parameters	companyLoginName	The partner organization login name
Endpoint Parameters	name	The name of the style sheet to update
HTTP Method	PUT
Request Form Parameters	file	The CSS file for the style sheet
Request Body Parameters	None
Response Body Parameters	JSON data containing the style sheet details and associated links.

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/visionServices/styleSheets/alternate

Sample Response Body

"name": "alternate", "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/styleSheets/alternate" } ] }

Delete a Style Sheet for a Partner Organization

Delete a Style Sheet for a Partner Organization
Description	This endpoint deletes a style sheet for a partner organization.
URI Endpoint	/rest/v17/companies/{companyLoginName}/styleSheets/{name}
Endpoint Parameters	companyLoginName	The partner organization login name
Endpoint Parameters	name	The name of the style sheet to delete
HTTP Method	DELETE
Request Body Parameters	None
Response Body Parameters	HTTP Code 204

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/visionServices/styleSheets/alternate

Company Translation Web Services

Get All Translation Details for Host Company or a Partner Organization

Get All Translation Details for Host Company or a Partner Organization
Description	This endpoint retrieves all host company or partner organization translated company names in the supported language.
URI Endpoint	/rest/v17/companies/{companyLoginName}/translations
Endpoint Parameters	companyLoginName	The login name of the host company or partner organization
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data containing list of translations and associated links for the host company or partner organization.

URI Endpoint Sample

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

Sample Response Body

{ "items": [{ "name": "A1BM1", "language": { "languageCode": "en", "languageNumber": -1, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/languages/en" } ] }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/translations/en" } ] }, { "name": "DE A1BM1", "language": { "languageCode": "de", "languageNumber": 0, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/languages/de" } ] }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/translations/de" } ] }, { "name": "ZH CN A1BM1", "language": { "languageCode": "zh_CN", "languageNumber": 5, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/languages/zh_CN" } ] }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/translations/zh_CN" } ] } ], "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/translations" } ] }

Get Specific Translation Details for Host Company or a Partner Organization

Get Specific Translation Details for Host Company or a Partner Organization
Description	This endpoint retrieves specific translation details for a host company or partner organization.
URI Endpoint	/rest/v17/companies/{companyLoginName}/translations/{languageCode}
Endpoint Parameters	companyLoginName	The partner organization login name
Endpoint Parameters	languageCode	The unique language code value to specify the language Refer to Supported Languages to identify language code values.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data containing translation name, translation language and associated links for the host company or partner organization.

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/visionServices/translations/zh_CN

Sample Response Body

{ "name": "Vision Services zh_CN", "language": { "languageNumber": 5, "languageCode": "zh_CN", "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/languages/zh_CN" } ] }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/translations/zh_CN" } ] }

Add Translations for Host Company or a Partner Organization

Add Translations for Host Company or a Partner Organization
Description	This endpoint adds translations to a host company or partner organization.
URI Endpoint	/rest/v17/companies/{companyLoginName}/translations
Endpoint Parameters	companyLoginName	The login name of the host company or partner organization
HTTP Method	POST
Request Body Parameters	name	(Required) The translation name of the host company or partner organization
Request Body Parameters	languageCode	(Required) The unique language code value to specify the language Refer to Supported Languages to identify language code values.
Response Body Parameters	JSON data containing translation name, translation language, and associated links for the host company or partner organization.

URI Endpoint Sample

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

Sample Request Body

{ "name": "Fr Company visionServices", "language": { "languageNumber": 1, "languageCode": "fr" } }

Sample Response Body

{ "name": "Fr Company visionServices", "language": { "languageNumber": 1, "languageCode": "fr", "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/languages/fr" } ] }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/translations" } ] }

Update Host Company or Partner Organization Translations

Update Host Company or Partner Organization Translations
Description	This endpoint replace (add, remove, or replace) the entire host company or partner organization translations with the translation values specified in the web services request.
URI Endpoint	/rest/v17/companies/{companyLoginName}/translations
Endpoint Parameters	companyLoginName	The login name of the host company or partner organization
HTTP Method	PATCH
Request Body Parameters	The array of translation patch operations
	op	The operation to be performed. Allowed values: `add`, `remove`, or `replace`
	path	The JSON pointer string for "path" property
	value	The target value
	name	(Required for add and replace operations) The translation name of the host company or partner organization
	languageCode	(Required for add operation) The unique language code value to specify the language Refer to Supported Languages to identify language code values.
Response Body Parameters	JSON data containing translation name, translation language, and associated links for the host company or partner organization.

URI Endpoint Sample

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

Sample Request Body

[{ "op": "add", "path": "/", "value": { "name": "Czech Company visionServices", "language": { "languageCode": "cs_CZ" } } }, { "op": "replace", "path": "/de", "value": { "name": "Company visionServices Update" } }, { "op": "remove", "path": "/da_DK" } ]

Sample Response Body

{ "items": [{ "name": "A1BM1", "language": { "languageCode": "en", "languageNumber": -1, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/languages/en" } ] }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v14/companies/visionServices/translations/en" } ] }, { "name": "Company visionServices Update", "language": { "languageCode": "de", "languageNumber": 0, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/languages/de" } ] }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/translations/de" } ] }, { "name": "Czech Company visionServices", "language": { "languageCode": "cs_CZ", "languageNumber": 7, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v17/languages" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v17/languages/cs_CZ" } ] }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/translations/cs_CZ" } ] } ], "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v17/companies/visionServices/translations" } ] }

Delete a Translation for a Host Company or Partner Organization

Delete a Translation for a Host Company or Partner Organization
Description	This endpoint deletes a translation for a specific language for a host company or partner organization.
URI Endpoint	/rest/v17/companies/{companyLoginName}/translations/{languageCode}
Endpoint Parameters	companyLoginName	The login name of the host company or partner organization
Endpoint Parameters	languageCode	The unique language code value to specify the language Refer to Supported Languages to identify language code values.
HTTP Method	DELETE
Request Body Parameters	None
Response Body Parameters	HTTP Code 204

URI Endpoint Sample

https://site.oracle.com/rest/v17/companies/visionServices/translations/cs_CN

Company REST API

Overview

Administration

Company Style Sheet Web Services

Company Translation Web Services

Related Topics