Jump to

• Request
• Response
• Examples

Delete a connection

delete

/api/20210901/catalog/connections/{connectionId}

Remove a connection from an Analytics instance.

Request

Path Parameters

• connectionId(required): string(byte)
  The ID of the connection with Base64 encoding. For example, if your connection has the object ID 'user'.'connId', enter the Base64 encoded value, J3VzZXInLidjb25uSWQn

There's no request body for this operation.

Back to Top

Response

200 Response

Successful operation.

401 Response

Unauthorized (missing or expired credentials, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

403 Response

Forbidden (missing permissions for operation, request denied for unspecified reason, and so on).

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

404 Response

Not Found. The requested resource was not found.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  Short error code that defines the error, meant for programmatic parsing.
• message(required): string
  Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

Back to Top

Examples

In this example, you delete a connection to Oracle Autonomous Data Warehouse (ADW) that you no longer want called oracle_adw_walletless. The object ID of the connection is 'admin'.'oracle_adw_walletless', which has the Base64 encoded connectionId value J2FkbWluJy4nb3JhY2xlX2Fkd193YWxsZXRsZXNzJw==.

cURL Example

First, obtain the object ID of the connection you want to delete and Base64 encode the value to determine the connectionId. You can obtain the Object ID value from the Inspect Connection dialog in Oracle Analytics Cloud.

Run the cURL command with the connectionId:

curl -i \
 --header 'Authorization: Bearer <token>' \
 --header 'Content-Type: application/json' \
 --request DELETE 'https://<hostname>/api/20210901/catalog/connections/J2FkbWluJy4nb3JhY2xlX2Fkd193YWxsZXRsZXNzJw=='

Example of Response Header

Not applicable.

Example of Response Body

Not applicable.

Back to Top