Retrieve an Exploration Source
get
/iot/api/v2/apps/{app-id}/explorationSources/{explorationsource-id}
The API is deprecated and may be removed in a future release.
Request
Path Parameters
-
app-id: string
A unique identifier for the IoT Application
-
explorationsource-id: string
A unique identifier for the Exploration Source
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.
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=singular
200 Response
Successfully processed.
Root Schema : AnalyticsImpl_receive
Type:
Show Source
object
-
activationTime:
integer
Endpoint activation time
-
activationTimeAsString:
integer
Endpoint activation time
-
annotations:
object annotations
Additional Properties Allowed: additionalPropertiesAnnotations that will be applied to the messages passed to the Analytics engine
-
applicationid:
string
ID of the Application this analytics instance was created for
-
connectivity:
object ConnectivityStatus_receive
-
created:
integer
Endpoint created time
-
createdAsString:
integer
Endpoint created time
-
description:
string
Endpoint description
-
destId:
string
Property description was not set
-
directlyConnectedOwner:
object directlyConnectedOwner
Directly connected owner to Endpoint
-
format:
string
URN of the message format to which this Analytics instance will be subscribed
-
formatStatus:
string
The flag shows user attention is necessaryOne of [relevant, obsolete, noformat].
-
id:
string
Unique ID for each Analytics instance
-
lastHeardTimeAsString:
integer
Endpoint last heard time property
-
messageAnnotator:
object MessageAnnotatorModel_receive
-
messageAnnotatorId:
string
Property description was not set
-
messageFormat:
object MessageFormatModel_receive
-
metadata:
object metadata
Additional Properties Allowed: additionalPropertiesEndpoint metadata
-
name:
string
Endpoint name
-
partnerName:
string
Partner name
-
resources:
array resources
List of endpoints resources
- sharedSecret: string
-
state:
string
Endpoint stateOne of [REGISTERED, ACTIVATED, ENABLED, DISABLED, DECOMMISSIONED, UNKNOWN].
-
streamid:
string
Unique identifier that will be provided by the Analytics engine
-
type:
string
Analytics instance type: "OEP"
Nested Schema : annotations
Type:
object
Additional Properties Allowed
Show Source
-
string
A map of the following type: Map<String, String>
Annotations that will be applied to the messages passed to the Analytics engine
Show Source
Nested Schema : ConnectivityStatus_receive
Type:
Show Source
object
-
lastHeardEpochTime:
integer
Property description was not set
-
onlineSinceEpochTime:
integer
Property description was not set
-
onlineSinceTime:
integer
Property description was not set
-
status:
string
One of [NEVER_HEARD_FROM, OFFLINE, ONLINE].
Nested Schema : directlyConnectedOwner
Type:
object
Directly connected owner to Endpoint
Show Source
-
links(optional):
array links
The set of API navigation links.
Nested Schema : MessageAnnotatorModel_receive
Type:
Show Source
object
-
annotations:
array annotations
Property description was not set
-
description:
string
Property description was not set
-
id:
string
Property description was not set
-
name:
string
Property description was not set
Nested Schema : MessageFormatModel_receive
Type:
Show Source
object
-
description:
string
Property description was not set
-
deviceModel:
string
Property description was not set
-
explorationId:
string
Property description was not set
-
name:
string
Property description was not set
-
severity:
string
Property description was not set
-
sourceId:
string
Property description was not set
-
sourceType:
string
One of [UNKNOWN, DEVICE_MODEL, EXPLORATION, ANALYTICS].
-
type:
string
One of [DATA, ALERT, EXPLORATION, EXPLORATION_DATA, EXPLORATION_ALERT, IACS_DATA, IACS_ALERT].
-
uRN:
string
Property description was not set
-
value:
object MessageFormatValue_receive
Nested Schema : metadata
Type:
object
Additional Properties Allowed
Show Source
-
string
A map of the following type: Map<String, String>
Endpoint metadata
Show Source
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
Nested Schema : MessageAnnotation_receive
Type:
Show Source
object
-
appFields:
array appFields
Property description was not set
-
destinationFields:
array destinationFields
Property description was not set
-
senderFields:
array senderFields
Property description was not set
-
sourceFields:
array sourceFields
Property description was not set
-
type:
string
Property description was not set
Nested Schema : MessageFormatValue_receive
Type:
Show Source
object
-
fields:
array fields
Property description was not set
Nested Schema : MessageFormatField_receive
Type:
Show Source
object
-
name:
string
Property description was not set
-
optional:
boolean
Property description was not set
-
type:
string
One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].
Nested Schema : EndpointResourceModel_receive
Type:
Show Source
object
-
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
Nested Schema : methods
Type:
array
This array may contain the following items: GET, POST, PUT, DELETE.
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.
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.
Examples
The following example shows how to retrieve an
explorationSources
instance having a specific endpoint Id by submitting a GET request on the REST resource using cURL. For more information about cURL, see
Use cURL.
Note:
In the request and response,iotserver
will be replaced by name and port of your assigned Oracle IoT Cloud Service instance. The format of the Cloud Service instance is
myinstance-myidentitydomain.iot.us.oraclecloud.com
and the default port is
443
curl-X GET -H 'Accept:application/json' -H 'Authorization: Basic aW90OndlbGNvbWUx' "http://iotserver:7101/iot/api/v2/apps/0-AM/explorationSources/0-BQ"
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"annotations":null,
"applicationid":"0-AM",
"callbackUrl":null,
"description":"Readings from my thermometer",
"format":"urn:com:oracle:iot:device:thermometer:attributes",
"id":"0-BQ",
"name":"My Thermometer Source",
"state":"ENABLED",
"streamid":"90",
"type":"OEP",
"activationTime":null,
"activationTimeAsString":null,
"created":1468284574765,
"createdAsString":"2016-07-12T00:49:34.765Z",
"directlyConnectedOwner":null,
"lastHeardTimeAsString":null,
"messageAnnotatorId":null,
"messageFormat":{
"urn":"urn:com:oracle:iot:device:thermometer:attributes",
"name":"Thermometer",
"description":"",
"type":"DATA",
"deviceModel":"urn:com:oracle:iot:device:thermometer",
"value":{
"fields":[
{
"name":"temperature",
"optional":false,
"type":"NUMBER"
}
]
}
},
"metadata":{
},
"resources":[
],
"sharedSecret":null,
"links":[
{
"href":"http://iotserver:7101/iot/api/v2/apps/0-AM/explorationSources/0-BQ/",
"rel":"self"
},
{
"href":"http://iotserver:7101/iot/api/v2/apps/0-AM/explorationSources/0-BQ/",
"rel":"canonical"
}
]
}