SharedstorageAPI.md

SharedstorageAPI

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

Method	HTTP request	Description
getSharedStorageValue	GET /api/2/private/shared-storage/{name}
getUserStorageValue	GET /api/2/private/user-storage/{name}
setSharedStorageValue	POST /api/2/private/shared-storage/{name}
setUserStorageValue	POST /api/2/private/user-storage/{name}

getSharedStorageValue

    open class func getSharedStorageValue( name: String) -> Promise<StorageResponse>

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 name = "name_example" // String | 

SharedstorageAPI.getSharedStorageValue(name: name).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

Return type

StorageResponse

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getUserStorageValue

    open class func getUserStorageValue( name: String) -> Promise<StorageResponse>

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 name = "name_example" // String | 

SharedstorageAPI.getUserStorageValue(name: name).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

Return type

StorageResponse

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

setSharedStorageValue

    open class func setSharedStorageValue( name: String,  storageRequest: StorageRequest) -> Promise<StorageResponse>

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 name = "name_example" // String | 
let storageRequest = StorageRequest(value: "value_example", initiator: "initiator_example") // StorageRequest | 

SharedstorageAPI.setSharedStorageValue(name: name, storageRequest: storageRequest).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
storageRequest	StorageRequest

Return type

StorageResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

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

setUserStorageValue

    open class func setUserStorageValue( name: String,  storageRequest: StorageRequest) -> Promise<StorageResponse>

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 name = "name_example" // String | 
let storageRequest = StorageRequest(value: "value_example", initiator: "initiator_example") // StorageRequest | 

SharedstorageAPI.setUserStorageValue(name: name, storageRequest: storageRequest).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
storageRequest	StorageRequest

Return type

StorageResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

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