2.4.4 Obtaining the Information Necessary To Stop a Discovery

This API request acquires the information necessary to stop a discovery.

Execution permission

Admin

API version

Request format

GET http[s]://host:port/Analytics/version/services/Discoveries/actions/stop

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

Attribute	Type	Description
name	string	Name of the execute an operation.
href	string	URL of the execute an operation.
method	string	Name of the method.
type	string	Data format of the object.
parameters	anyType[]	A list of objects necessary to execute an operation. No value is set.

Status codes

Status code	Reason phrase	Description
200	OK	Success.
401	Unauthorized	No login privilege.
403	Forbidden	No reference privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[Request Header]
GET http://localhost:22015/Analytics/v1/services/Discoveries/actions/stop/ HTTP/1.1
Host: localhost:22015
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 25 May 2020 02:48:17 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 8145f2e5623a6863f92284d7419ab4fa89b138_Vlo8Y30IFF0IHk4SCAJcHgUXDVg=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Content-Type: application/json
Content-Length: 192


[Response Body]
{
  "name" : "stop",
  "href" : "http://localhost:22015/Analytics/v1/services/Discoveries/actions/stop/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ ]
}