This document lists all the REST API changes in Secure Data Space version 4 (a.k.a. DRACOON version 4) compared to Secure Data Space version 3.
General Information
- The path is changed to /api/v4 for all APIs.
- All APIs that return time information now default to UTC. If you should still require the server's local time, please set the X-Sds-Date-Format header accordingly.
- All filters, sort criteria and model attributes are now camelCase. All previous snake_case strings have been changed.
- All occurrences of displayName are reworked and now consistent.
- Salutations have been removed. Please use gender instead. Salutation is a branding/UI issue and needs to be configured there in correspondance to gender and language.
- Configuring of expiration dates is changed: the attribute expireAt is now wrapped by a new optional structure named objectExpiration. This structure contains the attributes expireAt and enableExpiration. If the expiration date should be set, both sub attributes need to be provided with valid data. To disable an active expiration date, simply set the sub attribute enableExpiration to false. If objectExpiration is not set, no changes are made to the currently set or not set expiration date.
- All data volumes are changed to bytes. Conversion factor is 1024.
Legend
- A = added
- C = changed
- R = removed
|
|
API |
Comment |
|
|
/auth |
C |
POST /auth/login |
all error responses 423 are now 403 (Forbidden) |
|
|
C |
POST /auth/reset_password |
success response code is now 204 |
|
|
C |
PUT /auth/reset_password/{token} |
success response code is now 204 |
|
/config |
C |
PUT /config/authSettings |
success response code is now 204 |
|
|
C |
PUT /config/settings |
success response code is now 204 |
|
/customers |
R |
GET /customers |
removed deprecated API, please use /provisioning API instead |
|
|
R |
POST /customers |
removed deprecated API, please use /provisioning API instead |
|
|
R |
GET /customers/{customer_id} |
removed deprecated API, please use /provisioning API instead |
|
|
R |
PUT /customers/{customer_id} |
removed deprecated API, please use /provisioning API instead |
|
|
R |
DELETE /customers/{customer_id} |
removed deprecated API, please use /provisioning API instead |
|
|
R |
GET /customers/actions/checkuser |
removed deprecated API, please use /provisioning API instead |
|
|
R |
PUT /customers/actions/lock/{customer_id} |
removed deprecated API, please use /provisioning API instead |
|
/groups |
C |
POST /groups |
group members can no longer be set upon creation, please use a succeeding POST /groups/{group_id}/users request room permissions can no longer be set, please use PUT /nodes/rooms/{room_id}/groups instead success response code is now 201 attributes to set expiration date are changed, new structure objectExpiration introduced, please see General Information for more details |
|
|
C |
PUT /groups |
group members can no longer be set upon creation, please use a succeeding POST /groups/{group_id}/users request room permissions can no longer be set, please use PUT /nodes/rooms/{room_id}/groups instead expiration date are changed, new structure objectExpiration introduced, please see General Information for more details |
|
|
C |
DELETE /groups/{group_id} |
success response code is now 204 |
|
|
R |
POST /groups/{group_id}/rooms |
removed deprecated API, please use PUT /nodes/rooms/{room_id}/groups to grant or change permissions to/of an user group |
|
|
R |
PUT /groups/{group_id}/rooms |
removed deprecated API, please use PUT /nodes/rooms/{room_id}/groups to grant or change permissions to/of an user group |
|
|
R |
DELETE /groups/{group_id}/rooms |
removed deprecated API, please use DELETE /nodes/rooms/{room_id}/groups to revoke permissions of a user group |
|
|
C |
POST /groups/{group_id}/users |
API now adds users to group; previously existing users are no longer removed |
|
|
R |
PUT /groups/{group_id}/users |
removed deprecated API, please use POST /groups/{group_id}/users to add users to an user group |
|
|
A |
GET /groups/{group_id}/roles |
Retrieve all roles of a user group |
|
/nodes |
C |
GET /nodes |
removed deprecated attribute cntShares, please use specific cntDownloadShares andcntUploadShares instead |
|
|
C |
GET /nodes/{nodes_id} |
removed deprecated attribute cntShares, please use specific cntDownloadShares andcntUploadShares instead |
|
|
A |
DELETE /nodes/{node_id} |
New API to delete one single Node |
|
|
C |
POST /nodes/{node_id}/copy_to |
success response code is now 201 |
|
|
C |
POST /nodes/{node_id}/favorite |
success response code is now 201 |
|
|
C |
DELETE /nodes/{node_id}/favorite |
success response code is now 204 |
|
|
C |
POST /nodes/deleted_nodes/actions/restore |
success response code is now 204 |
|
|
R |
GET /nodes/files/{file_id} |
removed deprecated API, please use GET /nodes/{node_id} instead |
|
|
C |
PUT /nodes/files/{file_id} |
API now returns a Node instead of FileData attributes to set expiration date are changed, new structure objectExpiration introduced, please see General Information for more details |
|
|
R |
DELETE /nodes/files/{file_id} |
removed deprecated API, please use DELETE /nodes or DELETE /nodes/{node_id} instead |
|
|
C |
POST /nodes/files/keys |
success response code is now 204 |
|
|
C |
POST /nodes/files/uploads |
success response code is now 201 attributes to set expiration date are changed, new structure objectExpiration introduced, please see General Information for more details |
|
|
C |
POST /nodes/files/uploads/{upload_id} |
success response code is now 201 |
|
|
C |
PUT /nodes/files/uploads/{upload_id} |
API now returns a Node instead of FileData success response code is now 201 (hash returned) or 202 (hash pending) |
|
|
C |
DELETE /nodes/files/uploads/{upload_id} |
success response code is now 204 |
|
|
R |
GET /nodes/folders/{folder_id} |
removed deprecated API, please use GET /nodes/{node_id} instead |
|
|
C |
POST /nodes/folders |
API now returns a Node instead of FolderData success response code is now 201 |
|
|
C |
PUT /nodes/folders/{folder_id} |
API now returns a Node instead of FolderData |
|
|
R |
DELETE /nodes/folders/{folder_id} |
removed deprecated API, please use DELETE /nodes or DELETE /nodes/{nodes_id} instead |
|
|
R |
GET /nodes/folders/{folder_id}/children |
removed deprecated API, please use GET /nodes instead |
|
|
R |
POST /nodes/folders/{folder_id}/children |
removed deprecated API, please use POST /nodes/{node_id}/copy_to instead |
|
|
R |
PUT /nodes/folders/{folder_id}/children |
removed deprecated API, please use POST /nodes/{node_id}/move_to instead |
|
|
R |
GET /nodes/rooms/{room_id} |
removed deprecated API, please use GET /nodes/{node_id} instead |
|
|
C |
POST /nodes/rooms |
API now returns a Node instead of RoomData success response code is now 201 |
|
|
C |
PUT /nodes/rooms/{room_id} |
API now returns a Node instead of RoomData, API now used to configure a DataRoom as parent admin (set name and quota) |
|
|
R |
PATCH /nodes/rooms/{room_id} |
removed deprecated API, please use PUT /nodes/rooms/{room_id} or PUT /nodes/rooms/{room_id}/config instead |
|
|
R |
DELETE /nodes/rooms/{room_id} |
removed deprecated API, please use DELETE /nodes or DELETE /nodes/{node_id} instead |
|
|
A |
PUT /nodes/rooms/{room_id}/config |
new API to change the config of a DataRoom as DataRoomAdmin (configure Recycle Bin andPermissions Inheritance) |
|
|
R |
GET /nodes/rooms/{room_id}/children |
removed deprecated API, please use GET /nodes instead |
|
|
R |
POST /nodes/rooms/{room_id}/children |
removed deprecated API, please use POST /nodes/{node_id}/copy_to |
|
|
R |
PUT /nodes/rooms/{room_id}/children |
removed deprecated API, please use POST /nodes/{node_id}/move_to |
|
|
R |
POST /nodes/rooms/{room_id}/groups |
removed deprecated API, please use PUT /nodes/rooms/{room_id}/groups to add or change group permissions |
|
|
C |
PUT /nodes/rooms/{room_id}/groups |
reworked API to set or change group permissions success response code is now 204 |
|
|
C |
DELETE /nodes/rooms/{room_id}/groups |
success response code is now 204 |
|
|
R |
GET /nodes/rooms/{room_id}/groups/{group_id} |
removed deprecated API, please use GET /nodes/rooms/{room_id}/groups to query group permissions |
|
|
R |
PUT /nodes/rooms/{room_id}/groups/{group_id} |
removed deprecated API, please use PUT /nodes/rooms/{room_id}/groups to change group permissions |
|
|
R |
DELETE /nodes/rooms/{room_id}/groups/{group_id} |
removed deprecated API, please use DELETE /nodes/rooms/{room_id}/groups to revoke group permissions |
|
|
R |
POST /nodes/rooms/{room_id}/users |
removed deprecated API, please use PUT /nodes/rooms/{room_id}/users to add or change user permissions |
|
|
C |
PUT /nodes/rooms/{room_id}/users |
reworked API to set or change user permissions success response code is now 204 |
|
|
C |
DELETE /nodes/rooms/{room_id}/users |
success response code is now 204 |
|
|
R |
GET /nodes/rooms/{room_id}/users/{user_id} |
removed deprecated API, please use GET /nodes/rooms/{room_id}/users to query user permissions |
|
|
R |
PUT /nodes/rooms/{room_id}/users/{user_id} |
removed deprecated API, please use PUT /nodes/rooms/{room_id}/users to change user permissions |
|
|
R |
DELETE /nodes/rooms/{room_id}/users/{user_id} |
removed deprecated API, please use DELETE /nodes/rooms/{room_id}/users to revoke user permissions |
|
|
A |
GET /nodes/rooms/pending |
new API to query pending permissions of new group members |
|
|
A |
PUT /nodes/rooms/pending |
new API to modify pending permissions of new group members |
|
|
C |
POST /nodes/zip |
attribute type is no longer required |
|
/provisioning |
C |
POST /provisioning/customers |
attribute doNotNotify removed, please use notifyUser instead success response code is now 201 |
|
|
C |
GET /provisioning/customers/{customer_id}/users |
users' global permissions are no longer returned, roles are provided instead |
|
/public |
C |
POST /public/shares/uploads/{access_key} |
success response code is now 201 |
|
|
C |
POST /public/shares/uploads/{access_key}/{upload_id} |
success response code is now 201 |
|
|
C |
PUT /public/shares/uploads/{access_key}/{upload_id} |
success response code is now 201 (hash returned) or 202 (hash pending) |
|
|
C |
DELETE /public/shares/uploads/{access_key}/{upload_id} |
success response code is now 204 |
|
|
A |
GET /public/time |
new API to query the current server time |
|
/roles |
A |
GET /roles |
new API to query all existing roles |
|
|
A |
GET /roles/{role_id}/groups |
new API to query all user groups assigned to a certain role |
|
|
A |
POST /roles/{role_id}/groups |
new API to assign user groups to a certain role |
|
|
A |
DELETE /roles/{role_id}/groups |
new API to revoke user groups from a certain role |
|
|
A |
GET /roles/{role_id}/users |
new API to query all users assigned to a certain role |
|
|
A |
POST /roles/{role_id}/users |
new API to assign users to a certain role |
|
|
A |
DELETE /roles/{role_id}/users |
new API to revoke users from a certain role |
|
/shares |
C |
GET /shares/downloads |
attributes fileId and sourceId are no longer returned, please use nodeId instead |
|
|
C |
POST /shares/downloads |
attributes fileId and sourceId are no longer returned, please use nodeId instead success response code is now 201 attributes to set expiration date are changed, new structure objectExpiration introduced, please see General Information for more details |
|
|
C |
GET /shares/downloads/{share_id} |
attributes fileId and sourceId are no longer returned, please use nodeId instead |
|
|
C |
DELETE /shares/downloads/{share_id} |
success response code is now 204 |
|
|
C |
POST /shares/uploads |
success response code is now 201 attributes to set expiration date are changed, new structure objectExpiration introduced, please see General Information for more details |
|
|
C |
DELETE /shares/uploads/{share_id} |
success response code is now 204 |
|
/system |
C |
POST /system/config/auth/ads |
success response code is now 201 |
|
|
C |
POST /system/config/oauth/clients |
success response code is now 201 |
|
/uploads |
C |
POST /uploads/{token} |
success response code is now 201 This API should no longer be used for anonymous uploads (via upload shares), please use POST /public/shares/uploads/{access_key}/{upload_id} instead. |
|
|
C |
PUT /uploads/{token} |
API now returns a Node instead of FileData success response code is now 201 (hash returned) or 202 (hash pending) |
|
|
C |
DELETE /upoads/{token} |
success response code is now 204 |
|
/user |
C |
POST /user/logout |
success response code is now 204 |
|
|
C |
GET /user/account |
user's global permissions are no longer returned, roles are provided instead removed deprecated attribute isInitialPasswordChanged, please use needsToChangePasswordinstead removed deprecated attribute salutation, please use gender instead |
|
|
C |
PUT /user/account |
user's global permissions are no longer returned, roles are provided instead removed deprecated attribute isInitialPasswordChanged, please use needsToChangePasswordinstead removed deprecated attribute salutation, please use gender instead |
|
|
C |
PUT /user/account/password |
success response code is now 204 |
|
|
C |
POST /user/account/keypair |
success response code is now 204 |
|
|
C |
DELETE /user/account/keypair |
success response code is now 204 |
|
/users |
C |
GET /users |
users' global permissions are no longer returned, roles are provided instead removed deprecated attribute salutation, please use gender instead |
|
|
C |
POST /users |
user's global permissions can no longer be set, please use POST /roles/{role_id}/users instead user's group memberships can no longer be set, please use POST /groups/{group_id}/users instead user's room permissions can no longer be set, please use PUT /nodes/rooms/{room_id}/users instead user's global permissions are no longer returned, roles are provided instead removed deprecated attribute salutation, please use gender instead success response code is now 201 attributes to set expiration date are changed, new structure objectExpiration introduced, please see General Information for more details |
|
|
C |
GET /users/{user_id} |
user's global permissions are no longer returned, roles are provided instead removed deprecated attribute salutation, please use gender instead |
|
|
C |
PUT /users/{user_id} |
user's global permissions can no longer be set, please use POST /roles/{role_id}/users instead user's group memberships can no longer be set, please use POST /groups/{group_id}/users instead user's room permissions can no longer be set, please use PUT /nodes/rooms/{room_id}/users instead user's global permissions are no longer returned, roles are provided instead removed deprecated attribute salutation, please use gender instead attributes to set expiration date are changed, new structure objectExpiration introduced, please see General Information for more details |
|
|
C |
DELETE /users/{user_id} |
success response code is now 204 |
|
|
R |
POST /users/{user_id}/groups |
removed deprecated API, please use POST /groups/{group_id}/users and DELETE /groups/{group_id}/users instead |
|
|
R |
PUT /users/{user_id}/groups |
removed deprecated API, please use POST /groups/{group_id}/users instead |
|
|
R |
DELETE /users/{user_id}/groups |
removed deprecated API, please use DELETE /groups/{group_id}/users instead |
|
|
R |
POST /users/{user_id}/rooms |
removed deprecated API, please use PUT /nodes/rooms/{room_id}/users and DELETE /nodes/rooms/{room_id}/users instead |
|
|
R |
PUT /users/{user_id}/rooms |
removed deprecated API, please use PUT /nodes/rooms/{room_id}/users instead |
|
|
R |
DELETE /users/{user_id}/rooms |
removed deprecated API, please use DELETE /nodes/rooms/{room_id}/users instead |
|
|
A |
GET /users/{user_id}/roles |
new API to provide a user's roles |
|
|
R |
GET /users/roles |
removed deprecated API |
|
C |
POST /users/{user_id}/userAttributes |
success response code is now 201 |
|
|
|
C |
DELETE /users/{user_id}/userAttributes/{key} |
success response code is now 204 |
Comments
0 comments
Article is closed for comments.