REST API for Oracle IoT Fleet Monitoring Cloud Service

List shipment field definitions

get

/fleetMonitoring/clientapi/v2/shipments/fields

This operation returns the set of extended field definitions supported; which could be present in shipments payload.

Request

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

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 : ShipmentExtendedField_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":{
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "name",
                    "group"
                ],
                "properties":{
                    "name":{
                        "type":"string",
                        "description":"Unique name of the extended field"
                    },
                    "group":{
                        "type":"string",
                        "description":"Type of the extended field. Following group types are supported &qot;VehicleIdentifier&qot;, &qot;ShipmentIdentifier&qot;, &qot;CarrierIdentifier&qot;;One of [VehicleIdentifier, ShipmentIdentifier, CarrierIdentifier]."
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "description":"The set of API navigation links.",
            "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"
                    }
                }
            }
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean"
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "name",
            "group"
        ],
        "properties":{
            "name":{
                "type":"string",
                "description":"Unique name of the extended field"
            },
            "group":{
                "type":"string",
                "description":"Type of the extended field. Following group types are supported &qot;VehicleIdentifier&qot;, &qot;ShipmentIdentifier&qot;, &qot;CarrierIdentifier&qot;;One of [VehicleIdentifier, ShipmentIdentifier, CarrierIdentifier]."
            }
        }
    }
}

Nested Schema : links

Type: array

The set of API navigation links.

Show Source

Array of: object items

{
    "type":"array",
    "description":"The set of API navigation links.",
    "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

group: string

Type of the extended field. Following group types are supported &qot;VehicleIdentifier&qot;, &qot;ShipmentIdentifier&qot;, &qot;CarrierIdentifier&qot;;One of [VehicleIdentifier, ShipmentIdentifier, CarrierIdentifier].
name: string

Unique name of the extended field

{
    "type":"object",
    "required":[
        "name",
        "group"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Unique name of the extended field"
        },
        "group":{
            "type":"string",
            "description":"Type of the extended field. Following group types are supported &qot;VehicleIdentifier&qot;, &qot;ShipmentIdentifier&qot;, &qot;CarrierIdentifier&qot;;One of [VehicleIdentifier, ShipmentIdentifier, CarrierIdentifier]."
        }
    }
}

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.

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.

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

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

Example of Response Body

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


{
    "items":[
        {
            "name":"Unique name of the extended field",
            "group":"Type of the extended field. Following group types are supported &qot;VehicleIdentifier&qot;, &qot;ShipmentIdentifier&qot;, &qot;CarrierIdentifier&qot;;One of [VehicleIdentifier, ShipmentIdentifier, CarrierIdentifier]."
        },
        {
            "name":"Unique name of the extended field",
            "group":"Type of the extended field. Following group types are supported &qot;VehicleIdentifier&qot;, &qot;ShipmentIdentifier&qot;, &qot;CarrierIdentifier&qot;;One of [VehicleIdentifier, ShipmentIdentifier, CarrierIdentifier]."
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
        },
        {
            "rel":"canonical",
            "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
        }
    ],
    "count":2,
    "limit":10,
    "offset":0,
    "hasMore":false
}

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/fields

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.