EditSharingTokenOfAsset

Class Description

Add/Edit/Remove a SharingToken of an Asset. A sharingToken is an alternate name of an asset. Assets can be addressed by their sharing token aswell as there alias, while the alias is immutable. The sharingToken must be globally unqiue, so setting an already existing token will fail.

RPC Configuration

Rpc Name:

Plain: EditSharingTokenOfAsset
Sha1: ab2acb59f809fc11ef02c631b8a6b5e748842a6d

Rpc Call

RPCs can be called by their plain name or their SHA1 representation.

Rpc Parameters:

"userToken" : string,
"sharedSecret" : string,
"assetAlias" : string,
"sharingToken" : ?string = null 

Parameter Description

@param ?string sharingToken The new Sharingtoken of the Asset. Send null to delete the current sharingToken instead of modifying.

Requires Login:

true

Requires Context:

Context

The context providing parameter can either be a contagt-id (8-Bytes, Alphaumeric) or an integer as a building id. The context parameter name should make the choice obviouse, the type has not to be defined manually.

false

Requires WriteAccess:

WriteAccess

Only accounts that have an explicit write access to the defined context can execute this RPC, no matter if the authentication level matches or not.

false

Requires AuthenticationLevel:

Context

Authentication levels allow the SuperUser to define a by-RPC granular access configuration. If RPCs are chained in a single unified call and lenient is enabled, all allowed RPCs will be executed, while execution will fail entirely with lenient set to false.

LOCAL_ADMINISTRATOR

Requires Subbuilding Merge Strategy:

REPLACE

Cache Configuration

Response Cache

All writing RPCs are not Cacheable, also Caching will be disabled by the paramters nocache and readonly.

Cache enabled:

false

Account Method Authentication

This RPC requires Account Method Authenticaton with the following configuration:

Requires Account Login:

tipp

The Account login is not the default api login. See LoginViaUser and LoginViaEmail

true

Account Usertoken Parameter Name:

tipp

This Usertoken is not the same one, as the api login usertoken.

userToken

Account Shared Secret Parameter Name:

sharedSecret

Requires Asset Permission:

true

Sample Request

->

{
    "userToken": "MX8Tndlt3Qx5LdSsygHfq8gJd3v5Qdb4HKfuD7qXKo5RFU3fF1W7dQeHvEqg1eBL",
    "sharedSecret": "ea75c32046a8be46a47474931df9ffe4",
    "assetAlias": "My_Fifth_Asset",
    "sharingToken": "My#5TestSharingToken"
}

<-

false