curl --request POST \
--url https://api.connectedfleet.michelin.com/job-management/job/listJobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"groupName": "<string>",
"scheduledStartDateTimeFrom": "<string>",
"scheduledStartDateTimeTo": "<string>",
"personId": "<string>",
"personName": "<string>",
"vehicleId": "<string>",
"vehicleName": "<string>",
"statuses": [],
"jobTypeIds": [
"<string>"
],
"limit": 123,
"nextToken": "<string>"
}
'import requests
url = "https://api.connectedfleet.michelin.com/job-management/job/listJobs"
payload = {
"groupName": "<string>",
"scheduledStartDateTimeFrom": "<string>",
"scheduledStartDateTimeTo": "<string>",
"personId": "<string>",
"personName": "<string>",
"vehicleId": "<string>",
"vehicleName": "<string>",
"statuses": [],
"jobTypeIds": ["<string>"],
"limit": 123,
"nextToken": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
groupName: '<string>',
scheduledStartDateTimeFrom: '<string>',
scheduledStartDateTimeTo: '<string>',
personId: '<string>',
personName: '<string>',
vehicleId: '<string>',
vehicleName: '<string>',
statuses: [],
jobTypeIds: ['<string>'],
limit: 123,
nextToken: '<string>'
})
};
fetch('https://api.connectedfleet.michelin.com/job-management/job/listJobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.connectedfleet.michelin.com/job-management/job/listJobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'groupName' => '<string>',
'scheduledStartDateTimeFrom' => '<string>',
'scheduledStartDateTimeTo' => '<string>',
'personId' => '<string>',
'personName' => '<string>',
'vehicleId' => '<string>',
'vehicleName' => '<string>',
'statuses' => [
],
'jobTypeIds' => [
'<string>'
],
'limit' => 123,
'nextToken' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.connectedfleet.michelin.com/job-management/job/listJobs"
payload := strings.NewReader("{\n \"groupName\": \"<string>\",\n \"scheduledStartDateTimeFrom\": \"<string>\",\n \"scheduledStartDateTimeTo\": \"<string>\",\n \"personId\": \"<string>\",\n \"personName\": \"<string>\",\n \"vehicleId\": \"<string>\",\n \"vehicleName\": \"<string>\",\n \"statuses\": [],\n \"jobTypeIds\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"nextToken\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.connectedfleet.michelin.com/job-management/job/listJobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"groupName\": \"<string>\",\n \"scheduledStartDateTimeFrom\": \"<string>\",\n \"scheduledStartDateTimeTo\": \"<string>\",\n \"personId\": \"<string>\",\n \"personName\": \"<string>\",\n \"vehicleId\": \"<string>\",\n \"vehicleName\": \"<string>\",\n \"statuses\": [],\n \"jobTypeIds\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"nextToken\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.connectedfleet.michelin.com/job-management/job/listJobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"groupName\": \"<string>\",\n \"scheduledStartDateTimeFrom\": \"<string>\",\n \"scheduledStartDateTimeTo\": \"<string>\",\n \"personId\": \"<string>\",\n \"personName\": \"<string>\",\n \"vehicleId\": \"<string>\",\n \"vehicleName\": \"<string>\",\n \"statuses\": [],\n \"jobTypeIds\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"nextToken\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"jobs": [
{
"jobId": "<string>",
"jobNumber": "<string>",
"jobTitle": "<string>",
"clientName": "<string>",
"accountNumber": "<string>",
"contactName": "<string>",
"contactEmail": "<string>",
"contactPhone": "<string>",
"notes": "<string>",
"lat": 123,
"lng": 123,
"address": "<string>",
"statusChangeTimestamp": "<string>",
"statusChangeId": "<string>",
"scheduledStartDateTime": "<string>",
"jobDuration": "<string>",
"arrivalWindowStart": "<string>",
"arrivalWindowEnd": "<string>",
"personId": "<string>",
"vehicleId": "<string>",
"groupName": "<string>",
"personName": "<string>",
"vehicleName": "<string>",
"orderNumbers": [
"<string>"
],
"driverNotes": "<string>",
"statusHistory": [
{
"date": "<string>",
"personId": "<string>",
"name": "<string>",
"statusChangeId": "<string>"
}
],
"actualStart": "<string>",
"actualEnd": "<string>",
"overrideLat": 123,
"overrideLng": 123,
"jobHistory": [
{
"date": "<string>",
"personId": "<string>",
"name": "<string>",
"assignedPersonName": "<string>",
"assignedAssetName": "<string>"
}
],
"jobRadius": 123,
"eta": "<string>",
"etaDistanceKms": 123,
"lastEtaCalcTime": "<string>",
"jobTypeId": "<string>",
"jobType": {
"id": "<string>",
"label": "<string>",
"description": "<string>",
"global": true,
"used": true,
"disabled": true,
"key": "<string>",
"earliestStartTime": 123,
"latestStartTime": 123,
"duration": "<string>",
"notes": "<string>",
"resources": [
{
"name": "<string>",
"fileType": "<string>",
"storageUrl": "<string>",
"uploadUrl": "<string>",
"presignedGetUrl": "<string>"
}
],
"sendJobReportOnCompletion": true,
"workflowId": "<string>"
},
"jobPhotos": [
{
"date": "<string>",
"downloadUrl": "<string>"
}
],
"jobSignature": {
"date": "<string>",
"downloadUrl": "<string>",
"signeeName": "<string>"
},
"linkingId": "<string>",
"linkedJobDescription": "<string>",
"linkedJobIndex": "<string>",
"resources": [
{
"name": "<string>",
"fileType": "<string>",
"storageUrl": "<string>",
"uploadUrl": "<string>",
"presignedGetUrl": "<string>"
}
],
"subStatus": {
"key": "<string>",
"value": "<string>"
},
"lastServerTime": "<string>",
"visitResults": [
{
"jobScheduledStart": "<string>",
"taskAnswers": [
{
"title": "<string>",
"description": "<string>",
"key": "<string>",
"statusChangeId": "<string>",
"timestamp": "<string>",
"nextTaskKey": "<string>",
"onTransitionTo": "<string>",
"mandatory": true,
"includeInReport": true,
"value": {
"stringValues": [
"<string>"
],
"integerValue": 123,
"doubleValue": 123,
"blobValues": [
"<string>"
]
},
"onTransitionToLabel": "<string>",
"personId": "<string>",
"personName": "<string>"
}
]
}
],
"subStatusLabel": "<string>",
"statusLabel": "<string>"
}
],
"nextToken": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
],
"count": 123
}List jobs
POST request to retrieve a list of jobs. Jobs are ordered in ascending scheduledStartDateTime order.
curl --request POST \
--url https://api.connectedfleet.michelin.com/job-management/job/listJobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"groupName": "<string>",
"scheduledStartDateTimeFrom": "<string>",
"scheduledStartDateTimeTo": "<string>",
"personId": "<string>",
"personName": "<string>",
"vehicleId": "<string>",
"vehicleName": "<string>",
"statuses": [],
"jobTypeIds": [
"<string>"
],
"limit": 123,
"nextToken": "<string>"
}
'import requests
url = "https://api.connectedfleet.michelin.com/job-management/job/listJobs"
payload = {
"groupName": "<string>",
"scheduledStartDateTimeFrom": "<string>",
"scheduledStartDateTimeTo": "<string>",
"personId": "<string>",
"personName": "<string>",
"vehicleId": "<string>",
"vehicleName": "<string>",
"statuses": [],
"jobTypeIds": ["<string>"],
"limit": 123,
"nextToken": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
groupName: '<string>',
scheduledStartDateTimeFrom: '<string>',
scheduledStartDateTimeTo: '<string>',
personId: '<string>',
personName: '<string>',
vehicleId: '<string>',
vehicleName: '<string>',
statuses: [],
jobTypeIds: ['<string>'],
limit: 123,
nextToken: '<string>'
})
};
fetch('https://api.connectedfleet.michelin.com/job-management/job/listJobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.connectedfleet.michelin.com/job-management/job/listJobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'groupName' => '<string>',
'scheduledStartDateTimeFrom' => '<string>',
'scheduledStartDateTimeTo' => '<string>',
'personId' => '<string>',
'personName' => '<string>',
'vehicleId' => '<string>',
'vehicleName' => '<string>',
'statuses' => [
],
'jobTypeIds' => [
'<string>'
],
'limit' => 123,
'nextToken' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.connectedfleet.michelin.com/job-management/job/listJobs"
payload := strings.NewReader("{\n \"groupName\": \"<string>\",\n \"scheduledStartDateTimeFrom\": \"<string>\",\n \"scheduledStartDateTimeTo\": \"<string>\",\n \"personId\": \"<string>\",\n \"personName\": \"<string>\",\n \"vehicleId\": \"<string>\",\n \"vehicleName\": \"<string>\",\n \"statuses\": [],\n \"jobTypeIds\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"nextToken\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.connectedfleet.michelin.com/job-management/job/listJobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"groupName\": \"<string>\",\n \"scheduledStartDateTimeFrom\": \"<string>\",\n \"scheduledStartDateTimeTo\": \"<string>\",\n \"personId\": \"<string>\",\n \"personName\": \"<string>\",\n \"vehicleId\": \"<string>\",\n \"vehicleName\": \"<string>\",\n \"statuses\": [],\n \"jobTypeIds\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"nextToken\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.connectedfleet.michelin.com/job-management/job/listJobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"groupName\": \"<string>\",\n \"scheduledStartDateTimeFrom\": \"<string>\",\n \"scheduledStartDateTimeTo\": \"<string>\",\n \"personId\": \"<string>\",\n \"personName\": \"<string>\",\n \"vehicleId\": \"<string>\",\n \"vehicleName\": \"<string>\",\n \"statuses\": [],\n \"jobTypeIds\": [\n \"<string>\"\n ],\n \"limit\": 123,\n \"nextToken\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"jobs": [
{
"jobId": "<string>",
"jobNumber": "<string>",
"jobTitle": "<string>",
"clientName": "<string>",
"accountNumber": "<string>",
"contactName": "<string>",
"contactEmail": "<string>",
"contactPhone": "<string>",
"notes": "<string>",
"lat": 123,
"lng": 123,
"address": "<string>",
"statusChangeTimestamp": "<string>",
"statusChangeId": "<string>",
"scheduledStartDateTime": "<string>",
"jobDuration": "<string>",
"arrivalWindowStart": "<string>",
"arrivalWindowEnd": "<string>",
"personId": "<string>",
"vehicleId": "<string>",
"groupName": "<string>",
"personName": "<string>",
"vehicleName": "<string>",
"orderNumbers": [
"<string>"
],
"driverNotes": "<string>",
"statusHistory": [
{
"date": "<string>",
"personId": "<string>",
"name": "<string>",
"statusChangeId": "<string>"
}
],
"actualStart": "<string>",
"actualEnd": "<string>",
"overrideLat": 123,
"overrideLng": 123,
"jobHistory": [
{
"date": "<string>",
"personId": "<string>",
"name": "<string>",
"assignedPersonName": "<string>",
"assignedAssetName": "<string>"
}
],
"jobRadius": 123,
"eta": "<string>",
"etaDistanceKms": 123,
"lastEtaCalcTime": "<string>",
"jobTypeId": "<string>",
"jobType": {
"id": "<string>",
"label": "<string>",
"description": "<string>",
"global": true,
"used": true,
"disabled": true,
"key": "<string>",
"earliestStartTime": 123,
"latestStartTime": 123,
"duration": "<string>",
"notes": "<string>",
"resources": [
{
"name": "<string>",
"fileType": "<string>",
"storageUrl": "<string>",
"uploadUrl": "<string>",
"presignedGetUrl": "<string>"
}
],
"sendJobReportOnCompletion": true,
"workflowId": "<string>"
},
"jobPhotos": [
{
"date": "<string>",
"downloadUrl": "<string>"
}
],
"jobSignature": {
"date": "<string>",
"downloadUrl": "<string>",
"signeeName": "<string>"
},
"linkingId": "<string>",
"linkedJobDescription": "<string>",
"linkedJobIndex": "<string>",
"resources": [
{
"name": "<string>",
"fileType": "<string>",
"storageUrl": "<string>",
"uploadUrl": "<string>",
"presignedGetUrl": "<string>"
}
],
"subStatus": {
"key": "<string>",
"value": "<string>"
},
"lastServerTime": "<string>",
"visitResults": [
{
"jobScheduledStart": "<string>",
"taskAnswers": [
{
"title": "<string>",
"description": "<string>",
"key": "<string>",
"statusChangeId": "<string>",
"timestamp": "<string>",
"nextTaskKey": "<string>",
"onTransitionTo": "<string>",
"mandatory": true,
"includeInReport": true,
"value": {
"stringValues": [
"<string>"
],
"integerValue": 123,
"doubleValue": 123,
"blobValues": [
"<string>"
]
},
"onTransitionToLabel": "<string>",
"personId": "<string>",
"personName": "<string>"
}
]
}
],
"subStatusLabel": "<string>",
"statusLabel": "<string>"
}
],
"nextToken": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
],
"count": 123
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Name of a group. Must be specified if a value for either personName or vehicleName is not specified
Start of the period of scheduled fulfilment date, in UTC, in the format of either YYYY-MM-DD or YYYY-MM-DDThh:mmZ.
End of the period of scheduled fulfilment date, in UTC, in the format of either YYYY-MM-DD or YYYY-MM-DDThh:mmZ.
ID of the person
Name of a driver that has been assigned a job. Must be specified if a value for either vehicleName or groupName is not specified.
ID of the vehicle
Name of a vehicle that has been assigned a job. Must be specified if a value for either personName or groupName is not specified.
Jobs with the specified status will be included in the response e.g. NEW, ASSIGNED, IN_PROGRESS, ACCEPTED, VISITED.
NEW, ASSIGNED, RECEIVED, IN_PROGRESS, VISITED, CANCELLED, MISSED, ACCEPTED, INCOMPLETE, $UNKNOWN Jobs with the specified job type will be included in the response.
The number of jobs to include in the output. If not specified, it will default to 20. Advise this is not set to greater than 1000 to avoid any issues with response size.
Token returned in a previous call to this endpoint to get the next set of details.
Was this page helpful?
