configuration/put

Creates new or updates existing property.

Authorization

Access JSON Web Token (ManageConfiguration)

Request Topic and Payload

Topic

dh/request

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "name": {string},
    "value": {string}
}

Payload Parameters

Property NameRequiredTypeDescription
actionYesstringAction name: configuration/put
requestIdNoobjectRequest unique identifier, will be passed back in the response message.
nameYesstringConfiguration parameter name.
valueYesstringConfiguration parameter value.

Response Topic and Payload

Topic

dh/response/configuration/put@{clientId}

Payload Representation

{
    "action": {string},
    "status": {string},
    "requestId": {object},
    "configuration": {
        "name": {string},
        "value": {string},
        "entityVersion": {integer}
    }
}
Property NameTypeDescription
actionstringAction name: configuration/put
statusstringOperation execution status (success or error).
requestIdobjectRequest unique identifier as specified in the request message.
configurationobjectThe Configuration resource.
configuration.namestringConfiguration parameter name.
configuration.valuestringConfiguration parameter value.
configuration.entityVersionintegerSpecifies the version field or property of an entity class.