1. REST API for Oracle IoT Asset Monitoring Cloud Service
  2. Tasks
  3. Assets Managment

Replace asset by ID

put

/assetMonitoring/clientapi/v2/assets/{asset-id}

This operation replaces asset details by the provided definition for the given asset ID.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : AssetImpl_create
Type: object
Show Source
Nested Schema : Place_create
Type: object
Show Source
Nested Schema : attributes
Type: array
Property description was not set
Show Source
Nested Schema : groupNames
Type: array
Property description was not set
Show Source
Nested Schema : idBasedPaths
Type: array
Property description was not set
Show Source
Nested Schema : MetricSnapshot_create
Type: object
Show Source
Nested Schema : nameBasedPaths
Type: array
Property description was not set
Show Source
Nested Schema : storagePlaces
Type: array
Property description was not set
Show Source
Nested Schema : tags
Type: array
Property description was not set
Show Source
Nested Schema : typeBasedPaths
Type: array
Property description was not set
Show Source
Nested Schema : geoFences
Type: array
Property description was not set
Show Source
Nested Schema : tags
Type: array
Property description was not set
Show Source
Nested Schema : AssetAttribute_create
Type: object
Show Source
Nested Schema : metricValues
Type: array
Property description was not set
Show Source
Nested Schema : MetricValue_create
Type: object
Show Source
Nested Schema : GeoPosition_create
Type: object
Show Source
Nested Schema : metadata
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : params
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : additionalElements
Type: array
Property description was not set
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : AssetImpl_receive
Type: object
Show Source
Nested Schema : actions
Type: object
Property description was not set
Show Source
Nested Schema : Place_receive
Type: object
Show Source
Nested Schema : attributes
Type: array
Property description was not set
Show Source
Nested Schema : classes
Type: array
Property description was not set
Show Source
Nested Schema : groupNames
Type: array
Property description was not set
Show Source
Nested Schema : groups
Type: object
Property description was not set
Show Source
Nested Schema : idBasedPaths
Type: array
Property description was not set
Show Source
Nested Schema : MetricSnapshot_receive
Type: object
Show Source
Nested Schema : nameBasedPaths
Type: array
Property description was not set
Show Source
Nested Schema : queryGroups
Type: object
Property description was not set
Show Source
Nested Schema : storagePlaces
Type: array
Property description was not set
Show Source
Nested Schema : tags
Type: array
Property description was not set
Show Source
Nested Schema : typeBasedPaths
Type: array
Property description was not set
Show Source
Nested Schema : FloorPlan_receive
Type: object
Show Source
Nested Schema : geoFences
Type: array
Property description was not set
Show Source
Nested Schema : places
Type: object
Property description was not set
Show Source
Nested Schema : tags
Type: array
Property description was not set
Show Source
Nested Schema : image
Type: object
Show Source
Nested Schema : FloorPlanReferencePoints_receive
Type: object
Show Source
Nested Schema : AssetAttribute_receive
Type: object
Show Source
Nested Schema : metricValues
Type: array
Property description was not set
Show Source
Nested Schema : MetricValue_receive
Type: object
Show Source
Nested Schema : GeoPosition_receive
Type: object
Show Source
Nested Schema : metadata
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : params
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : additionalElements
Type: array
Property description was not set
Show Source

400 Response

Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

401 Response

Unauthorized. The request requires user authentication.

404 Response

Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.

406 Response

Request Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

415 Response

Unsupported Media Type. The request entity has a media type which the server or resource does not support.
Back to Top

Examples

curl -X PUT 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/assetMonitoring/clientapi/v2/assets/{asset-id}

Example of Request Body

The following example shows the content of the request body in JSON format:


{
    "assignedPlace":{
        "description":"Property description was not set",
        "geoFences":[
            "geoFences_1",
            "geoFences_2",
            "geoFences_3"
        ],
        "id":"28c14f5c7bcc-6603",
        "name":"Property description was not set",
        "organizationId":"35f33aa32af6-4d62",
        "parent":"Property description was not set",
        "tags":[
            "tags_1",
            "tags_2",
            "tags_3"
        ],
        "type":"Property description was not set"
    },
    "attributes":[
        {
            "binaryValue":"Property description was not set",
            "booleanValue":false,
            "dateValue":"Property description was not set",
            "name":"Property description was not set",
            "numberValue":12345,
            "stringValue":"Property description was not set",
            "type":"One of [STRING, NUMBER, BOOLEAN, DATE, BINARY, DEVICE, ASSET, URI, ALERT, SENSOR]."
        }
    ],
    "description":"Property description was not set",
    "geoLocation":"Property description was not set",
    "groupNames":[
        "groupNames_1",
        "groupNames_2",
        "groupNames_3"
    ],
    "idBasedPaths":[
        "idBasedPaths_1",
        "idBasedPaths_2",
        "idBasedPaths_3"
    ],
    "lastModifiedBy":"Property description was not set",
    "lastModifiedTime":1469184297746,
    "lastModifiedTimeAsString":1469184297746,
    "lastReportedTime":1469184297746,
    "lastReportedTimeAsString":1469184297746,
    "location":"Property description was not set",
    "metricSnapshot":{
        "metricValues":[
            {
                "booleanValue":false,
                "computedTime":1469184297746,
                "confidenceLevel":12345,
                "entityId":"26e9400e650e-402f",
                "entityType":"Property description was not set",
                "eventTime":1469184297746,
                "eventTimeAsString":"2016-07-22T10:44:57.746Z",
                "geoLocationValue":{
                    "additionalElements":[
                        "additionalElements_1",
                        "additionalElements_2",
                        "additionalElements_3"
                    ],
                    "altitude":0.0,
                    "latitude":0.0,
                    "longitude":0.0,
                    "valid":false
                },
                "id":"773e6eba2c2-7ebc",
                "interval":"One of [DYNAMIC, CURRENT, EVERY2MINUTE, HOURLY, DAILY, NEXT24HOURS, WEEKLY, BIWEEKLY, NEXT7DAYS, NEXT30DAYS, MONTHLY, DAYS90, STATIC].",
                "lastKnown":false,
                "metadata":{
                    "metadata_key1":"metadata_value1",
                    "metadata_key2":"metadata_value2",
                    "metadata_key3":"metadata_value3"
                },
                "name":"Property description was not set",
                "numericValue":12345,
                "params":{
                    "params_key1":"params_value1",
                    "params_key2":"params_value2",
                    "params_key3":"params_value3"
                },
                "stringValue":"Property description was not set",
                "type":"One of [KPI, PREDICTION, ANOMALY, TREND_NELSON, TREND, SENSOR]."
            }
        ]
    },
    "name":"Property description was not set",
    "nameBasedPaths":[
        "nameBasedPaths_1",
        "nameBasedPaths_2",
        "nameBasedPaths_3"
    ],
    "parentId":"5ada4cb14a67-6a9",
    "registeredBy":"Property description was not set",
    "registrationTime":1469184297746,
    "registrationTimeAsString":1469184297746,
    "storagePlaces":[
        "storagePlaces_1",
        "storagePlaces_2",
        "storagePlaces_3"
    ],
    "tags":[
        "tags_1",
        "tags_2",
        "tags_3"
    ],
    "type":"Property description was not set",
    "typeBasedPaths":[
        "typeBasedPaths_1",
        "typeBasedPaths_2",
        "typeBasedPaths_3"
    ],
    "typeId":"565e554188b-3fa0"
}

Example of Response Body

The following example shows the content of the response body in JSON format:


{
    "actions":{
        "links":[
            {
                "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
                "rel":"self"
            },
            {
                "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
                "rel":"canonical"
            }
        ]
    },
    "assignedPlace":{
        "description":"Property description was not set",
        "floorplan":{
            "description":"Property description was not set",
            "id":"6762159f2bc3-7a3b",
            "image":{
                "links":[
                    {
                        "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
                        "rel":"self"
                    },
                    {
                        "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
                        "rel":"canonical"
                    }
                ]
            },
            "name":"Property description was not set",
            "referencePoints":{
                "imageP1":"Property description was not set",
                "imageP2":"Property description was not set",
                "mapP1":"Property description was not set",
                "mapP2":"Property description was not set"
            }
        },
        "geoFences":[
            "geoFences_1",
            "geoFences_2",
            "geoFences_3"
        ],
        "id":"699874169d8-7171",
        "name":"Property description was not set",
        "organizationId":"3f8d75d73cba-51d4",
        "parent":"Property description was not set",
        "places":{
            "links":[
                {
                    "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
                    "rel":"self"
                },
                {
                    "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
                    "rel":"canonical"
                }
            ]
        },
        "tags":[
            "tags_1",
            "tags_2",
            "tags_3"
        ],
        "type":"Property description was not set"
    },
    "attributes":[
        {
            "binaryValue":"Property description was not set",
            "booleanValue":false,
            "dateValue":"Property description was not set",
            "name":"Property description was not set",
            "numberValue":12345,
            "stringValue":"Property description was not set",
            "type":"One of [STRING, NUMBER, BOOLEAN, DATE, BINARY, DEVICE, ASSET, URI, ALERT, SENSOR]."
        }
    ],
    "checkedOutBy":"Property description was not set",
    "checkedOutStatus":false,
    "checkedOutTime":1469184297746,
    "checkedOutTimeAsString":"2016-07-22T10:44:57.746Z",
    "classes":[
        "classes_1",
        "classes_2",
        "classes_3"
    ],
    "description":"Property description was not set",
    "eamId":"2f5450fc1809-507a",
    "geoLocation":"Property description was not set",
    "groupNames":[
        "groupNames_1",
        "groupNames_2",
        "groupNames_3"
    ],
    "groups":{
        "links":[
            {
                "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
                "rel":"self"
            },
            {
                "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
                "rel":"canonical"
            }
        ]
    },
    "id":"983451535a-23ae",
    "idBasedPaths":[
        "idBasedPaths_1",
        "idBasedPaths_2",
        "idBasedPaths_3"
    ],
    "isHidden":false,
    "lastModifiedBy":"Property description was not set",
    "lastModifiedTime":1469184297746,
    "lastModifiedTimeAsString":1469184297746,
    "lastReportedTime":1469184297746,
    "lastReportedTimeAsString":1469184297746,
    "location":"Property description was not set",
    "metricSnapshot":{
        "metricValues":[
            {
                "booleanValue":false,
                "computedTime":1469184297746,
                "confidenceLevel":12345,
                "entityId":"1dce0f5f4b-6e85",
                "entityType":"Property description was not set",
                "eventTime":1469184297746,
                "eventTimeAsString":"2016-07-22T10:44:57.746Z",
                "geoLocationValue":{
                    "additionalElements":[
                        "additionalElements_1",
                        "additionalElements_2",
                        "additionalElements_3"
                    ],
                    "altitude":0.0,
                    "latitude":0.0,
                    "longitude":0.0,
                    "valid":false
                },
                "id":"473a33532492-e6f",
                "interval":"One of [DYNAMIC, CURRENT, EVERY2MINUTE, HOURLY, DAILY, NEXT24HOURS, WEEKLY, BIWEEKLY, NEXT7DAYS, NEXT30DAYS, MONTHLY, DAYS90, STATIC].",
                "lastKnown":false,
                "metadata":{
                    "metadata_key1":"metadata_value1",
                    "metadata_key2":"metadata_value2",
                    "metadata_key3":"metadata_value3"
                },
                "name":"Property description was not set",
                "numericValue":12345,
                "params":{
                    "params_key1":"params_value1",
                    "params_key2":"params_value2",
                    "params_key3":"params_value3"
                },
                "stringValue":"Property description was not set",
                "type":"One of [KPI, PREDICTION, ANOMALY, TREND_NELSON, TREND, SENSOR]."
            }
        ]
    },
    "name":"Property description was not set",
    "nameBasedPaths":[
        "nameBasedPaths_1",
        "nameBasedPaths_2",
        "nameBasedPaths_3"
    ],
    "organizationId":"22028c4179c-4bde",
    "parentId":"1d3b27cf108f-3c79",
    "queryGroups":{
        "links":[
            {
                "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
                "rel":"self"
            },
            {
                "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
                "rel":"canonical"
            }
        ]
    },
    "registeredBy":"Property description was not set",
    "registrationTime":1469184297746,
    "registrationTimeAsString":1469184297746,
    "status":"One of [DRAFT, ACTIVE, INACTIVE].",
    "storagePlaces":[
        "storagePlaces_1",
        "storagePlaces_2",
        "storagePlaces_3"
    ],
    "tags":[
        "tags_1",
        "tags_2",
        "tags_3"
    ],
    "type":"Property description was not set",
    "typeBasedPaths":[
        "typeBasedPaths_1",
        "typeBasedPaths_2",
        "typeBasedPaths_3"
    ],
    "typeId":"80871cd5836-262"
}



Complete cURL Example

The following example shows a complete cURL command that you can use to perform the described operation:

curl -X PUT 
   -u <username>:<password> 
   -H 'Accept: application/json'  
   -d '{"assignedPlace":{"description":"Property description was not set","geoFences":["geoFences_1","geoFences_2","geoFences_3"],"id":"28c14f5c7bcc-6603","name":"Property description was not set","organizationId":"35f33aa32af6-4d62","parent":"Property description was not set","tags":["tags_1","tags_2","tags_3"],"type":"Property description was not set"},"attributes":[{"binaryValue":"Property description was not set","booleanValue":false,"dateValue":"Property description was not set","name":"Property description was not set","numberValue":12345,"stringValue":"Property description was not set","type":"One of [STRING, NUMBER, BOOLEAN, DATE, BINARY, DEVICE, ASSET, URI, ALERT, SENSOR]."}],"description":"Property description was not set","geoLocation":"Property description was not set","groupNames":["groupNames_1","groupNames_2","groupNames_3"],"idBasedPaths":["idBasedPaths_1","idBasedPaths_2","idBasedPaths_3"],"lastModifiedBy":"Property description was not set","lastModifiedTime":1469184297746,"lastModifiedTimeAsString":1469184297746,"lastReportedTime":1469184297746,"lastReportedTimeAsString":1469184297746,"location":"Property description was not set","metricSnapshot":{"metricValues":[{"booleanValue":false,"computedTime":1469184297746,"confidenceLevel":12345,"entityId":"26e9400e650e-402f","entityType":"Property description was not set","eventTime":1469184297746,"eventTimeAsString":"2016-07-22T10:44:57.746Z","geoLocationValue":{"additionalElements":["additionalElements_1","additionalElements_2","additionalElements_3"],"altitude":0.0,"latitude":0.0,"longitude":0.0,"valid":false},"id":"773e6eba2c2-7ebc","interval":"One of [DYNAMIC, CURRENT, EVERY2MINUTE, HOURLY, DAILY, NEXT24HOURS, WEEKLY, BIWEEKLY, NEXT7DAYS, NEXT30DAYS, MONTHLY, DAYS90, STATIC].","lastKnown":false,"metadata":{"metadata_key1":"metadata_value1","metadata_key2":"metadata_value2","metadata_key3":"metadata_value3"},"name":"Property description was not set","numericValue":12345,"params":{"params_key1":"params_value1","params_key2":"params_value2","params_key3":"params_value3"},"stringValue":"Property description was not set","type":"One of [KPI, PREDICTION, ANOMALY, TREND_NELSON, TREND, SENSOR]."}]},"name":"Property description was not set","nameBasedPaths":["nameBasedPaths_1","nameBasedPaths_2","nameBasedPaths_3"],"parentId":"5ada4cb14a67-6a9","registeredBy":"Property description was not set","registrationTime":1469184297746,"registrationTimeAsString":1469184297746,"storagePlaces":["storagePlaces_1","storagePlaces_2","storagePlaces_3"],"tags":["tags_1","tags_2","tags_3"],"type":"Property description was not set","typeBasedPaths":["typeBasedPaths_1","typeBasedPaths_2","typeBasedPaths_3"],"typeId":"565e554188b-3fa0"}'
   https://iotserver/assetMonitoring/clientapi/v2/assets/1f841ee819ec-1fe5



Note that in the request, https://iotserver will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is https://myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.
Back to Top