Help Center/ KooDrive/ API Reference/ API/ Sharing Management - Access Links/ Creating an Asynchronous Sharing Task
Updated on 2024-07-30 GMT+08:00
View PDF
Share

Creating an Asynchronous Sharing Task

Function

Create an asynchronous sharing task.

URI

POST /koodrive/ose/v1/share/tasks

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.

X-Traceid

No

String

Service trace ID, which contains 58 bits.
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

taskType

Yes

Integer

Batch operation task type. 1: download; 2: dump.

containerId

Yes

String

Space where the file is located.

fileIds

Yes

Array of strings

File ID list.

targetFileId

No

FileIdInfo object

File ID information.

zipName

No

String

Compressed package name, which is the same as that of the package created for download in File Management.

shareId

Yes

String

Sharing ID.

kdstoken

No

String

Temporary token for sharing.
Table 3 FileIdInfo

Parameter

Mandatory

Type

Description

fileId

Yes

String

File ID.

containerId

Yes

String

Space ID.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code

String

Response code.

msg

String

Response information.

taskId

String

Task ID.

Example Requests

POST /koodrive/ose/v1/share/tasks

{
  "taskType" : 0,
  "containerId" : "string",
  "fileIds" : [ "string" ],
  "targetFileId" : {
    "fileId" : "string",
    "containerId" : "string"
  },
  "zipName" : "string",
  "shareId" : "string",
  "kdstoken" : "string"
}

Example Responses

Status code: 200

OK

{
  "code" : "string",
  "msg" : "string",
  "taskId" : "string"
}

Status Codes

Status Code

Description

200

OK