Retrieve what-if invocation object
get
/assetMonitoring/clientapi/v2/assets/{asset-id}/whatIfInvocations/{invocation-id}
Returns what-if invocation object by specified id
Request
Path Parameters
-
asset-id: string
Entity description is undefined
-
invocation-id: string
ID of invocation
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
200 Response
Successfully processed.
Root Schema : AssetWhatIfInvocation_receive
Type:
Show Source
object
-
duration:
integer
Property description was not set
-
endTime:
integer
Property description was not set
-
id:
string
Property description was not set
-
lastModifiedBy:
string
Property description was not set
-
scenarioId:
string
Property description was not set
-
startedBy:
string
Property description was not set
-
startTime:
integer
Property description was not set
-
status:
string
One of [CREATED, RUNNING, COMPLETED, STOPPED, FAILED].
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.
Examples
curl -X GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/assetMonitoring/clientapi/v2/assets/{asset-id}/whatIfInvocations/{invocation-id}
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"duration":12345,
"endTime":1469184297746,
"id":"688530765109-2df7",
"lastModifiedBy":"Property description was not set",
"scenarioId":"22e14d691509-37ed",
"startTime":1469184297746,
"startedBy":"Property description was not set",
"status":"One of [CREATED, RUNNING, COMPLETED, STOPPED, FAILED]."
}
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/assets/3be7d9b7d3c-1dc3/whatIfInvocations/3be7d9b7d3c-1dc3
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.