Logo

View the Project on GitHub elements-storage/elements-sdk-swift

MainAPI

All URIs are relative to https://elements.local

Method HTTP request Description
applyConfiguration POST /api/2/configuration/apply  
beep POST /api/2/system/beep  
checkCertificate POST /api/2/system/certificate/check  
checkChunkUploaded GET /api/2/uploads/chunk  
checkInternetConnectivity POST /api/2/system/check-connectivity  
checkStorNextLicense POST /api/2/stornext-license/check  
collectDiagnostics POST /api/2/system/collect-diagnostics  
createArchive POST /api/2/download-archive/create  
createGroup POST /api/2/groups  
createHomeWorkspace POST /api/2/users/{id}/home  
createNTPServer POST /api/2/system/time/servers  
createUser POST /api/2/users  
createWorkstation POST /api/2/workstations  
deleteDownloadArchive DELETE /api/2/download-archive/{id}  
deleteGroup DELETE /api/2/groups/{id}  
deleteHomeWorkspace DELETE /api/2/users/{id}/home  
deleteNTPServer DELETE /api/2/system/time/servers/{id}  
deleteUser DELETE /api/2/users/{id}  
deleteWorkstation DELETE /api/2/workstations/{id}  
disableUserTOTP DELETE /api/2/users/{id}/totp  
enableUserTOTP POST /api/2/users/{id}/totp  
finishUpload POST /api/2/uploads/finish  
fixLDAPGroupMemberships POST /api/2/ldap-servers/{id}/fix-memberships  
getAllDownloadArchives GET /api/2/download-archive  
getAllDownloads GET /api/2/downloads  
getAllGroups GET /api/2/groups  
getAllLDAPServers GET /api/2/ldap-servers  
getAllNTPServers GET /api/2/system/time/servers  
getAllStorageNodes GET /api/2/nodes  
getAllUsers GET /api/2/users  
getAllWorkstations GET /api/2/workstations  
getCertificateConfiguration GET /api/2/system/certificate  
getClientDownloadFile GET /api/2/downloads/clients/{file}  
getClientDownloads GET /api/2/downloads/clients  
getCurrentWorkstation GET /api/2/workstations/current  
getDownload GET /api/2/downloads/{id}  
getDownloadArchive GET /api/2/download-archive/{id}  
getDownloadArchiveFile GET /api/2/download-archive/{id}/download  
getDownloadFile GET /api/2/downloads/{id}/download  
getDownloadIcon GET /api/2/downloads/{id}/icon  
getGroup GET /api/2/groups/{id}  
getHomeWorkspace GET /api/2/users/{id}/home  
getIPMIConfiguration GET /api/2/nodes/{id}/ipmi  
getLDAPServer GET /api/2/ldap-servers/{id}  
getLDAPServerGroups GET /api/2/ldap-servers/{id}/groups  
getLDAPServerUsers GET /api/2/ldap-servers/{id}/users  
getLicense GET /api/2/license  
getLocalTime GET /api/2/system/time  
getLog GET /api/2/system/log/{path}  
getNTPServer GET /api/2/system/time/servers/{id}  
getNodeIPMISensors GET /api/2/nodes/{id}/sensors  
getNodeStats GET /api/2/nodes/{id}/stats  
getParameters GET /api/2/parameters  
getProfile GET /api/2/users/me  
getReleaseNotes GET /api/2/release-notes  
getSMTPConfiguration GET /api/2/system/smtp  
getServiceStatus GET /api/2/nodes/{id}/services/{service}  
getStorNextLicense GET /api/2/stornext-license  
getStorageNode GET /api/2/nodes/{id}  
getSystemInfo GET /api/2/system/info  
getUser GET /api/2/users/{id}  
getWorkstation GET /api/2/workstations/{id}  
installStorNextLicense POST /api/2/stornext-license  
patchCurrentWorkstation PATCH /api/2/workstations/current  
patchDownloadArchive PATCH /api/2/download-archive/{id}  
patchGroup PATCH /api/2/groups/{id}  
patchNTPServer PATCH /api/2/system/time/servers/{id}  
patchProfile PATCH /api/2/users/me  
patchUser PATCH /api/2/users/{id}  
patchWorkstation PATCH /api/2/workstations/{id}  
previewUser POST /api/2/users/preview  
reboot POST /api/2/system/reboot  
registerUpload POST /api/2/uploads/register  
registerUploadMetadata POST /api/2/uploads/metadata  
renderEmailTemplatePreview POST /api/2/system/smtp/preview  
resetUserPassword POST /api/2/users/{id}/password/reset  
runServiceOperation POST /api/2/nodes/{id}/services/{service}/{operation}  
setIPMIConfiguration PUT /api/2/nodes/{id}/ipmi  
setLocalTime POST /api/2/system/time  
setMyPassword POST /api/2/users/me/password  
setUserPassword POST /api/2/users/{id}/password  
shutdown POST /api/2/system/shutdown  
startSolrReindex POST /api/2/system/solr/reindex  
startSupportSession POST /api/2/system/support-session/start  
startSystemBackup POST /api/2/system/backup/start  
syncLDAPGroup POST /api/2/groups/{id}/ldap-sync  
syncLDAPUsers POST /api/2/ldap-servers/{id}/sync-users  
syncTime POST /api/2/system/time/sync  
syncUserTOTP PUT /api/2/users/{id}/totp  
testSMTPConfiguration POST /api/2/system/smtp/test  
updateCertificateConfiguration PUT /api/2/system/certificate  
updateCurrentWorkstation PUT /api/2/workstations/current  
updateDownloadArchive PUT /api/2/download-archive/{id}  
updateGroup PUT /api/2/groups/{id}  
updateNTPServer PUT /api/2/system/time/servers/{id}  
updateParameters PUT /api/2/parameters  
updateProfile PUT /api/2/users/me  
updateSMTPConfiguration PUT /api/2/system/smtp  
updateUser PUT /api/2/users/{id}  
updateWorkstation PUT /api/2/workstations/{id}  
uploadChunk POST /api/2/uploads/chunk  

applyConfiguration

    open class func applyConfiguration() -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


MainAPI.applyConfiguration().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

beep

    open class func beep() -> Promise<Void>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


MainAPI.beep().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

checkCertificate

    open class func checkCertificate( certificate: Certificate) -> Promise<Void>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let certificate = Certificate(certificate: "certificate_example", key: "key_example", name: "name_example", issuer: "issuer_example", domains: "domains_example", fingerprint: "fingerprint_example", notValidBefore: "notValidBefore_example", notValidAfter: "notValidAfter_example", expired: "expired_example", keyMatches: "keyMatches_example", domainMatches: "domainMatches_example") // Certificate | 

MainAPI.checkCertificate(certificate: certificate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
certificate Certificate    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

checkChunkUploaded

    open class func checkChunkUploaded( uploadId: String? = nil,  chunkNumber: String? = nil) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let uploadId = "uploadId_example" // String |  (optional)
let chunkNumber = "chunkNumber_example" // String |  (optional)

MainAPI.checkChunkUploaded(uploadId: uploadId, chunkNumber: chunkNumber).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
uploadId String   [optional]
chunkNumber String   [optional]

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

checkInternetConnectivity

    open class func checkInternetConnectivity() -> Promise<CheckConnectivityEndpointResponse>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


MainAPI.checkInternetConnectivity().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

CheckConnectivityEndpointResponse

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

checkStorNextLicense

    open class func checkStorNextLicense( stornextLicense: StornextLicense) -> Promise<[StorNextLicenseCheckEndpointResponse]>

Required permissions * User account permission: system:admin-access * License component: stornext_mdc

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let stornextLicense = StornextLicense(license: "license_example") // StornextLicense | 

MainAPI.checkStorNextLicense(stornextLicense: stornextLicense).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
stornextLicense StornextLicense    

Return type

[StorNextLicenseCheckEndpointResponse]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

collectDiagnostics

    open class func collectDiagnostics() -> Promise<DownloadArchive>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


MainAPI.collectDiagnostics().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

DownloadArchive

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createArchive

    open class func createArchive( createDownloadArchive: CreateDownloadArchive) -> Promise<DownloadArchive>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let createDownloadArchive = CreateDownloadArchive(paths: ["paths_example"], fileIds: [123], bundleIds: [123], proxy: false, forRoot: 123) // CreateDownloadArchive | 

MainAPI.createArchive(createDownloadArchive: createDownloadArchive).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
createDownloadArchive CreateDownloadArchive    

Return type

DownloadArchive

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createGroup

    open class func createGroup( elementsGroupDetail: ElementsGroupDetail) -> Promise<ElementsGroupDetail>

Required permissions * User account permission: users:view (read) / users:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let elementsGroupDetail = ElementsGroupDetail(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], members: [ElementsUserReference(id: 123, allowChangingPassword: false, allowWanLogin: false, allowedFsPaths: ["allowedFsPaths_example"], allowedFsWritePaths: ["allowedFsWritePaths_example"], avatar: "avatar_example", clientSessions: [ClientSession(id: 123, user: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), mountedWorkspaces: "mountedWorkspaces_example", started: Date(), lastUpdated: Date(), workstation: "workstation_example")], defaultPage: "defaultPage_example", displayName: "displayName_example", effectivePermissions: ["effectivePermissions_example"], email: "email_example", expiry: Date(), ancillaryPathReadOnly: false, ancillaryPath: "ancillaryPath_example", fmBookmarks: ["fmBookmarks_example"], fullName: "fullName_example", gid: 123, groupPermissions: ["groupPermissions_example"], hasPassword: false, home: 123, isExternal: false, isCloud: false, isCloudDefault: false, isEnabled: false, language: "language_example", lastSeen: Date(), ldap: 123, ldapDn: "ldapDn_example", passwordChangeRequired: false, permissions: ["permissions_example"], shaperCeiling: 123, shaperRate: 123, syncId: 123, totpEnabled: false, uid: 123, unixUsername: "unixUsername_example", username: "username_example")], ldap: LDAPServerReference(id: 123, name: "name_example", winbindSeparator: "winbindSeparator_example", ntDomain: "ntDomain_example"), name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false) // ElementsGroupDetail | 

MainAPI.createGroup(elementsGroupDetail: elementsGroupDetail).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
elementsGroupDetail ElementsGroupDetail    

Return type

ElementsGroupDetail

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createHomeWorkspace

    open class func createHomeWorkspace( id: Int,  createHomeWorkspaceRequest: CreateHomeWorkspaceRequest) -> Promise<Workspace>

Required permissions * User account permission: users:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this User.
let createHomeWorkspaceRequest = CreateHomeWorkspaceRequest(volume: 123) // CreateHomeWorkspaceRequest | 

MainAPI.createHomeWorkspace(id: id, createHomeWorkspaceRequest: createHomeWorkspaceRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this User.  
createHomeWorkspaceRequest CreateHomeWorkspaceRequest    

Return type

Workspace

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createNTPServer

    open class func createNTPServer( nTPServer: NTPServer) -> Promise<NTPServer>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let nTPServer = NTPServer(id: 123, address: "address_example", options: "options_example") // NTPServer | 

MainAPI.createNTPServer(nTPServer: nTPServer).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
nTPServer NTPServer    

Return type

NTPServer

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createUser

    open class func createUser( elementsUserDetail: ElementsUserDetail) -> Promise<ElementsUserDetail>

Required permissions * User account permission: None (read) / users:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let elementsUserDetail = ElementsUserDetail(id: 123, allowChangingPassword: false, allowWanLogin: false, allowedFsPaths: ["allowedFsPaths_example"], allowedFsWritePaths: ["allowedFsWritePaths_example"], avatar: "avatar_example", clientSessions: [ClientSession(id: 123, user: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), mountedWorkspaces: "mountedWorkspaces_example", started: Date(), lastUpdated: Date(), workstation: "workstation_example")], defaultPage: "defaultPage_example", displayName: "displayName_example", effectivePermissions: ["effectivePermissions_example"], email: "email_example", expiry: Date(), ancillaryPathReadOnly: false, ancillaryPath: "ancillaryPath_example", fmBookmarks: ["fmBookmarks_example"], fullName: "fullName_example", gid: 123, groupPermissions: ["groupPermissions_example"], hasPassword: false, home: 123, isExternal: false, isCloud: false, isCloudDefault: false, isEnabled: false, language: "language_example", lastSeen: Date(), ldap: LDAPServerReference(id: 123, name: "name_example", winbindSeparator: "winbindSeparator_example", ntDomain: "ntDomain_example"), ldapDn: "ldapDn_example", passwordChangeRequired: false, permissions: ["permissions_example"], shaperCeiling: 123, shaperRate: 123, syncId: 123, totpEnabled: false, uid: 123, unixUsername: "unixUsername_example", username: "username_example", groups: [123]) // ElementsUserDetail | 

MainAPI.createUser(elementsUserDetail: elementsUserDetail).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
elementsUserDetail ElementsUserDetail    

Return type

ElementsUserDetail

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createWorkstation

    open class func createWorkstation( workstation: Workstation) -> Promise<Workstation>

Required permissions * Authenticated user * Own workstation or User account permission: workstations:view (read) / workstations:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let workstation = Workstation(id: "id_example", clientSessions: [ClientSession(id: 123, user: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), mountedWorkspaces: "mountedWorkspaces_example", started: Date(), lastUpdated: Date(), workstation: "workstation_example")], displayName: "displayName_example", rdcAllowUsers: [ElementsUserReference(id: 123, allowChangingPassword: false, allowWanLogin: false, allowedFsPaths: ["allowedFsPaths_example"], allowedFsWritePaths: ["allowedFsWritePaths_example"], avatar: "avatar_example", clientSessions: [nil], defaultPage: "defaultPage_example", displayName: "displayName_example", effectivePermissions: ["effectivePermissions_example"], email: "email_example", expiry: Date(), ancillaryPathReadOnly: false, ancillaryPath: "ancillaryPath_example", fmBookmarks: ["fmBookmarks_example"], fullName: "fullName_example", gid: 123, groupPermissions: ["groupPermissions_example"], hasPassword: false, home: 123, isExternal: false, isCloud: false, isCloudDefault: false, isEnabled: false, language: "language_example", lastSeen: Date(), ldap: 123, ldapDn: "ldapDn_example", passwordChangeRequired: false, permissions: ["permissions_example"], shaperCeiling: 123, shaperRate: 123, syncId: 123, totpEnabled: false, uid: 123, unixUsername: "unixUsername_example", username: "username_example")], rdcAllowGroups: [ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123])], name: "name_example", hostname: "hostname_example", rdcLastUsed: Date(), rdcDisableUpnp: false, rdcClientPort: 123, rdcHostPort: 123) // Workstation | 

MainAPI.createWorkstation(workstation: workstation).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
workstation Workstation    

Return type

Workstation

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteDownloadArchive

    open class func deleteDownloadArchive( id: UUID) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this download archive.

MainAPI.deleteDownloadArchive(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this download archive.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteGroup

    open class func deleteGroup( id: Int) -> Promise<Void>

Required permissions * User account permission: users:view (read) / users:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Group.

MainAPI.deleteGroup(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Group.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteHomeWorkspace

    open class func deleteHomeWorkspace( id: Int) -> Promise<Void>

Required permissions * User account permission: users:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this User.

MainAPI.deleteHomeWorkspace(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this User.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteNTPServer

    open class func deleteNTPServer( id: Int) -> Promise<Void>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this NTP Server.

MainAPI.deleteNTPServer(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this NTP Server.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteUser

    open class func deleteUser( id: Int) -> Promise<Void>

Required permissions * User account permission: None (read) / users:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this User.

MainAPI.deleteUser(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this User.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteWorkstation

    open class func deleteWorkstation( id: String) -> Promise<Void>

Required permissions * Authenticated user * Own workstation or User account permission: workstations:view (read) / workstations:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = "id_example" // String | A unique value identifying this workstation.

MainAPI.deleteWorkstation(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id String A unique value identifying this workstation.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

disableUserTOTP

    open class func disableUserTOTP( id: Int) -> Promise<Void>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this User.

MainAPI.disableUserTOTP(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this User.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enableUserTOTP

    open class func enableUserTOTP( id: Int,  enableTOTPRequest: EnableTOTPRequest) -> Promise<Void>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this User.
let enableTOTPRequest = EnableTOTPRequest(key: "key_example", otp: "otp_example") // EnableTOTPRequest | 

MainAPI.enableUserTOTP(id: id, enableTOTPRequest: enableTOTPRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this User.  
enableTOTPRequest EnableTOTPRequest    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

finishUpload

    open class func finishUpload( finishUploadEndpointRequest: FinishUploadEndpointRequest) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let finishUploadEndpointRequest = FinishUploadEndpointRequest(uploadId: "uploadId_example") // FinishUploadEndpointRequest | 

MainAPI.finishUpload(finishUploadEndpointRequest: finishUploadEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
finishUploadEndpointRequest FinishUploadEndpointRequest    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fixLDAPGroupMemberships

    open class func fixLDAPGroupMemberships( id: Int) -> Promise<Void>

Required permissions * User account permission: users:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this LDAP Server.

MainAPI.fixLDAPGroupMemberships(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this LDAP Server.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllDownloadArchives

    open class func getAllDownloadArchives( ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[DownloadArchive]>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MainAPI.getAllDownloadArchives(ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[DownloadArchive]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllDownloads

    open class func getAllDownloads( name: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[Download]>

Required permissions * User account permission: downloads:view

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let name = "name_example" // String | Filter the returned list by `name`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MainAPI.getAllDownloads(name: name, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
name String Filter the returned list by `name`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[Download]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllGroups

    open class func getAllGroups( name: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[ElementsGroup]>

Required permissions * User account permission: users:view (read) / users:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let name = "name_example" // String | Filter the returned list by `name`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MainAPI.getAllGroups(name: name, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
name String Filter the returned list by `name`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[ElementsGroup]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllLDAPServers

    open class func getAllLDAPServers( ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[LDAPServer]>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MainAPI.getAllLDAPServers(ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[LDAPServer]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllNTPServers

    open class func getAllNTPServers( address: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[NTPServer]>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let address = "address_example" // String | Filter the returned list by `address`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MainAPI.getAllNTPServers(address: address, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
address String Filter the returned list by `address`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[NTPServer]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllStorageNodes

    open class func getAllStorageNodes( type: String? = nil,  backend: String? = nil,  name: String? = nil,  address: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil,  includeStatus: Bool? = nil) -> Promise<[StorageNode]>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let type = "type_example" // String | Filter the returned list by `type`. (optional)
let backend = "backend_example" // String | Filter the returned list by `backend`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let address = "address_example" // String | Filter the returned list by `address`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)
let includeStatus = true // Bool |  (optional)

MainAPI.getAllStorageNodes(type: type, backend: backend, name: name, address: address, ordering: ordering, limit: limit, offset: offset, includeStatus: includeStatus).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
type String Filter the returned list by `type`. [optional]
backend String Filter the returned list by `backend`. [optional]
name String Filter the returned list by `name`. [optional]
address String Filter the returned list by `address`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]
includeStatus Bool   [optional]

Return type

[StorageNode]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllUsers

    open class func getAllUsers( username: String? = nil,  home: String? = nil,  fullName: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil,  includeAllowedFsPaths: Bool? = nil,  includeClientSessions: Bool? = nil) -> Promise<[ElementsUser]>

Required permissions * User account permission: None (read) / users:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let username = "username_example" // String | Filter the returned list by `username`. (optional)
let home = "home_example" // String | Filter the returned list by `home`. (optional)
let fullName = "fullName_example" // String | Filter the returned list by `full_name`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)
let includeAllowedFsPaths = true // Bool |  (optional)
let includeClientSessions = true // Bool |  (optional)

MainAPI.getAllUsers(username: username, home: home, fullName: fullName, ordering: ordering, limit: limit, offset: offset, includeAllowedFsPaths: includeAllowedFsPaths, includeClientSessions: includeClientSessions).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
username String Filter the returned list by `username`. [optional]
home String Filter the returned list by `home`. [optional]
fullName String Filter the returned list by `full_name`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]
includeAllowedFsPaths Bool   [optional]
includeClientSessions Bool   [optional]

Return type

[ElementsUser]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllWorkstations

    open class func getAllWorkstations( hostname: String? = nil,  name: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[Workstation]>

Required permissions * Authenticated user * Own workstation or User account permission: workstations:view (read) / workstations:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let hostname = "hostname_example" // String | Filter the returned list by `hostname`. (optional)
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MainAPI.getAllWorkstations(hostname: hostname, name: name, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
hostname String Filter the returned list by `hostname`. [optional]
name String Filter the returned list by `name`. [optional]
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

[Workstation]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCertificateConfiguration

    open class func getCertificateConfiguration() -> Promise<Certificate>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


MainAPI.getCertificateConfiguration().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

Certificate

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getClientDownloadFile

    open class func getClientDownloadFile( file: String) -> Promise<Void>

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let file = "file_example" // String | 

MainAPI.getClientDownloadFile(file: file).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
file String    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getClientDownloads

    open class func getClientDownloads() -> Promise<[ClientsEndpointResponse]>

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


MainAPI.getClientDownloads().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

[ClientsEndpointResponse]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCurrentWorkstation

    open class func getCurrentWorkstation( ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<Workstation>

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MainAPI.getCurrentWorkstation(ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

Workstation

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDownload

    open class func getDownload( id: Int) -> Promise<Download>

Required permissions * User account permission: downloads:view

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this download.

MainAPI.getDownload(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this download.  

Return type

Download

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDownloadArchive

    open class func getDownloadArchive( id: UUID) -> Promise<DownloadArchive>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this download archive.

MainAPI.getDownloadArchive(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this download archive.  

Return type

DownloadArchive

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDownloadArchiveFile

    open class func getDownloadArchiveFile( id: UUID) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this download archive.

MainAPI.getDownloadArchiveFile(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this download archive.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDownloadFile

    open class func getDownloadFile( id: Int) -> Promise<Void>

Required permissions * User account permission: downloads:view

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this download.

MainAPI.getDownloadFile(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this download.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDownloadIcon

    open class func getDownloadIcon( id: Int) -> Promise<Void>

Required permissions * User account permission: downloads:view

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this download.

MainAPI.getDownloadIcon(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this download.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroup

    open class func getGroup( id: Int) -> Promise<ElementsGroupDetail>

Required permissions * User account permission: users:view (read) / users:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Group.

MainAPI.getGroup(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Group.  

Return type

ElementsGroupDetail

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getHomeWorkspace

    open class func getHomeWorkspace( id: Int) -> Promise<Workspace>

Required permissions * User account permission: users:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this User.

MainAPI.getHomeWorkspace(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this User.  

Return type

Workspace

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getIPMIConfiguration

    open class func getIPMIConfiguration( id: Int) -> Promise<Ipmi>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Storage Node.

MainAPI.getIPMIConfiguration(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Storage Node.  

Return type

Ipmi

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLDAPServer

    open class func getLDAPServer( id: Int) -> Promise<LDAPServer>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this LDAP Server.

MainAPI.getLDAPServer(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this LDAP Server.  

Return type

LDAPServer

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLDAPServerGroups

    open class func getLDAPServerGroups( id: Int) -> Promise<LDAPServerGroups>

Required permissions * User account permission: users:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this LDAP Server.

MainAPI.getLDAPServerGroups(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this LDAP Server.  

Return type

LDAPServerGroups

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLDAPServerUsers

    open class func getLDAPServerUsers( id: Int) -> Promise<LDAPServerUsers>

Required permissions * User account permission: users:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this LDAP Server.

MainAPI.getLDAPServerUsers(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this LDAP Server.  

Return type

LDAPServerUsers

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLicense

    open class func getLicense() -> Promise<License>

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


MainAPI.getLicense().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

License

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLocalTime

    open class func getLocalTime() -> Promise<TimeEndpointResponse>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


MainAPI.getLocalTime().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

TimeEndpointResponse

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLog

    open class func getLog( path: String,  offset: Int? = nil) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let path = "path_example" // String | 
let offset = 987 // Int |  (optional)

MainAPI.getLog(path: path, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
path String    
offset Int   [optional]

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getNTPServer

    open class func getNTPServer( id: Int) -> Promise<NTPServer>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this NTP Server.

MainAPI.getNTPServer(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this NTP Server.  

Return type

NTPServer

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getNodeIPMISensors

    open class func getNodeIPMISensors( id: Int) -> Promise<Sensors>

Required permissions * User account permission: system:status:view

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Storage Node.

MainAPI.getNodeIPMISensors(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Storage Node.  

Return type

Sensors

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getNodeStats

    open class func getNodeStats( id: Int) -> Promise<Stats>

Required permissions * User account permission: system:status:view

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Storage Node.

MainAPI.getNodeStats(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Storage Node.  

Return type

Stats

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getParameters

    open class func getParameters( ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<Parameters>

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MainAPI.getParameters(ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

Parameters

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getProfile

    open class func getProfile( ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<ElementsUserProfile>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

MainAPI.getProfile(ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
ordering String Which field to use when ordering the results. [optional]
limit Int Number of results to return per page. [optional]
offset Int The initial index from which to return the results. [optional]

Return type

ElementsUserProfile

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getReleaseNotes

    open class func getReleaseNotes() -> Promise<[ReleaseNotesEndpointResponse]>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


MainAPI.getReleaseNotes().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

[ReleaseNotesEndpointResponse]

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSMTPConfiguration

    open class func getSMTPConfiguration() -> Promise<SMTPConfiguration>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


MainAPI.getSMTPConfiguration().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

SMTPConfiguration

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getServiceStatus

    open class func getServiceStatus( id: Int,  service: String) -> Promise<ServiceStatus>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Storage Node.
let service = "service_example" // String | 

MainAPI.getServiceStatus(id: id, service: service).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Storage Node.  
service String    

Return type

ServiceStatus

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getStorNextLicense

    open class func getStorNextLicense() -> Promise<StorNextLicenseEndpointResponse>

Required permissions * User account permission: system:admin-access * License component: stornext_mdc

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


MainAPI.getStorNextLicense().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

StorNextLicenseEndpointResponse

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getStorageNode

    open class func getStorageNode( id: Int,  includeStatus: Bool? = nil) -> Promise<StorageNode>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Storage Node.
let includeStatus = true // Bool |  (optional)

MainAPI.getStorageNode(id: id, includeStatus: includeStatus).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Storage Node.  
includeStatus Bool   [optional]

Return type

StorageNode

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSystemInfo

    open class func getSystemInfo() -> Promise<SystemInfoEndpointResponse>

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


MainAPI.getSystemInfo().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

SystemInfoEndpointResponse

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUser

    open class func getUser( id: Int) -> Promise<ElementsUserDetail>

Required permissions * User account permission: None (read) / users:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this User.

MainAPI.getUser(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this User.  

Return type

ElementsUserDetail

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getWorkstation

    open class func getWorkstation( id: String) -> Promise<Workstation>

Required permissions * Authenticated user * Own workstation or User account permission: workstations:view (read) / workstations:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = "id_example" // String | A unique value identifying this workstation.

MainAPI.getWorkstation(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id String A unique value identifying this workstation.  

Return type

Workstation

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

installStorNextLicense

    open class func installStorNextLicense( stornextLicense: StornextLicense) -> Promise<StorNextLicenseEndpointResponse>

Required permissions * User account permission: system:admin-access * License component: stornext_mdc

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let stornextLicense = StornextLicense(license: "license_example") // StornextLicense | 

MainAPI.installStorNextLicense(stornextLicense: stornextLicense).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
stornextLicense StornextLicense    

Return type

StorNextLicenseEndpointResponse

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchCurrentWorkstation

    open class func patchCurrentWorkstation( workstationPartialUpdate: WorkstationPartialUpdate) -> Promise<Workstation>

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let workstationPartialUpdate = WorkstationPartialUpdate(id: "id_example", rdcAllowUsers: [ElementsUserReference(id: 123, allowChangingPassword: false, allowWanLogin: false, allowedFsPaths: ["allowedFsPaths_example"], allowedFsWritePaths: ["allowedFsWritePaths_example"], avatar: "avatar_example", clientSessions: [ClientSession(id: 123, user: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), mountedWorkspaces: "mountedWorkspaces_example", started: Date(), lastUpdated: Date(), workstation: "workstation_example")], defaultPage: "defaultPage_example", displayName: "displayName_example", effectivePermissions: ["effectivePermissions_example"], email: "email_example", expiry: Date(), ancillaryPathReadOnly: false, ancillaryPath: "ancillaryPath_example", fmBookmarks: ["fmBookmarks_example"], fullName: "fullName_example", gid: 123, groupPermissions: ["groupPermissions_example"], hasPassword: false, home: 123, isExternal: false, isCloud: false, isCloudDefault: false, isEnabled: false, language: "language_example", lastSeen: Date(), ldap: 123, ldapDn: "ldapDn_example", passwordChangeRequired: false, permissions: ["permissions_example"], shaperCeiling: 123, shaperRate: 123, syncId: 123, totpEnabled: false, uid: 123, unixUsername: "unixUsername_example", username: "username_example")], rdcAllowGroups: [ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123])], report: "TODO", name: "name_example", hostname: "hostname_example", rdcLastUsed: Date(), rdcDisableUpnp: false, rdcClientPort: 123, rdcHostPort: 123) // WorkstationPartialUpdate | 

MainAPI.patchCurrentWorkstation(workstationPartialUpdate: workstationPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
workstationPartialUpdate WorkstationPartialUpdate    

Return type

Workstation

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchDownloadArchive

    open class func patchDownloadArchive( id: UUID,  downloadArchivePartialUpdate: DownloadArchivePartialUpdate) -> Promise<DownloadArchive>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this download archive.
let downloadArchivePartialUpdate = DownloadArchivePartialUpdate(id: 123, taskInfo: TaskInfo(id: "id_example", displayName: "displayName_example", kwargs: "TODO", subtask: Subtask(id: 123, kwargs: "TODO", graphLayout: "TODO", validationError: "validationError_example", trigger: "trigger_example", name: "name_example", noopDontSave: false, noConcurrency: false, timeout: 123, logVariable: false, task: "task_example", conditionVariable: "conditionVariable_example", conditionValue: "conditionValue_example", sync: false, queue: "queue_example", enqueueAtFront: false, parent: 123, relativeTo: 123), worker: StorageNodeMini(id: 123, name: "name_example", address: "address_example", type: 123), user: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), workstation: Workstation(id: "id_example", clientSessions: [ClientSession(id: 123, user: nil, mountedWorkspaces: "mountedWorkspaces_example", started: Date(), lastUpdated: Date(), workstation: "workstation_example")], displayName: "displayName_example", rdcAllowUsers: [ElementsUserReference(id: 123, allowChangingPassword: false, allowWanLogin: false, allowedFsPaths: ["allowedFsPaths_example"], allowedFsWritePaths: ["allowedFsWritePaths_example"], avatar: "avatar_example", clientSessions: [nil], defaultPage: "defaultPage_example", displayName: "displayName_example", effectivePermissions: ["effectivePermissions_example"], email: "email_example", expiry: Date(), ancillaryPathReadOnly: false, ancillaryPath: "ancillaryPath_example", fmBookmarks: ["fmBookmarks_example"], fullName: "fullName_example", gid: 123, groupPermissions: ["groupPermissions_example"], hasPassword: false, home: 123, isExternal: false, isCloud: false, isCloudDefault: false, isEnabled: false, language: "language_example", lastSeen: Date(), ldap: 123, ldapDn: "ldapDn_example", passwordChangeRequired: false, permissions: ["permissions_example"], shaperCeiling: 123, shaperRate: 123, syncId: 123, totpEnabled: false, uid: 123, unixUsername: "unixUsername_example", username: "username_example")], rdcAllowGroups: [ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123])], name: "name_example", hostname: "hostname_example", rdcLastUsed: Date(), rdcDisableUpnp: false, rdcClientPort: 123, rdcHostPort: 123), progress: TaskProgress(message: "message_example", current: 123, max: 123), logPath: "logPath_example", name: "name_example", taskName: "taskName_example", workerName: "workerName_example", queue: "queue_example", state: 123, stateText: "stateText_example", jobInstance: 123, started: Date(), finished: Date(), exception: "exception_example", traceback: "traceback_example", schedule: 123), name: "name_example", path: "path_example", progressUnit: 123, user: 123) // DownloadArchivePartialUpdate | 

MainAPI.patchDownloadArchive(id: id, downloadArchivePartialUpdate: downloadArchivePartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this download archive.  
downloadArchivePartialUpdate DownloadArchivePartialUpdate    

Return type

DownloadArchive

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchGroup

    open class func patchGroup( id: Int,  elementsGroupDetailPartialUpdate: ElementsGroupDetailPartialUpdate) -> Promise<ElementsGroupDetail>

Required permissions * User account permission: users:view (read) / users:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Group.
let elementsGroupDetailPartialUpdate = ElementsGroupDetailPartialUpdate(permissions: ["permissions_example"], members: [ElementsUserReference(id: 123, allowChangingPassword: false, allowWanLogin: false, allowedFsPaths: ["allowedFsPaths_example"], allowedFsWritePaths: ["allowedFsWritePaths_example"], avatar: "avatar_example", clientSessions: [ClientSession(id: 123, user: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), mountedWorkspaces: "mountedWorkspaces_example", started: Date(), lastUpdated: Date(), workstation: "workstation_example")], defaultPage: "defaultPage_example", displayName: "displayName_example", effectivePermissions: ["effectivePermissions_example"], email: "email_example", expiry: Date(), ancillaryPathReadOnly: false, ancillaryPath: "ancillaryPath_example", fmBookmarks: ["fmBookmarks_example"], fullName: "fullName_example", gid: 123, groupPermissions: ["groupPermissions_example"], hasPassword: false, home: 123, isExternal: false, isCloud: false, isCloudDefault: false, isEnabled: false, language: "language_example", lastSeen: Date(), ldap: 123, ldapDn: "ldapDn_example", passwordChangeRequired: false, permissions: ["permissions_example"], shaperCeiling: 123, shaperRate: 123, syncId: 123, totpEnabled: false, uid: 123, unixUsername: "unixUsername_example", username: "username_example")], ldap: LDAPServerReference(id: 123, name: "name_example", winbindSeparator: "winbindSeparator_example", ntDomain: "ntDomain_example"), name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false) // ElementsGroupDetailPartialUpdate | 

MainAPI.patchGroup(id: id, elementsGroupDetailPartialUpdate: elementsGroupDetailPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Group.  
elementsGroupDetailPartialUpdate ElementsGroupDetailPartialUpdate    

Return type

ElementsGroupDetail

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchNTPServer

    open class func patchNTPServer( id: Int,  nTPServerPartialUpdate: NTPServerPartialUpdate) -> Promise<NTPServer>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this NTP Server.
let nTPServerPartialUpdate = NTPServerPartialUpdate(address: "address_example", options: "options_example") // NTPServerPartialUpdate | 

MainAPI.patchNTPServer(id: id, nTPServerPartialUpdate: nTPServerPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this NTP Server.  
nTPServerPartialUpdate NTPServerPartialUpdate    

Return type

NTPServer

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchProfile

    open class func patchProfile( elementsUserProfilePartialUpdate: ElementsUserProfilePartialUpdate) -> Promise<ElementsUserProfile>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let elementsUserProfilePartialUpdate = ElementsUserProfilePartialUpdate(avatar: "avatar_example", defaultPage: "defaultPage_example", fullName: "fullName_example", language: "language_example", fmBookmarks: ["fmBookmarks_example"]) // ElementsUserProfilePartialUpdate | 

MainAPI.patchProfile(elementsUserProfilePartialUpdate: elementsUserProfilePartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
elementsUserProfilePartialUpdate ElementsUserProfilePartialUpdate    

Return type

ElementsUserProfile

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchUser

    open class func patchUser( id: Int,  elementsUserDetailPartialUpdate: ElementsUserDetailPartialUpdate) -> Promise<ElementsUserDetail>

Required permissions * User account permission: None (read) / users:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this User.
let elementsUserDetailPartialUpdate = ElementsUserDetailPartialUpdate(allowChangingPassword: false, allowWanLogin: false, avatar: "avatar_example", defaultPage: "defaultPage_example", email: "email_example", expiry: Date(), ancillaryPathReadOnly: false, ancillaryPath: "ancillaryPath_example", fmBookmarks: ["fmBookmarks_example"], fullName: "fullName_example", gid: 123, home: 123, isExternal: false, isCloud: false, isCloudDefault: false, isEnabled: false, language: "language_example", lastSeen: Date(), ldap: LDAPServerReference(id: 123, name: "name_example", winbindSeparator: "winbindSeparator_example", ntDomain: "ntDomain_example"), ldapDn: "ldapDn_example", passwordChangeRequired: false, permissions: ["permissions_example"], shaperCeiling: 123, shaperRate: 123, totpEnabled: false, uid: 123, unixUsername: "unixUsername_example", username: "username_example", groups: [123]) // ElementsUserDetailPartialUpdate | 

MainAPI.patchUser(id: id, elementsUserDetailPartialUpdate: elementsUserDetailPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this User.  
elementsUserDetailPartialUpdate ElementsUserDetailPartialUpdate    

Return type

ElementsUserDetail

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchWorkstation

    open class func patchWorkstation( id: String,  workstationPartialUpdate: WorkstationPartialUpdate) -> Promise<Workstation>

Required permissions * Authenticated user * Own workstation or User account permission: workstations:view (read) / workstations:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = "id_example" // String | A unique value identifying this workstation.
let workstationPartialUpdate = WorkstationPartialUpdate(id: "id_example", rdcAllowUsers: [ElementsUserReference(id: 123, allowChangingPassword: false, allowWanLogin: false, allowedFsPaths: ["allowedFsPaths_example"], allowedFsWritePaths: ["allowedFsWritePaths_example"], avatar: "avatar_example", clientSessions: [ClientSession(id: 123, user: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), mountedWorkspaces: "mountedWorkspaces_example", started: Date(), lastUpdated: Date(), workstation: "workstation_example")], defaultPage: "defaultPage_example", displayName: "displayName_example", effectivePermissions: ["effectivePermissions_example"], email: "email_example", expiry: Date(), ancillaryPathReadOnly: false, ancillaryPath: "ancillaryPath_example", fmBookmarks: ["fmBookmarks_example"], fullName: "fullName_example", gid: 123, groupPermissions: ["groupPermissions_example"], hasPassword: false, home: 123, isExternal: false, isCloud: false, isCloudDefault: false, isEnabled: false, language: "language_example", lastSeen: Date(), ldap: 123, ldapDn: "ldapDn_example", passwordChangeRequired: false, permissions: ["permissions_example"], shaperCeiling: 123, shaperRate: 123, syncId: 123, totpEnabled: false, uid: 123, unixUsername: "unixUsername_example", username: "username_example")], rdcAllowGroups: [ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123])], report: "TODO", name: "name_example", hostname: "hostname_example", rdcLastUsed: Date(), rdcDisableUpnp: false, rdcClientPort: 123, rdcHostPort: 123) // WorkstationPartialUpdate | 

MainAPI.patchWorkstation(id: id, workstationPartialUpdate: workstationPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id String A unique value identifying this workstation.  
workstationPartialUpdate WorkstationPartialUpdate    

Return type

Workstation

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

previewUser

    open class func previewUser( userPreviewRequest: UserPreviewRequest) -> Promise<UserPreviewResponse>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let userPreviewRequest = UserPreviewRequest(username: "username_example") // UserPreviewRequest | 

MainAPI.previewUser(userPreviewRequest: userPreviewRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
userPreviewRequest UserPreviewRequest    

Return type

UserPreviewResponse

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reboot

    open class func reboot() -> Promise<Void>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


MainAPI.reboot().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

registerUpload

    open class func registerUpload( registerUploadEndpointRequest: RegisterUploadEndpointRequest) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let registerUploadEndpointRequest = RegisterUploadEndpointRequest(uploadId: "uploadId_example", path: "path_example") // RegisterUploadEndpointRequest | 

MainAPI.registerUpload(registerUploadEndpointRequest: registerUploadEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
registerUploadEndpointRequest RegisterUploadEndpointRequest    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

registerUploadMetadata

    open class func registerUploadMetadata( registerUploadMetadataEndpointRequest: RegisterUploadMetadataEndpointRequest) -> Promise<Void>

Required permissions * User account permission: media:access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let registerUploadMetadataEndpointRequest = RegisterUploadMetadataEndpointRequest(items: [MetadataItem(customFields: "TODO", path: "path_example")]) // RegisterUploadMetadataEndpointRequest | 

MainAPI.registerUploadMetadata(registerUploadMetadataEndpointRequest: registerUploadMetadataEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
registerUploadMetadataEndpointRequest RegisterUploadMetadataEndpointRequest    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

renderEmailTemplatePreview

    open class func renderEmailTemplatePreview( emailPreview: EmailPreview) -> Promise<Void>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let emailPreview = EmailPreview(styling: "TODO") // EmailPreview | 

MainAPI.renderEmailTemplatePreview(emailPreview: emailPreview).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
emailPreview EmailPreview    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

resetUserPassword

    open class func resetUserPassword( id: Int) -> Promise<Void>

Required permissions * User account permission: users:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this User.

MainAPI.resetUserPassword(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this User.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

runServiceOperation

    open class func runServiceOperation( id: Int,  operation: String,  service: String) -> Promise<Void>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Storage Node.
let operation = "operation_example" // String | 
let service = "service_example" // String | 

MainAPI.runServiceOperation(id: id, operation: operation, service: service).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Storage Node.  
operation String    
service String    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setIPMIConfiguration

    open class func setIPMIConfiguration( id: Int,  ipmi: Ipmi) -> Promise<Ipmi>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Storage Node.
let ipmi = Ipmi(ip: "ip_example", netmask: "netmask_example", gateway: "gateway_example") // Ipmi | 

MainAPI.setIPMIConfiguration(id: id, ipmi: ipmi).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Storage Node.  
ipmi Ipmi    

Return type

Ipmi

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setLocalTime

    open class func setLocalTime( timeEndpointRequest: TimeEndpointRequest) -> Promise<TimeEndpointResponse>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let timeEndpointRequest = TimeEndpointRequest(time: 123, timezone: Timezone(value: "value_example", name: "name_example")) // TimeEndpointRequest | 

MainAPI.setLocalTime(timeEndpointRequest: timeEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
timeEndpointRequest TimeEndpointRequest    

Return type

TimeEndpointResponse

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setMyPassword

    open class func setMyPassword( changeOwnPasswordRequest: ChangeOwnPasswordRequest) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let changeOwnPasswordRequest = ChangeOwnPasswordRequest(currentPassword: "currentPassword_example", currentOtp: "currentOtp_example", password: "password_example") // ChangeOwnPasswordRequest | 

MainAPI.setMyPassword(changeOwnPasswordRequest: changeOwnPasswordRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
changeOwnPasswordRequest ChangeOwnPasswordRequest    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setUserPassword

    open class func setUserPassword( id: Int,  changePasswordRequest: ChangePasswordRequest) -> Promise<Void>

Required permissions * User account permission: users:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this User.
let changePasswordRequest = ChangePasswordRequest(password: "password_example") // ChangePasswordRequest | 

MainAPI.setUserPassword(id: id, changePasswordRequest: changePasswordRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this User.  
changePasswordRequest ChangePasswordRequest    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

shutdown

    open class func shutdown() -> Promise<Void>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


MainAPI.shutdown().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

startSolrReindex

    open class func startSolrReindex() -> Promise<SolrReindexEndpointResponse>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


MainAPI.startSolrReindex().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

SolrReindexEndpointResponse

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

startSupportSession

    open class func startSupportSession() -> Promise<TaskInfo>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


MainAPI.startSupportSession().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

startSystemBackup

    open class func startSystemBackup( path: Path) -> Promise<TaskInfo>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let path = Path(path: "path_example") // Path | 

MainAPI.startSystemBackup(path: path).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
path Path    

Return type

TaskInfo

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

syncLDAPGroup

    open class func syncLDAPGroup( id: Int) -> Promise<Void>

Required permissions * User account permission: users:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Group.

MainAPI.syncLDAPGroup(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Group.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

syncLDAPUsers

    open class func syncLDAPUsers( id: Int) -> Promise<Void>

Required permissions * User account permission: users:manage

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this LDAP Server.

MainAPI.syncLDAPUsers(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this LDAP Server.  

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

syncTime

    open class func syncTime( timeSyncEndpointRequest: TimeSyncEndpointRequest) -> Promise<TimeSyncEndpointResponse>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let timeSyncEndpointRequest = TimeSyncEndpointRequest(server: "server_example") // TimeSyncEndpointRequest | 

MainAPI.syncTime(timeSyncEndpointRequest: timeSyncEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
timeSyncEndpointRequest TimeSyncEndpointRequest    

Return type

TimeSyncEndpointResponse

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

syncUserTOTP

    open class func syncUserTOTP( id: Int,  syncTOTPRequest: SyncTOTPRequest) -> Promise<SyncTOTP>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this User.
let syncTOTPRequest = SyncTOTPRequest(otp: "otp_example") // SyncTOTPRequest | 

MainAPI.syncUserTOTP(id: id, syncTOTPRequest: syncTOTPRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this User.  
syncTOTPRequest SyncTOTPRequest    

Return type

SyncTOTP

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

testSMTPConfiguration

    open class func testSMTPConfiguration( testSMTP: TestSMTP) -> Promise<Void>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let testSMTP = TestSMTP(email: "email_example") // TestSMTP | 

MainAPI.testSMTPConfiguration(testSMTP: testSMTP).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
testSMTP TestSMTP    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateCertificateConfiguration

    open class func updateCertificateConfiguration( certificate: Certificate) -> Promise<Certificate>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let certificate = Certificate(certificate: "certificate_example", key: "key_example", name: "name_example", issuer: "issuer_example", domains: "domains_example", fingerprint: "fingerprint_example", notValidBefore: "notValidBefore_example", notValidAfter: "notValidAfter_example", expired: "expired_example", keyMatches: "keyMatches_example", domainMatches: "domainMatches_example") // Certificate | 

MainAPI.updateCertificateConfiguration(certificate: certificate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
certificate Certificate    

Return type

Certificate

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateCurrentWorkstation

    open class func updateCurrentWorkstation( workstation: Workstation) -> Promise<Workstation>

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let workstation = Workstation(id: "id_example", clientSessions: [ClientSession(id: 123, user: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), mountedWorkspaces: "mountedWorkspaces_example", started: Date(), lastUpdated: Date(), workstation: "workstation_example")], displayName: "displayName_example", rdcAllowUsers: [ElementsUserReference(id: 123, allowChangingPassword: false, allowWanLogin: false, allowedFsPaths: ["allowedFsPaths_example"], allowedFsWritePaths: ["allowedFsWritePaths_example"], avatar: "avatar_example", clientSessions: [nil], defaultPage: "defaultPage_example", displayName: "displayName_example", effectivePermissions: ["effectivePermissions_example"], email: "email_example", expiry: Date(), ancillaryPathReadOnly: false, ancillaryPath: "ancillaryPath_example", fmBookmarks: ["fmBookmarks_example"], fullName: "fullName_example", gid: 123, groupPermissions: ["groupPermissions_example"], hasPassword: false, home: 123, isExternal: false, isCloud: false, isCloudDefault: false, isEnabled: false, language: "language_example", lastSeen: Date(), ldap: 123, ldapDn: "ldapDn_example", passwordChangeRequired: false, permissions: ["permissions_example"], shaperCeiling: 123, shaperRate: 123, syncId: 123, totpEnabled: false, uid: 123, unixUsername: "unixUsername_example", username: "username_example")], rdcAllowGroups: [ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123])], name: "name_example", hostname: "hostname_example", rdcLastUsed: Date(), rdcDisableUpnp: false, rdcClientPort: 123, rdcHostPort: 123) // Workstation | 

MainAPI.updateCurrentWorkstation(workstation: workstation).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
workstation Workstation    

Return type

Workstation

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateDownloadArchive

    open class func updateDownloadArchive( id: UUID,  downloadArchive: DownloadArchive) -> Promise<DownloadArchive>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // UUID | A UUID string identifying this download archive.
let downloadArchive = DownloadArchive(id: 123, taskInfo: TaskInfo(id: "id_example", displayName: "displayName_example", kwargs: "TODO", subtask: Subtask(id: 123, kwargs: "TODO", graphLayout: "TODO", validationError: "validationError_example", trigger: "trigger_example", name: "name_example", noopDontSave: false, noConcurrency: false, timeout: 123, logVariable: false, task: "task_example", conditionVariable: "conditionVariable_example", conditionValue: "conditionValue_example", sync: false, queue: "queue_example", enqueueAtFront: false, parent: 123, relativeTo: 123), worker: StorageNodeMini(id: 123, name: "name_example", address: "address_example", type: 123), user: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), workstation: Workstation(id: "id_example", clientSessions: [ClientSession(id: 123, user: nil, mountedWorkspaces: "mountedWorkspaces_example", started: Date(), lastUpdated: Date(), workstation: "workstation_example")], displayName: "displayName_example", rdcAllowUsers: [ElementsUserReference(id: 123, allowChangingPassword: false, allowWanLogin: false, allowedFsPaths: ["allowedFsPaths_example"], allowedFsWritePaths: ["allowedFsWritePaths_example"], avatar: "avatar_example", clientSessions: [nil], defaultPage: "defaultPage_example", displayName: "displayName_example", effectivePermissions: ["effectivePermissions_example"], email: "email_example", expiry: Date(), ancillaryPathReadOnly: false, ancillaryPath: "ancillaryPath_example", fmBookmarks: ["fmBookmarks_example"], fullName: "fullName_example", gid: 123, groupPermissions: ["groupPermissions_example"], hasPassword: false, home: 123, isExternal: false, isCloud: false, isCloudDefault: false, isEnabled: false, language: "language_example", lastSeen: Date(), ldap: 123, ldapDn: "ldapDn_example", passwordChangeRequired: false, permissions: ["permissions_example"], shaperCeiling: 123, shaperRate: 123, syncId: 123, totpEnabled: false, uid: 123, unixUsername: "unixUsername_example", username: "username_example")], rdcAllowGroups: [ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123])], name: "name_example", hostname: "hostname_example", rdcLastUsed: Date(), rdcDisableUpnp: false, rdcClientPort: 123, rdcHostPort: 123), progress: TaskProgress(message: "message_example", current: 123, max: 123), logPath: "logPath_example", name: "name_example", taskName: "taskName_example", workerName: "workerName_example", queue: "queue_example", state: 123, stateText: "stateText_example", jobInstance: 123, started: Date(), finished: Date(), exception: "exception_example", traceback: "traceback_example", schedule: 123), uncompressedSize: 123, size: 123, expires: "expires_example", files: ["files_example"], name: "name_example", path: "path_example", createdAt: Date(), progressUnit: 123, user: 123) // DownloadArchive | 

MainAPI.updateDownloadArchive(id: id, downloadArchive: downloadArchive).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id UUID A UUID string identifying this download archive.  
downloadArchive DownloadArchive    

Return type

DownloadArchive

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateGroup

    open class func updateGroup( id: Int,  elementsGroupDetail: ElementsGroupDetail) -> Promise<ElementsGroupDetail>

Required permissions * User account permission: users:view (read) / users:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this Group.
let elementsGroupDetail = ElementsGroupDetail(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], members: [ElementsUserReference(id: 123, allowChangingPassword: false, allowWanLogin: false, allowedFsPaths: ["allowedFsPaths_example"], allowedFsWritePaths: ["allowedFsWritePaths_example"], avatar: "avatar_example", clientSessions: [ClientSession(id: 123, user: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), mountedWorkspaces: "mountedWorkspaces_example", started: Date(), lastUpdated: Date(), workstation: "workstation_example")], defaultPage: "defaultPage_example", displayName: "displayName_example", effectivePermissions: ["effectivePermissions_example"], email: "email_example", expiry: Date(), ancillaryPathReadOnly: false, ancillaryPath: "ancillaryPath_example", fmBookmarks: ["fmBookmarks_example"], fullName: "fullName_example", gid: 123, groupPermissions: ["groupPermissions_example"], hasPassword: false, home: 123, isExternal: false, isCloud: false, isCloudDefault: false, isEnabled: false, language: "language_example", lastSeen: Date(), ldap: 123, ldapDn: "ldapDn_example", passwordChangeRequired: false, permissions: ["permissions_example"], shaperCeiling: 123, shaperRate: 123, syncId: 123, totpEnabled: false, uid: 123, unixUsername: "unixUsername_example", username: "username_example")], ldap: LDAPServerReference(id: 123, name: "name_example", winbindSeparator: "winbindSeparator_example", ntDomain: "ntDomain_example"), name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false) // ElementsGroupDetail | 

MainAPI.updateGroup(id: id, elementsGroupDetail: elementsGroupDetail).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this Group.  
elementsGroupDetail ElementsGroupDetail    

Return type

ElementsGroupDetail

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateNTPServer

    open class func updateNTPServer( id: Int,  nTPServer: NTPServer) -> Promise<NTPServer>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this NTP Server.
let nTPServer = NTPServer(id: 123, address: "address_example", options: "options_example") // NTPServer | 

MainAPI.updateNTPServer(id: id, nTPServer: nTPServer).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this NTP Server.  
nTPServer NTPServer    

Return type

NTPServer

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateParameters

    open class func updateParameters( parameters: Parameters) -> Promise<Parameters>

Required permissions * <class ‘rest_framework.permissions.AllowAny’>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let parameters = Parameters(id: 123, mediaForceShowDeleted: false, analytics: false, identifyCommand: "identifyCommand_example", externalUrl: "externalUrl_example", brandingCss: "brandingCss_example", brandingLogo: "brandingLogo_example", fmNewDirectoryMode: "fmNewDirectoryMode_example", icapServer: "icapServer_example", icapPort: 123, icapService: "icapService_example", icapScanUploads: false, ltfsDefaultRestoreToOriginalLocation: false, ltfsDefaultSearchDirectories: false, ltfsLibraryAddress: "ltfsLibraryAddress_example", mediaAutoPlay: false, mediaAutoTransport: false, mediaAutoScan: false, mediaAutoProxy: false, mediaAutoVeritoneUpload: false, mediaProxyH264Preset: "mediaProxyH264Preset_example", mediaDefaultCustomFieldType: "mediaDefaultCustomFieldType_example", mediaDefaultDeleteBehaviour: "mediaDefaultDeleteBehaviour_example", mediaRecycleBin: false, fileManagerRecycleBin: false, ntpOfferSync: false, slugifyWorkspacePath: false, slugifyShares: false, smtpFrom: "smtpFrom_example", smtpServer: "smtpServer_example", smtpPort: 123, smtpTls: "smtpTls_example", smtpUsername: "smtpUsername_example", smtpEhlo: "smtpEhlo_example", mailStyling: "mailStyling_example", tasksLimit: 123, tasksHardLimit: 123, umaskAfp: "umaskAfp_example", umaskSmb: "umaskSmb_example", usersDefaultPermissions: "usersDefaultPermissions_example", workspacesFolderTemplatePath: "workspacesFolderTemplatePath_example", workspacesMode: "workspacesMode_example", workspacesPath: "workspacesPath_example", language: "language_example", emailLogoUrl: "emailLogoUrl_example", mediaKeepSelectionWhenBrowsing: false, tasksRunScheduled: false, httpsRedirect: "httpsRedirect_example", sslCertificate: "sslCertificate_example", sslCertificateKey: "sslCertificateKey_example", otpPolicy: "otpPolicy_example") // Parameters | 

MainAPI.updateParameters(parameters: parameters).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
parameters Parameters    

Return type

Parameters

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateProfile

    open class func updateProfile( elementsUserProfile: ElementsUserProfile) -> Promise<ElementsUserProfile>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let elementsUserProfile = ElementsUserProfile(avatar: "avatar_example", defaultPage: "defaultPage_example", fullName: "fullName_example", language: "language_example", fmBookmarks: ["fmBookmarks_example"], id: 123, username: "username_example", unixUsername: "unixUsername_example", displayName: "displayName_example", email: "email_example", ldap: LDAPServer(id: 123, name: "name_example", winbindSeparator: "winbindSeparator_example", ntDomain: "ntDomain_example"), effectivePermissions: ["effectivePermissions_example"]) // ElementsUserProfile | 

MainAPI.updateProfile(elementsUserProfile: elementsUserProfile).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
elementsUserProfile ElementsUserProfile    

Return type

ElementsUserProfile

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateSMTPConfiguration

    open class func updateSMTPConfiguration( sMTPConfiguration: SMTPConfiguration) -> Promise<SMTPConfiguration>

Required permissions * User account permission: system:admin-access

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let sMTPConfiguration = SMTPConfiguration(fromAddress: "fromAddress_example", server: "server_example", port: 123, tls: "tls_example", username: "username_example", password: "password_example") // SMTPConfiguration | 

MainAPI.updateSMTPConfiguration(sMTPConfiguration: sMTPConfiguration).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
sMTPConfiguration SMTPConfiguration    

Return type

SMTPConfiguration

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateUser

    open class func updateUser( id: Int,  elementsUserDetail: ElementsUserDetail) -> Promise<ElementsUserDetail>

Required permissions * User account permission: None (read) / users:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this User.
let elementsUserDetail = ElementsUserDetail(id: 123, allowChangingPassword: false, allowWanLogin: false, allowedFsPaths: ["allowedFsPaths_example"], allowedFsWritePaths: ["allowedFsWritePaths_example"], avatar: "avatar_example", clientSessions: [ClientSession(id: 123, user: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), mountedWorkspaces: "mountedWorkspaces_example", started: Date(), lastUpdated: Date(), workstation: "workstation_example")], defaultPage: "defaultPage_example", displayName: "displayName_example", effectivePermissions: ["effectivePermissions_example"], email: "email_example", expiry: Date(), ancillaryPathReadOnly: false, ancillaryPath: "ancillaryPath_example", fmBookmarks: ["fmBookmarks_example"], fullName: "fullName_example", gid: 123, groupPermissions: ["groupPermissions_example"], hasPassword: false, home: 123, isExternal: false, isCloud: false, isCloudDefault: false, isEnabled: false, language: "language_example", lastSeen: Date(), ldap: LDAPServerReference(id: 123, name: "name_example", winbindSeparator: "winbindSeparator_example", ntDomain: "ntDomain_example"), ldapDn: "ldapDn_example", passwordChangeRequired: false, permissions: ["permissions_example"], shaperCeiling: 123, shaperRate: 123, syncId: 123, totpEnabled: false, uid: 123, unixUsername: "unixUsername_example", username: "username_example", groups: [123]) // ElementsUserDetail | 

MainAPI.updateUser(id: id, elementsUserDetail: elementsUserDetail).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id Int A unique integer value identifying this User.  
elementsUserDetail ElementsUserDetail    

Return type

ElementsUserDetail

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateWorkstation

    open class func updateWorkstation( id: String,  workstation: Workstation) -> Promise<Workstation>

Required permissions * Authenticated user * Own workstation or User account permission: workstations:view (read) / workstations:manage (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = "id_example" // String | A unique value identifying this workstation.
let workstation = Workstation(id: "id_example", clientSessions: [ClientSession(id: 123, user: ElementsUserMini(id: 123, avatar: "avatar_example", displayName: "displayName_example", email: "email_example", fullName: "fullName_example", isExternal: false, isCloud: false, username: "username_example"), mountedWorkspaces: "mountedWorkspaces_example", started: Date(), lastUpdated: Date(), workstation: "workstation_example")], displayName: "displayName_example", rdcAllowUsers: [ElementsUserReference(id: 123, allowChangingPassword: false, allowWanLogin: false, allowedFsPaths: ["allowedFsPaths_example"], allowedFsWritePaths: ["allowedFsWritePaths_example"], avatar: "avatar_example", clientSessions: [nil], defaultPage: "defaultPage_example", displayName: "displayName_example", effectivePermissions: ["effectivePermissions_example"], email: "email_example", expiry: Date(), ancillaryPathReadOnly: false, ancillaryPath: "ancillaryPath_example", fmBookmarks: ["fmBookmarks_example"], fullName: "fullName_example", gid: 123, groupPermissions: ["groupPermissions_example"], hasPassword: false, home: 123, isExternal: false, isCloud: false, isCloudDefault: false, isEnabled: false, language: "language_example", lastSeen: Date(), ldap: 123, ldapDn: "ldapDn_example", passwordChangeRequired: false, permissions: ["permissions_example"], shaperCeiling: 123, shaperRate: 123, syncId: 123, totpEnabled: false, uid: 123, unixUsername: "unixUsername_example", username: "username_example")], rdcAllowGroups: [ElementsGroupReference(id: 123, permissions: ["permissions_example"], membersPreview: [MemberPreview(id: 123, avatar: "avatar_example", email: "email_example")], effectivePermissions: ["effectivePermissions_example"], name: "name_example", ldapDn: "ldapDn_example", unixGroupname: "unixGroupname_example", gid: 123, ancillaryPath: "ancillaryPath_example", ancillaryPathReadOnly: false, ldap: 123, members: [123])], name: "name_example", hostname: "hostname_example", rdcLastUsed: Date(), rdcDisableUpnp: false, rdcClientPort: 123, rdcHostPort: 123) // Workstation | 

MainAPI.updateWorkstation(id: id, workstation: workstation).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
id String A unique value identifying this workstation.  
workstation Workstation    

Return type

Workstation

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

uploadChunk

    open class func uploadChunk( uploadChunkEndpointRequest: UploadChunkEndpointRequest) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let uploadChunkEndpointRequest = UploadChunkEndpointRequest(uploadId: "uploadId_example", chunkNumber: 123, totalChunks: 123) // UploadChunkEndpointRequest | 

MainAPI.uploadChunk(uploadChunkEndpointRequest: uploadChunkEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name Type Description Notes
uploadChunkEndpointRequest UploadChunkEndpointRequest    

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]