REST API for Oracle IoT Fleet Monitoring Cloud Service

Retrieve incident occurrence count

get

/fleetMonitoring/clientapi/v2/incidents/{incident-id}/occurrences/count

This operation returns the count of all the occurrences of an incident that is specified by its incident ID.

Request

Path Parameters

incident-id: string

ID of the incident that contain the occurrences.

Header Parameters

X-ORACLE-IOT-ORG(optional): string

To allow targeting requests to different organizations. The header value should contain the organization identifier(orgId). This header is optional, if not provided orgId will be ORA_DEFAULT_ORG

Response

Supported Media Types

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

200 Response

Successfully processed.

Root Schema : RuleOccurrence_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)

{
    "type":"object",
    "required":[
        "items",
        "links",
        "limit",
        "offset",
        "count",
        "hasMore"
    ],
    "properties":{
        "offset":{
            "format":"int32",
            "type":"integer"
        },
        "count":{
            "format":"int32",
            "type":"integer"
        },
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "links":{
            "description":"The set of API navigation links.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "description":"Relation type",
                        "type":"string",
                        "example":"canonical"
                    },
                    "href":{
                        "description":"The target resource URI",
                        "type":"string",
                        "example":"https://iotserver/iot/api/vX/some/API/path"
                    }
                }
            }
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "id",
                    "incidentId",
                    "time",
                    "satisfiedPredicates"
                ],
                "properties":{
                    "satisfiedPredicates":{
                        "description":"Property description was not set",
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/SatisfiedPredicate_receive"
                        }
                    },
                    "links":{
                        "description":"The set of API navigation links.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "rel":{
                                    "description":"Relation type",
                                    "type":"string",
                                    "example":"canonical"
                                },
                                "href":{
                                    "description":"The target resource URI",
                                    "type":"string",
                                    "example":"https://iotserver/iot/api/vX/some/API/path"
                                }
                            }
                        }
                    },
                    "id":{
                        "description":"Property description was not set",
                        "type":"string"
                    },
                    "time":{
                        "description":"Property description was not set",
                        "type":"integer"
                    },
                    "incidentId":{
                        "description":"Property description was not set",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "id",
            "incidentId",
            "time",
            "satisfiedPredicates"
        ],
        "properties":{
            "satisfiedPredicates":{
                "description":"Property description was not set",
                "type":"array",
                "items":{
                    "$ref":"#/definitions/SatisfiedPredicate_receive"
                }
            },
            "links":{
                "description":"The set of API navigation links.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "rel":{
                            "description":"Relation type",
                            "type":"string",
                            "example":"canonical"
                        },
                        "href":{
                            "description":"The target resource URI",
                            "type":"string",
                            "example":"https://iotserver/iot/api/vX/some/API/path"
                        }
                    }
                }
            },
            "id":{
                "description":"Property description was not set",
                "type":"string"
            },
            "time":{
                "description":"Property description was not set",
                "type":"integer"
            },
            "incidentId":{
                "description":"Property description was not set",
                "type":"string"
            }
        }
    }
}

Nested Schema : links

Type: array

The set of API navigation links.

Show Source

Array of: object items

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

Nested Schema : items

Type: object

Show Source

id: string

Property description was not set
incidentId: string

Property description was not set
links(optional): array links

The set of API navigation links.
satisfiedPredicates: array satisfiedPredicates

Property description was not set
time: integer

Property description was not set

{
    "type":"object",
    "required":[
        "id",
        "incidentId",
        "time",
        "satisfiedPredicates"
    ],
    "properties":{
        "satisfiedPredicates":{
            "description":"Property description was not set",
            "type":"array",
            "items":{
                "$ref":"#/definitions/SatisfiedPredicate_receive"
            }
        },
        "links":{
            "description":"The set of API navigation links.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "description":"Relation type",
                        "type":"string",
                        "example":"canonical"
                    },
                    "href":{
                        "description":"The target resource URI",
                        "type":"string",
                        "example":"https://iotserver/iot/api/vX/some/API/path"
                    }
                }
            }
        },
        "id":{
            "description":"Property description was not set",
            "type":"string"
        },
        "time":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "incidentId":{
            "description":"Property description was not set",
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

The set of API navigation links.

Show Source

Array of: object items

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

Nested Schema : satisfiedPredicates

Type: array

Property description was not set

Show Source

Array of: object SatisfiedPredicate_receive

{
    "description":"Property description was not set",
    "type":"array",
    "items":{
        "$ref":"#/definitions/SatisfiedPredicate_receive"
    }
}

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

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

Nested Schema : SatisfiedPredicate_receive

Type: object

Show Source

information: object information

Additional Properties Allowed: additionalProperties

Property description was not set
links(optional): array links

The set of API navigation links.
type: string

Property description was not set

{
    "type":"object",
    "required":[
        "type",
        "information"
    ],
    "properties":{
        "information":{
            "description":"Property description was not set",
            "additionalProperties":{
                "description":"Map of the following type: Map&lt;String, String&gt;",
                "type":"string"
            },
            "type":"object",
            "properties":{
            }
        },
        "links":{
            "description":"The set of API navigation links.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "description":"Relation type",
                        "type":"string",
                        "example":"canonical"
                    },
                    "href":{
                        "description":"The target resource URI",
                        "type":"string",
                        "example":"https://iotserver/iot/api/vX/some/API/path"
                    }
                }
            }
        },
        "type":{
            "description":"Property description was not set",
            "type":"string"
        }
    }
}

Nested Schema : information

Type: object

Additional Properties Allowed

Show Source

string

Map of the following type: Map<String, String>

{
    "description":"Property description was not set",
    "additionalProperties":{
        "description":"Map of the following type: Map&lt;String, String&gt;",
        "type":"string"
    },
    "type":"object",
    "properties":{
    }
}

Property description was not set

Show Source

{
    "description":"Property description was not set",
    "additionalProperties":{
        "description":"Map of the following type: Map&lt;String, String&gt;",
        "type":"string"
    },
    "type":"object",
    "properties":{
    }
}

Nested Schema : links

Type: array

The set of API navigation links.

Show Source

Array of: object items

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

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

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

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

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

401 Response

Unauthorized. The request requires user authentication.

406 Response

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

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/fleetMonitoring/clientapi/v2/incidents/{incident-id}/occurrences/count

Example of Response Body

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

 {
   "count":2,
  "links":[
      {
         "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path/",
         "rel":"self"
      },
      {
         "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path/",
         "rel":"canonical"
      }
   ]
}

Complete cURL Example

The following example shows the complete cURL command that can be used to perform the described operation:

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/fleetMonitoring/clientapi/v2/incidents/196869166390-16a9/occurrences/count

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.