Restart the Service Instance (v1)
REST Resource
POST /interop/rest/v1/services/resetservice
Request
Supported Media Types: application/json
Payload: JSON
Table 2-198 Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
service_type |
Value for the service type. Service type can be one of the
following: PBCS for Planning and Budgeting,
EPBCS for Enterprise Planning and Budgeting,
FCCS for Financial Consolidation and Close,
TRCS for Tax Reporting, EDMCS
for Enterprise Data Management, PCMCS for
Profitability and Cost Management, or ARCS for
Account Reconciliation.
|
Path | Yes | None |
comment |
Comment about executing the restart | Payload | Yes | None |
autotune |
If set to true, runs the auto tune algorithm
before the restart. This ensures that Essbase index caches for BSO
cubes are optimized for your application.
|
Payload | No | false |
Example of Request Body
{
"comment": "Reset requested by Administrator",
"autotune": "true"
}
Response
Table 2-199 Parameters
| Name | Description |
|---|---|
Details |
In case of errors, details are published with the error string |
Status |
See Migration Status Codes |
Links |
Detailed information about the link |
Href |
Links to API call or status API |
Action |
The HTTP call type |
Rel |
Possible values: If the value is set to Job Status, you can use the href to get the status of the reset service |
Data |
Parameters as key value pairs passed in the request |
Example of Response Body
{
"details": null,
"status": -1,
"items": null,
"links": [
{
"href": "http://<BASE-URL>/interop/rest/v1/services/resetservice",
"action": "POST",
"rel": "self",
"data": null
},
{
"href": "http://<BASE-URL>/interop/rest/v1/services/jobs/hardreset/<JOB-ID>",
"action": "GET",
"rel": "Job Status",
"data": null
}
]
}Sample cURL Command
curl -X POST -s -u '<USERNAME>:<PASSWORD>' -H 'Content-Type: application/json' -d 'parameters={"comment":"<COMMENT>"}' 'http://<BASE-URL>/interop/rest/v1/services/resetservice'