Jump to

• Request
• Response

Retrieve Resources of a Device

get

/iot/api/v2/apps/{app-id}/devices/{device-id}/resources

Retrieve a document that lists all resources hosted on the specified device

Request

Path Parameters

• app-id: string
  ID of application to be retrieved from Cloud Service
• device-id: string
  Unique identifier of the device

Query Parameters

• expand(optional): string
  The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
• fields(optional): string
  The comma-separated list of fields to be shown in response. By default all response object fields will be present.
• limit(optional): integer
  The maximum number of entries to return to the end user.
• offset(optional): integer
  The number that the first record of results is starting from.
• orderBy(optional): string
  Ordering criteria for the returned devices
• q(optional): string
  Query to filter devices (For more information on mongoDB query parameters refer to Using mongoDB Query Syntax.)
• since(optional): integer
  The starting point of the desired time interval, in milliseconds. The default is 0.
• totalResults(optional): boolean
  The total number of results suiting the request.
• until(optional): integer
  The finishing point of the desired time interval, in milliseconds. The default is 0.

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.resource+json;type=collection

200 Response

Successfully processed.

Body ()

Root Schema : EndpointResourceImpl_receive_list

Type: object

Show Source

• count: integer(int32)
• hasMore: boolean
• items: array items
• limit: integer(int32)
• links: array links
  The set of API navigation links.
• offset: integer(int32)

{
    "properties":{
        "count":{
            "format":"int32",
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "items":{
            "items":{
                "properties":{
                    "description":{
                        "description":"Property description was not set",
                        "type":"string"
                    },
                    "endpointId":{
                        "description":"Property description was not set",
                        "type":"string"
                    },
                    "id":{
                        "description":"Property description was not set",
                        "type":"string"
                    },
                    "methods":{
                        "description":"This array may contain the following items: GET, POST, PUT, DELETE.",
                        "items":{
                            "type":"string"
                        },
                        "type":"array"
                    },
                    "url":{
                        "description":"Property description was not set",
                        "type":"string"
                    }
                },
                "required":[
                    "endpointId",
                    "url",
                    "methods",
                    "id",
                    "description"
                ],
                "type":"object"
            },
            "type":"array"
        },
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "links":{
            "description":"The set of API navigation links.",
            "items":{
                "properties":{
                    "href":{
                        "description":"The target resource URI",
                        "example":"https://iotserver/iot/api/vX/some/API/path",
                        "type":"string"
                    },
                    "rel":{
                        "description":"Relation type",
                        "example":"canonical",
                        "type":"string"
                    }
                },
                "type":"object"
            },
            "type":"array"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        }
    },
    "required":[
        "items",
        "links",
        "limit",
        "offset",
        "count",
        "hasMore"
    ],
    "type":"object"
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "items":{
        "properties":{
            "description":{
                "description":"Property description was not set",
                "type":"string"
            },
            "endpointId":{
                "description":"Property description was not set",
                "type":"string"
            },
            "id":{
                "description":"Property description was not set",
                "type":"string"
            },
            "methods":{
                "description":"This array may contain the following items: GET, POST, PUT, DELETE.",
                "items":{
                    "type":"string"
                },
                "type":"array"
            },
            "url":{
                "description":"Property description was not set",
                "type":"string"
            }
        },
        "required":[
            "endpointId",
            "url",
            "methods",
            "id",
            "description"
        ],
        "type":"object"
    },
    "type":"array"
}

Nested Schema : links

Type: array

The set of API navigation links.

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Show Source

• description: string
  Property description was not set
• endpointId: string
  Property description was not set
• id: string
  Property description was not set
• methods: array methods
  This array may contain the following items: GET, POST, PUT, DELETE.
• url: string
  Property description was not set

{
    "properties":{
        "description":{
            "description":"Property description was not set",
            "type":"string"
        },
        "endpointId":{
            "description":"Property description was not set",
            "type":"string"
        },
        "id":{
            "description":"Property description was not set",
            "type":"string"
        },
        "methods":{
            "description":"This array may contain the following items: GET, POST, PUT, DELETE.",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "url":{
            "description":"Property description was not set",
            "type":"string"
        }
    },
    "required":[
        "endpointId",
        "url",
        "methods",
        "id",
        "description"
    ],
    "type":"object"
}

Nested Schema : methods

Type: array

This array may contain the following items: GET, POST, PUT, DELETE.

Show Source

• Array of: string

{
    "description":"This array may contain the following items: GET, POST, PUT, DELETE.",
    "items":{
        "type":"string"
    },
    "type":"array"
}

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

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

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.

403 Response

Forbidden. The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated.

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.

405 Response

Method Not Allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

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