REST API for Oracle IoT Asset Monitoring Cloud Service

Retrieve floor plan

get

/assetMonitoring/clientapi/v2/places/{place-name}/floorplan

Get detailed description of plan object. This non-org aware REST API will be deprecated in future releases.

Request

Path Parameters

place-name: string

Entity description is undefined

Response

Supported Media Types

application/json
application/vnd.oracle.resource+json;type=singular

200 Response

Successfully processed.

Root Schema : FloorPlanImpl_receive

Type: object

Show Source

description: string

A human friendly description
id: string

Floor plan unique id
image: object image

Base64 encoded string corresponding to the floor plan image
name: string

Floor plan name
referencePoints: object FloorPlanReferencePoints_receive

{
    "type":"object",
    "required":[
        "id",
        "name",
        "description",
        "image",
        "referencePoints"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Floor plan unique id"
        },
        "name":{
            "type":"string",
            "description":"Floor plan name"
        },
        "description":{
            "type":"string",
            "description":"A human friendly description"
        },
        "image":{
            "type":"object",
            "description":"Base64 encoded string corresponding to the floor plan image",
            "properties":{
                "links":{
                    "type":"array",
                    "description":"The set of API navigation links.",
                    "items":{
                        "type":"object",
                        "properties":{
                            "rel":{
                                "description":"Relation type",
                                "type":"string",
                                "example":"canonical"
                            },
                            "href":{
                                "description":"The target resource URI",
                                "type":"string",
                                "example":"https://iotserver/iot/api/vX/some/API/path"
                            }
                        }
                    }
                }
            }
        },
        "referencePoints":{
            "$ref":"#/definitions/FloorPlanReferencePoints_receive"
        }
    }
}

Nested Schema : image

Type: object

Base64 encoded string corresponding to the floor plan image

Show Source

links(optional): array links

The set of API navigation links.

{
    "type":"object",
    "description":"Base64 encoded string corresponding to the floor plan image",
    "properties":{
        "links":{
            "type":"array",
            "description":"The set of API navigation links.",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "description":"Relation type",
                        "type":"string",
                        "example":"canonical"
                    },
                    "href":{
                        "description":"The target resource URI",
                        "type":"string",
                        "example":"https://iotserver/iot/api/vX/some/API/path"
                    }
                }
            }
        }
    }
}

Nested Schema : FloorPlanReferencePoints_receive

Type: object

Show Source

imageP1: string

Property description was not set
imageP2: string

Property description was not set
mapP1: string

Property description was not set
mapP2: string

Property description was not set

{
    "properties":{
        "imageP1":{
            "description":"Property description was not set",
            "type":"string"
        },
        "imageP2":{
            "description":"Property description was not set",
            "type":"string"
        },
        "mapP1":{
            "description":"Property description was not set",
            "type":"string"
        },
        "mapP2":{
            "description":"Property description was not set",
            "type":"string"
        }
    },
    "required":[
        "imageP1",
        "imageP2",
        "mapP1",
        "mapP2"
    ],
    "type":"object"
}

Nested Schema : links

Type: array

The set of API navigation links.

Show Source

Array of: object items

{
    "type":"array",
    "description":"The set of API navigation links.",
    "items":{
        "type":"object",
        "properties":{
            "rel":{
                "description":"Relation type",
                "type":"string",
                "example":"canonical"
            },
            "href":{
                "description":"The target resource URI",
                "type":"string",
                "example":"https://iotserver/iot/api/vX/some/API/path"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

href(optional): string

The target resource URI

Example: https://iotserver/iot/api/vX/some/API/path
rel(optional): string

Relation type

Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "description":"Relation type",
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "description":"The target resource URI",
            "type":"string",
            "example":"https://iotserver/iot/api/vX/some/API/path"
        }
    }
}

401 Response

Unauthorized. The request requires user authentication.

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.

Examples

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/assetMonitoring/clientapi/v2/places/{place-name}/floorplan

Example of Response Body

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


{
    "id":"348e3f1f630b-5692",
    "name":"Floor plan name",
    "description":"A human friendly description",
    "image":{
        "links":[
            {
                "rel":"self",
                "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path"
            },
            {
                "rel":"canonical",
                "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path"
            }
        ]
    },
    "referencePoints":{
        "imageP1":"Coordinates of the first point on image",
        "imageP2":"Coordinates of the second point on image",
        "mapP1":"Geographic coordinates of the first point",
        "mapP2":"Geographic coordinates of the second point"
    }
}

Complete cURL Example

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

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/assetMonitoring/clientapi/v2/places/{place-name}/floorplan

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.