PATCH v1/core/Accounts/{accId}/devices/iotdevices/{iotDevId}

Patch a the specified IOT Device

Request Information

Parameters

NameDescriptionAdditional information
accId
the account id

Define this parameter in the request URI.

iotDevId
the device id

Define this parameter in the request URI.

value
the device object

Define this parameter in the request body.

Request body formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: One or more errors occurred.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: One or more errors occurred.

text/javascript

Sample:

An exception has occurred while using the formatter 'JsonPMediaTypeFormatter' to generate sample for media type 'text/javascript'. Exception message: One or more errors occurred.

application/xml, text/xml

Sample:
<JsonPatchDocumentOfIOTDeviceCA1DLPoZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Marvin.JsonPatch" />

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'JsonPatchDocument`1'.

application/bson

Sample:

An exception has occurred while using the formatter 'BsonMediaTypeFormatter' to generate sample for media type 'application/bson'. Exception message: Requested value 'sample string 3' was not found.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "Success": true,
  "Data": {
    "ID": 1,
    "UserID": 2,
    "Description": "sample string 3",
    "CName": "sample string 4",
    "CertificatePins": {
      "sha256": "sample string 1"
    },
    "MACAddress": "sample string 5",
    "x509Cert": {
      "RawData": null
    },
    "AuthType": "CLI",
    "Status": "Enabled",
    "ActivationUsername": "sample string 6",
    "ActivationPassword": "sample string 7",
    "ActivationLastCN": "sample string 8",
    "ActivationLastPins": {
      "sha256": "sample string 1"
    }
  },
  "ErrorCode": 2,
  "ErrorDescription": "sample string 3",
  "Meta": "sample string 4"
}

text/javascript

Sample:
{"Success":true,"Data":{"ID":1,"UserID":2,"Description":"sample string 3","CName":"sample string 4","CertificatePins":{"sha256":"sample string 1"},"MACAddress":"sample string 5","x509Cert":{"RawData":null},"AuthType":0,"Status":0,"ActivationUsername":"sample string 6","ActivationPassword":"sample string 7","ActivationLastCN":"sample string 8","ActivationLastPins":{"sha256":"sample string 1"}},"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml, text/xml

Sample:
<PBNBReturnOfIOTDeviceCA1DLPoZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <Data>
    <ActivationLastCN>sample string 8</ActivationLastCN>
    <ActivationLastPins xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfAlgorithmTypestringnrZUfPn6>
        <d3p1:Key>sha256</d3p1:Key>
        <d3p1:Value>sample string 1</d3p1:Value>
      </d3p1:KeyValueOfAlgorithmTypestringnrZUfPn6>
    </ActivationLastPins>
    <ActivationPassword>sample string 7</ActivationPassword>
    <ActivationUsername>sample string 6</ActivationUsername>
    <AuthType>CLI</AuthType>
    <CName>sample string 4</CName>
    <CertificatePins xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfAlgorithmTypestringnrZUfPn6>
        <d3p1:Key>sha256</d3p1:Key>
        <d3p1:Value>sample string 1</d3p1:Value>
      </d3p1:KeyValueOfAlgorithmTypestringnrZUfPn6>
    </CertificatePins>
    <Description>sample string 3</Description>
    <ID>1</ID>
    <MACAddress>sample string 5</MACAddress>
    <Status>Enabled</Status>
    <UserID>2</UserID>
    <x509Cert xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Security.Cryptography.X509Certificates">
      <RawData i:nil="true" xmlns="" />
    </x509Cert>
  </Data>
  <ErrorCode>2</ErrorCode>
  <ErrorDescription>sample string 3</ErrorDescription>
  <Meta>sample string 4</Meta>
  <Success>true</Success>
</PBNBReturnOfIOTDeviceCA1DLPoZ>

application/bson

Sample:
�SuccessData�IDUserIDDescriptionsample string 3CNamesample string 4CertificatePins!sha256sample string 1MACAddresssample string 5x509Cert
RawDataAuthTypeStatusActivationUsernamesample string 6ActivationPasswordsample string 7ActivationLastCNsample string 8ActivationLastPins!sha256sample string 1ErrorCodeErrorDescriptionsample string 3Metasample string 4