Example: Deleting a file permanently

Frequency of useCommon
TriggerUser initiated
Pre-conditions
  • A file at '/123/folder
  • The user has EDIT permissions on the file
Actors
  • An authenticated user (user)
Communication Flow: Kotlin
Files.delete.call(
    bulkRequestOf(FindByStringId(
        id = "/123/folder", 
    )),
    user
).orThrow()

/*
BulkResponse(
    responses = listOf(Unit), 
)
*/
Communication Flow: TypeScript
// Authenticated as user
await callAPI(FilesApi.delete(
    {
        "items": [
            {
                "id": "/123/folder"
            }
        ]
    }
);

/*
{
    "responses": [
        {
        }
    ]
}
*/
Communication Flow: Curl
# ------------------------------------------------------------------------------------------------------
# $host is the UCloud instance to contact. Example: 'http://localhost:8080' or 'https://cloud.sdu.dk'
# $accessToken is a valid access-token issued by UCloud
# ------------------------------------------------------------------------------------------------------

# Authenticated as user
curl -XDELETE -H "Authorization: Bearer $accessToken" -H "Content-Type: content-type: application/json; charset=utf-8" "$host/api/files" -d '{
    "items": [
        {
            "id": "/123/folder"
        }
    ]
}'


# {
#     "responses": [
#         {
#         }
#     ]
# }
Communication Flow: Visual