Upgrade Operator Connect Customer License
This request enables you to upgrade the customer license type from OC Essential to OC EssentialPlus or OC OC Pro.
URI
{{baseUrl}}/api/v2/customer/{customerGuid}/action/upgrade
HTTP Method
POST
Example Request Body
{
"UpgradetoLicense": 5,
"licenseCount": 50
}Request Body
|
Parameter |
Type |
Description |
||||||
|---|---|---|---|---|---|---|---|---|
|
UpgradetoLicense |
integer |
One of the following values:
|
||||||
|
licenseCount |
integer |
The number of required licenses for the configured license type. |
Example Response
The initial response displays the Task Id.
|
Parameter |
Type |
Description |
|---|---|---|
|
taskId |
string |
The queued task Id that is generated for this action. You must run the Task request to retrieve the status of the action. See Task Status. Note that the tsk_ string in the prefix is unique for this endpoint. |
"tsk_185510"The execution of the request may take a few minutes. The status will progress from 'In Progress' to 'Completed Success'. See for details.
{
"id": "tsk_185510",
"status": "CompletedSuccess",
"details": [
null
],
"executionMessages": [],
"outputData": {},
"createTime": "0001-01-01T00:00:00",
"completeTime": null,
"cancellationRequested": null
} HTTP Responses
| ■ | 200 OK |
|
Parameter |
Type |
Description |
||||||
|---|---|---|---|---|---|---|---|---|
|
id |
string |
The task Id that is generated for this action. See Task Status. |
||||||
|
status |
string |
Aggregated status reflecting update status on both the Live Platform and Operator Connect:
|
||||||
|
details |
array |
Additional details. |
||||||
|
executionMessages |
null |
Internal debugging messages. | ||||||
|
outputData |
list array |
- |
||||||
|
createTime |
string($date-time) |
Timestamp indicating the time that the license upgrade request was initiated. |
||||||
|
completeTime |
string($date-time) |
Timestamp indicating the time that the license upgrade request processing completed. |
||||||
|
cancellationRequested |
Boolean |
Indicates whether the request processing was canceled by the client application. This parameter is not relevant for Live Platform. |
| ■ | 409 Tenant is already upgraded: |
{
"title": "Tenant is already upgraded: OC EssentialPlus",
"status": 409
}| ■ | 500 wrong value used: When the 'upgradetoLicense' parameter is configured with an invalid value: |
{
"upgradeToLicense": 7,
"licenseCount": 20
}The following error is displayed:
{
"title": "Value cannot be null. (Parameter 's')",
"status": 500,
"detail": "ErrorTicket=03a95735-ae13-4c3b-9f92-9fe30ff91db1"
}See 'upgradeToLicense' parameters shown above for valid types.