1. REST API for Oracle IoT Asset Monitoring Cloud Service
  2. Tasks
  3. Places Management

Retrieve place details

get

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

This operation retrieves the details of a place for the given place name. This non-org aware REST API will be deprecated in future releases.

Request

Path Parameters
  • Unique name of place to be retrieved from Oracle IoT Asset Monitoring Cloud Service
Query Parameters
  • The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
  • The comma-separated list of fields to be shown in response. By default all response object fields will be present.
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : PlaceImpl_receive
Type: object
Show Source
Nested Schema : FloorPlan_receive
Type: object
Show Source
Nested Schema : geoFences
Type: array
References (0..N) to IoT geo fences related to the place
Show Source
Nested Schema : places
Type: object
References (0..N) to places contained in the place
Show Source
Nested Schema : tags
Type: array
User defined tags for the place. Can be used by users for quick search, logical grouping of places etc.
Show Source
Nested Schema : image
Type: object
Show Source
Nested Schema : FloorPlanReferencePoints_receive
Type: object
Show Source

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.
Back to Top

Examples

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

Example of Response Body

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


{
    "id":"1f1f3f126537-116b",
    "name":"The place name ",
    "type":"Type of the place, e.g. GEO_ROUTE, GEO_CIRCLE, GEO_POLYGON, GEO_POINT, CITY, STATE, COUNTRY etc. Can be null.",
    "description":"A human friendly description",
    "organizationId":"fdc12a2437a-1a4d",
    "geoFences":[
        "geoFences_1",
        "geoFences_2",
        "geoFences_3"
    ],
    "parent":"References to a place containing the place",
    "places":{
        "links":[
            {
                "rel":"self",
                "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path"
            },
            {
                "rel":"canonical",
                "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path"
            }
        ]
    },
    "tags":[
        "tags_1",
        "tags_2",
        "tags_3"
    ],
    "floorplan":{
        "id":"2308442a6187-2ba2",
        "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}



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