Start a shipment
post
/fleetMonitoring/clientapi/v2/shipments/start
This operation changes the status of the given shipments from PLANNED to EN_ROUTE
Permissions
To update the shipment the request must have IoTFleetMonitoringDriversGroup role credentials.
Permissions
To update the shipment the request must have IoTFleetMonitoringDriversGroup role credentials.
Request
Supported Media Types
- application/json
Query Parameters
-
powerUnitId(optional): string
Power Unit ID
-
powerUnitRegNumber(optional): string
Entity description is undefined
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
Root Schema : BulkOperationResponse_create
Type:
Show Source
object
-
createdEntries:
array createdEntries
Property description was not set
-
errorEntries:
array errorEntries
Property description was not set
-
failedEntries:
array failedEntries
Property description was not set
-
totalEntries:
integer
Property description was not set
-
updatedEntries:
array updatedEntries
Property description was not set
Nested Schema : CreatedOrUpdatedEntry_create
Type:
Show Source
object
-
externalId:
string
Property description was not set
-
id:
string
Property description was not set
-
index:
integer
Property description was not set
-
links:
array links
Property description was not set
-
name:
string
Property description was not set
Nested Schema : RestLink_create
Type:
Show Source
object
-
:
string
Property description was not set
-
uri:
object URI_create
Nested Schema : URI_create
Type:
Show Source
object
-
absolute:
boolean
Property description was not set
-
authority:
string
Property description was not set
-
fragment:
string
Property description was not set
-
host:
string
Property description was not set
-
opaque:
boolean
Property description was not set
-
path:
string
Property description was not set
-
port:
integer
Property description was not set
-
query:
string
Property description was not set
-
rawAuthority:
string
Property description was not set
-
rawFragment:
string
Property description was not set
-
rawPath:
string
Property description was not set
-
rawQuery:
string
Property description was not set
-
rawSchemeSpecificPart:
string
Property description was not set
-
rawUserInfo:
string
Property description was not set
-
scheme:
string
Property description was not set
-
schemeSpecificPart:
string
Property description was not set
-
userInfo:
string
Property description was not set
Nested Schema : ErrorOrFailedEntry_create
Type:
Show Source
object
-
detail:
string
Property description was not set
-
errorCode:
string
Property description was not set
-
externalId:
string
Property description was not set
-
id:
string
Property description was not set
-
index:
integer
Property description was not set
-
name:
string
Property description was not set
Response
Supported Media Types
- application/json
200 Response
Successfully processed.
Root Schema : BulkOperationResponse_receive
Type:
Show Source
object
-
createdEntries:
array createdEntries
Property description was not set
-
errorEntries:
array errorEntries
Property description was not set
-
failedEntries:
array failedEntries
Property description was not set
-
totalEntries:
integer
Property description was not set
-
updatedEntries:
array updatedEntries
Property description was not set
Nested Schema : CreatedOrUpdatedEntry_receive
Type:
Show Source
object
-
externalId:
string
Property description was not set
-
id:
string
Property description was not set
-
index:
integer
Property description was not set
-
links:
array links
Property description was not set
-
name:
string
Property description was not set
Nested Schema : ErrorOrFailedEntry_receive
Type:
Show Source
object
-
detail:
string
Property description was not set
-
errorCode:
string
Property description was not set
-
externalId:
string
Property description was not set
-
id:
string
Property description was not set
-
index:
integer
Property description was not set
-
name:
string
Property description was not set
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 POST
-u <username>:<password>
-H 'Accept: application/json'
-H 'Content-Type: application/json'
https://iotserver/fleetMonitoring/clientapi/v2/shipments/start
Example of Request Body
The following example shows the content of the request body in JSON format:
{
"ids" : ["shipment_ID"]
}
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"totalEntries": 1,
"updatedEntries": [
{
"index": 0,
"id": "FB7FD9B7-11C5-49E9-B02B-E0D8547FD22C",
"externalId": "Planned-Shipment-2",
"name": "Planned_Shipment-2",
"links": [
{
"href": "https://iotserver:443/fleetMonitoring/clientapi/v2/shipments/start/FB7FD9B7-11C5-49E9-B02B-E0D8547FD22C",
"rel": "self"
}
]
}
],
"links": [
{
"href": "https://iotserver:443/fleetMonitoring/clientapi/v2/shipments/start/?powerUnitId=84AF5251-8A87-4373-B6C3-AA861B6A2E7D",
"rel": "self"
},
{
"href": "https://iotserver:443/fleetMonitoring/clientapi/v2/shipments/start/?powerUnitId=84AF5251-8A87-4373-B6C3-AA861B6A2E7D",
"rel": "canonical"
}
]
}
Complete cURL Example
The following example shows a complete cURL command that you can use to perform the described operation:
curl -X POST
-u <username>:<password>
-H 'Accept: application/json'
-H 'Content-Type: application/json'
-d '{"totalEntries":12345,"createdEntries":[{"index":12345,"id":"56b54a325902-168a","externalId":"61c65b3618d5-4b61","name":"Property description was not set","links":[{"":"Property description was not set","uri":{"schemeSpecificPart":"Property description was not set","rawAuthority":"Property description was not set","rawUserInfo":"Property description was not set","rawPath":"Property description was not set","rawQuery":"Property description was not set","rawFragment":"Property description was not set","rawSchemeSpecificPart":"Property description was not set","absolute":false,"path":"Property description was not set","opaque":false,"scheme":"Property description was not set","authority":"Property description was not set","fragment":"Property description was not set","query":"Property description was not set","host":"Property description was not set","userInfo":"Property description was not set","port":12345}}]}],"errorEntries":[{"detail":"Property description was not set","errorCode":"Property description was not set","externalId":"2a23f756e97-9c1","index":12345,"name":"Property description was not set","id":"35754a032914-40fd"}],"failedEntries":[{"detail":"Property description was not set","errorCode":"Property description was not set","externalId":"5b8124d73fa1-1f2e","index":12345,"name":"Property description was not set","id":"71774d5110e6-45c6"}],"updatedEntries":[{"index":12345,"id":"617c63204554-222e","externalId":"32d64357484a-3e2c","name":"Property description was not set","links":[{"":"Property description was not set","uri":{"schemeSpecificPart":"Property description was not set","rawAuthority":"Property description was not set","rawUserInfo":"Property description was not set","rawPath":"Property description was not set","rawQuery":"Property description was not set","rawFragment":"Property description was not set","rawSchemeSpecificPart":"Property description was not set","absolute":false,"path":"Property description was not set","opaque":false,"scheme":"Property description was not set","authority":"Property description was not set","fragment":"Property description was not set","query":"Property description was not set","host":"Property description was not set","userInfo":"Property description was not set","port":12345}}]}]}'
https://iotserver/fleetMonitoring/clientapi/v2/shipments/start
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.