Updated on 2024-08-05 GMT+08:00

Deleting a Shared Link

Function

This API is used to delete a shared link.

URI

DELETE /v3/{project_id}/connections/share

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

To obtain this value, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

X-Language

No

String

Language.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

shared_conn_id

Yes

String

ID of a shared link.

users

Yes

Array of ShareConnUserInfo objects

User.

Table 4 ShareConnUserInfo

Parameter

Mandatory

Type

Description

user_id

Yes

String

User ID.

user_name

Yes

String

Username.

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum length: 8

Maximum length: 36

error_msg

String

Error message.

Minimum length: 2

Maximum length: 512

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum length: 8

Maximum length: 36

error_msg

String

Error message.

Minimum length: 2

Maximum length: 512

Example Requests

Deleting a shared link

DELETE https://{{endpoint}}/v3/{{project_id}}/connections/share 
{ 
  "users" : [ { 
    "user_id" : "0852a89ae180d5401f5ac00271a4a02e", 
    "user_name" : "username1" 
  }, { 
    "user_id" : "07da4af00180d5651f49c00200b352b5", 
    "user_name" : "username2" 
  } ], 
  "shared_conn_id" : "ee64e597-4f25-486f-bba1-0c850b3b59d6" 
}

Example Responses

None

Status Code

Status Code

Description

200

Success.

400

Bad request.

500

Internal server error.

Error Code

See Error Codes.