Jump to

• Request
• Response
• Examples

List all what-if invocation objects

get

/assetMonitoring/clientapi/v2/assets/{asset-id}/whatIfInvocations

Returns the list of what-if invocation objects

Request

Path Parameters

• asset-id: string
  Entity description is undefined

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 asset what-if invocation list
• q(optional): string
  Query to filter asset what-if invocations on the server (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

200 Response

Successfully processed.

Body ()

Root Schema : AssetWhatIfInvocation_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":{
                    "duration":{
                        "description":"Property description was not set",
                        "type":"integer"
                    },
                    "endTime":{
                        "description":"Property description was not set",
                        "type":"integer"
                    },
                    "id":{
                        "description":"Property description was not set",
                        "type":"string"
                    },
                    "lastModifiedBy":{
                        "description":"Property description was not set",
                        "type":"string"
                    },
                    "scenarioId":{
                        "description":"Property description was not set",
                        "type":"string"
                    },
                    "startTime":{
                        "description":"Property description was not set",
                        "type":"integer"
                    },
                    "startedBy":{
                        "description":"Property description was not set",
                        "type":"string"
                    },
                    "status":{
                        "description":"One of [CREATED, RUNNING, COMPLETED, STOPPED, FAILED].",
                        "type":"string"
                    }
                },
                "required":[
                    "lastModifiedBy",
                    "scenarioId",
                    "startedBy",
                    "endTime",
                    "id",
                    "duration",
                    "status",
                    "startTime"
                ],
                "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":{
            "duration":{
                "description":"Property description was not set",
                "type":"integer"
            },
            "endTime":{
                "description":"Property description was not set",
                "type":"integer"
            },
            "id":{
                "description":"Property description was not set",
                "type":"string"
            },
            "lastModifiedBy":{
                "description":"Property description was not set",
                "type":"string"
            },
            "scenarioId":{
                "description":"Property description was not set",
                "type":"string"
            },
            "startTime":{
                "description":"Property description was not set",
                "type":"integer"
            },
            "startedBy":{
                "description":"Property description was not set",
                "type":"string"
            },
            "status":{
                "description":"One of [CREATED, RUNNING, COMPLETED, STOPPED, FAILED].",
                "type":"string"
            }
        },
        "required":[
            "lastModifiedBy",
            "scenarioId",
            "startedBy",
            "endTime",
            "id",
            "duration",
            "status",
            "startTime"
        ],
        "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

• 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].

{
    "properties":{
        "duration":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "endTime":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "id":{
            "description":"Property description was not set",
            "type":"string"
        },
        "lastModifiedBy":{
            "description":"Property description was not set",
            "type":"string"
        },
        "scenarioId":{
            "description":"Property description was not set",
            "type":"string"
        },
        "startTime":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "startedBy":{
            "description":"Property description was not set",
            "type":"string"
        },
        "status":{
            "description":"One of [CREATED, RUNNING, COMPLETED, STOPPED, FAILED].",
            "type":"string"
        }
    },
    "required":[
        "lastModifiedBy",
        "scenarioId",
        "startedBy",
        "endTime",
        "id",
        "duration",
        "status",
        "startTime"
    ],
    "type":"object"
}

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"
}

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.

Back to Top

Examples

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/assetMonitoring/clientapi/v2/assets/{asset-id}/whatIfInvocations 

Example of Response Body

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

{
    "count":2,
    "hasMore":false,
    "items":[
        {
            "duration":12345,
            "endTime":1469184297746,
            "id":"340941d398f-3b7c",
            "lastModifiedBy":"Property description was not set",
            "scenarioId":"60cd5bae1474-1a30",
            "startTime":1469184297746,
            "startedBy":"Property description was not set",
            "status":"One of [CREATED, RUNNING, COMPLETED, STOPPED, FAILED]."
        },
        {
            "duration":12345,
            "endTime":1469184297746,
            "id":"90b66c86320-49f6",
            "lastModifiedBy":"Property description was not set",
            "scenarioId":"147560de4a1b-34b6",
            "startTime":1469184297746,
            "startedBy":"Property description was not set",
            "status":"One of [CREATED, RUNNING, COMPLETED, STOPPED, FAILED]."
        }
    ],
    "limit":10,
    "links":[
        {
            "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
            "rel":"self"
        },
        {
            "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
            "rel":"canonical"
        }
    ],
    "offset":0
} 

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/554475b54eb7-3d05/whatIfInvocations 

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