dracoon.public
Module dracoon.public
API
Definitions
ballerinax/dracoon.public Ballerina library
Overview
This is a generated connector for Dracoon API v4.28.3 OpenAPI specification.
Dracoon allows to store bussiness files using client sode encryption, file sharing and data access over cloud.
Ballerina connector for Dracoon allows integration with Dracoon REST API via Ballerina language.
Prerequisites
- Create an Dracoon account
- Obtaining tokens
- Use this guide to obtain the API key related to your account
Clients
dracoon.public: Client
This is a generated connector from Dracoon API v4.28.3 OpenAPI specification.
REST Web Services for DRACOON. Developer Information Get SDKs on GitHub
Terms of service
Constructor
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a Dracoon account and obtain OAuth tokens following this guide.
init (ClientConfig clientConfig, string serviceUrl)
- clientConfig ClientConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://stats.bis.org/api/v1" - URL of the target service
requestPublicDownloadShareInfo
function requestPublicDownloadShareInfo(string accessKey, string? xSdsDateFormat) returns PublicDownloadShare|error
Request public Download Share information
Parameters
- accessKey string - Access key
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
Return Type
- PublicDownloadShare|error - OK
generateDownloadUrlPublic
function generateDownloadUrlPublic(string accessKey, PublicDownloadTokenGenerateRequest payload) returns PublicDownloadTokenGenerateResponse|error
Generate download URL
Return Type
- PublicDownloadTokenGenerateResponse|error - Created
downloadFileViaTokenPublic
function downloadFileViaTokenPublic(string accessKey, string token, string? range, boolean? genericMimetype, boolean? inline) returns Response|error
Download file with token
Parameters
- accessKey string - Access key
- token string - Download token
- range string? (default ()) - Range e.g.
bytes=0-999
- genericMimetype boolean? (default ()) - Always return
application/octet-stream
instead of specific mimetype
- inline boolean? (default ()) - Use Content-Disposition:
inline
instead ofattachment
downloadfileviatokenpublic1
function downloadfileviatokenpublic1(string accessKey, string token, string? range, boolean? genericMimetype, boolean? inline) returns Response|error
Download file with token
Parameters
- accessKey string - Access key
- token string - Download token
- range string? (default ()) - Range e.g.
bytes=0-999
- genericMimetype boolean? (default ()) - Always return
application/octet-stream
instead of specific mimetype
- inline boolean? (default ()) - Use Content-Disposition:
inline
instead ofattachment
requestPublicUploadShareInfo
function requestPublicUploadShareInfo(string accessKey, string? xSdsSharePassword, string? xSdsDateFormat) returns PublicUploadShare|error
Request public Upload Share information
Parameters
- accessKey string - Access key
- xSdsSharePassword string? (default ()) - Upload share password. Should be base64-encoded. Plain X-Sds-Share-Passwords are deprecated and will be removed in the future
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
Return Type
- PublicUploadShare|error - OK
createShareUploadChannel
function createShareUploadChannel(string accessKey, CreateShareUploadChannelRequest payload) returns CreateShareUploadChannelResponse|error
Create new file upload channel
Return Type
- CreateShareUploadChannelResponse|error - Created
requestUploadStatusPublic
function requestUploadStatusPublic(string accessKey, string uploadId) returns S3ShareUploadStatus|error
Request status of S3 file upload
Return Type
- S3ShareUploadStatus|error - OK
completeFileUploadViaShare
function completeFileUploadViaShare(string accessKey, string uploadId, UserFileKeyList payload, string? xSdsDateFormat) returns PublicUploadedFileData|error
Complete file upload
Parameters
- accessKey string - Access key
- uploadId string - Upload channel ID
- payload UserFileKeyList - Mandatory for encrypted shares
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
Return Type
- PublicUploadedFileData|error - Created
uploadfileasbinarypublic1
function uploadfileasbinarypublic1(string accessKey, string uploadId, AccessKeyUploadIdBody payload, string? xSdsDateFormat, string? contentRange) returns ChunkUploadResponse|error
Upload file
Parameters
- accessKey string - Access key
- uploadId string - Upload channel ID
- payload AccessKeyUploadIdBody - File
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
- contentRange string? (default ()) - Content-Range e.g.
bytes 0-999/3980
Return Type
- ChunkUploadResponse|error - Created
cancelFileUploadViaShare
Cancel file upload
completeS3FileUploadViaShare
function completeS3FileUploadViaShare(string accessKey, string uploadId, CompleteS3ShareUploadRequest payload) returns Response|error
Complete S3 file upload
Parameters
- accessKey string - Access key
- uploadId string - Upload channel ID
- payload CompleteS3ShareUploadRequest -
generatePresignedUrlsPublic
function generatePresignedUrlsPublic(string accessKey, string uploadId, GeneratePresignedUrlsRequest payload, string? xSdsDateFormat) returns PresignedUrlList|error
Generate presigned URLs for S3 file upload
Parameters
- accessKey string - Access key
- uploadId string - Upload channel ID
- payload GeneratePresignedUrlsRequest -
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
Return Type
- PresignedUrlList|error - Created
requestThirdPartyDependencies
function requestThirdPartyDependencies() returns ThirdPartyDependenciesData[]|error
Request third-party software dependencies
Return Type
- ThirdPartyDependenciesData[]|error - OK
requestSoftwareVersion
function requestSoftwareVersion(string? xSdsDateFormat) returns SoftwareVersionData|error
Request software version information
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
Return Type
- SoftwareVersionData|error - OK
requestSystemInfo
function requestSystemInfo(boolean? isEnabled) returns SystemInfo|error
Request system information
Parameters
- isEnabled boolean? (default ()) - Show only enabled authentication methods
Return Type
- SystemInfo|error - OK
requestActiveDirectoryAuthInfo
function requestActiveDirectoryAuthInfo(boolean? isGlobalAvailable) returns ActiveDirectoryAuthInfo|error
Request Active Directory authentication information
Parameters
- isGlobalAvailable boolean? (default ()) - Show only global available items
Return Type
requestOpenIdAuthInfo
function requestOpenIdAuthInfo(boolean? isGlobalAvailable) returns OpenIdAuthInfo|error
Request OpenID Connect provider authentication information
Parameters
- isGlobalAvailable boolean? (default ()) - Show only global available items
Return Type
- OpenIdAuthInfo|error - OK
requestSystemTime
function requestSystemTime(string? xSdsDateFormat) returns SdsServerTime|error
Request system time
Parameters
- xSdsDateFormat string? (default ()) - Date time format (cf. RFC 3339 & leettime.de)
Return Type
- SdsServerTime|error - OK
Records
dracoon.public: AccessKeyUploadIdBody
Fields
- file string? -
dracoon.public: ActiveDirectory
Active Directory information
Fields
- alias string - Unique name for an Active Directory configuration
- id int - ID
- isGlobalAvailable boolean - Is available for all customers
dracoon.public: ActiveDirectoryAuthInfo
List of Active Directories
Fields
- items ActiveDirectory[] - List of available Active Directories
dracoon.public: AuthMethod
Authentication method
Fields
- isEnabled boolean - Is enabled
- name string - Authentication methods:
-
basic
-
active_directory
-
radius
-
openid
-
- priority int - Priority (smaller values have higher priority)
dracoon.public: ChunkUploadResponse
Chunk upload response
Fields
- hash string - Hash value of transferred chunk
- size int - Chunk size
dracoon.public: ClientConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion string(default "1.1") - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- followRedirects FollowRedirects?(default ()) - Configurations associated with Redirection
- poolConfig PoolConfiguration?(default ()) - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig?(default ()) - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig?(default ()) - Configurations associated with retrying
- cookieConfig CookieConfig?(default ()) - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket?(default ()) - SSL/TLS-related options
dracoon.public: CompleteS3ShareUploadRequest
Request model for completing a S3 file upload
Fields
- parts S3FileUploadPart[] - List of S3 file upload parts
- userFileKeyList UserFileKey[]? - List of user file keys
dracoon.public: CreateShareUploadChannelRequest
Request model for creating an upload channel
Fields
- directS3Upload boolean? - Since v4.15.0 Upload direct to S3
- name string - File name
- password string? - Password
- size int? - File size in byte
- timestampCreation string? - Since v4.22.0 Time the node was created on external file system (default: current server datetime in UTC format)
- timestampModification string? - Since v4.22.0 Time the content of a node was last modified on external file system (default: current server datetime in UTC format)
dracoon.public: CreateShareUploadChannelResponse
Upload channel information
Fields
- token string? - Deprecated since v4.3.0 Upload token
- uploadId string - Upload (channel) ID
- uploadUrl string - (public) Upload URL
dracoon.public: EncryptionInfo
Encryption states
Fields
- dataSpaceKeyState string - DRACOON key state
- roomKeyState string - Room key state
- userKeyState string - User key state
dracoon.public: ErrorResponse
Error information
Fields
- code int - HTTP status code
- debugInfo string? - Debug information
- errorCode int? - Internal error code
- message string - HTTP status code description
dracoon.public: FileKey
File key information
Fields
- iv string - Initial vector
- 'key string - Encryption key
- tag string - Authentication tag (needed with authenticated encryption)
- 'version string - Version
dracoon.public: GeneratePresignedUrlsRequest
Request model for generating presigned URLs
Fields
- firstPartNumber int - First part number of a range of requested presigned URLs (for S3 it is:
1
)
- lastPartNumber int - Last part number of a range of requested presigned URLs
- size int -
Content-Length
header size for each presigned URL (in bytes) MUST be >= 5 MB except the last part.
dracoon.public: Node
Node information (Node can be a room, folder or file)
Fields
- authParentId int? - Since v4.15.0 Auth parent room ID
- branchVersion int? - Version of last change in this node or a node further down the tree.
- children Node[]? - Deprecated since v4.10.0 Child nodes list (if requested) (for rooms / folders only)
- classification int? - Classification ID:
-
1
- public -
2
- internal -
3
- confidential -
4
- strictly confidential
-
- cntAdmins int? - Deprecated since v4.2.0 Number of admins (for rooms only)
- cntChildren int? - Deprecated since v4.11.0 Number of direct children (no recursion; for rooms / folders only)
- cntComments int? - Returns the number of comments of this node.
- cntDeletedVersions int? - Number of deleted versions of this file / folder (for rooms / folders only)
- cntDownloadShares int? - Returns the number of Download Shares of this node.
- cntFiles int? - Since v4.11.0 Amount of direct child files where this node is the parent node (no recursion; for rooms / folders only)
- cntFolders int? - Since v4.11.0 Amount of direct child folders where this node is the parent node (no recursion; for rooms / folders only)
- cntRooms int? - Since v4.11.0 Amount of direct child rooms where this node is the parent node (no recursion; for rooms only)
- cntUploadShares int? - Returns the number of Upload Shares of this node.
- cntUsers int? - Deprecated since v4.2.0 Number of users (for rooms only)
- createdAt string? - Creation date
- createdBy UserInfo? - User information
- encryptionInfo EncryptionInfo? - Encryption states
- expireAt string? - Expiration date
- fileType string? - File type / extension (for files only)
- hasActivitiesLog boolean? - Is activities log active (for rooms only)
- hasRecycleBin boolean? - Deprecated since v4.10.0 Is recycle bin active (for rooms only) Recycle bin is always on (disabling is not possible).
- hash string? - MD5 hash of file
- id int - Node ID
- inheritPermissions boolean? - Inherit permissions from parent room
(default:
false
ifparentId
is0
; otherwise:true
)
- isBrowsable boolean? - Since v4.11.0 Determines whether node is browsable by client (for rooms only)
- isEncrypted boolean? - Encryption state
- isFavorite boolean? - Node is marked as favorite (for rooms / folders only)
- mediaToken string? - Media server media token
- mediaType string? - File media type (for files only)
- name string - Name
- notes string? - User notes
- parentId int? - Parent node ID (room or folder)
- parentPath string? - Parent node path
/
if node is a root node (room)
- permissions NodePermissions? - Node permissions
- quota int? - Quota in byte
- recycleBinRetentionPeriod int? - Retention period for deleted nodes in days
- size int? - Node size in byte
- timestampCreation string? - Since v4.22.0 Time the node was created on external file system
- timestampModification string? - Since v4.22.0 Time the content of a node was last modified on external file system
- 'type string - Node type
- updatedAt string? - Modification date
- updatedBy UserInfo? - User information
dracoon.public: NodePermissions
Node permissions
Fields
- change boolean - User / Group may update metadata of nodes: rename files and folders, change classification, etc.
- create boolean - User / Group may upload files, create folders and copy / move files to this room, overwriting is not possible.
- delete boolean - User / Group may overwrite and remove files / folders, move files from this room.
- deleteRecycleBin boolean - User / Group may permanently remove files / folders from the recycle bin.
- manage boolean - User / Group may grant all of the above permissions to other users and groups independently, may update room metadata and create / update / delete subordinary rooms, has all permissions.
- manageDownloadShare boolean - User / Group may create Download Shares for files and containers view all previously created Download Shares in this room.
- manageUploadShare boolean - User / Group may create Upload Shares for containers, view all previously created Upload Shares in this room.
- read boolean - User / Group may see all rooms, files and folders in the room and download everything, copy files from this room.
- readRecycleBin boolean - User / Group may look up files / folders in the recycle bin.
- restoreRecycleBin boolean - User / Group may restore files / folders from recycle bin - room permissions required.
dracoon.public: OpenIdAuthInfo
List of OpenID Connect providers
Fields
- items OpenIdProvider[] - List of available OpenID Connect identity providers
dracoon.public: OpenIdProvider
OpenID Connect provider information
Fields
- id int - ID
- isGlobalAvailable boolean - Is available for all customers
- issuer string - Issuer identifier of the IDP The value is a case sensitive URL.
- mappingClaim string - Name of the claim which is used for the user mapping.
- name string - Name of the IDP
- userManagementUrl string? - URL of the user management UI. Use empty string to remove.
dracoon.public: PresignedUrl
Presigned URL information
Fields
- partNumber int - Corresponding part number
- url string - S3 presigned URL
dracoon.public: PresignedUrlList
List of generated presigned URLs
Fields
- urls PresignedUrl[] - List of S3 presigned URLs
dracoon.public: PrivateKeyContainer
Private key container
Fields
- createdAt string? - Since v4.24.0 Creation date
- createdBy int? - Since v4.24.0 Created by user
- expireAt string? - Expiration date
- privateKey string - Private key
- 'version string - Version
dracoon.public: PublicDownloadShare
Download Share information
Fields
- createdAt string - Creation date
- creatorName string - Creator name
- creatorUsername string? - Creator username
- expireAt string? - Expiration date
- fileKey FileKey? - File key information
- fileName string - File name
- hasDownloadLimit boolean - Since v4.11.0 Determines whether Download Share has a limit for amount of downloads
- isEncrypted boolean? - Encryption state
- isProtected boolean - Is share protected by password
- limitReached boolean - Downloads limit reached
- mediaType string - Since v4.11.0
-
application/zip
(for folders and rooms) - actual file media type (for files only)
-
- name string? - Share display name (alias name)
- notes string? - User notes
- privateKeyContainer PrivateKeyContainer? - Private key container
- size int - File size or container size not compressed (in bytes)
dracoon.public: PublicDownloadTokenGenerateRequest
Request model for generating download URL
Fields
- password string? - Password (only for password-protected shares)
dracoon.public: PublicDownloadTokenGenerateResponse
Download URL
Fields
- downloadUrl string? - Download URL
- token string - Deprecated since v4.3.0 Download token
dracoon.public: PublicKeyContainer
Public key container
Fields
- createdAt string? - Since v4.24.0 Creation date
- createdBy int? - Since v4.24.0 Created by user
- expireAt string? - Expiration date
- publicKey string - Public key
- 'version string - Version
dracoon.public: PublicUploadedFileData
File information
Fields
- createdAt string - Creation date
- hash string? - Hash value of transferred file
- name string - Name
- size int - File size in byte
dracoon.public: PublicUploadShare
Upload Share information
Fields
- createdAt string - Creation date
- creatorName string - Since v4.11.0 Creator name
- creatorUsername string? - Since v4.11.0 Creator username
- expireAt string? - Expiration date
- isEncrypted boolean? - Encryption state
- isProtected boolean - Is share protected by password
- maxSize float? - Deprecated since v4.2.0 Maximal total size of uploaded files (in bytes)
- maxSlots int - Deprecated since v4.2.0 Maximal amount of files to upload
- name string? - Share display name (alias name)
- notes string? - User notes
- remainingSize int? - Remaining size
- remainingSlots int? - Remaining slots
- showUploadedFiles boolean? - Allow display of already uploaded files
- uploadedFiles PublicUploadedFileData[]? - List of (public) uploaded files
- userUserPublicKeyList UserUserPublicKeyList? - List of user public keys
dracoon.public: RoomData
Room information
Fields
- children RoomData[]? - Deprecated since v4.10.0 List of rooms, where this room is a parent (if exist)
- cntAdmins int? - Deprecated since v4.2.0 Number of admins (for rooms only)
- cntDownloadShares int? - Returns the number of Download Shares of this node.
- cntUploadShares int? - Returns the number of Upload Shares of this node.
- cntUsers int? - Deprecated since v4.2.0 Number of users (for rooms only)
- createdAt string? - Expiration date
- createdBy UserInfo? - User information
- hasRecycleBin boolean - Deprecated since v4.10.0 Is recycle bin active (for rooms only) Recycle bin is always on (disabling is not possible).
- id int - Room ID
- isEncrypted boolean - Encryption state
- isFavorite boolean? - Node is marked as favorite (for rooms / folders only)
- isGranted boolean - Is user granted room permissions
- name string - Name
- parentId int? - Parent node ID (room or folder)
- permissions NodePermissions? - Node permissions
- quota int? - Quota in byte
- recycleBinRetentionPeriod int - Retention period for deleted nodes in days
- size int? - Room size
- 'type string? - Node type
- updatedAt string? - Modification date
- updatedBy UserInfo? - User information
dracoon.public: S3FileUploadPart
S3 file upload part information
Fields
- partEtag string - Corresponding part ETag
- partNumber int - Corresponding part number
dracoon.public: S3ShareUploadStatus
S3 file upload status information
Fields
- errorDetails ErrorResponse? - Error information
- fileName string - File name
- size int? - File size in byte
- status string - S3 file upload status:
-
transfer
- upload in progress -
finishing
- completing file upload -
done
- file upload successully done -
error
- an error occurred while file upload
-
dracoon.public: SdsServerTime
DRACOON server time
Fields
- time string? - DRACOON server time
dracoon.public: SoftwareVersionData
Software version information
Fields
- buildDate string - Build date
- isDracoonCloud boolean? - Since v4.24.0 Determines if the DRACOON Core is deployed in the cloud environment
- restApiVersion string - REST API version
- scmRevisionNumber string - Revision number
- sdsServerVersion string - DRACOON server version
dracoon.public: SystemInfo
System information (default language and authentication methods)
Fields
- authMethods AuthMethod[] - Deprecated since v4.13.0
Authentication methods:
-
sql
-
active_directory
-
radius
-
openid
authData
instead -
- hideLoginInputFields boolean - Since v4.13.0 Defines if login fields should be hidden
- s3EnforceDirectUpload boolean - Since v4.15.0 Determines whether S3 direct upload is enforced or not
- s3Hosts string[] - Since v4.14.0 List of S3 Hosts for CSP header
- useS3Storage boolean - Since v4.21.0 Defines if S3 is used as storage backend
dracoon.public: ThirdPartyDependenciesData
Third-party dependency information
Fields
- artifactId string - Third party dependencies artifactId
- description string - Third party dependencies description
- groupId string - Third party dependencies groupId
- id string - Third party dependencies id
- licenses string[] - Third party dependencies licenses type
- name string - Third party dependencies name
- 'type string - Third party dependencies type
- url string - Third party dependencies url
- 'version string - Third party dependencies version
dracoon.public: UserFileKey
User file key
Fields
- fileKey FileKey - File key information
- userId int - Unique identifier for the user
dracoon.public: UserFileKeyList
List of user file keys
Deprecated
Fields
- items UserFileKey[]? - List of user file keys
dracoon.public: UserInfo
User information
Fields
- avatarUuid string - Since v4.11.0 Avatar UUID
- displayName string? - Deprecated since v4.11.0
Display name
use other fields from
UserInfo
instead to combine a display name
- email string? - Since v4.11.0 Email
- firstName string - Since v4.11.0
User first name (mandatory if
userType
isinternal
)
- id int - Unique identifier for the user
- lastName string - Since v4.11.0
User last name (mandatory if
userType
isinternal
)
- title string? - Deprecated since v4.18.0 Job title
- userName string - Since v4.13.0
Username (only returned for
internal
users)
- userType string - Since v4.11.0
User type:
-
internal
- ordinary DRACOON user -
external
- external user without DRACOON account -
system
- system user (non human ) -
deleted
- deleted DRACOON user
-
dracoon.public: UserUserPublicKey
Public key information
Fields
- id int? - Unique identifier for the user
- publicKeyContainer PublicKeyContainer? - Public key container
dracoon.public: UserUserPublicKeyList
List of user public keys
Fields
- items UserUserPublicKey[] - List of user public keys
Import
import ballerinax/dracoon.public;
Metadata
Released date: over 2 years ago
Version: 1.2.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.0.0
GraalVM compatible: Yes
Pull count
Total: 1
Current verison: 1
Weekly downloads
Keywords
Content & Files/File Management & Storage
Cost/Paid
Contributors