Jump to

• Request
• Response
• Examples

Retrieve shipment count

get

/fleetMonitoring/clientapi/v2/shipments/count

This operation returns the count of shipments that are filtered by a query.

Request

Query Parameters

• q(optional): string
  Query to filter subset of trips whose count will be returned. (For more information on mongoDB query parameters refer to Using mongoDB Query Syntax.)

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successfully processed.

Body ()

Root Schema : RecordsCount_receive

Type: object

Show Source

• count: integer
  Requested objects count

{
    "properties":{
        "count":{
            "description":"Requested objects count",
            "type":"integer"
        }
    },
    "required":[
        "count"
    ],
    "type":"object"
}

401 Response

Unauthorized. The request requires user authentication.

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

Examples

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/fleetMonitoring/clientapi/v2/shipments/count 

Example of Response Body

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

{
    "count":2
} 

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/fleetMonitoring/clientapi/v2/shipments/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.

Back to Top