2.5.15 Change of the status of a service to disabled
Function
Changes the status of the specified service to disabled.
Execution permissions
Admin role, Develop role, Modify role
API version
v1
Request format
POST http://host:port/Automation/version/objects/Services/id/actions/disable/invoke
Status code
The following table describes the various status codes that can be returned as the response to a request.
Status code |
Message |
Description |
---|---|---|
200 |
OK |
Processing has been successfully completed. |
400 |
Bad Request |
A query parameter is invalid. |
401 |
Unauthorized |
The user does not have login permission. |
404 |
Not found |
The permission is invalid, or the resource does not exist. |
409 |
Conflict |
The service is in a status that cannot be changed to disabled. |
412 |
Precondition failed |
The server is not available. |
500 |
Server-side error |
A server processing error occurred. |
Response schema
The following shows the structure of the response body for a request.
{ "instanceID" : "instance-id", "created" : "created-date-and-time", "updated" : "updated-date-and-time", "completed" : "completed-date-and-time", "state" : "state", "affectedResources" : [ {...} ], "result" : [ {...} ], "resultType" : "result-type" }
Usage example
In the following example, the API function changes the status of the service whose instanceID is 2004 to disabled.
Request header: POST /Automation/v1/objects/Services/2004/actions/disable/invoke HTTP/1.1 Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: curl/7.36.0 Host: 10.196.184.182:22015 Accept: application/json Content-Type: application/json Content-Length: 175 Accept-Language: ja Response header: HTTP/1.1 200 OK Date: Thu, 30 Jul 2015 05:07:57 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO 3bae2e194f9f7417a578e3d18492e9ccf94388_Vlo8Y30JdDBUB3ljJSVPaRtjBSA=_V0810 Access-Control-Allow-Origin: * Access-Control-Allow-Methods: GET, POST, DELETE, PUT, HEAD, OPTIONS Access-Control-Allow-Credentials: true Cache-Control: no-cache Transfer-Encoding: chunked Content-Type: application/json Response body: { "instanceID" : "ff785246-c3c9-425c-87a5-109336e8b387", "created" : "2015-07-30T14:07:58.053+09:00", "updated" : "2015-07-30T14:07:58.053+09:00", "completed" : "2015-07-30T14:07:58.053+09:00", "state" : "success", "affectedResource" : [ "http://10.196.184.182:22015/Automation/v1/objects/Services/2004" ], "result" : [ ] }