Delete Connection
delete
http://{host}:{port}/veridata/v1/services/configuration/connections/{Id}
Required Role: Administrator, SuperUser, CommandLineOperator
API to delete veridata connection.
Request
Path Parameters
-
Id(required): integer
Connection ID to be deleted.
Query Parameters
-
force: boolean
When true, deletes the Job, Group and Compare Pairs associated with this Connection.Default Value:
false
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
204 Response
No Content.
400 Response
Bad Request.
Root Schema : Error
Type:
Show Source
object-
errCode: string
Veridata Error Code.
-
errMsg: string
Veridata Error Message.
Example:
{
"errCode":"OGGV-00001",
"errMsg":"Error message"
}401 Response
Unauthorized.
Root Schema : Error
Type:
Show Source
object-
errCode: string
Veridata Error Code.
-
errMsg: string
Veridata Error Message.
Example:
{
"errCode":"OGGV-00001",
"errMsg":"Error message"
}404 Response
Not Found.
Root Schema : Error
Type:
Show Source
object-
errCode: string
Veridata Error Code.
-
errMsg: string
Veridata Error Message.
Example:
{
"errCode":"OGGV-00001",
"errMsg":"Error message"
}500 Response
Server Error.
Root Schema : Error
Type:
Show Source
object-
errCode: string
Veridata Error Code.
-
errMsg: string
Veridata Error Message.
Example:
{
"errCode":"OGGV-00001",
"errMsg":"Error message"
}