CreateAsset

Class Description

Create a new Asset and assign to an Account

RPC Configuration

Rpc Name:

Plain: CreateAsset
Sha1: da29da92d6549adf2b150d455a89ae8961c04226

Rpc Call

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

Rpc I18n Name:

createAssetI18n

Rpc Parameters:

"userToken" : string,
"sharedSecret" : string,
"assetAlias" : string,
"assetName" : string,
"image" : ?string = null 

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

File Receiver Configuration

This RPC can receive Files.

Maximum Filesize

4 MB

Accepted File MimeTypes:

[
    "image/png",
    "image/jpg",
    "image/jpeg",
    "image/svg+xml"
]

File Param Name(s):

[
    "image"
]

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": "Unittest_asset_tocreate",
    "assetName": "Asset created by unittest"
}

<-

"Unittest_asset_tocreate"