JWT is the most common authentication method you will use. These are used in our frontend application.
Also these are the only tokens that can be used inter-domain in the same deployment
Authorization: Bearer [YOUR TOKEN]
Persistent tokens are similar to user tokens, but they will not be invalidated after a time period or when logging out.
Authorization: API-Key [YOUR TOKEN]
SDK tokens are used for authenticating sdk based URLs and can be namespaced to prevent from too much access
Authorization: SDK-Key [YOUR TOKEN]
You will occasionally see that some sections have a V2
suffix, which means that those endpoints
are second generation ones. The main difference between the two other than section specific changes
is the possibility to expand related properties that are displayed as related keys (in most cases
those are UUIDs).
To expand a property simply add expand
query parameter with the desired key to expand.
Our API supports multiple expand
keywords in the URL.
Example:
https://app.meilirobots.com/api/v2/team/your-team/tasks/
{
...
"user": "b2a4038eaa6341d7a3cbe7c29635b1e3",
...
}
https://app.meilirobots.com/api/v2/team/your-team/tasks/?expand=user
{
...
"user": {
"uuid": "b2a4038eaa6341d7a3cbe7c29635b1e3",
...
}
...
}
Create User Authentication details
email required | string <email> |
password required | string |
{- "email": "johndoe@meilirobots.com",
- "password": "string"
}
{- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true,
- "token": "ed5a63a0caa045bc7429ad24efd6591195523ece"
}
Create a new persistent token
name required | string |
{- "name": "R1 Token"
}
{- "uuid": "ed5a63a0caa045bc7d29ad24efd6591195523ece",
- "name": "R1 Token",
- "created": "2019-08-24T14:15:22Z",
- "site": "app.meilirobots.com"
}
Get user persistent API token
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "ed5a63a0caa045bc7d29ad24efd6591195523ece",
- "name": "R1 Token",
- "created": "2019-08-24T14:15:22Z",
- "site": "app.meilirobots.com"
}
List all SDK tokens belonging to the organization
required | string or string UUID or SLUG of the target resource |
[- {
- "uuid": "f5ab0e553f1f4d03b9e84fd5cb7c7b3a",
- "name": "Task manager token",
- "task_access": true,
- "vehicle_access": true,
- "form_access": true,
- "created": "2019-08-24T14:15:22Z"
}
]
Create a new SDK token and attach it to the organization and the domain
required | string or string UUID or SLUG of the target resource |
name required | string |
task_access | boolean |
vehicle_access | boolean |
form_access | boolean |
{- "name": "Task manager token",
- "task_access": true,
- "vehicle_access": true,
- "form_access": true
}
[- {
- "uuid": "f5ab0e553f1f4d03b9e84fd5cb7c7b3a",
- "name": "Task manager token",
- "task_access": true,
- "vehicle_access": true,
- "form_access": true,
- "created": "2019-08-24T14:15:22Z"
}
]
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "f5ab0e553f1f4d03b9e84fd5cb7c7b3a",
- "name": "Task manager token",
- "task_access": true,
- "vehicle_access": true,
- "form_access": true,
- "created": "2019-08-24T14:15:22Z"
}
ActionTrail is a part of the application that provides users insights into the decision making process of inside the FMS. Here we log decisions and details about them from developers perspective.
Return a list of group logs
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "count": 1,
- "next": null,
- "page": 1,
- "previous": null,
- "results": [
- {
- "uuid": "02b4a0a9cc9246259b3911b31b3a8233",
- "message": "Task moved to rerun queue due to insufficient vehicles",
- "created_at": "2019-08-24T14:15:22Z"
}
]
}
If required you can get a detailed view of each log item including the serialized related objects, nature of their relationship as well as predefined set of extra details
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "02b4a0a9cc9246259b3911b31b3a8233",
- "message": "Task moved to rerun queue due to insufficient vehicles",
- "created_at": "2019-08-24T14:15:22Z",
- "details": "At the moment of task allocation process there were no available vehicles connected\nto the FMS, therefore Task was moved to rerun status to be executed in later iteration\n",
- "related_objects": [
- {
- "detail": "Current subtask at the moment of iteration\n",
- "object_type": "subtask",
- "serialized_object": {
- "uuid": "76a97471652d49b5b12bb771ea6ce83c",
- "executed_at": null,
- "index": 1,
- "status": "in_progress"
}
}
]
}
Return a list of team action log groups organized by time.
Logs are organized by hour
required | string or string UUID or SLUG of the target resource |
[- {
- "uuid": "02b4a0a9cc9246259b3911b31b3a8233",
- "created_at": "2019-08-24T14:15:22Z"
}
]
Using this endpoint, you can create a new dashboard view It will be create as a copy of the default dashboard preset by the admin
required | string or string UUID or SLUG of the target resource |
title | string |
is_default | boolean |
{- "title": "My View",
- "is_default": false
}
{- "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "title": "My View",
- "is_default": false,
- "is_preset": false
}
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
[- {
- "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "title": "Tasks Overview",
- "location": 100,
- "compatible_display_types": [
- "numbers",
- "pie",
- "donut",
- "bar"
], - "unit": "%",
- "show_legend": false,
- "api_url": "/notifications/"
}
]
required | string or string UUID or SLUG of the target resource |
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
[- {
- "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "title": "Default",
- "is_default": true,
- "dashboard_cards": [
- {
- "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "title": "Tasks",
- "is_hidden": false,
- "show_legend": false,
- "location": 100,
- "data": [
- {
- "label": "Total tasks",
- "value": 53
}
]
}
]
}
]
required | string or string UUID or SLUG of the target resource |
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
from_date | string <date> |
to_date | string <date> |
vehicle_categories | Array of strings <uuid> |
{- "from_date": "2022-01-01",
- "to_date": "2023-01-01",
- "vehicle_categories": [
- [
- "e7c4611dd9fa4b9f8c8cbaa70bbbf20d"
]
]
}
[- {
- "from_date": "2020-01-01",
- "to_date": "2020-01-01",
- "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "title": "Default",
- "dashboard_cards": [
- {
- "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "title": "Tasks",
- "is_hidden": false,
- "show_legend": false,
- "location": 100,
- "data": [
- {
- "label": "Total tasks",
- "value": 53
}
]
}
]
}
]
required | string or string UUID or SLUG of the target resource |
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
[- {
- "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "title": "Default",
- "is_default": true,
- "dashboard_cards": [
- {
- "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "title": "Tasks",
- "is_hidden": false,
- "show_legend": false,
- "location": 100,
- "data": [
- {
- "label": "Total tasks",
- "value": 53
}
]
}
]
}
]
required | string or string UUID or SLUG of the target resource |
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
[- {
- "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "title": "Tasks Overview",
- "location": 100,
- "display_type": "number_comparison",
- "unit": "%",
- "show_legend": false,
- "api_url": "string"
}
]
Using this endpoint, you can edit/delete cards inside an array If a card is not sent in the request body, it will be deleted Allows to change the location of the cards and other properties If sent as an object (dict) a new card will be created from the chosen preset.
required | string or string UUID or SLUG of the target resource |
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
title | string |
location required | number <integer> |
card_preset required | string <uuid> |
display_type | string |
unit | string |
show_legend | boolean |
[ ]
[- {
- "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "title": "Tasks Overview",
- "location": 100,
- "display_type": "number_comparison",
- "unit": "%",
- "show_legend": false,
- "api_url": "string"
}
]
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
title | string |
location | number <integer> |
display_type | string |
unit | string |
show_legend | boolean |
{- "title": "Total Tasks",
- "location": 100,
- "display_type": "number_comparison",
- "unit": "meters/sec",
- "show_legend": false
}
[- {
- "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "title": "Tasks Overview",
- "location": 100,
- "display_type": "number_comparison",
- "unit": "%",
- "show_legend": false,
- "api_url": "string"
}
]
required | string or string UUID or SLUG of the target resource |
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
[- {
- "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "title": "Tasks Overview",
- "location": 100,
- "display_type": "number_comparison",
- "unit": "%",
- "show_legend": false,
- "api_url": "string"
}
]
Using this endpoint, you can edit/delete cards inside an array If a card is not sent in the request body, it will be deleted Allows to change the location of the cards and other properties If sent as an object (dict) a new card will be created from the chosen preset.
required | string or string UUID or SLUG of the target resource |
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
title | string |
location required | number <integer> |
card_preset required | string <uuid> |
display_type | string |
unit | string |
show_legend | boolean |
[ ]
[- {
- "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "title": "Tasks Overview",
- "location": 100,
- "display_type": "number_comparison",
- "unit": "%",
- "show_legend": false,
- "api_url": "string"
}
]
[- "Africa/Abidjan",
- "Africa/Accra",
- "Africa/Addis_Ababa",
- "Africa/Algiers",
- "Africa/Asmara",
- "Africa/Asmera",
- "Africa/Bamako",
- "Africa/Bangui",
- "Africa/Banjul",
- "Africa/Bissau",
- "Africa/Blantyre",
- "Africa/Brazzaville",
- "Africa/Bujumbura",
- "Africa/Cairo",
- "Africa/Casablanca",
- "Africa/Ceuta",
- "Africa/Conakry",
- "Africa/Dakar",
- "Africa/Dar_es_Salaam",
- "Africa/Djibouti",
- "Africa/Douala",
- "Africa/El_Aaiun",
- "Africa/Freetown",
- "Africa/Gaborone",
- "Africa/Harare",
- "Africa/Johannesburg",
- "Africa/Juba",
- "Africa/Kampala",
- "Africa/Khartoum",
- "Africa/Kigali",
- "Africa/Kinshasa",
- "Africa/Lagos",
- "Africa/Libreville",
- "Africa/Lome",
- "Africa/Luanda",
- "Africa/Lubumbashi",
- "Africa/Lusaka",
- "Africa/Malabo",
- "Africa/Maputo",
- "Africa/Maseru",
- "Africa/Mbabane",
- "Africa/Mogadishu",
- "Africa/Monrovia",
- "Africa/Nairobi",
- "Africa/Ndjamena",
- "Africa/Niamey",
- "Africa/Nouakchott",
- "Africa/Ouagadougou",
- "Africa/Porto-Novo",
- "Africa/Sao_Tome",
- "Africa/Timbuktu",
- "Africa/Tripoli",
- "Africa/Tunis",
- "Africa/Windhoek",
- "America/Adak",
- "America/Anchorage",
- "America/Anguilla",
- "America/Antigua",
- "America/Araguaina",
- "America/Argentina/Buenos_Aires",
- "America/Argentina/Catamarca",
- "America/Argentina/ComodRivadavia",
- "America/Argentina/Cordoba",
- "America/Argentina/Jujuy",
- "America/Argentina/La_Rioja",
- "America/Argentina/Mendoza",
- "America/Argentina/Rio_Gallegos",
- "America/Argentina/Salta",
- "America/Argentina/San_Juan",
- "America/Argentina/San_Luis",
- "America/Argentina/Tucuman",
- "America/Argentina/Ushuaia",
- "America/Aruba",
- "America/Asuncion",
- "America/Atikokan",
- "America/Atka",
- "America/Bahia",
- "America/Bahia_Banderas",
- "America/Barbados",
- "America/Belem",
- "America/Belize",
- "America/Blanc-Sablon",
- "America/Boa_Vista",
- "America/Bogota",
- "America/Boise",
- "America/Buenos_Aires",
- "America/Cambridge_Bay",
- "America/Campo_Grande",
- "America/Cancun",
- "America/Caracas",
- "America/Catamarca",
- "America/Cayenne",
- "America/Cayman",
- "America/Chicago",
- "America/Chihuahua",
- "America/Coral_Harbour",
- "America/Cordoba",
- "America/Costa_Rica",
- "America/Creston",
- "America/Cuiaba",
- "America/Curacao",
- "America/Danmarkshavn",
- "America/Dawson",
- "America/Dawson_Creek",
- "America/Denver",
- "America/Detroit",
- "America/Dominica",
- "America/Edmonton",
- "America/Eirunepe",
- "America/El_Salvador",
- "America/Ensenada",
- "America/Fort_Nelson",
- "America/Fort_Wayne",
- "America/Fortaleza",
- "America/Glace_Bay",
- "America/Godthab",
- "America/Goose_Bay",
- "America/Grand_Turk",
- "America/Grenada",
- "America/Guadeloupe",
- "America/Guatemala",
- "America/Guayaquil",
- "America/Guyana",
- "America/Halifax",
- "America/Havana",
- "America/Hermosillo",
- "America/Indiana/Indianapolis",
- "America/Indiana/Knox",
- "America/Indiana/Marengo",
- "America/Indiana/Petersburg",
- "America/Indiana/Tell_City",
- "America/Indiana/Vevay",
- "America/Indiana/Vincennes",
- "America/Indiana/Winamac",
- "America/Indianapolis",
- "America/Inuvik",
- "America/Iqaluit",
- "America/Jamaica",
- "America/Jujuy",
- "America/Juneau",
- "America/Kentucky/Louisville",
- "America/Kentucky/Monticello",
- "America/Knox_IN",
- "America/Kralendijk",
- "America/La_Paz",
- "America/Lima",
- "America/Los_Angeles",
- "America/Louisville",
- "America/Lower_Princes",
- "America/Maceio",
- "America/Managua",
- "America/Manaus",
- "America/Marigot",
- "America/Martinique",
- "America/Matamoros",
- "America/Mazatlan",
- "America/Mendoza",
- "America/Menominee",
- "America/Merida",
- "America/Metlakatla",
- "America/Mexico_City",
- "America/Miquelon",
- "America/Moncton",
- "America/Monterrey",
- "America/Montevideo",
- "America/Montreal",
- "America/Montserrat",
- "America/Nassau",
- "America/New_York",
- "America/Nipigon",
- "America/Nome",
- "America/Noronha",
- "America/North_Dakota/Beulah",
- "America/North_Dakota/Center",
- "America/North_Dakota/New_Salem",
- "America/Nuuk",
- "America/Ojinaga",
- "America/Panama",
- "America/Pangnirtung",
- "America/Paramaribo",
- "America/Phoenix",
- "America/Port-au-Prince",
- "America/Port_of_Spain",
- "America/Porto_Acre",
- "America/Porto_Velho",
- "America/Puerto_Rico",
- "America/Punta_Arenas",
- "America/Rainy_River",
- "America/Rankin_Inlet",
- "America/Recife",
- "America/Regina",
- "America/Resolute",
- "America/Rio_Branco",
- "America/Rosario",
- "America/Santa_Isabel",
- "America/Santarem",
- "America/Santiago",
- "America/Santo_Domingo",
- "America/Sao_Paulo",
- "America/Scoresbysund",
- "America/Shiprock",
- "America/Sitka",
- "America/St_Barthelemy",
- "America/St_Johns",
- "America/St_Kitts",
- "America/St_Lucia",
- "America/St_Thomas",
- "America/St_Vincent",
- "America/Swift_Current",
- "America/Tegucigalpa",
- "America/Thule",
- "America/Thunder_Bay",
- "America/Tijuana",
- "America/Toronto",
- "America/Tortola",
- "America/Vancouver",
- "America/Virgin",
- "America/Whitehorse",
- "America/Winnipeg",
- "America/Yakutat",
- "America/Yellowknife",
- "Antarctica/Casey",
- "Antarctica/Davis",
- "Antarctica/DumontDUrville",
- "Antarctica/Macquarie",
- "Antarctica/Mawson",
- "Antarctica/McMurdo",
- "Antarctica/Palmer",
- "Antarctica/Rothera",
- "Antarctica/South_Pole",
- "Antarctica/Syowa",
- "Antarctica/Troll",
- "Antarctica/Vostok",
- "Arctic/Longyearbyen",
- "Asia/Aden",
- "Asia/Almaty",
- "Asia/Amman",
- "Asia/Anadyr",
- "Asia/Aqtau",
- "Asia/Aqtobe",
- "Asia/Ashgabat",
- "Asia/Ashkhabad",
- "Asia/Atyrau",
- "Asia/Baghdad",
- "Asia/Bahrain",
- "Asia/Baku",
- "Asia/Bangkok",
- "Asia/Barnaul",
- "Asia/Beirut",
- "Asia/Bishkek",
- "Asia/Brunei",
- "Asia/Calcutta",
- "Asia/Chita",
- "Asia/Choibalsan",
- "Asia/Chongqing",
- "Asia/Chungking",
- "Asia/Colombo",
- "Asia/Dacca",
- "Asia/Damascus",
- "Asia/Dhaka",
- "Asia/Dili",
- "Asia/Dubai",
- "Asia/Dushanbe",
- "Asia/Famagusta",
- "Asia/Gaza",
- "Asia/Harbin",
- "Asia/Hebron",
- "Asia/Ho_Chi_Minh",
- "Asia/Hong_Kong",
- "Asia/Hovd",
- "Asia/Irkutsk",
- "Asia/Istanbul",
- "Asia/Jakarta",
- "Asia/Jayapura",
- "Asia/Jerusalem",
- "Asia/Kabul",
- "Asia/Kamchatka",
- "Asia/Karachi",
- "Asia/Kashgar",
- "Asia/Kathmandu",
- "Asia/Katmandu",
- "Asia/Khandyga",
- "Asia/Kolkata",
- "Asia/Krasnoyarsk",
- "Asia/Kuala_Lumpur",
- "Asia/Kuching",
- "Asia/Kuwait",
- "Asia/Macao",
- "Asia/Macau",
- "Asia/Magadan",
- "Asia/Makassar",
- "Asia/Manila",
- "Asia/Muscat",
- "Asia/Nicosia",
- "Asia/Novokuznetsk",
- "Asia/Novosibirsk",
- "Asia/Omsk",
- "Asia/Oral",
- "Asia/Phnom_Penh",
- "Asia/Pontianak",
- "Asia/Pyongyang",
- "Asia/Qatar",
- "Asia/Qostanay",
- "Asia/Qyzylorda",
- "Asia/Rangoon",
- "Asia/Riyadh",
- "Asia/Saigon",
- "Asia/Sakhalin",
- "Asia/Samarkand",
- "Asia/Seoul",
- "Asia/Shanghai",
- "Asia/Singapore",
- "Asia/Srednekolymsk",
- "Asia/Taipei",
- "Asia/Tashkent",
- "Asia/Tbilisi",
- "Asia/Tehran",
- "Asia/Tel_Aviv",
- "Asia/Thimbu",
- "Asia/Thimphu",
- "Asia/Tokyo",
- "Asia/Tomsk",
- "Asia/Ujung_Pandang",
- "Asia/Ulaanbaatar",
- "Asia/Ulan_Bator",
- "Asia/Urumqi",
- "Asia/Ust-Nera",
- "Asia/Vientiane",
- "Asia/Vladivostok",
- "Asia/Yakutsk",
- "Asia/Yangon",
- "Asia/Yekaterinburg",
- "Asia/Yerevan",
- "Atlantic/Azores",
- "Atlantic/Bermuda",
- "Atlantic/Canary",
- "Atlantic/Cape_Verde",
- "Atlantic/Faeroe",
- "Atlantic/Faroe",
- "Atlantic/Jan_Mayen",
- "Atlantic/Madeira",
- "Atlantic/Reykjavik",
- "Atlantic/South_Georgia",
- "Atlantic/St_Helena",
- "Atlantic/Stanley",
- "Australia/ACT",
- "Australia/Adelaide",
- "Australia/Brisbane",
- "Australia/Broken_Hill",
- "Australia/Canberra",
- "Australia/Currie",
- "Australia/Darwin",
- "Australia/Eucla",
- "Australia/Hobart",
- "Australia/LHI",
- "Australia/Lindeman",
- "Australia/Lord_Howe",
- "Australia/Melbourne",
- "Australia/NSW",
- "Australia/North",
- "Australia/Perth",
- "Australia/Queensland",
- "Australia/South",
- "Australia/Sydney",
- "Australia/Tasmania",
- "Australia/Victoria",
- "Australia/West",
- "Australia/Yancowinna",
- "Brazil/Acre",
- "Brazil/DeNoronha",
- "Brazil/East",
- "Brazil/West",
- "CET",
- "CST6CDT",
- "Canada/Atlantic",
- "Canada/Central",
- "Canada/Eastern",
- "Canada/Mountain",
- "Canada/Newfoundland",
- "Canada/Pacific",
- "Canada/Saskatchewan",
- "Canada/Yukon",
- "Chile/Continental",
- "Chile/EasterIsland",
- "Cuba",
- "EET",
- "EST",
- "EST5EDT",
- "Egypt",
- "Eire",
- "Etc/GMT",
- "Etc/GMT+0",
- "Etc/GMT+1",
- "Etc/GMT+10",
- "Etc/GMT+11",
- "Etc/GMT+12",
- "Etc/GMT+2",
- "Etc/GMT+3",
- "Etc/GMT+4",
- "Etc/GMT+5",
- "Etc/GMT+6",
- "Etc/GMT+7",
- "Etc/GMT+8",
- "Etc/GMT+9",
- "Etc/GMT-0",
- "Etc/GMT-1",
- "Etc/GMT-10",
- "Etc/GMT-11",
- "Etc/GMT-12",
- "Etc/GMT-13",
- "Etc/GMT-14",
- "Etc/GMT-2",
- "Etc/GMT-3",
- "Etc/GMT-4",
- "Etc/GMT-5",
- "Etc/GMT-6",
- "Etc/GMT-7",
- "Etc/GMT-8",
- "Etc/GMT-9",
- "Etc/GMT0",
- "Etc/Greenwich",
- "Etc/UCT",
- "Etc/UTC",
- "Etc/Universal",
- "Etc/Zulu",
- "Europe/Amsterdam",
- "Europe/Andorra",
- "Europe/Astrakhan",
- "Europe/Athens",
- "Europe/Belfast",
- "Europe/Belgrade",
- "Europe/Berlin",
- "Europe/Bratislava",
- "Europe/Brussels",
- "Europe/Bucharest",
- "Europe/Budapest",
- "Europe/Busingen",
- "Europe/Chisinau",
- "Europe/Copenhagen",
- "Europe/Dublin",
- "Europe/Gibraltar",
- "Europe/Guernsey",
- "Europe/Helsinki",
- "Europe/Isle_of_Man",
- "Europe/Istanbul",
- "Europe/Jersey",
- "Europe/Kaliningrad",
- "Europe/Kiev",
- "Europe/Kirov",
- "Europe/Lisbon",
- "Europe/Ljubljana",
- "Europe/London",
- "Europe/Luxembourg",
- "Europe/Madrid",
- "Europe/Malta",
- "Europe/Mariehamn",
- "Europe/Minsk",
- "Europe/Monaco",
- "Europe/Moscow",
- "Europe/Nicosia",
- "Europe/Oslo",
- "Europe/Paris",
- "Europe/Podgorica",
- "Europe/Prague",
- "Europe/Riga",
- "Europe/Rome",
- "Europe/Samara",
- "Europe/San_Marino",
- "Europe/Sarajevo",
- "Europe/Saratov",
- "Europe/Simferopol",
- "Europe/Skopje",
- "Europe/Sofia",
- "Europe/Stockholm",
- "Europe/Tallinn",
- "Europe/Tirane",
- "Europe/Tiraspol",
- "Europe/Ulyanovsk",
- "Europe/Uzhgorod",
- "Europe/Vaduz",
- "Europe/Vatican",
- "Europe/Vienna",
- "Europe/Vilnius",
- "Europe/Volgograd",
- "Europe/Warsaw",
- "Europe/Zagreb",
- "Europe/Zaporozhye",
- "Europe/Zurich",
- "GB",
- "GB-Eire",
- "GMT",
- "GMT+0",
- "GMT-0",
- "GMT0",
- "Greenwich",
- "HST",
- "Hongkong",
- "Iceland",
- "Indian/Antananarivo",
- "Indian/Chagos",
- "Indian/Christmas",
- "Indian/Cocos",
- "Indian/Comoro",
- "Indian/Kerguelen",
- "Indian/Mahe",
- "Indian/Maldives",
- "Indian/Mauritius",
- "Indian/Mayotte",
- "Indian/Reunion",
- "Iran",
- "Israel",
- "Jamaica",
- "Japan",
- "Kwajalein",
- "Libya",
- "MET",
- "MST",
- "MST7MDT",
- "Mexico/BajaNorte",
- "Mexico/BajaSur",
- "Mexico/General",
- "NZ",
- "NZ-CHAT",
- "Navajo",
- "PRC",
- "PST8PDT",
- "Pacific/Apia",
- "Pacific/Auckland",
- "Pacific/Bougainville",
- "Pacific/Chatham",
- "Pacific/Chuuk",
- "Pacific/Easter",
- "Pacific/Efate",
- "Pacific/Enderbury",
- "Pacific/Fakaofo",
- "Pacific/Fiji",
- "Pacific/Funafuti",
- "Pacific/Galapagos",
- "Pacific/Gambier",
- "Pacific/Guadalcanal",
- "Pacific/Guam",
- "Pacific/Honolulu",
- "Pacific/Johnston",
- "Pacific/Kanton",
- "Pacific/Kiritimati",
- "Pacific/Kosrae",
- "Pacific/Kwajalein",
- "Pacific/Majuro",
- "Pacific/Marquesas",
- "Pacific/Midway",
- "Pacific/Nauru",
- "Pacific/Niue",
- "Pacific/Norfolk",
- "Pacific/Noumea",
- "Pacific/Pago_Pago",
- "Pacific/Palau",
- "Pacific/Pitcairn",
- "Pacific/Pohnpei",
- "Pacific/Ponape",
- "Pacific/Port_Moresby",
- "Pacific/Rarotonga",
- "Pacific/Saipan",
- "Pacific/Samoa",
- "Pacific/Tahiti",
- "Pacific/Tarawa",
- "Pacific/Tongatapu",
- "Pacific/Truk",
- "Pacific/Wake",
- "Pacific/Wallis",
- "Pacific/Yap",
- "Poland",
- "Portugal",
- "ROC",
- "ROK",
- "Singapore",
- "Turkey",
- "UCT",
- "US/Alaska",
- "US/Aleutian",
- "US/Arizona",
- "US/Central",
- "US/East-Indiana",
- "US/Eastern",
- "US/Hawaii",
- "US/Indiana-Starke",
- "US/Michigan",
- "US/Mountain",
- "US/Pacific",
- "US/Samoa",
- "UTC",
- "Universal",
- "W-SU",
- "WET",
- "Zulu"
]
Get form
required | string or string UUID or SLUG of the target resource |
{- "uuid": "e6a9741bd88d4e69bd5930010e9f4322",
- "name": "Vehicle form",
- "team": "7cf6aabb5116431fbab78efea4b783f0",
- "target_object": "vehicle",
- "variables": [
- {
- "uuid": "23cfba2de0264f03a024f759e57585a9",
- "name": "Is the vehicle autonomous?",
- "help_text": "Check if vehicle can work autonomously",
- "required": true,
- "sort_priority": 100,
- "variable": {
- "uuid": "e2e5878f2ed4466792e514a8f396e271",
- "organization": "287c54aeaa534b71bc2cfd7762018ba4",
- "name": "Autonomous",
- "variable_name": "autonomous",
- "variable_type": "boolean"
}
}
]
}
Update form
required | string or string UUID or SLUG of the target resource |
name required | string |
target_object required | string Enum: "vehicle" "task" "subtask" "task-preset" "subtask-preset" |
required | Array of objects (FormVariable) |
{- "name": "Vehicle form",
- "target_object": "vehicle",
- "variables": [
- {
- "name": "Is the vehicle autonomous?",
- "help_text": "Check if vehicle can work autonomously",
- "required": true,
- "sort_priority": 100,
- "variable": {
- "name": "Autonomous",
- "variable_name": "autonomous",
- "variable_type": "boolean"
}, - "variable_uuid": "23cfba2de0264f03a024f759e57585a9"
}
]
}
{- "uuid": "e6a9741bd88d4e69bd5930010e9f4322",
- "name": "Vehicle form",
- "team": "7cf6aabb5116431fbab78efea4b783f0",
- "target_object": "vehicle",
- "variables": [
- {
- "uuid": "23cfba2de0264f03a024f759e57585a9",
- "name": "Is the vehicle autonomous?",
- "help_text": "Check if vehicle can work autonomously",
- "required": true,
- "sort_priority": 100,
- "variable": {
- "uuid": "e2e5878f2ed4466792e514a8f396e271",
- "organization": "287c54aeaa534b71bc2cfd7762018ba4",
- "name": "Autonomous",
- "variable_name": "autonomous",
- "variable_type": "boolean"
}
}
]
}
Get object form entries
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
object-type required | string Enum: "task" "subtask" "task-preset" "subtask-preset" "vehicle" Verbose string of the type of the object |
{- "entries": [
- {
- "value": "Yes",
- "variable_name": "string",
- "variable_type": "vehicle"
}
]
}
Update form entries for object
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
object-type required | string Enum: "task" "subtask" "task-preset" "subtask-preset" "vehicle" Verbose string of the type of the object |
required | Array of objects (VariableEntry) |
{- "entries": [
- {
- "value": "Yes",
- "variable_name": "string"
}
]
}
{- "entries": [
- {
- "value": "Yes",
- "variable_name": "string",
- "variable_type": "vehicle"
}
]
}
Get form for specific object
object-type required | string Enum: "task" "subtask" "task-preset" "subtask-preset" "vehicle" Verbose string of the type of the object |
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "e6a9741bd88d4e69bd5930010e9f4322",
- "name": "Vehicle form",
- "team": "7cf6aabb5116431fbab78efea4b783f0",
- "target_object": "vehicle",
- "variables": [
- {
- "uuid": "23cfba2de0264f03a024f759e57585a9",
- "name": "Is the vehicle autonomous?",
- "help_text": "Check if vehicle can work autonomously",
- "required": true,
- "sort_priority": 100,
- "variable": {
- "uuid": "e2e5878f2ed4466792e514a8f396e271",
- "organization": "287c54aeaa534b71bc2cfd7762018ba4",
- "name": "Autonomous",
- "variable_name": "autonomous",
- "variable_type": "boolean"
}
}
]
}
Return a list of all forms for organization
required | string or string UUID or SLUG of the target resource |
[- {
- "uuid": "e6a9741bd88d4e69bd5930010e9f4322",
- "name": "Vehicle form",
- "team": "7cf6aabb5116431fbab78efea4b783f0",
- "target_object": "vehicle",
- "variables": [
- {
- "uuid": "23cfba2de0264f03a024f759e57585a9",
- "name": "Is the vehicle autonomous?",
- "help_text": "Check if vehicle can work autonomously",
- "required": true,
- "sort_priority": 100,
- "variable": {
- "uuid": "e2e5878f2ed4466792e514a8f396e271",
- "organization": "287c54aeaa534b71bc2cfd7762018ba4",
- "name": "Autonomous",
- "variable_name": "autonomous",
- "variable_type": "boolean"
}
}
]
}
]
Create a new form for organization
required | string or string UUID or SLUG of the target resource |
name required | string |
target_object required | string Enum: "vehicle" "task" "subtask" "task-preset" "subtask-preset" |
required | Array of objects (FormVariable) |
{- "name": "Vehicle form",
- "target_object": "vehicle",
- "variables": [
- {
- "name": "Is the vehicle autonomous?",
- "help_text": "Check if vehicle can work autonomously",
- "required": true,
- "sort_priority": 100,
- "variable": {
- "name": "Autonomous",
- "variable_name": "autonomous",
- "variable_type": "boolean"
}, - "variable_uuid": "23cfba2de0264f03a024f759e57585a9"
}
]
}
{- "uuid": "e6a9741bd88d4e69bd5930010e9f4322",
- "name": "Vehicle form",
- "team": "7cf6aabb5116431fbab78efea4b783f0",
- "target_object": "vehicle",
- "variables": [
- {
- "uuid": "23cfba2de0264f03a024f759e57585a9",
- "name": "Is the vehicle autonomous?",
- "help_text": "Check if vehicle can work autonomously",
- "required": true,
- "sort_priority": 100,
- "variable": {
- "uuid": "e2e5878f2ed4466792e514a8f396e271",
- "organization": "287c54aeaa534b71bc2cfd7762018ba4",
- "name": "Autonomous",
- "variable_name": "autonomous",
- "variable_type": "boolean"
}
}
]
}
Return a list of all variables available for organization
required | string or string UUID or SLUG of the target resource |
[- {
- "uuid": "e2e5878f2ed4466792e514a8f396e271",
- "organization": "287c54aeaa534b71bc2cfd7762018ba4",
- "name": "Autonomous",
- "variable_name": "autonomous",
- "variable_type": "boolean"
}
]
Create a new variable for organization
required | string or string UUID or SLUG of the target resource |
name required | string |
variable_name required | string <slug> |
variable_type required | string Enum: "string" "integer" "float" "boolean" |
{- "name": "Autonomous",
- "variable_name": "autonomous",
- "variable_type": "boolean"
}
{- "uuid": "e2e5878f2ed4466792e514a8f396e271",
- "organization": "287c54aeaa534b71bc2cfd7762018ba4",
- "name": "Autonomous",
- "variable_name": "autonomous",
- "variable_type": "boolean"
}
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "ce9f2e05d00740b7b3f9046c51a258ff",
- "image": "string",
- "image_dir": "string",
- "image_url": "string",
- "origin": [
- 0,
- 0,
- 0
], - "origin_x": 2.1,
- "origin_y": 1.2,
- "negate": 1,
- "occupied_thresh": 0,
- "original_height": 151,
- "original_width": 120,
- "map_analysis_tuning_parameter": 1000,
- "version": "1b5b355fa34149acdd22c741fec4b3a0",
- "image_details": "string"
}
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
origin_x | number <float> |
origin_y | number <float> |
{- "origin_x": 2.1,
- "origin_y": 1.2
}
{- "uuid": "ce9f2e05d00740b7b3f9046c51a258ff",
- "image": "string",
- "image_dir": "string",
- "image_url": "string",
- "origin": [
- 0,
- 0,
- 0
], - "origin_x": 2.1,
- "origin_y": 1.2,
- "negate": 1,
- "occupied_thresh": 0,
- "original_height": 151,
- "original_width": 120,
- "map_analysis_tuning_parameter": 1000,
- "version": "1b5b355fa34149acdd22c741fec4b3a0",
- "image_details": "string"
}
Retrieve a details about map area images including their URLs, build statuses
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "ce9f2e05d00740b7b3f9046c51a258ff",
- "generated_image_build_status": "done",
- "displayable_image_build_status": "done"
}
Update Map Analysis tuning parameters and re-trigger map generation
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
map_analysis_sharpness | integer or null [ 0 .. 1000 ] |
{- "map_analysis_sharpness": 1000
}
{- "map_analysis_sharpness": 1000
}
Upload a new area image with yaml configuration file (optional) and trigger map analysis for the new map image
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
image | string <binary> |
configuration_file | string or null <binary> (YamlAreaImageConfigurationFile) |
{- "uuid": "ce9f2e05d00740b7b3f9046c51a258ff",
- "image": "string",
- "image_dir": "string",
- "image_url": "string",
- "origin": [
- 0,
- 0,
- 0
], - "origin_x": 2.1,
- "origin_y": 1.2,
- "negate": 1,
- "occupied_thresh": 0,
- "original_height": 151,
- "original_width": 120,
- "map_analysis_tuning_parameter": 1000,
- "version": "1b5b355fa34149acdd22c741fec4b3a0",
- "image_details": "string"
}
Get a list of IoT device models belonging to a team
required | string or string UUID or SLUG of the target resource |
[- {
- "uuid": "fb9b8417728c425fb4ce3b870e55a950",
- "name": "Organization Door",
- "device_model_type": "door",
- "owner": "5657883de1dc40e4ad152ac137290ef0",
- "team": "36f7883de2dc40e2ad152dc137f90ef5",
- "states": [
- {
- "uuid": "28efb1c889124304baa48dc195a04fce",
- "title": "Open",
- "payload": "1"
}
], - "x_dimension": 100,
- "y_dimension": 700,
- "z_dimension": 2300,
- "metadata": {
- "updated_at": "2021-06-01T12:00:00Z",
- "created_at": "2021-06-01T12:00:00Z"
}
}
]
Batch update a list of device models based on their UUIDs
required | string or string UUID or SLUG of the target resource |
name | string |
device_model_type | string Enum: "door" "switch" "elevator" "traffic_light" "smart_device" "other_device" |
owner | string <uuid> |
team | string <uuid> |
Array of objects (IoTDeviceStateUpdate) The possible states of the device model. Associated devices will inherit these states | |
x_dimension | float |
y_dimension | float |
z_dimension | float |
[- {
- "name": "Organization Door",
- "device_model_type": "door",
- "owner": "5657883de1dc40e4ad152ac137290ef0",
- "team": "36f7883de2dc40e2ad152dc137f90ef5",
- "states": [
- {
- "title": "Open",
- "payload": "1"
}
], - "x_dimension": 100,
- "y_dimension": 700,
- "z_dimension": 2300
}
]
[- {
- "uuid": "fb9b8417728c425fb4ce3b870e55a950",
- "name": "Organization Door",
- "device_model_type": "door",
- "owner": "5657883de1dc40e4ad152ac137290ef0",
- "team": "36f7883de2dc40e2ad152dc137f90ef5",
- "states": [
- {
- "uuid": "28efb1c889124304baa48dc195a04fce",
- "title": "Open",
- "payload": "1"
}
], - "x_dimension": 100,
- "y_dimension": 700,
- "z_dimension": 2300,
- "metadata": {
- "updated_at": "2021-06-01T12:00:00Z",
- "created_at": "2021-06-01T12:00:00Z"
}
}
]
required | string or string UUID or SLUG of the target resource |
name | string |
device_model_type | string Enum: "door" "switch" "elevator" "traffic_light" "smart_device" "other_device" |
owner | string <uuid> |
team | string <uuid> |
Array of objects (IoTDeviceStateUpdate) The possible states of the device model. Associated devices will inherit these states | |
x_dimension | float |
y_dimension | float |
z_dimension | float |
{- "name": "Organization Door",
- "device_model_type": "door",
- "owner": "5657883de1dc40e4ad152ac137290ef0",
- "team": "36f7883de2dc40e2ad152dc137f90ef5",
- "states": [
- {
- "title": "Open",
- "payload": "1"
}
], - "x_dimension": 100,
- "y_dimension": 700,
- "z_dimension": 2300
}
{- "uuid": "fb9b8417728c425fb4ce3b870e55a950",
- "name": "Organization Door",
- "device_model_type": "door",
- "owner": "5657883de1dc40e4ad152ac137290ef0",
- "team": "36f7883de2dc40e2ad152dc137f90ef5",
- "states": [
- {
- "uuid": "28efb1c889124304baa48dc195a04fce",
- "title": "Open",
- "payload": "1"
}
], - "x_dimension": 100,
- "y_dimension": 700,
- "z_dimension": 2300,
- "metadata": {
- "updated_at": "2021-06-01T12:00:00Z",
- "created_at": "2021-06-01T12:00:00Z"
}
}
Get an IoT device model
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "fb9b8417728c425fb4ce3b870e55a950",
- "name": "Organization Door",
- "device_model_type": "door",
- "owner": "5657883de1dc40e4ad152ac137290ef0",
- "team": "36f7883de2dc40e2ad152dc137f90ef5",
- "states": [
- {
- "uuid": "28efb1c889124304baa48dc195a04fce",
- "title": "Open",
- "payload": "1"
}
], - "x_dimension": 100,
- "y_dimension": 700,
- "z_dimension": 2300,
- "metadata": {
- "updated_at": "2021-06-01T12:00:00Z",
- "created_at": "2021-06-01T12:00:00Z"
}
}
Update an IoT device
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
name | string |
device_model_type | string Enum: "door" "switch" "elevator" "traffic_light" "smart_device" "other_device" |
owner | string <uuid> |
team | string <uuid> |
Array of objects (IoTDeviceStateUpdate) The possible states of the device model. Associated devices will inherit these states | |
x_dimension | float |
y_dimension | float |
z_dimension | float |
{- "name": "Organization Door",
- "device_model_type": "door",
- "owner": "5657883de1dc40e4ad152ac137290ef0",
- "team": "36f7883de2dc40e2ad152dc137f90ef5",
- "states": [
- {
- "title": "Open",
- "payload": "1"
}
], - "x_dimension": 100,
- "y_dimension": 700,
- "z_dimension": 2300
}
{- "uuid": "fb9b8417728c425fb4ce3b870e55a950",
- "name": "Organization Door",
- "device_model_type": "door",
- "owner": "5657883de1dc40e4ad152ac137290ef0",
- "team": "36f7883de2dc40e2ad152dc137f90ef5",
- "states": [
- {
- "uuid": "28efb1c889124304baa48dc195a04fce",
- "title": "Open",
- "payload": "1"
}
], - "x_dimension": 100,
- "y_dimension": 700,
- "z_dimension": 2300,
- "metadata": {
- "updated_at": "2021-06-01T12:00:00Z",
- "created_at": "2021-06-01T12:00:00Z"
}
}
Get a list of IoT devices belonging to a team
required | string or string UUID or SLUG of the target resource |
[- {
- "uuid": "fb9b8417728c425fb4ce3b870e55a950",
- "model": "5657883deddc40e4ad152ac137290ef0",
- "model_type": "door",
- "active": true,
- "identifier": "front_door_1",
- "states": [
- {
- "uuid": "28efb1c889124304baa48dc195a04fce",
- "title": "Open",
- "payload": "1"
}
], - "points": [
- 10,
- 10
], - "title": "Front Door",
- "online": true,
- "status": {
- "uuid": "28efb1c889124304baa48dc195a04fce",
- "title": "Open",
- "payload": "1"
}, - "raw_status": "1",
- "metadata": {
- "updated_at": "2021-06-01T12:00:00Z",
- "created_at": "2021-06-01T12:00:00Z"
}
}
]
Get a list of IoT devices belonging to a team's indoor area
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
[- {
- "uuid": "fb9b8417728c425fb4ce3b870e55a950",
- "model": "5657883deddc40e4ad152ac137290ef0",
- "model_type": "door",
- "active": true,
- "identifier": "front_door_1",
- "states": [
- {
- "uuid": "28efb1c889124304baa48dc195a04fce",
- "title": "Open",
- "payload": "1"
}
], - "points": [
- 10,
- 10
], - "title": "Front Door",
- "online": true,
- "status": {
- "uuid": "28efb1c889124304baa48dc195a04fce",
- "title": "Open",
- "payload": "1"
}, - "raw_status": "1",
- "metadata": {
- "updated_at": "2021-06-01T12:00:00Z",
- "created_at": "2021-06-01T12:00:00Z"
}
}
]
Batch update a list of team's indoor area devices based on their UUIDs
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
model | string <uuid> |
active | boolean |
identifier | string The unique identifier of the device. Used for communication |
points | Array of arrays The current position of the device |
title | string |
[- {
- "model": "5657883deddc40e4ad152ac137290ef0",
- "active": true,
- "identifier": "front_door_1",
- "points": [
- 10,
- 10
], - "title": "Front Door"
}
]
[- {
- "uuid": "fb9b8417728c425fb4ce3b870e55a950",
- "model": "5657883deddc40e4ad152ac137290ef0",
- "model_type": "door",
- "active": true,
- "identifier": "front_door_1",
- "states": [
- {
- "uuid": "28efb1c889124304baa48dc195a04fce",
- "title": "Open",
- "payload": "1"
}
], - "points": [
- 10,
- 10
], - "title": "Front Door",
- "online": true,
- "status": {
- "uuid": "28efb1c889124304baa48dc195a04fce",
- "title": "Open",
- "payload": "1"
}, - "raw_status": "1",
- "metadata": {
- "updated_at": "2021-06-01T12:00:00Z",
- "created_at": "2021-06-01T12:00:00Z"
}
}
]
required | string or string UUID or SLUG of the target resource |
model | string <uuid> |
active | boolean |
identifier | string The unique identifier of the device. Used for communication |
points | Array of arrays The current position of the device |
title | string |
{- "model": "5657883deddc40e4ad152ac137290ef0",
- "active": true,
- "identifier": "front_door_1",
- "points": [
- 10,
- 10
], - "title": "Front Door"
}
{- "uuid": "fb9b8417728c425fb4ce3b870e55a950",
- "model": "5657883deddc40e4ad152ac137290ef0",
- "model_type": "door",
- "active": true,
- "identifier": "front_door_1",
- "states": [
- {
- "uuid": "28efb1c889124304baa48dc195a04fce",
- "title": "Open",
- "payload": "1"
}
], - "points": [
- 10,
- 10
], - "title": "Front Door",
- "online": true,
- "status": {
- "uuid": "28efb1c889124304baa48dc195a04fce",
- "title": "Open",
- "payload": "1"
}, - "raw_status": "1",
- "metadata": {
- "updated_at": "2021-06-01T12:00:00Z",
- "created_at": "2021-06-01T12:00:00Z"
}
}
Get an IoT device
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "fb9b8417728c425fb4ce3b870e55a950",
- "model": "5657883deddc40e4ad152ac137290ef0",
- "model_type": "door",
- "active": true,
- "identifier": "front_door_1",
- "states": [
- {
- "uuid": "28efb1c889124304baa48dc195a04fce",
- "title": "Open",
- "payload": "1"
}
], - "points": [
- 10,
- 10
], - "title": "Front Door",
- "online": true,
- "status": {
- "uuid": "28efb1c889124304baa48dc195a04fce",
- "title": "Open",
- "payload": "1"
}, - "raw_status": "1",
- "metadata": {
- "updated_at": "2021-06-01T12:00:00Z",
- "created_at": "2021-06-01T12:00:00Z"
}
}
Update an IoT device
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
model | string <uuid> |
active | boolean |
identifier | string The unique identifier of the device. Used for communication |
points | Array of arrays The current position of the device |
title | string |
{- "model": "5657883deddc40e4ad152ac137290ef0",
- "active": true,
- "identifier": "front_door_1",
- "points": [
- 10,
- 10
], - "title": "Front Door"
}
{- "uuid": "fb9b8417728c425fb4ce3b870e55a950",
- "model": "5657883deddc40e4ad152ac137290ef0",
- "model_type": "door",
- "active": true,
- "identifier": "front_door_1",
- "states": [
- {
- "uuid": "28efb1c889124304baa48dc195a04fce",
- "title": "Open",
- "payload": "1"
}
], - "points": [
- 10,
- 10
], - "title": "Front Door",
- "online": true,
- "status": {
- "uuid": "28efb1c889124304baa48dc195a04fce",
- "title": "Open",
- "payload": "1"
}, - "raw_status": "1",
- "metadata": {
- "updated_at": "2021-06-01T12:00:00Z",
- "created_at": "2021-06-01T12:00:00Z"
}
}
If manufacturer is not marked as public, to see this manufacturer other organizations will have to receive explicit visibility rights
required | string or string UUID or SLUG of the target resource |
organization required | string <uuid> |
{- "organization": "287c54aeaa534b71bc2cfd7762018ba4"
}
{- "organization": "287c54aeaa534b71bc2cfd7762018ba4",
- "site": "app.meilirobots.com"
}
Return a list of manufacturers
required | string or string UUID or SLUG of the target resource |
title | string Title of the manufacturer |
slug | string Slug of the manufacturer |
[- {
- "uuid": "287c54aeaa534b71bc2cfd7762018ba4",
- "title": "Meili",
- "slug": "meili",
- "default_email": "admin@meilirobots.com",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "image": "string",
- "is_manufacturer": true,
- "is_manufacturer_public": true,
- "address": {
- "uuid": "577129fbddb145179645d6490780ce27",
- "name": "Administrator",
- "company_name": "Meili",
- "default_email": "admin@meilirobots.com",
- "address1": "Ny Carlsberg Vej 68",
- "address2": null,
- "city": "Copenhagen",
- "zip_code": 11111,
- "country": "Denmark",
- "country_code": "DK"
}, - "billing_address": {
- "uuid": "577129fbddb145179645d6490780ce27",
- "name": "Administrator",
- "company_name": "Meili",
- "default_email": "admin@meilirobots.com",
- "address1": "Ny Carlsberg Vej 68",
- "address2": null,
- "city": "Copenhagen",
- "zip_code": 11111,
- "country": "Denmark",
- "country_code": "DK"
}
}
]
Usually manufacturers cannot access most vehicle data, however if access is given and is valid, they will be able to see full details and edit them
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "e75bad8cf2ae4d338926d0d8a3ed3921",
- "valid_to": "2019-08-24T14:15:22Z",
- "vehicle": {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo"
}, - "granted_to": {
- "uuid": "287c54aeaa534b71bc2cfd7762018ba4",
- "title": "Meili",
- "slug": "meili"
}, - "granted_by": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}
}
Usually manufacturers cannot access most vehicle data, however if access is given and is valid, they will be able to see full details and edit them
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
duration required | integer Default: 1 Time defined in days |
{- "duration": 1
}
{- "uuid": "e75bad8cf2ae4d338926d0d8a3ed3921",
- "valid_to": "2019-08-24T14:15:22Z",
- "vehicle": {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo"
}, - "granted_to": {
- "uuid": "287c54aeaa534b71bc2cfd7762018ba4",
- "title": "Meili",
- "slug": "meili"
}, - "granted_by": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}
}
Get a list of all notifications for the current user with optional pagination.
page | integer Default: 1 Example: page=1 Page number for pagination |
{- "notifications": [
- {
- "_id": "62fcad2fe2e3b4000176dabd",
- "text": "Task 20220811_0001 is stuck. It will be terminated if no action is taken",
- "read": true,
- "task": "577129fbddb145179645d6490780ce27",
- "team": "",
- "org": "",
- "vehicle": "",
- "notification_level": "info",
- "notification_type": "system"
}
]
}
{- "notifications": [
- {
- "_id": "62fcad2fe2e3b4000176dabd",
- "text": "Task 20220811_0001 is stuck. It will be terminated if no action is taken",
- "read": true,
- "task": "577129fbddb145179645d6490780ce27",
- "team": "",
- "org": "",
- "vehicle": "",
- "notification_level": "info",
- "notification_type": "system"
}
]
}
{- "notifications": [
- {
- "_id": "62fcad2fe2e3b4000176dabd",
- "text": "Task 20220811_0001 is stuck. It will be terminated if no action is taken",
- "read": true,
- "task": "577129fbddb145179645d6490780ce27",
- "team": "",
- "org": "",
- "vehicle": "",
- "notification_level": "info",
- "notification_type": "system"
}
]
}
Mark a notification as read by its UUID.
id required | string Example: 62fcad2fe2e3b4000176dabd |
{- "notification": {
- "_id": "62fcad2fe2e3b4000176dabd",
- "text": "Task 20220811_0001 is stuck. It will be terminated if no action is taken",
- "read": true,
- "task": "577129fbddb145179645d6490780ce27",
- "team": "",
- "org": "",
- "vehicle": "",
- "notification_level": "info",
- "notification_type": "system"
}
}
Mark multiple notifications as read by their UUIDs.
[- "62fcad2fe2e3b4000176dabd"
]
{- "read": true,
- "uuids": [
- "123e4567e89b12d3a456426614174000"
]
}
Delete multiple notifications by their UUIDs.
[- "62fcad2fe2e3b4000176dabd"
]
{- "deleted": true,
- "uuids": [
- [
- "62fcad2fe2e3b4000176dabd",
- "60b725f10c9d0f2d3ebaf03b"
]
]
}
Get a list of all notifications for a specific team with optional pagination.
team_uuid required | string Example: 57712ffbddb1451f9645d6490780ce27 |
page | integer Default: 1 Example: page=1 Page number for pagination |
{- "notifications": [
- {
- "_id": "62fcad2fe2e3b4000176dabd",
- "text": "Task 20220811_0001 is stuck. It will be terminated if no action is taken",
- "read": true,
- "task": "577129fbddb145179645d6490780ce27",
- "team": "",
- "org": "",
- "vehicle": "",
- "notification_level": "info",
- "notification_type": "system"
}
]
}
Marks all notifications for a given team as read.
team_uuid required | string Example: 57712ffbddb1451f9645d6490780ce27 |
page | integer Default: 1 Example: page=1 Page number for pagination |
{- "notifications": [
- {
- "_id": "62fcad2fe2e3b4000176dabd",
- "text": "Task 20220811_0001 is stuck. It will be terminated if no action is taken",
- "read": true,
- "task": "577129fbddb145179645d6490780ce27",
- "team": "",
- "org": "",
- "vehicle": "",
- "notification_level": "info",
- "notification_type": "system"
}
]
}
Marks a specific notification as read for a given team.
team_uuid required | string Example: 57712ffbddb1451f9645d6490780ce27 |
notification_id required | string Example: 60b725f10c9d0f2d3ebaf03b |
{- "notification": {
- "_id": "62fcad2fe2e3b4000176dabd",
- "text": "Task 20220811_0001 is stuck. It will be terminated if no action is taken",
- "read": true,
- "task": "577129fbddb145179645d6490780ce27",
- "team": "",
- "org": "",
- "vehicle": "",
- "notification_level": "info",
- "notification_type": "system"
}
}
Deletes a specific notification within a given team by notification ID.
team_uuid required | string Example: 57712ffbddb1451f9645d6490780ce27 |
notification_id required | string Example: 60b725f10c9d0f2d3ebaf03b |
{- "deleted": true,
- "uuid": "60b725f10c9d0f2d3ebaf03b"
}
Marks multiple notifications within a given team as read using a request body containing an array of UUIDs.
team_uuid required | string Example: 57712ffbddb1451f9645d6490780ce27 |
[- "62fcad2fe2e3b4000176dabd",
- "60b725f10c9d0f2d3ebaf03b"
]
{- "read": true,
- "uuids": [
- "62fcad2fe2e3b4000176dabd",
- "60b725f10c9d0f2d3ebaf03b"
]
}
Deletes multiple notifications within a given team using a request body containing an array of UUIDs.
team_uuid required | string Example: 57712ffbddb1451f9645d6490780ce27 |
[- "62fcad2fe2e3b4000176dabd",
- "60b725f10c9d0f2d3ebaf03b"
]
{- "deleted": true,
- "uuids": [
- "62fcad2fe2e3b4000176dabd",
- "60b725f10c9d0f2d3ebaf03b"
]
}
Establish a WebSocket connection to receive real-time notification updates for the current user.
token required | string Example: token=jwt_token JWT authentication token for the user |
{- "detail": "WebSocket connection established"
}
[- {
- "uuid": "287c54aeaa534b71bc2cfd7762018ba4",
- "title": "Meili",
- "slug": "meili",
- "default_email": "admin@meilirobots.com",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "image": "string",
- "is_manufacturer": true,
- "is_manufacturer_public": true,
- "address": {
- "uuid": "577129fbddb145179645d6490780ce27",
- "name": "Administrator",
- "company_name": "Meili",
- "default_email": "admin@meilirobots.com",
- "address1": "Ny Carlsberg Vej 68",
- "address2": null,
- "city": "Copenhagen",
- "zip_code": 11111,
- "country": "Denmark",
- "country_code": "DK"
}, - "billing_address": {
- "uuid": "577129fbddb145179645d6490780ce27",
- "name": "Administrator",
- "company_name": "Meili",
- "default_email": "admin@meilirobots.com",
- "address1": "Ny Carlsberg Vej 68",
- "address2": null,
- "city": "Copenhagen",
- "zip_code": 11111,
- "country": "Denmark",
- "country_code": "DK"
}
}
]
Create a new organization
title required | string |
default_email required | string or null <email> |
invitation_token required | string |
is_manufacturer | boolean |
is_manufacturer_public | boolean |
required | object (Address) |
object (Address) |
{- "title": "Meili",
- "default_email": "admin@meilirobots.com",
- "invitation_token": "string",
- "is_manufacturer": true,
- "is_manufacturer_public": true,
- "address": {
- "uuid": "577129fbddb145179645d6490780ce27",
- "name": "Administrator",
- "company_name": "Meili",
- "default_email": "admin@meilirobots.com",
- "address1": "Ny Carlsberg Vej 68",
- "address2": null,
- "city": "Copenhagen",
- "zip_code": 11111,
- "country": "Denmark",
- "country_code": "DK"
}, - "billing_address": {
- "uuid": "577129fbddb145179645d6490780ce27",
- "name": "Administrator",
- "company_name": "Meili",
- "default_email": "admin@meilirobots.com",
- "address1": "Ny Carlsberg Vej 68",
- "address2": null,
- "city": "Copenhagen",
- "zip_code": 11111,
- "country": "Denmark",
- "country_code": "DK"
}
}
{- "uuid": "287c54aeaa534b71bc2cfd7762018ba4",
- "title": "Meili",
- "slug": "meili",
- "default_email": "admin@meilirobots.com",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "image": "string",
- "is_manufacturer": true,
- "is_manufacturer_public": true,
- "address": {
- "uuid": "577129fbddb145179645d6490780ce27",
- "name": "Administrator",
- "company_name": "Meili",
- "default_email": "admin@meilirobots.com",
- "address1": "Ny Carlsberg Vej 68",
- "address2": null,
- "city": "Copenhagen",
- "zip_code": 11111,
- "country": "Denmark",
- "country_code": "DK"
}, - "billing_address": {
- "uuid": "577129fbddb145179645d6490780ce27",
- "name": "Administrator",
- "company_name": "Meili",
- "default_email": "admin@meilirobots.com",
- "address1": "Ny Carlsberg Vej 68",
- "address2": null,
- "city": "Copenhagen",
- "zip_code": 11111,
- "country": "Denmark",
- "country_code": "DK"
}
}
required | string or string UUID or SLUG of the target resource |
{- "uuid": "287c54aeaa534b71bc2cfd7762018ba4",
- "title": "Meili",
- "slug": "meili",
- "default_email": "admin@meilirobots.com",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "image": "string",
- "is_manufacturer": true,
- "is_manufacturer_public": true,
- "address": {
- "uuid": "577129fbddb145179645d6490780ce27",
- "name": "Administrator",
- "company_name": "Meili",
- "default_email": "admin@meilirobots.com",
- "address1": "Ny Carlsberg Vej 68",
- "address2": null,
- "city": "Copenhagen",
- "zip_code": 11111,
- "country": "Denmark",
- "country_code": "DK"
}, - "billing_address": {
- "uuid": "577129fbddb145179645d6490780ce27",
- "name": "Administrator",
- "company_name": "Meili",
- "default_email": "admin@meilirobots.com",
- "address1": "Ny Carlsberg Vej 68",
- "address2": null,
- "city": "Copenhagen",
- "zip_code": 11111,
- "country": "Denmark",
- "country_code": "DK"
}
}
required | string or string UUID or SLUG of the target resource |
title required | string |
default_email required | string or null <email> |
invitation_token required | string |
is_manufacturer | boolean |
is_manufacturer_public | boolean |
required | object (Address) |
object (Address) |
{- "title": "Meili",
- "default_email": "admin@meilirobots.com",
- "invitation_token": "string",
- "is_manufacturer": true,
- "is_manufacturer_public": true,
- "address": {
- "uuid": "577129fbddb145179645d6490780ce27",
- "name": "Administrator",
- "company_name": "Meili",
- "default_email": "admin@meilirobots.com",
- "address1": "Ny Carlsberg Vej 68",
- "address2": null,
- "city": "Copenhagen",
- "zip_code": 11111,
- "country": "Denmark",
- "country_code": "DK"
}, - "billing_address": {
- "uuid": "577129fbddb145179645d6490780ce27",
- "name": "Administrator",
- "company_name": "Meili",
- "default_email": "admin@meilirobots.com",
- "address1": "Ny Carlsberg Vej 68",
- "address2": null,
- "city": "Copenhagen",
- "zip_code": 11111,
- "country": "Denmark",
- "country_code": "DK"
}
}
{- "uuid": "287c54aeaa534b71bc2cfd7762018ba4",
- "title": "Meili",
- "slug": "meili",
- "default_email": "admin@meilirobots.com",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "image": "string",
- "is_manufacturer": true,
- "is_manufacturer_public": true,
- "address": {
- "uuid": "577129fbddb145179645d6490780ce27",
- "name": "Administrator",
- "company_name": "Meili",
- "default_email": "admin@meilirobots.com",
- "address1": "Ny Carlsberg Vej 68",
- "address2": null,
- "city": "Copenhagen",
- "zip_code": 11111,
- "country": "Denmark",
- "country_code": "DK"
}, - "billing_address": {
- "uuid": "577129fbddb145179645d6490780ce27",
- "name": "Administrator",
- "company_name": "Meili",
- "default_email": "admin@meilirobots.com",
- "address1": "Ny Carlsberg Vej 68",
- "address2": null,
- "city": "Copenhagen",
- "zip_code": 11111,
- "country": "Denmark",
- "country_code": "DK"
}
}
Return a list of members in organizations
required | string or string UUID or SLUG of the target resource |
ordering | string Enum: "created_at" "user" "membership_type" Order objects by field To specify descending order, prefix the field name with a minus sign ("-"). Example: To order by "created_at" in descending order, use "-created_at". |
[- {
- "uuid": "287c54aeaa534b71bc2cfd7762018ba4",
- "user": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}, - "membership_type": "owner",
- "created_at": "2019-08-24T14:15:22Z"
}
]
Create a new invitation for user to organization
required | string or string UUID or SLUG of the target resource |
object (User) | |
membership_type | string Enum: "owner" "admin" "maintainer" "member" "observer" |
string <email> |
{- "user": {
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen"
}, - "membership_type": "owner",
- "email": "employee@meilirobots.com"
}
{- "uuid": "35e4c73591e94fc4a15094dd5cd150e5",
- "user": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}, - "membership_type": "owner",
- "used": true,
- "email": "employee@meilirobots.com"
}
List all teams of the organization
required | string or string UUID or SLUG of the target resource |
[- {
- "uuid": "bce8a727106f4b4cad2e71264fd9d027",
- "slug": "meili-office",
- "status": "ok",
- "title": "Meili Office",
- "organization": {
- "uuid": "287c54aeaa534b71bc2cfd7762018ba4",
- "title": "Meili",
- "slug": "meili"
}, - "description": "string",
- "creator": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}, - "address": {
- "uuid": "577129fbddb145179645d6490780ce27",
- "name": "Administrator",
- "company_name": "Meili",
- "default_email": "admin@meilirobots.com",
- "address1": "Ny Carlsberg Vej 68",
- "address2": null,
- "city": "Copenhagen",
- "zip_code": 11111,
- "country": "Denmark",
- "country_code": "DK"
}, - "operation_type": "inside",
- "image": "string",
- "battery_defaults": {
- "emergency_battery_level": null,
- "emergency_distance": null,
- "working_battery_level": null
}
}
]
Retrieve organization membership
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "287c54aeaa534b71bc2cfd7762018ba4",
- "user": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}, - "membership_type": "owner",
- "created_at": "2019-08-24T14:15:22Z"
}
Update organization membership
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
object (User) | |
membership_type required | string Enum: "owner" "admin" "maintainer" "member" "observer" |
{- "user": {
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen"
}, - "membership_type": "owner"
}
{- "uuid": "287c54aeaa534b71bc2cfd7762018ba4",
- "user": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}, - "membership_type": "owner",
- "created_at": "2019-08-24T14:15:22Z"
}
Return a list of all vehicles in the organization
required | string or string UUID or SLUG of the target resource |
ordering | string Enum: "created_at" "verbose_name" "environment_type" "vehicle_type" "vehicle_serial_number" "priority_level" "category" "max_load" "integration_type" Order objects by field To specify descending order, prefix the field name with a minus sign ("-"). Example: To order by "created_at" in descending order, use "-created_at". |
team | string Filter vehicles by team (team slug or title) |
name | string Filter vehicles by name (verbose_name) |
slug | string Filter vehicles by slug |
category | string Filter vehicles by category (category slug or title) |
[- {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo",
- "slug": "floating-flamingo",
- "vehicle_type": "amr",
- "environment_type": "inside",
- "vehicle_serial_number": "fe9fc7b5d6ef40d5b0b73fa85a378456",
- "active": true,
- "category": "c2bfb3237b874e238a7efa727d8485f8",
- "category_name": "TurtleBot",
- "team": "4c310b85696e4ffe9283f9bdfe2337f1",
- "team_name": "Warehouse team 1",
- "full_battery": null,
- "emergency_battery_level": null,
- "emergency_distance": null,
- "use_team_battery_defaults": true,
- "manufacturer": null,
- "custom_manufacturer": "meili",
- "batch_tasks": true,
- "battery_management_enabled": true,
- "working_battery_level": 25,
- "dimensions": [
- 100,
- 100,
- 100
], - "executing_looped_task": false,
- "message_frequency": 1,
- "traffic_control_delay": 0,
- "is_collision_detected": false,
- "collision_type": null,
- "integration_type": "ROS",
- "initial_position": {
- "x": null,
- "y": null,
- "theta": null
}, - "vehicle_state": "ready",
- "battery_configured": true,
- "inherit_category_topics": true,
- "drivable_distance": 2000
}
]
Create a new vehicle for the organization
required | string or string UUID or SLUG of the target resource |
external_identifier | string |
verbose_name | string |
vehicle_type | string Enum: "amr" "agv" |
environment_type | string Enum: "inside" "outside" |
vehicle_serial_number | string |
active required | boolean |
category | string <uuid> |
category_name | string |
team | string <uuid> |
team_name | string |
full_battery | double |
emergency_battery_level | double |
emergency_distance | double |
use_team_battery_defaults | boolean |
manufacturer | string |
custom_manufacturer | string |
batch_tasks | boolean If set to true, all tasks will be batched into a single message and approved as one |
battery_management_enabled | boolean |
working_battery_level | double |
dimensions | Array of integers |
executing_looped_task | boolean |
message_frequency | double |
traffic_control_delay | double |
is_collision_detected | boolean |
collision_type | string |
integration_type | string Enum: "ROS" "MIR" "Noovelia" "VDA5050" "Wewo" "Youibot" |
object | |
vehicle_state | string Enum: "ready" "navigating" "pause" "charging" "emergency_stop" "manual_control" |
battery_configured | boolean |
inherit_category_topics | boolean |
drivable_distance | double |
{- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo",
- "vehicle_type": "amr",
- "environment_type": "inside",
- "vehicle_serial_number": "fe9fc7b5d6ef40d5b0b73fa85a378456",
- "active": true,
- "category": "c2bfb3237b874e238a7efa727d8485f8",
- "category_name": "TurtleBot",
- "team": "4c310b85696e4ffe9283f9bdfe2337f1",
- "team_name": "Warehouse team 1",
- "full_battery": null,
- "emergency_battery_level": null,
- "emergency_distance": null,
- "use_team_battery_defaults": true,
- "manufacturer": null,
- "custom_manufacturer": "meili",
- "batch_tasks": true,
- "battery_management_enabled": true,
- "working_battery_level": 25,
- "dimensions": [
- 100,
- 100,
- 100
], - "executing_looped_task": false,
- "message_frequency": 1,
- "traffic_control_delay": 0,
- "is_collision_detected": false,
- "collision_type": null,
- "integration_type": "ROS",
- "initial_position": {
- "x": null,
- "y": null,
- "theta": null
}, - "vehicle_state": "ready",
- "battery_configured": true,
- "inherit_category_topics": true,
- "drivable_distance": 2000
}
{- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo",
- "slug": "floating-flamingo",
- "vehicle_type": "amr",
- "environment_type": "inside",
- "vehicle_serial_number": "fe9fc7b5d6ef40d5b0b73fa85a378456",
- "active": true,
- "category": "c2bfb3237b874e238a7efa727d8485f8",
- "category_name": "TurtleBot",
- "team": "4c310b85696e4ffe9283f9bdfe2337f1",
- "team_name": "Warehouse team 1",
- "full_battery": null,
- "emergency_battery_level": null,
- "emergency_distance": null,
- "use_team_battery_defaults": true,
- "manufacturer": null,
- "custom_manufacturer": "meili",
- "batch_tasks": true,
- "battery_management_enabled": true,
- "working_battery_level": 25,
- "dimensions": [
- 100,
- 100,
- 100
], - "executing_looped_task": false,
- "message_frequency": 1,
- "traffic_control_delay": 0,
- "is_collision_detected": false,
- "collision_type": null,
- "integration_type": "ROS",
- "initial_position": {
- "x": null,
- "y": null,
- "theta": null
}, - "vehicle_state": "ready",
- "battery_configured": true,
- "inherit_category_topics": true,
- "drivable_distance": 2000
}
Return a list of all vehicle categories available in the organization
required | string or string UUID or SLUG of the target resource |
ordering | string Enum: "created_at" "verbose_name" "environment_type" "vehicle_type" "vehicle_serial_number" "priority_level" "category" "max_load" "integration_type" Order objects by field To specify descending order, prefix the field name with a minus sign ("-"). Example: To order by "created_at" in descending order, use "-created_at". |
team | string Filter vehicles by team (team slug or title) |
name | string Filter vehicles by name (verbose_name) |
slug | string Filter vehicles by slug |
category | string Filter vehicles by category (category slug or title) |
[- {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "title": "Floating Flamingo",
- "slug": "floating-flamingo",
- "is_global": false,
- "max_load": 100,
- "dimensions": [
- 100,
- 140,
- 80
], - "container_dimensions": [
- 100,
- 140,
- 80
], - "vehicle_type": "amr",
- "extra_details": { }
}
]
Create a new vehicle category for the organization
required | string or string UUID or SLUG of the target resource |
title | string |
max_load | number The maximum load of the vehicle category in Kg |
dimensions | Array of numbers The dimensions of the vehicle category |
container_dimensions | Array of numbers The container dimensions of the vehicle category |
vehicle_type | string Enum: "amr" "agv" The type of the vehicle category |
extra_details | object Extra details of the vehicle category |
{- "title": "Floating Flamingo",
- "max_load": 100,
- "dimensions": [
- 100,
- 140,
- 80
], - "container_dimensions": [
- 100,
- 140,
- 80
], - "vehicle_type": "amr",
- "extra_details": { }
}
{- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "title": "Floating Flamingo",
- "slug": "floating-flamingo",
- "is_global": false,
- "max_load": 100,
- "dimensions": [
- 100,
- 140,
- 80
], - "container_dimensions": [
- 100,
- 140,
- 80
], - "vehicle_type": "amr",
- "extra_details": { }
}
List all SDK tokens belonging to the organization
required | string or string UUID or SLUG of the target resource |
[- {
- "uuid": "f5ab0e553f1f4d03b9e84fd5cb7c7b3a",
- "name": "Task manager token",
- "task_access": true,
- "vehicle_access": true,
- "form_access": true,
- "created": "2019-08-24T14:15:22Z"
}
]
Create a new SDK token and attach it to the organization and the domain
required | string or string UUID or SLUG of the target resource |
name required | string |
task_access | boolean |
vehicle_access | boolean |
form_access | boolean |
{- "name": "Task manager token",
- "task_access": true,
- "vehicle_access": true,
- "form_access": true
}
[- {
- "uuid": "f5ab0e553f1f4d03b9e84fd5cb7c7b3a",
- "name": "Task manager token",
- "task_access": true,
- "vehicle_access": true,
- "form_access": true,
- "created": "2019-08-24T14:15:22Z"
}
]
This part of documentation describes the functionality of setups that help teams organize their fleets into smaller groups
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "4b141de094a94e4a97d809c5522d7d6c",
- "verbose_name": "Setup 1",
- "pin": "HKGEG",
- "created_at": "2022-07-22T10:40:21.224184+02:00",
- "used": "2019-08-24T14:15:22Z",
- "mqtt_id": "meili-agent-fff53e61-005c-4116-9c5c-cde6c501ee83",
- "ros_logs_frequency": 0,
- "vehicles": [
- {
- "uuid": "08b5fe9879584060b42907ee6f9ebadb",
- "prefix": "string",
- "topic_overrides": [
- {
- "label": "pose",
- "topic": "string",
- "message_type": "string"
}
], - "vehicle": {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo"
}
}
]
}
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
verbose_name required | string |
ros_logs_frequency | integer or null |
Array of objects (SetupVehicleProfile) |
{- "verbose_name": "Setup 1",
- "ros_logs_frequency": 0,
- "vehicles": [
- {
- "uuid": "08b5fe9879584060b42907ee6f9ebadb",
- "prefix": "string",
- "topic_overrides": [
- {
- "label": "pose",
- "topic": "string",
- "message_type": "string"
}
]
}
]
}
{- "uuid": "4b141de094a94e4a97d809c5522d7d6c",
- "verbose_name": "Setup 1",
- "pin": "HKGEG",
- "created_at": "2022-07-22T10:40:21.224184+02:00",
- "used": "2019-08-24T14:15:22Z",
- "mqtt_id": "meili-agent-fff53e61-005c-4116-9c5c-cde6c501ee83",
- "ros_logs_frequency": 0,
- "vehicles": [
- {
- "uuid": "08b5fe9879584060b42907ee6f9ebadb",
- "prefix": "string",
- "topic_overrides": [
- {
- "label": "pose",
- "topic": "string",
- "message_type": "string"
}
], - "vehicle": {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo"
}
}
]
}
required | string or string UUID or SLUG of the target resource |
used | string Enum: true false Filter setups by used state |
verbose_name | string Filter setups by verbose name |
[- {
- "uuid": "4b141de094a94e4a97d809c5522d7d6c",
- "verbose_name": "Setup 1",
- "pin": "HKGEG",
- "created_at": "2022-07-22T10:40:21.224184+02:00",
- "used": "2019-08-24T14:15:22Z",
- "mqtt_id": "meili-agent-fff53e61-005c-4116-9c5c-cde6c501ee83",
- "ros_logs_frequency": 0,
- "vehicles": [
- {
- "uuid": "08b5fe9879584060b42907ee6f9ebadb",
- "prefix": "string",
- "topic_overrides": [
- {
- "label": "pose",
- "topic": "string",
- "message_type": "string"
}
], - "vehicle": {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo"
}
}
]
}
]
required | string or string UUID or SLUG of the target resource |
verbose_name required | string |
ros_logs_frequency | integer or null |
Array of objects (SetupVehicleProfile) |
{- "verbose_name": "Setup 1",
- "ros_logs_frequency": 0,
- "vehicles": [
- {
- "uuid": "08b5fe9879584060b42907ee6f9ebadb",
- "prefix": "string",
- "topic_overrides": [
- {
- "label": "pose",
- "topic": "string",
- "message_type": "string"
}
]
}
]
}
[- {
- "uuid": "4b141de094a94e4a97d809c5522d7d6c",
- "verbose_name": "Setup 1",
- "pin": "HKGEG",
- "created_at": "2022-07-22T10:40:21.224184+02:00",
- "used": "2019-08-24T14:15:22Z",
- "mqtt_id": "meili-agent-fff53e61-005c-4116-9c5c-cde6c501ee83",
- "ros_logs_frequency": 0,
- "vehicles": [
- {
- "uuid": "08b5fe9879584060b42907ee6f9ebadb",
- "prefix": "string",
- "topic_overrides": [
- {
- "label": "pose",
- "topic": "string",
- "message_type": "string"
}
], - "vehicle": {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo"
}
}
]
}
]
This section of our API documentation will document the functionality of Tasks.
Note: Please see Tasks V2 part of our documentation to use the latest version of the API that includes latest developments.
Return scheduled tasks
required | string or string UUID or SLUG of the target resource |
{- "uuid": "17fdb48466104825b800d791c6a813d7",
- "name": "Schedule for preset Recurring preset",
- "preset": "20128c30066b4c6dbb1261d0c5387c11",
- "date": "2019-08-24",
- "time": "14:15:22Z",
- "enabled": true,
- "one_time": true,
- "week_days": [
- 0
], - "task_preset": {
- "uuid": "20128c30066b4c6dbb1261d0c5387c11",
- "title": "Recurring preset",
- "slug": "recurring-preset",
- "subtasks": [
- {
- "uuid": "bcca2d0c24994fe897b365ae740cb811",
- "index": 0,
- "indoor_point": {
- "uuid": "36ee0ac1e01045758b52cef09451e908",
- "x": 10,
- "y": 10,
- "rotation": 35.5,
- "metric": {
- "x": 1.42,
- "y": 1.42
}, - "preset": "f7e0568514c14357a974cb716ea88c2d"
}, - "auto_confirmation": true
}
], - "confirmation_methods": [
- "user"
], - "auto_confirmation": true
}, - "date_tz": "2019-08-24",
- "time_tz": "14:15:22Z",
- "week_days_tz": [
- 0
], - "offline": true,
- "execute_every": 0,
- "vehicle_uuid": "49ced169d8f44808b0422cf5317d9e45",
- "cron": "*/5 * * * *",
- "active_from": "14:15:22Z",
- "active_to": "14:15:22Z",
- "active_from_tz": "14:15:22Z",
- "active_to_tz": "14:15:22Z"
}
Update scheduled task
required | string or string UUID or SLUG of the target resource |
name | string |
preset | string <uuid> |
date | string <date> |
time | string <time> |
enabled | boolean |
week_days | Array of integers (Weekdays) Items Enum: 0 1 2 3 4 5 6 |
required | object (TaskPreset) |
week_days_tz | Array of integers (Weekdays) Items Enum: 0 1 2 3 4 5 6 |
offline | boolean |
execute_every | integer |
vehicle_uuid | string or null <uuid> |
active_from | string or null <time> |
active_to | string or null <time> |
{- "name": "Schedule for preset Recurring preset",
- "preset": "20128c30066b4c6dbb1261d0c5387c11",
- "date": "2019-08-24",
- "time": "14:15:22Z",
- "enabled": true,
- "week_days": [
- 0
], - "task_preset": {
- "title": "Recurring preset",
- "subtasks": [
- {
- "point_uuid": "36ee0ac1e01045758b52cef09451e908",
- "index": 0,
- "auto_confirmation": true
}
], - "confirmation_methods": [
- "user"
], - "auto_confirmation": true
}, - "week_days_tz": [
- 0
], - "offline": true,
- "execute_every": 0,
- "vehicle_uuid": "49ced169d8f44808b0422cf5317d9e45",
- "active_from": "14:15:22Z",
- "active_to": "14:15:22Z"
}
{- "uuid": "17fdb48466104825b800d791c6a813d7",
- "name": "Schedule for preset Recurring preset",
- "preset": "20128c30066b4c6dbb1261d0c5387c11",
- "date": "2019-08-24",
- "time": "14:15:22Z",
- "enabled": true,
- "one_time": true,
- "week_days": [
- 0
], - "task_preset": {
- "uuid": "20128c30066b4c6dbb1261d0c5387c11",
- "title": "Recurring preset",
- "slug": "recurring-preset",
- "subtasks": [
- {
- "uuid": "bcca2d0c24994fe897b365ae740cb811",
- "index": 0,
- "indoor_point": {
- "uuid": "36ee0ac1e01045758b52cef09451e908",
- "x": 10,
- "y": 10,
- "rotation": 35.5,
- "metric": {
- "x": 1.42,
- "y": 1.42
}, - "preset": "f7e0568514c14357a974cb716ea88c2d"
}, - "auto_confirmation": true
}
], - "confirmation_methods": [
- "user"
], - "auto_confirmation": true
}, - "date_tz": "2019-08-24",
- "time_tz": "14:15:22Z",
- "week_days_tz": [
- 0
], - "offline": true,
- "execute_every": 0,
- "vehicle_uuid": "49ced169d8f44808b0422cf5317d9e45",
- "cron": "*/5 * * * *",
- "active_from": "14:15:22Z",
- "active_to": "14:15:22Z",
- "active_from_tz": "14:15:22Z",
- "active_to_tz": "14:15:22Z"
}
Cancel next execution of a scheduled task
required | string or string UUID or SLUG of the target resource |
{- "uuid": "17fdb48466104825b800d791c6a813d7",
- "scheduled_task": "17fdb48466104825b800d791c6a813d7",
- "from_time": "2020-01-01T00:00+01:00",
- "to_time": "2023-11-01T23:00+01:00"
}
Return task
required | string or string UUID or SLUG of the target resource |
{- "uuid": "11495b9cca374e41a1cda9604169235b",
- "number": "20220113_0543",
- "task_status": "created",
- "created_at": "2019-08-24T14:15:22Z",
- "executed_at": "2019-08-24T14:15:22Z",
- "disconnected": "2019-08-24T14:15:22Z",
- "seen": true,
- "user": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}, - "vehicle": {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo",
- "slug": "floating-flamingo",
- "vehicle_type": "amr",
- "environment_type": "inside",
- "vehicle_serial_number": "fe9fc7b5d6ef40d5b0b73fa85a378456",
- "active": true,
- "category": "c2bfb3237b874e238a7efa727d8485f8",
- "category_name": "TurtleBot",
- "team": "4c310b85696e4ffe9283f9bdfe2337f1",
- "team_name": "Warehouse team 1",
- "full_battery": null,
- "emergency_battery_level": null,
- "emergency_distance": null,
- "use_team_battery_defaults": true,
- "manufacturer": null,
- "custom_manufacturer": "meili",
- "batch_tasks": true,
- "battery_management_enabled": true,
- "working_battery_level": 25,
- "dimensions": [
- 100,
- 100,
- 100
], - "executing_looped_task": false,
- "message_frequency": 1,
- "traffic_control_delay": 0,
- "is_collision_detected": false,
- "collision_type": null,
- "integration_type": "ROS",
- "initial_position": {
- "x": null,
- "y": null,
- "theta": null
}, - "vehicle_state": "ready",
- "battery_configured": true,
- "inherit_category_topics": true,
- "drivable_distance": 2000
}, - "subtasks": [
- {
- "uuid": "76a97471652d49b5b12bb771ea6ce83c",
- "name": "Point 1",
- "executed_at": "2019-08-24T14:15:22Z",
- "preset": "f7e0568514c14357a974cb716ea88c2d",
- "index": 0,
- "status": "created",
- "location": {
- "uuid": "36ee0ac1e01045758b52cef09451e908",
- "x": 10,
- "y": 10,
- "rotation": 35.5,
- "metric": {
- "x": 1.42,
- "y": 1.42
}, - "preset": "f7e0568514c14357a974cb716ea88c2d"
}, - "auto_confirmation": true
}
], - "relaunched_from": "4b1a2e81219349808207e366907040bc",
- "is_relaunchable": true,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user"
], - "preset": "f7e0568514c14357a974cb716ea88c2d",
- "scheduled_task": "aaa25487c17b4ddeaabf06cf4c5b2cf8"
}
Confirm leg of the task
required | string or string UUID or SLUG of the target resource |
{- "uuid": "11495b9cca374e41a1cda9604169235b",
- "number": "20220113_0543",
- "task_status": "created",
- "created_at": "2019-08-24T14:15:22Z",
- "executed_at": "2019-08-24T14:15:22Z",
- "disconnected": "2019-08-24T14:15:22Z",
- "seen": true,
- "user": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}, - "vehicle": {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo",
- "slug": "floating-flamingo",
- "vehicle_type": "amr",
- "environment_type": "inside",
- "vehicle_serial_number": "fe9fc7b5d6ef40d5b0b73fa85a378456",
- "active": true,
- "category": "c2bfb3237b874e238a7efa727d8485f8",
- "category_name": "TurtleBot",
- "team": "4c310b85696e4ffe9283f9bdfe2337f1",
- "team_name": "Warehouse team 1",
- "full_battery": null,
- "emergency_battery_level": null,
- "emergency_distance": null,
- "use_team_battery_defaults": true,
- "manufacturer": null,
- "custom_manufacturer": "meili",
- "batch_tasks": true,
- "battery_management_enabled": true,
- "working_battery_level": 25,
- "dimensions": [
- 100,
- 100,
- 100
], - "executing_looped_task": false,
- "message_frequency": 1,
- "traffic_control_delay": 0,
- "is_collision_detected": false,
- "collision_type": null,
- "integration_type": "ROS",
- "initial_position": {
- "x": null,
- "y": null,
- "theta": null
}, - "vehicle_state": "ready",
- "battery_configured": true,
- "inherit_category_topics": true,
- "drivable_distance": 2000
}, - "subtasks": [
- {
- "uuid": "76a97471652d49b5b12bb771ea6ce83c",
- "name": "Point 1",
- "executed_at": "2019-08-24T14:15:22Z",
- "preset": "f7e0568514c14357a974cb716ea88c2d",
- "index": 0,
- "status": "created",
- "location": {
- "uuid": "36ee0ac1e01045758b52cef09451e908",
- "x": 10,
- "y": 10,
- "rotation": 35.5,
- "metric": {
- "x": 1.42,
- "y": 1.42
}, - "preset": "f7e0568514c14357a974cb716ea88c2d"
}, - "auto_confirmation": true
}
], - "relaunched_from": "4b1a2e81219349808207e366907040bc",
- "is_relaunchable": true,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user"
], - "preset": "f7e0568514c14357a974cb716ea88c2d",
- "scheduled_task": "aaa25487c17b4ddeaabf06cf4c5b2cf8"
}
Relaunch or mark task as seen
required | string or string UUID or SLUG of the target resource |
seen | boolean |
relaunch | boolean |
{- "seen": true,
- "relaunch": true
}
{- "uuid": "11495b9cca374e41a1cda9604169235b",
- "number": "20220113_0543",
- "task_status": "created",
- "created_at": "2019-08-24T14:15:22Z",
- "executed_at": "2019-08-24T14:15:22Z",
- "disconnected": "2019-08-24T14:15:22Z",
- "seen": true,
- "user": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}, - "vehicle": {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo",
- "slug": "floating-flamingo",
- "vehicle_type": "amr",
- "environment_type": "inside",
- "vehicle_serial_number": "fe9fc7b5d6ef40d5b0b73fa85a378456",
- "active": true,
- "category": "c2bfb3237b874e238a7efa727d8485f8",
- "category_name": "TurtleBot",
- "team": "4c310b85696e4ffe9283f9bdfe2337f1",
- "team_name": "Warehouse team 1",
- "full_battery": null,
- "emergency_battery_level": null,
- "emergency_distance": null,
- "use_team_battery_defaults": true,
- "manufacturer": null,
- "custom_manufacturer": "meili",
- "batch_tasks": true,
- "battery_management_enabled": true,
- "working_battery_level": 25,
- "dimensions": [
- 100,
- 100,
- 100
], - "executing_looped_task": false,
- "message_frequency": 1,
- "traffic_control_delay": 0,
- "is_collision_detected": false,
- "collision_type": null,
- "integration_type": "ROS",
- "initial_position": {
- "x": null,
- "y": null,
- "theta": null
}, - "vehicle_state": "ready",
- "battery_configured": true,
- "inherit_category_topics": true,
- "drivable_distance": 2000
}, - "subtasks": [
- {
- "uuid": "76a97471652d49b5b12bb771ea6ce83c",
- "name": "Point 1",
- "executed_at": "2019-08-24T14:15:22Z",
- "preset": "f7e0568514c14357a974cb716ea88c2d",
- "index": 0,
- "status": "created",
- "location": {
- "uuid": "36ee0ac1e01045758b52cef09451e908",
- "x": 10,
- "y": 10,
- "rotation": 35.5,
- "metric": {
- "x": 1.42,
- "y": 1.42
}, - "preset": "f7e0568514c14357a974cb716ea88c2d"
}, - "auto_confirmation": true
}
], - "relaunched_from": "4b1a2e81219349808207e366907040bc",
- "is_relaunchable": true,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user"
], - "preset": "f7e0568514c14357a974cb716ea88c2d",
- "scheduled_task": "aaa25487c17b4ddeaabf06cf4c5b2cf8"
}
Fail task and the remaining subtasks
required | string or string UUID or SLUG of the target resource |
{- "uuid": "11495b9cca374e41a1cda9604169235b",
- "number": "20220113_0543",
- "task_status": "created",
- "created_at": "2019-08-24T14:15:22Z",
- "executed_at": "2019-08-24T14:15:22Z",
- "disconnected": "2019-08-24T14:15:22Z",
- "seen": true,
- "user": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}, - "vehicle": {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo",
- "slug": "floating-flamingo",
- "vehicle_type": "amr",
- "environment_type": "inside",
- "vehicle_serial_number": "fe9fc7b5d6ef40d5b0b73fa85a378456",
- "active": true,
- "category": "c2bfb3237b874e238a7efa727d8485f8",
- "category_name": "TurtleBot",
- "team": "4c310b85696e4ffe9283f9bdfe2337f1",
- "team_name": "Warehouse team 1",
- "full_battery": null,
- "emergency_battery_level": null,
- "emergency_distance": null,
- "use_team_battery_defaults": true,
- "manufacturer": null,
- "custom_manufacturer": "meili",
- "batch_tasks": true,
- "battery_management_enabled": true,
- "working_battery_level": 25,
- "dimensions": [
- 100,
- 100,
- 100
], - "executing_looped_task": false,
- "message_frequency": 1,
- "traffic_control_delay": 0,
- "is_collision_detected": false,
- "collision_type": null,
- "integration_type": "ROS",
- "initial_position": {
- "x": null,
- "y": null,
- "theta": null
}, - "vehicle_state": "ready",
- "battery_configured": true,
- "inherit_category_topics": true,
- "drivable_distance": 2000
}, - "subtasks": [
- {
- "uuid": "76a97471652d49b5b12bb771ea6ce83c",
- "name": "Point 1",
- "executed_at": "2019-08-24T14:15:22Z",
- "preset": "f7e0568514c14357a974cb716ea88c2d",
- "index": 0,
- "status": "created",
- "location": {
- "uuid": "36ee0ac1e01045758b52cef09451e908",
- "x": 10,
- "y": 10,
- "rotation": 35.5,
- "metric": {
- "x": 1.42,
- "y": 1.42
}, - "preset": "f7e0568514c14357a974cb716ea88c2d"
}, - "auto_confirmation": true
}
], - "relaunched_from": "4b1a2e81219349808207e366907040bc",
- "is_relaunchable": true,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user"
], - "preset": "f7e0568514c14357a974cb716ea88c2d",
- "scheduled_task": "aaa25487c17b4ddeaabf06cf4c5b2cf8"
}
Return task preset
required | string or string UUID or SLUG of the target resource |
{- "uuid": "20128c30066b4c6dbb1261d0c5387c11",
- "title": "Recurring preset",
- "slug": "recurring-preset",
- "subtasks": [
- {
- "uuid": "bcca2d0c24994fe897b365ae740cb811",
- "index": 0,
- "indoor_point": {
- "uuid": "36ee0ac1e01045758b52cef09451e908",
- "x": 10,
- "y": 10,
- "rotation": 35.5,
- "metric": {
- "x": 1.42,
- "y": 1.42
}, - "preset": "f7e0568514c14357a974cb716ea88c2d"
}, - "auto_confirmation": true
}
], - "confirmation_methods": [
- "user"
], - "auto_confirmation": true
}
Launch a task from preset
required | string or string UUID or SLUG of the target resource |
number | string or null |
auto_confirmation | boolean |
looped_task | boolean |
priority_level | integer |
{- "number": "20200113_0451",
- "auto_confirmation": true,
- "looped_task": true,
- "priority_level": 0
}
{- "uuid": "11495b9cca374e41a1cda9604169235b",
- "number": "20220113_0543",
- "task_status": "created",
- "created_at": "2019-08-24T14:15:22Z",
- "executed_at": "2019-08-24T14:15:22Z",
- "disconnected": "2019-08-24T14:15:22Z",
- "seen": true,
- "user": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}, - "vehicle": {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo",
- "slug": "floating-flamingo",
- "vehicle_type": "amr",
- "environment_type": "inside",
- "vehicle_serial_number": "fe9fc7b5d6ef40d5b0b73fa85a378456",
- "active": true,
- "category": "c2bfb3237b874e238a7efa727d8485f8",
- "category_name": "TurtleBot",
- "team": "4c310b85696e4ffe9283f9bdfe2337f1",
- "team_name": "Warehouse team 1",
- "full_battery": null,
- "emergency_battery_level": null,
- "emergency_distance": null,
- "use_team_battery_defaults": true,
- "manufacturer": null,
- "custom_manufacturer": "meili",
- "batch_tasks": true,
- "battery_management_enabled": true,
- "working_battery_level": 25,
- "dimensions": [
- 100,
- 100,
- 100
], - "executing_looped_task": false,
- "message_frequency": 1,
- "traffic_control_delay": 0,
- "is_collision_detected": false,
- "collision_type": null,
- "integration_type": "ROS",
- "initial_position": {
- "x": null,
- "y": null,
- "theta": null
}, - "vehicle_state": "ready",
- "battery_configured": true,
- "inherit_category_topics": true,
- "drivable_distance": 2000
}, - "subtasks": [
- {
- "uuid": "76a97471652d49b5b12bb771ea6ce83c",
- "name": "Point 1",
- "executed_at": "2019-08-24T14:15:22Z",
- "preset": "f7e0568514c14357a974cb716ea88c2d",
- "index": 0,
- "status": "created",
- "location": {
- "uuid": "36ee0ac1e01045758b52cef09451e908",
- "x": 10,
- "y": 10,
- "rotation": 35.5,
- "metric": {
- "x": 1.42,
- "y": 1.42
}, - "preset": "f7e0568514c14357a974cb716ea88c2d"
}, - "auto_confirmation": true
}
], - "relaunched_from": "4b1a2e81219349808207e366907040bc",
- "is_relaunchable": true,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user"
], - "preset": "f7e0568514c14357a974cb716ea88c2d",
- "scheduled_task": "aaa25487c17b4ddeaabf06cf4c5b2cf8"
}
Update task preset
required | string or string UUID or SLUG of the target resource |
title required | string |
required | Array of objects (SubtaskPreset) |
confirmation_methods | Array of strings (ConfirmationMethodList) Items Enum: "user" "auto" "workflow" "trigger" |
auto_confirmation | boolean |
{- "title": "Recurring preset",
- "subtasks": [
- {
- "point_uuid": "36ee0ac1e01045758b52cef09451e908",
- "index": 0,
- "auto_confirmation": true
}
], - "confirmation_methods": [
- "user"
], - "auto_confirmation": true
}
{- "uuid": "20128c30066b4c6dbb1261d0c5387c11",
- "title": "Recurring preset",
- "slug": "recurring-preset",
- "subtasks": [
- {
- "uuid": "bcca2d0c24994fe897b365ae740cb811",
- "index": 0,
- "indoor_point": {
- "uuid": "36ee0ac1e01045758b52cef09451e908",
- "x": 10,
- "y": 10,
- "rotation": 35.5,
- "metric": {
- "x": 1.42,
- "y": 1.42
}, - "preset": "f7e0568514c14357a974cb716ea88c2d"
}, - "auto_confirmation": true
}
], - "confirmation_methods": [
- "user"
], - "auto_confirmation": true
}
Return a list of team tasks
required | string or string UUID or SLUG of the target resource |
user | string Enum: "self" "user@email.com" Filter tasks by user |
time | string Enum: "today" "yesterday" "week" Filter tasks by time period |
range | string Examples: range=2020-01-01T00:00:00/2020-01-01T23:59:59 range=2024 range=2024-01 range=2024-01-01 range=2024-01-01T00:00:00/2024-01-03 Filter tasks by exact time range,The range can be a single date/datetime or a date/datetime range.,It expects the date/datetime in the team's timezone. |
state | string Enum: "progressing" "executed" Filter tasks by state |
status | string Enum: "created" "pending" "rerun" "sent" "terminated" "in_progress" "completed" "aborted" "failed" "failed_offline" "completed_offline" "offline" Filter tasks by status |
vehicle_slug | string Example: vehicle_slug=v1 Filter tasks by vehicle slug |
vehicle_verbose_name | string Example: vehicle_verbose_name=v1 Filter tasks by vehicle verbose name |
[- {
- "uuid": "11495b9cca374e41a1cda9604169235b",
- "number": "20220113_0543",
- "task_status": "created",
- "created_at": "2019-08-24T14:15:22Z",
- "executed_at": "2019-08-24T14:15:22Z",
- "disconnected": "2019-08-24T14:15:22Z",
- "seen": true,
- "user": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}, - "vehicle": {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo",
- "slug": "floating-flamingo",
- "vehicle_type": "amr",
- "environment_type": "inside",
- "vehicle_serial_number": "fe9fc7b5d6ef40d5b0b73fa85a378456",
- "active": true,
- "category": "c2bfb3237b874e238a7efa727d8485f8",
- "category_name": "TurtleBot",
- "team": "4c310b85696e4ffe9283f9bdfe2337f1",
- "team_name": "Warehouse team 1",
- "full_battery": null,
- "emergency_battery_level": null,
- "emergency_distance": null,
- "use_team_battery_defaults": true,
- "manufacturer": null,
- "custom_manufacturer": "meili",
- "batch_tasks": true,
- "battery_management_enabled": true,
- "working_battery_level": 25,
- "dimensions": [
- 100,
- 100,
- 100
], - "executing_looped_task": false,
- "message_frequency": 1,
- "traffic_control_delay": 0,
- "is_collision_detected": false,
- "collision_type": null,
- "integration_type": "ROS",
- "initial_position": {
- "x": null,
- "y": null,
- "theta": null
}, - "vehicle_state": "ready",
- "battery_configured": true,
- "inherit_category_topics": true,
- "drivable_distance": 2000
}, - "subtasks": [
- {
- "uuid": "76a97471652d49b5b12bb771ea6ce83c",
- "name": "Point 1",
- "executed_at": "2019-08-24T14:15:22Z",
- "preset": "f7e0568514c14357a974cb716ea88c2d",
- "index": 0,
- "status": "created",
- "location": {
- "uuid": "36ee0ac1e01045758b52cef09451e908",
- "x": 10,
- "y": 10,
- "rotation": 35.5,
- "metric": {
- "x": 1.42,
- "y": 1.42
}, - "preset": "f7e0568514c14357a974cb716ea88c2d"
}, - "auto_confirmation": true
}
], - "relaunched_from": "4b1a2e81219349808207e366907040bc",
- "is_relaunchable": true,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user"
], - "preset": "f7e0568514c14357a974cb716ea88c2d",
- "scheduled_task": "aaa25487c17b4ddeaabf06cf4c5b2cf8"
}
]
Create a new task for the team
required | string or string UUID or SLUG of the target resource |
number | string |
required | Array of objects (SubtaskCreationObject) |
auto_confirmation | boolean |
confirmation_methods | Array of strings (ConfirmationMethodList) Items Enum: "user" "auto" "workflow" "trigger" |
vehicle_uuid | string <uuid> If specified, FMS will automatically assign the selected vehicle and skip allocation |
vehicle_category_uuid | string <uuid> If specified, FMS will only selected vehicles from the given category |
{- "number": "20220113_0543",
- "tasks": [
- {
- "location": "36ee0ac1e01045758b52cef09451e908",
- "index": 0,
- "auto_confirmation": true
}
], - "auto_confirmation": true,
- "confirmation_methods": [
- "user"
], - "vehicle_uuid": "49ced169d8f44808b0422cf5317d9e45",
- "vehicle_category_uuid": "c2bfb3237b874e238a7efa727d8485f8"
}
{- "uuid": "11495b9cca374e41a1cda9604169235b",
- "number": "20220113_0543",
- "task_status": "created",
- "created_at": "2019-08-24T14:15:22Z",
- "executed_at": "2019-08-24T14:15:22Z",
- "disconnected": "2019-08-24T14:15:22Z",
- "seen": true,
- "user": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}, - "vehicle": {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo",
- "slug": "floating-flamingo",
- "vehicle_type": "amr",
- "environment_type": "inside",
- "vehicle_serial_number": "fe9fc7b5d6ef40d5b0b73fa85a378456",
- "active": true,
- "category": "c2bfb3237b874e238a7efa727d8485f8",
- "category_name": "TurtleBot",
- "team": "4c310b85696e4ffe9283f9bdfe2337f1",
- "team_name": "Warehouse team 1",
- "full_battery": null,
- "emergency_battery_level": null,
- "emergency_distance": null,
- "use_team_battery_defaults": true,
- "manufacturer": null,
- "custom_manufacturer": "meili",
- "batch_tasks": true,
- "battery_management_enabled": true,
- "working_battery_level": 25,
- "dimensions": [
- 100,
- 100,
- 100
], - "executing_looped_task": false,
- "message_frequency": 1,
- "traffic_control_delay": 0,
- "is_collision_detected": false,
- "collision_type": null,
- "integration_type": "ROS",
- "initial_position": {
- "x": null,
- "y": null,
- "theta": null
}, - "vehicle_state": "ready",
- "battery_configured": true,
- "inherit_category_topics": true,
- "drivable_distance": 2000
}, - "subtasks": [
- {
- "uuid": "76a97471652d49b5b12bb771ea6ce83c",
- "name": "Point 1",
- "executed_at": "2019-08-24T14:15:22Z",
- "preset": "f7e0568514c14357a974cb716ea88c2d",
- "index": 0,
- "status": "created",
- "location": {
- "uuid": "36ee0ac1e01045758b52cef09451e908",
- "x": 10,
- "y": 10,
- "rotation": 35.5,
- "metric": {
- "x": 1.42,
- "y": 1.42
}, - "preset": "f7e0568514c14357a974cb716ea88c2d"
}, - "auto_confirmation": true
}
], - "relaunched_from": "4b1a2e81219349808207e366907040bc",
- "is_relaunchable": true,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user"
], - "preset": "f7e0568514c14357a974cb716ea88c2d",
- "scheduled_task": "aaa25487c17b4ddeaabf06cf4c5b2cf8"
}
Return a list of team task presets
required | string or string UUID or SLUG of the target resource |
title | string Filter task presets by title |
[- {
- "uuid": "20128c30066b4c6dbb1261d0c5387c11",
- "title": "Recurring preset",
- "slug": "recurring-preset",
- "subtasks": [
- {
- "uuid": "bcca2d0c24994fe897b365ae740cb811",
- "index": 0,
- "indoor_point": {
- "uuid": "36ee0ac1e01045758b52cef09451e908",
- "x": 10,
- "y": 10,
- "rotation": 35.5,
- "metric": {
- "x": 1.42,
- "y": 1.42
}, - "preset": "f7e0568514c14357a974cb716ea88c2d"
}, - "auto_confirmation": true
}
], - "confirmation_methods": [
- "user"
], - "auto_confirmation": true
}
]
Create a new task preset for the team
required | string or string UUID or SLUG of the target resource |
title required | string |
required | Array of objects (SubtaskPreset) |
confirmation_methods | Array of strings (ConfirmationMethodList) Items Enum: "user" "auto" "workflow" "trigger" |
auto_confirmation | boolean |
{- "title": "Recurring preset",
- "subtasks": [
- {
- "point_uuid": "36ee0ac1e01045758b52cef09451e908",
- "index": 0,
- "auto_confirmation": true
}
], - "confirmation_methods": [
- "user"
], - "auto_confirmation": true
}
{- "uuid": "20128c30066b4c6dbb1261d0c5387c11",
- "title": "Recurring preset",
- "slug": "recurring-preset",
- "subtasks": [
- {
- "uuid": "bcca2d0c24994fe897b365ae740cb811",
- "index": 0,
- "indoor_point": {
- "uuid": "36ee0ac1e01045758b52cef09451e908",
- "x": 10,
- "y": 10,
- "rotation": 35.5,
- "metric": {
- "x": 1.42,
- "y": 1.42
}, - "preset": "f7e0568514c14357a974cb716ea88c2d"
}, - "auto_confirmation": true
}
], - "confirmation_methods": [
- "user"
], - "auto_confirmation": true
}
Return a list of team task schedules
required | string or string UUID or SLUG of the target resource |
enabled | string Enum: true false Filter tasks by enabled state |
type | string Enum: "one-time" "repeating" Filter tasks by type |
show_all | string Enum: true false Returns only upcoming if show_all is not specified |
[- {
- "uuid": "17fdb48466104825b800d791c6a813d7",
- "name": "Schedule for preset Recurring preset",
- "preset": "20128c30066b4c6dbb1261d0c5387c11",
- "date": "2019-08-24",
- "time": "14:15:22Z",
- "enabled": true,
- "one_time": true,
- "week_days": [
- 0
], - "task_preset": {
- "uuid": "20128c30066b4c6dbb1261d0c5387c11",
- "title": "Recurring preset",
- "slug": "recurring-preset",
- "subtasks": [
- {
- "uuid": "bcca2d0c24994fe897b365ae740cb811",
- "index": 0,
- "indoor_point": {
- "uuid": "36ee0ac1e01045758b52cef09451e908",
- "x": 10,
- "y": 10,
- "rotation": 35.5,
- "metric": {
- "x": 1.42,
- "y": 1.42
}, - "preset": "f7e0568514c14357a974cb716ea88c2d"
}, - "auto_confirmation": true
}
], - "confirmation_methods": [
- "user"
], - "auto_confirmation": true
}, - "date_tz": "2019-08-24",
- "time_tz": "14:15:22Z",
- "week_days_tz": [
- 0
], - "offline": true,
- "execute_every": 0,
- "vehicle_uuid": "49ced169d8f44808b0422cf5317d9e45",
- "cron": "*/5 * * * *",
- "active_from": "14:15:22Z",
- "active_to": "14:15:22Z",
- "active_from_tz": "14:15:22Z",
- "active_to_tz": "14:15:22Z"
}
]
Create a new task schedule for the team
required | string or string UUID or SLUG of the target resource |
name | string |
preset | string <uuid> |
date | string <date> |
time | string <time> |
enabled | boolean |
week_days | Array of integers (Weekdays) Items Enum: 0 1 2 3 4 5 6 |
required | object (TaskPreset) |
week_days_tz | Array of integers (Weekdays) Items Enum: 0 1 2 3 4 5 6 |
offline | boolean |
execute_every | integer |
vehicle_uuid | string or null <uuid> |
active_from | string or null <time> |
active_to | string or null <time> |
{- "name": "Schedule for preset Recurring preset",
- "preset": "20128c30066b4c6dbb1261d0c5387c11",
- "date": "2019-08-24",
- "time": "14:15:22Z",
- "enabled": true,
- "week_days": [
- 0
], - "task_preset": {
- "title": "Recurring preset",
- "subtasks": [
- {
- "point_uuid": "36ee0ac1e01045758b52cef09451e908",
- "index": 0,
- "auto_confirmation": true
}
], - "confirmation_methods": [
- "user"
], - "auto_confirmation": true
}, - "week_days_tz": [
- 0
], - "offline": true,
- "execute_every": 0,
- "vehicle_uuid": "49ced169d8f44808b0422cf5317d9e45",
- "active_from": "14:15:22Z",
- "active_to": "14:15:22Z"
}
{- "uuid": "17fdb48466104825b800d791c6a813d7",
- "name": "Schedule for preset Recurring preset",
- "preset": "20128c30066b4c6dbb1261d0c5387c11",
- "date": "2019-08-24",
- "time": "14:15:22Z",
- "enabled": true,
- "one_time": true,
- "week_days": [
- 0
], - "task_preset": {
- "uuid": "20128c30066b4c6dbb1261d0c5387c11",
- "title": "Recurring preset",
- "slug": "recurring-preset",
- "subtasks": [
- {
- "uuid": "bcca2d0c24994fe897b365ae740cb811",
- "index": 0,
- "indoor_point": {
- "uuid": "36ee0ac1e01045758b52cef09451e908",
- "x": 10,
- "y": 10,
- "rotation": 35.5,
- "metric": {
- "x": 1.42,
- "y": 1.42
}, - "preset": "f7e0568514c14357a974cb716ea88c2d"
}, - "auto_confirmation": true
}
], - "confirmation_methods": [
- "user"
], - "auto_confirmation": true
}, - "date_tz": "2019-08-24",
- "time_tz": "14:15:22Z",
- "week_days_tz": [
- 0
], - "offline": true,
- "execute_every": 0,
- "vehicle_uuid": "49ced169d8f44808b0422cf5317d9e45",
- "cron": "*/5 * * * *",
- "active_from": "14:15:22Z",
- "active_to": "14:15:22Z",
- "active_from_tz": "14:15:22Z",
- "active_to_tz": "14:15:22Z"
}
This section of our API documentation will document the details of the second generation tasks.
The main difference between the v1 and v2 being configurable task actions which introduces more flexibility, but also at the same time more complexity to the endpoints.
user | string Enum: "self" "user@email.com" Filter tasks by user |
time | string Enum: "today" "yesterday" "week" Filter tasks by time period |
range | string Examples: range=2020-01-01T00:00:00/2020-01-01T23:59:59 range=2024 range=2024-01 range=2024-01-01 range=2024-01-01T00:00:00/2024-01-03 Filter tasks by exact time range,The range can be a single date/datetime or a date/datetime range.,It expects the date/datetime in the team's timezone. |
state | string Enum: "progressing" "executed" Filter tasks by state |
status | string Enum: "created" "pending" "rerun" "sent" "terminated" "in_progress" "completed" "aborted" "failed" "failed_offline" "completed_offline" "offline" Filter tasks by status |
vehicle_slug | string Example: vehicle_slug=v1 Filter tasks by vehicle slug |
vehicle_verbose_name | string Example: vehicle_verbose_name=v1 Filter tasks by vehicle verbose name |
expand | string Enum: "user" "required_vehicle_category" Example: expand=user Expand specific related fields for detailed information. |
{- "count": 1,
- "next": "string",
- "page": 1,
- "previous": "string",
- "results": [
- {
- "uuid": "11495b9cca374e41a1cda9604169235b",
- "number": "20220113_0543",
- "status": "created",
- "seen": true,
- "priority_level": 50,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user"
], - "can_be_confirmed": true,
- "can_be_relaunched": true,
- "relaunched_from": "7c2a734c-6bd1-4710-9e0f-c8542192fe44",
- "relaunched_task": "5f06ebe5-f11a-41db-8ce6-6788a157162f",
- "vehicle": "49ced169d8f44808b0422cf5317d9e45",
- "required_vehicle_category": "c2bfb3237b874e238a7efa727d8485f8",
- "looped_task": true,
- "subtasks": [
- {
- "uuid": "76a97471652d49b5b12bb771ea6ce83c",
- "status": "created",
- "index": 0,
- "ros_goal_id": "string",
- "action": {
- "uuid": "20a3cda5113b426ab890e592bfe9c3be",
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "form_values": { },
- "point": "36ee0ac1e01045758b52cef09451e908"
}, - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "executed_at": null,
- "robot_executed_at": null
}
}
], - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "executed_at": null,
- "disconnected": null
}, - "user": "dc1d2ecb8f00446496edf6edf3d813e7"
}
]
}
number | string |
priority_level | integer |
auto_confirmation | boolean |
confirmation_methods | Array of strings (ConfirmationMethodList) Items Enum: "user" "auto" "workflow" "trigger" |
vehicle | string <uuid> |
required_vehicle_category | string <uuid> |
looped_task | boolean |
required | Array of objects (tasks_Subtask) |
{- "number": "20220113_0543",
- "priority_level": 50,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user"
], - "vehicle": "49ced169d8f44808b0422cf5317d9e45",
- "required_vehicle_category": "c2bfb3237b874e238a7efa727d8485f8",
- "looped_task": true,
- "subtasks": [
- {
- "index": 0,
- "action": {
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "form_values": { },
- "point": "36ee0ac1e01045758b52cef09451e908"
}, - "action_preset": "7ffbf210-83d5-4706-8103-9a4d40d47c9c"
}
]
}
{- "uuid": "11495b9cca374e41a1cda9604169235b",
- "number": "20220113_0543",
- "status": "created",
- "seen": true,
- "priority_level": 50,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user"
], - "can_be_confirmed": true,
- "can_be_relaunched": true,
- "relaunched_from": "7c2a734c-6bd1-4710-9e0f-c8542192fe44",
- "relaunched_task": "5f06ebe5-f11a-41db-8ce6-6788a157162f",
- "vehicle": "49ced169d8f44808b0422cf5317d9e45",
- "required_vehicle_category": "c2bfb3237b874e238a7efa727d8485f8",
- "looped_task": true,
- "subtasks": [
- {
- "uuid": "76a97471652d49b5b12bb771ea6ce83c",
- "status": "created",
- "index": 0,
- "ros_goal_id": "string",
- "action": {
- "uuid": "20a3cda5113b426ab890e592bfe9c3be",
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "form_values": { },
- "point": "36ee0ac1e01045758b52cef09451e908"
}, - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "executed_at": null,
- "robot_executed_at": null
}
}
], - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "executed_at": null,
- "disconnected": null
}, - "user": "dc1d2ecb8f00446496edf6edf3d813e7"
}
Endpoint returns all task action definitions that are accessible to the team specified in the URL, both team member created ones and system generated ones that are not editable.
public | string Filter task action definitions by public state |
required_object | string Examples: required_object=form required_object=point required_object=path Filter task action definitions by required_object |
required_object | string Filter task action definitions by device_type |
displayable_name | string Search for tasks by displayable name |
slug | string Search for tasks by slug |
expand | string Value: "form" Example: expand=form Expand specific related fields for detailed information. |
{- "count": 1,
- "next": "string",
- "page": 1,
- "previous": "string",
- "results": [
- {
- "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "system_generated": false,
- "displayable_name": "Move to Point",
- "slug": "move_to_point",
- "description": "string",
- "form": "e2e5878f2ed4466792e514a8f396e271",
- "required_object": "form",
- "user_input_needed": true,
- "wait_for_confirmation": true
}
]
}
Create a new task action definition that is only accessible for the current team
displayable_name required | string |
slug | string <slug> |
description | string or null |
form | string or null <uuid> Required if Note: this field is not expandable |
required_object required | string Enum: "form" "point" "path" |
user_input_needed | boolean Default: true |
wait_for_confirmation | boolean Default: true |
{- "displayable_name": "Move to Point",
- "slug": "move_to_point",
- "description": "string",
- "form": "e2e5878f2ed4466792e514a8f396e271",
- "required_object": "form",
- "user_input_needed": true,
- "wait_for_confirmation": true
}
{- "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "system_generated": false,
- "displayable_name": "Move to Point",
- "slug": "move_to_point",
- "description": "string",
- "form": "e2e5878f2ed4466792e514a8f396e271",
- "required_object": "form",
- "user_input_needed": true,
- "wait_for_confirmation": true
}
expand | string Enum: "definition" "device" Example: expand=definition Expand specific related fields for detailed information. |
{- "count": 1,
- "next": "string",
- "page": 1,
- "previous": "string",
- "results": [
- {
- "uuid": "320ac1c8a0d94c07a41ea4143a4b780a",
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "description": "string",
- "point": null,
- "form_values": {
- "shelf_id": "Shelf1",
- "sub_area": "SubArea1"
}
}
]
}
definition required | string <uuid> |
description | string |
point | string or null <hex> Note: this field is not expandable |
form_values | object |
{- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "description": "string",
- "point": null,
- "form_values": {
- "shelf_id": "Shelf1",
- "sub_area": "SubArea1"
}
}
{- "uuid": "320ac1c8a0d94c07a41ea4143a4b780a",
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "description": "string",
- "point": null,
- "form_values": {
- "shelf_id": "Shelf1",
- "sub_area": "SubArea1"
}
}
{- "count": 1,
- "next": "string",
- "page": 1,
- "previous": "string",
- "results": [
- {
- "uuid": "20128c30066b4c6dbb1261d0c5387c11",
- "title": "Pick from Shelf 1",
- "slug": "pick-from-shelf-1",
- "required_vehicle_category": null,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user",
- "auto",
- "workflow",
- "trigger"
], - "looped_task": true,
- "subtasks": [
- {
- "uuid": "bcca2d0c24994fe897b365ae740cb811",
- "index": 0,
- "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "action": {
- "uuid": "20a3cda5113b426ab890e592bfe9c3be",
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "form_values": { },
- "point": "36ee0ac1e01045758b52cef09451e908"
}
}
], - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "priority_level": 50
}
]
}
title required | string <slug> |
slug | string <slug> |
required_vehicle_category | string <hex> |
auto_confirmation | boolean |
confirmation_methods | Array of strings |
looped_task | boolean |
required | Array of objects (task-preset_SubtaskPreset) |
priority_level | integer |
{- "title": "Pick from Shelf 1",
- "slug": "pick-from-shelf-1",
- "required_vehicle_category": null,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user",
- "auto",
- "workflow",
- "trigger"
], - "looped_task": true,
- "subtasks": [
- {
- "index": 0,
- "action": {
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "form_values": { },
- "point": "36ee0ac1e01045758b52cef09451e908"
}
}
], - "priority_level": 50
}
{- "uuid": "20128c30066b4c6dbb1261d0c5387c11",
- "title": "Pick from Shelf 1",
- "slug": "pick-from-shelf-1",
- "required_vehicle_category": null,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user",
- "auto",
- "workflow",
- "trigger"
], - "looped_task": true,
- "subtasks": [
- {
- "uuid": "bcca2d0c24994fe897b365ae740cb811",
- "index": 0,
- "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "action": {
- "uuid": "20a3cda5113b426ab890e592bfe9c3be",
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "form_values": { },
- "point": "36ee0ac1e01045758b52cef09451e908"
}
}
], - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "priority_level": 50
}
{- "uuid": "11495b9cca374e41a1cda9604169235b",
- "number": "20220113_0543",
- "status": "created",
- "seen": true,
- "priority_level": 50,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user"
], - "can_be_confirmed": true,
- "can_be_relaunched": true,
- "relaunched_from": "7c2a734c-6bd1-4710-9e0f-c8542192fe44",
- "relaunched_task": "5f06ebe5-f11a-41db-8ce6-6788a157162f",
- "vehicle": "49ced169d8f44808b0422cf5317d9e45",
- "required_vehicle_category": "c2bfb3237b874e238a7efa727d8485f8",
- "looped_task": true,
- "subtasks": [
- {
- "uuid": "76a97471652d49b5b12bb771ea6ce83c",
- "status": "created",
- "index": 0,
- "ros_goal_id": "string",
- "action": {
- "uuid": "20a3cda5113b426ab890e592bfe9c3be",
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "form_values": { },
- "point": "36ee0ac1e01045758b52cef09451e908"
}, - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "executed_at": null,
- "robot_executed_at": null
}
}
], - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "executed_at": null,
- "disconnected": null
}
}
{- "uuid": "11495b9cca374e41a1cda9604169235b",
- "number": "20220113_0543",
- "status": "created",
- "seen": true,
- "priority_level": 50,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user"
], - "can_be_confirmed": true,
- "can_be_relaunched": true,
- "relaunched_from": "7c2a734c-6bd1-4710-9e0f-c8542192fe44",
- "relaunched_task": "5f06ebe5-f11a-41db-8ce6-6788a157162f",
- "vehicle": "49ced169d8f44808b0422cf5317d9e45",
- "required_vehicle_category": "c2bfb3237b874e238a7efa727d8485f8",
- "looped_task": true,
- "subtasks": [
- {
- "uuid": "76a97471652d49b5b12bb771ea6ce83c",
- "status": "created",
- "index": 0,
- "ros_goal_id": "string",
- "action": {
- "uuid": "20a3cda5113b426ab890e592bfe9c3be",
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "form_values": { },
- "point": "36ee0ac1e01045758b52cef09451e908"
}, - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "executed_at": null,
- "robot_executed_at": null
}
}
], - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "executed_at": null,
- "disconnected": null
}
}
number | string |
priority_level | integer |
auto_confirmation | boolean |
confirmation_methods | Array of strings (ConfirmationMethodList) Items Enum: "user" "auto" "workflow" "trigger" |
vehicle | string <uuid> |
required_vehicle_category | string <uuid> |
looped_task | boolean |
required | Array of objects (tasks_Subtask) |
{- "number": "20220113_0543",
- "priority_level": 50,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user"
], - "vehicle": "49ced169d8f44808b0422cf5317d9e45",
- "required_vehicle_category": "c2bfb3237b874e238a7efa727d8485f8",
- "looped_task": true,
- "subtasks": [
- {
- "index": 0,
- "action": {
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "form_values": { },
- "point": "36ee0ac1e01045758b52cef09451e908"
}, - "action_preset": "7ffbf210-83d5-4706-8103-9a4d40d47c9c"
}
]
}
{- "uuid": "11495b9cca374e41a1cda9604169235b",
- "number": "20220113_0543",
- "status": "created",
- "seen": true,
- "priority_level": 50,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user"
], - "can_be_confirmed": true,
- "can_be_relaunched": true,
- "relaunched_from": "7c2a734c-6bd1-4710-9e0f-c8542192fe44",
- "relaunched_task": "5f06ebe5-f11a-41db-8ce6-6788a157162f",
- "vehicle": "49ced169d8f44808b0422cf5317d9e45",
- "required_vehicle_category": "c2bfb3237b874e238a7efa727d8485f8",
- "looped_task": true,
- "subtasks": [
- {
- "uuid": "76a97471652d49b5b12bb771ea6ce83c",
- "status": "created",
- "index": 0,
- "ros_goal_id": "string",
- "action": {
- "uuid": "20a3cda5113b426ab890e592bfe9c3be",
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "form_values": { },
- "point": "36ee0ac1e01045758b52cef09451e908"
}, - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "executed_at": null,
- "robot_executed_at": null
}
}
], - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "executed_at": null,
- "disconnected": null
}
}
{- "uuid": "11495b9cca374e41a1cda9604169235b",
- "number": "20220113_0543",
- "status": "created",
- "seen": true,
- "priority_level": 50,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user"
], - "can_be_confirmed": true,
- "can_be_relaunched": true,
- "relaunched_from": "7c2a734c-6bd1-4710-9e0f-c8542192fe44",
- "relaunched_task": "5f06ebe5-f11a-41db-8ce6-6788a157162f",
- "vehicle": "49ced169d8f44808b0422cf5317d9e45",
- "required_vehicle_category": "c2bfb3237b874e238a7efa727d8485f8",
- "looped_task": true,
- "subtasks": [
- {
- "uuid": "76a97471652d49b5b12bb771ea6ce83c",
- "status": "created",
- "index": 0,
- "ros_goal_id": "string",
- "action": {
- "uuid": "20a3cda5113b426ab890e592bfe9c3be",
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "form_values": { },
- "point": "36ee0ac1e01045758b52cef09451e908"
}, - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "executed_at": null,
- "robot_executed_at": null
}
}
], - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "executed_at": null,
- "disconnected": null
}
}
{- "uuid": "20128c30066b4c6dbb1261d0c5387c11",
- "title": "Pick from Shelf 1",
- "slug": "pick-from-shelf-1",
- "required_vehicle_category": null,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user",
- "auto",
- "workflow",
- "trigger"
], - "looped_task": true,
- "subtasks": [
- {
- "uuid": "bcca2d0c24994fe897b365ae740cb811",
- "index": 0,
- "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "action": {
- "uuid": "20a3cda5113b426ab890e592bfe9c3be",
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "form_values": { },
- "point": "36ee0ac1e01045758b52cef09451e908"
}
}
], - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "priority_level": 50
}
title required | string <slug> |
slug | string <slug> |
required_vehicle_category | string <hex> |
auto_confirmation | boolean |
confirmation_methods | Array of strings |
looped_task | boolean |
required | Array of objects (task-preset_SubtaskPreset) |
priority_level | integer |
{- "title": "Pick from Shelf 1",
- "slug": "pick-from-shelf-1",
- "required_vehicle_category": null,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user",
- "auto",
- "workflow",
- "trigger"
], - "looped_task": true,
- "subtasks": [
- {
- "index": 0,
- "action": {
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "form_values": { },
- "point": "36ee0ac1e01045758b52cef09451e908"
}
}
], - "priority_level": 50
}
{- "uuid": "20128c30066b4c6dbb1261d0c5387c11",
- "title": "Pick from Shelf 1",
- "slug": "pick-from-shelf-1",
- "required_vehicle_category": null,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user",
- "auto",
- "workflow",
- "trigger"
], - "looped_task": true,
- "subtasks": [
- {
- "uuid": "bcca2d0c24994fe897b365ae740cb811",
- "index": 0,
- "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "action": {
- "uuid": "20a3cda5113b426ab890e592bfe9c3be",
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "form_values": { },
- "point": "36ee0ac1e01045758b52cef09451e908"
}
}
], - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "priority_level": 50
}
{- "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "system_generated": false,
- "displayable_name": "Move to Point",
- "slug": "move_to_point",
- "description": "string",
- "form": "e2e5878f2ed4466792e514a8f396e271",
- "required_object": "form",
- "user_input_needed": true,
- "wait_for_confirmation": true
}
displayable_name required | string |
slug | string <slug> |
description | string or null |
form | string or null <uuid> Required if Note: this field is not expandable |
required_object required | string Enum: "form" "point" "path" |
user_input_needed | boolean Default: true |
wait_for_confirmation | boolean Default: true |
{- "displayable_name": "Move to Point",
- "slug": "move_to_point",
- "description": "string",
- "form": "e2e5878f2ed4466792e514a8f396e271",
- "required_object": "form",
- "user_input_needed": true,
- "wait_for_confirmation": true
}
{- "uuid": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "system_generated": false,
- "displayable_name": "Move to Point",
- "slug": "move_to_point",
- "description": "string",
- "form": "e2e5878f2ed4466792e514a8f396e271",
- "required_object": "form",
- "user_input_needed": true,
- "wait_for_confirmation": true
}
definition required | string <uuid> |
description | string |
point | string or null <hex> Note: this field is not expandable |
form_values | object |
{- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "description": "string",
- "point": null,
- "form_values": {
- "shelf_id": "Shelf1",
- "sub_area": "SubArea1"
}
}
{- "uuid": "320ac1c8a0d94c07a41ea4143a4b780a",
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "description": "string",
- "point": null,
- "form_values": {
- "shelf_id": "Shelf1",
- "sub_area": "SubArea1"
}
}
decision | string Enum: "continue_same" "continue_different" "abort" Decision on how to proceed with the task that is awaiting an abort decision. |
{- "decision": "continue_same"
}
{- "uuid": "11495b9cca374e41a1cda9604169235b",
- "number": "20220113_0543",
- "status": "created",
- "seen": true,
- "priority_level": 50,
- "auto_confirmation": true,
- "confirmation_methods": [
- "user"
], - "can_be_confirmed": true,
- "can_be_relaunched": true,
- "relaunched_from": "7c2a734c-6bd1-4710-9e0f-c8542192fe44",
- "relaunched_task": "5f06ebe5-f11a-41db-8ce6-6788a157162f",
- "vehicle": "49ced169d8f44808b0422cf5317d9e45",
- "required_vehicle_category": "c2bfb3237b874e238a7efa727d8485f8",
- "looped_task": true,
- "subtasks": [
- {
- "uuid": "76a97471652d49b5b12bb771ea6ce83c",
- "status": "created",
- "index": 0,
- "ros_goal_id": "string",
- "action": {
- "uuid": "20a3cda5113b426ab890e592bfe9c3be",
- "definition": "e7c4611dd9fa4b9f8c8cbaa70bbbf20d",
- "form_values": { },
- "point": "36ee0ac1e01045758b52cef09451e908"
}, - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "executed_at": null,
- "robot_executed_at": null
}
}
], - "metadata": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "executed_at": null,
- "disconnected": null
}
}
[- {
- "uuid": "bce8a727106f4b4cad2e71264fd9d027",
- "slug": "meili-office",
- "status": "ok",
- "title": "Meili Office",
- "organization": {
- "uuid": "287c54aeaa534b71bc2cfd7762018ba4",
- "title": "Meili",
- "slug": "meili"
}, - "description": "string",
- "creator": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}, - "address": {
- "uuid": "577129fbddb145179645d6490780ce27",
- "name": "Administrator",
- "company_name": "Meili",
- "default_email": "admin@meilirobots.com",
- "address1": "Ny Carlsberg Vej 68",
- "address2": null,
- "city": "Copenhagen",
- "zip_code": 11111,
- "country": "Denmark",
- "country_code": "DK"
}, - "operation_type": "inside",
- "image": "string",
- "battery_defaults": {
- "emergency_battery_level": null,
- "emergency_distance": null,
- "working_battery_level": null
}
}
]
Return team by identifier
required | string or string UUID or SLUG of the target resource |
{- "uuid": "8946d2e1366043dd919db31bd8a54833",
- "membership_type": "member",
- "user": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}
}
Update team
required | string or string UUID or SLUG of the target resource |
membership_type | string Enum: "member" "admin" "maintainer" "owner" "observer" |
object (User) |
{- "membership_type": "member",
- "user": {
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen"
}
}
{- "uuid": "8946d2e1366043dd919db31bd8a54833",
- "membership_type": "member",
- "user": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}
}
Retrieve Team Settings
required | string or string UUID or SLUG of the target resource |
{- "path_rerouting": false,
- "stationary_collision_detection_threshold": 1,
- "traffic_control_stay_on_distance": 1.5,
- "traffic_control_cross_conflict_distance": 1.5,
- "traffic_control_head_on_distance": 1.5,
- "traffic_control_agv_distance": 1.5,
- "safety_distance_threshold": 500,
- "on_station_allowed_deviation": 500,
- "after_finished_task_wait_time": 500,
- "enable_free_roaming": true,
- "receive_trajectory_from_robots": false,
- "distance_between_waypoints": 0.2,
- "task_alert_time": 300,
- "task_timeout": 300,
- "disable_station_locking": false,
- "common_path_multiplier": 0,
- "disable_automatic_path_planning": false,
- "move_to_rest_zone_when_charged": false,
- "move_to_charging_zone_after_timeout": false,
- "disable_zone_obstacle_validation": false,
- "safety_distance_threshold_in_m": 0.5
}
Update Team Settings
required | string or string UUID or SLUG of the target resource |
path_rerouting | boolean |
stationary_collision_detection_threshold | decimal Determines the distance to find collision between the robots. |
traffic_control_stay_on_distance | decimal Determines the safety distance for stay on collisions in meters. |
traffic_control_cross_conflict_distance | decimal Determines the safety distance for cross conflict collisions in meters. |
traffic_control_head_on_distance | decimal Determines the safety distance for head on collisions in meters. |
traffic_control_agv_distance | decimal Determines the safety distance for AGV collisions in meters. |
safety_distance_threshold | integer |
on_station_allowed_deviation | integer The maximum distance between the robot and the station where the robot will be considered to be on that station. |
after_finished_task_wait_time | integer The time a robot will wait after completing its task, before it will be sent to a resting zone. If the value is set up to -1, the system won't send robots to resting zones. |
enable_free_roaming | boolean Enables robots to execute tasks even if two station are not connected with path |
receive_trajectory_from_robots | boolean |
distance_between_waypoints | decimal Determines the distance between waypoints in path in meters. If the value is set up to -1, the system will use a minimal number of waypoints (only corner points) to define the route. |
task_alert_time | integer The time (in seconds) until the user is notified about a robot disconnecting when the robot has an active task. The task will also be terminated after this time |
task_timeout | integer The time (in seconds) a task has been inactive before the task is terminated. The time is determined by when the most recent subtask was created or started execution, whichever is more recent. |
disable_station_locking | boolean Enables to send simultaneously more than one task to the same station |
common_path_multiplier | decimal When the value is greater than 0, it will raise the cost (or prevent when the value reaches 10) associated with sending a mission that includes a path already being utilized by an ongoing mission. |
disable_automatic_path_planning | boolean Disabling this option means that the Meili path planner will not be employed for path creation. As a result, automatic obstacle avoidance will not be enabled. |
move_to_rest_zone_when_charged | boolean If set to true, robots will move to a resting zone when they are charged. Otherwise, they will stay in a charging zone. |
move_to_charging_zone_after_timeout | boolean If set to true, robots will move to a charging zone after timeout. Otherwise, they will move to a resting zone. |
disable_zone_obstacle_validation | boolean Disables the obstacles check for all types of zones. WARNING if set true, zones can be on top of obstacles. |
safety_distance_threshold_in_m | decimal Determines the Safety Distance between obstacles and vehicles. |
{- "path_rerouting": false,
- "stationary_collision_detection_threshold": 1,
- "traffic_control_stay_on_distance": 1.5,
- "traffic_control_cross_conflict_distance": 1.5,
- "traffic_control_head_on_distance": 1.5,
- "traffic_control_agv_distance": 1.5,
- "safety_distance_threshold": 500,
- "on_station_allowed_deviation": 500,
- "after_finished_task_wait_time": 500,
- "enable_free_roaming": true,
- "receive_trajectory_from_robots": false,
- "distance_between_waypoints": 0.2,
- "task_alert_time": 300,
- "task_timeout": 300,
- "disable_station_locking": false,
- "common_path_multiplier": 0,
- "disable_automatic_path_planning": false,
- "move_to_rest_zone_when_charged": false,
- "move_to_charging_zone_after_timeout": false,
- "disable_zone_obstacle_validation": false,
- "safety_distance_threshold_in_m": 0.5
}
{- "path_rerouting": false,
- "stationary_collision_detection_threshold": 1,
- "traffic_control_stay_on_distance": 1.5,
- "traffic_control_cross_conflict_distance": 1.5,
- "traffic_control_head_on_distance": 1.5,
- "traffic_control_agv_distance": 1.5,
- "safety_distance_threshold": 500,
- "on_station_allowed_deviation": 500,
- "after_finished_task_wait_time": 500,
- "enable_free_roaming": true,
- "receive_trajectory_from_robots": false,
- "distance_between_waypoints": 0.2,
- "task_alert_time": 300,
- "task_timeout": 300,
- "disable_station_locking": false,
- "common_path_multiplier": 0,
- "disable_automatic_path_planning": false,
- "move_to_rest_zone_when_charged": false,
- "move_to_charging_zone_after_timeout": false,
- "disable_zone_obstacle_validation": false,
- "safety_distance_threshold_in_m": 0.5
}
Return a list of team members
required | string or string UUID or SLUG of the target resource |
{- "uuid": "8946d2e1366043dd919db31bd8a54833",
- "membership_type": "member",
- "user": {
- "uuid": "dc1d2ecb8f00446496edf6edf3d813e7",
- "email": "johndoe@meilirobots.com",
- "username": "johndoe",
- "first_name": "John",
- "last_name": "Doe",
- "timezone": "Europe/Copenhagen",
- "is_staff": true
}
}
Retrieve a list of possible messages types for MQTT communications. These messages are originating from FMS internals and sent to your vehicles using MQTT in VDA5050 JSON message type.
required | string or string UUID or SLUG of the target resource |
{- "message_types": {
- "message_types": [
- "docking_routine_finalize_request",
- "docking_routine_request",
- "drop_command",
- "path_rerouting",
- "slow_down",
- "task",
- "topic_init"
]
}
}
Debug your communications by sending a sample message of specified type to your robot.
required | string or string UUID or SLUG of the target resource |
message_type | string Enum: "docking_routine_finalize_request" "docking_routine_request" "drop_command" "path_rerouting" "slow_down" "task" "topic_init" |
vehicle | string <hex> UUID of the vehicle to send the message to |
{- "message_type": "docking_routine_finalize_request",
- "vehicle": "49ced169d8f44808b0422cf5317d9e45"
}
{- "detail": "OK"
}
This endpoint is used to trigger an emergency stop on a team. This will stop all the robots in the team and will prevent them from moving until the emergency stop is reset.
required | string or string UUID or SLUG of the target resource |
{- "recalculations_needed": true,
- "calculations_done": true,
- "user_input_required": true,
- "points_exist": true
}
This endpoint is used to reset an emergency stop on a team. This will allow to assign new missions to the robots.
required | string or string UUID or SLUG of the target resource |
{- "recalculations_needed": true,
- "calculations_done": true,
- "user_input_required": true,
- "points_exist": true
}
Return a list of team triggers
required | string or string UUID or SLUG of the target resource |
[- {
- "uuid": "ffbee424bcd24e98847a257f8bb81ab3",
- "verbose_name": "Production line confirmation trigger",
- "token": "4c68a5d45c3eef408ac5a297c4682ad7429f3f17",
- "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
- "use_http": true,
- "use_mqtt": false,
- "station": "36ee0ac1e01045758b52cef09451e908",
- "mqtt_id": "meili-trigger-c6650d45-5972-4bfd-9f22-5cb6cfd5cd4f",
- "use_token_authentication": false,
- "use_ip_authentication": false,
- "ip_whitelist": [
- "127.0.0.1"
], - "action": "location_confirm"
}
]
Create a new trigger for the team
required | string or string UUID or SLUG of the target resource |
verbose_name required | string |
url | string <url> |
use_http | boolean If selected, it will allow triggering actions via the HTTP URL provided |
use_mqtt | boolean If selected, it will allow triggering actions to the MQTT topic |
station | string <uuid> |
use_token_authentication | boolean If selected, it will require to pass token via X-MEILI-TRIGGER-TOKEN HTTP header |
use_ip_authentication | boolean If selected, will only allow triggering actions for request coming from the whitelisted IPs |
ip_whitelist | Array of strings |
action | string Enum: "location_confirm" "location_fail" "task_launch" |
{- "verbose_name": "Production line confirmation trigger",
- "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
- "use_http": true,
- "use_mqtt": false,
- "station": "36ee0ac1e01045758b52cef09451e908",
- "use_token_authentication": false,
- "use_ip_authentication": false,
- "ip_whitelist": [
- "127.0.0.1"
], - "action": "location_confirm"
}
{- "uuid": "ffbee424bcd24e98847a257f8bb81ab3",
- "verbose_name": "Production line confirmation trigger",
- "token": "4c68a5d45c3eef408ac5a297c4682ad7429f3f17",
- "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
- "use_http": true,
- "use_mqtt": false,
- "station": "36ee0ac1e01045758b52cef09451e908",
- "mqtt_id": "meili-trigger-c6650d45-5972-4bfd-9f22-5cb6cfd5cd4f",
- "use_token_authentication": false,
- "use_ip_authentication": false,
- "ip_whitelist": [
- "127.0.0.1"
], - "action": "location_confirm"
}
Return trigger
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "ffbee424bcd24e98847a257f8bb81ab3",
- "verbose_name": "Production line confirmation trigger",
- "token": "4c68a5d45c3eef408ac5a297c4682ad7429f3f17",
- "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
- "use_http": true,
- "use_mqtt": false,
- "station": "36ee0ac1e01045758b52cef09451e908",
- "mqtt_id": "meili-trigger-c6650d45-5972-4bfd-9f22-5cb6cfd5cd4f",
- "use_token_authentication": false,
- "use_ip_authentication": false,
- "ip_whitelist": [
- "127.0.0.1"
], - "action": "location_confirm"
}
Update trigger
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
verbose_name required | string |
url | string <url> |
use_http | boolean If selected, it will allow triggering actions via the HTTP URL provided |
use_mqtt | boolean If selected, it will allow triggering actions to the MQTT topic |
station | string <uuid> |
use_token_authentication | boolean If selected, it will require to pass token via X-MEILI-TRIGGER-TOKEN HTTP header |
use_ip_authentication | boolean If selected, will only allow triggering actions for request coming from the whitelisted IPs |
ip_whitelist | Array of strings |
action | string Enum: "location_confirm" "location_fail" "task_launch" |
{- "verbose_name": "Production line confirmation trigger",
- "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
- "use_http": true,
- "use_mqtt": false,
- "station": "36ee0ac1e01045758b52cef09451e908",
- "use_token_authentication": false,
- "use_ip_authentication": false,
- "ip_whitelist": [
- "127.0.0.1"
], - "action": "location_confirm"
}
{- "uuid": "ffbee424bcd24e98847a257f8bb81ab3",
- "verbose_name": "Production line confirmation trigger",
- "token": "4c68a5d45c3eef408ac5a297c4682ad7429f3f17",
- "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
- "use_http": true,
- "use_mqtt": false,
- "station": "36ee0ac1e01045758b52cef09451e908",
- "mqtt_id": "meili-trigger-c6650d45-5972-4bfd-9f22-5cb6cfd5cd4f",
- "use_token_authentication": false,
- "use_ip_authentication": false,
- "ip_whitelist": [
- "127.0.0.1"
], - "action": "location_confirm"
}
Return a list of all vehicles in the organization
required | string or string UUID or SLUG of the target resource |
ordering | string Enum: "created_at" "verbose_name" "environment_type" "vehicle_type" "vehicle_serial_number" "priority_level" "category" "max_load" "integration_type" Order objects by field To specify descending order, prefix the field name with a minus sign ("-"). Example: To order by "created_at" in descending order, use "-created_at". |
team | string Filter vehicles by team (team slug or title) |
name | string Filter vehicles by name (verbose_name) |
slug | string Filter vehicles by slug |
category | string Filter vehicles by category (category slug or title) |
[- {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo",
- "slug": "floating-flamingo",
- "vehicle_type": "amr",
- "environment_type": "inside",
- "vehicle_serial_number": "fe9fc7b5d6ef40d5b0b73fa85a378456",
- "active": true,
- "category": "c2bfb3237b874e238a7efa727d8485f8",
- "category_name": "TurtleBot",
- "team": "4c310b85696e4ffe9283f9bdfe2337f1",
- "team_name": "Warehouse team 1",
- "full_battery": null,
- "emergency_battery_level": null,
- "emergency_distance": null,
- "use_team_battery_defaults": true,
- "manufacturer": null,
- "custom_manufacturer": "meili",
- "batch_tasks": true,
- "battery_management_enabled": true,
- "working_battery_level": 25,
- "dimensions": [
- 100,
- 100,
- 100
], - "executing_looped_task": false,
- "message_frequency": 1,
- "traffic_control_delay": 0,
- "is_collision_detected": false,
- "collision_type": null,
- "integration_type": "ROS",
- "initial_position": {
- "x": null,
- "y": null,
- "theta": null
}, - "vehicle_state": "ready",
- "battery_configured": true,
- "inherit_category_topics": true,
- "drivable_distance": 2000
}
]
Create a new vehicle for the organization
required | string or string UUID or SLUG of the target resource |
external_identifier | string |
verbose_name | string |
vehicle_type | string Enum: "amr" "agv" |
environment_type | string Enum: "inside" "outside" |
vehicle_serial_number | string |
active required | boolean |
category | string <uuid> |
category_name | string |
team | string <uuid> |
team_name | string |
full_battery | double |
emergency_battery_level | double |
emergency_distance | double |
use_team_battery_defaults | boolean |
manufacturer | string |
custom_manufacturer | string |
batch_tasks | boolean If set to true, all tasks will be batched into a single message and approved as one |
battery_management_enabled | boolean |
working_battery_level | double |
dimensions | Array of integers |
executing_looped_task | boolean |
message_frequency | double |
traffic_control_delay | double |
is_collision_detected | boolean |
collision_type | string |
integration_type | string Enum: "ROS" "MIR" "Noovelia" "VDA5050" "Wewo" "Youibot" |
object | |
vehicle_state | string Enum: "ready" "navigating" "pause" "charging" "emergency_stop" "manual_control" |
battery_configured | boolean |
inherit_category_topics | boolean |
drivable_distance | double |
{- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo",
- "vehicle_type": "amr",
- "environment_type": "inside",
- "vehicle_serial_number": "fe9fc7b5d6ef40d5b0b73fa85a378456",
- "active": true,
- "category": "c2bfb3237b874e238a7efa727d8485f8",
- "category_name": "TurtleBot",
- "team": "4c310b85696e4ffe9283f9bdfe2337f1",
- "team_name": "Warehouse team 1",
- "full_battery": null,
- "emergency_battery_level": null,
- "emergency_distance": null,
- "use_team_battery_defaults": true,
- "manufacturer": null,
- "custom_manufacturer": "meili",
- "batch_tasks": true,
- "battery_management_enabled": true,
- "working_battery_level": 25,
- "dimensions": [
- 100,
- 100,
- 100
], - "executing_looped_task": false,
- "message_frequency": 1,
- "traffic_control_delay": 0,
- "is_collision_detected": false,
- "collision_type": null,
- "integration_type": "ROS",
- "initial_position": {
- "x": null,
- "y": null,
- "theta": null
}, - "vehicle_state": "ready",
- "battery_configured": true,
- "inherit_category_topics": true,
- "drivable_distance": 2000
}
{- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo",
- "slug": "floating-flamingo",
- "vehicle_type": "amr",
- "environment_type": "inside",
- "vehicle_serial_number": "fe9fc7b5d6ef40d5b0b73fa85a378456",
- "active": true,
- "category": "c2bfb3237b874e238a7efa727d8485f8",
- "category_name": "TurtleBot",
- "team": "4c310b85696e4ffe9283f9bdfe2337f1",
- "team_name": "Warehouse team 1",
- "full_battery": null,
- "emergency_battery_level": null,
- "emergency_distance": null,
- "use_team_battery_defaults": true,
- "manufacturer": null,
- "custom_manufacturer": "meili",
- "batch_tasks": true,
- "battery_management_enabled": true,
- "working_battery_level": 25,
- "dimensions": [
- 100,
- 100,
- 100
], - "executing_looped_task": false,
- "message_frequency": 1,
- "traffic_control_delay": 0,
- "is_collision_detected": false,
- "collision_type": null,
- "integration_type": "ROS",
- "initial_position": {
- "x": null,
- "y": null,
- "theta": null
}, - "vehicle_state": "ready",
- "battery_configured": true,
- "inherit_category_topics": true,
- "drivable_distance": 2000
}
Return a list of all vehicle categories available in the organization
required | string or string UUID or SLUG of the target resource |
ordering | string Enum: "created_at" "verbose_name" "environment_type" "vehicle_type" "vehicle_serial_number" "priority_level" "category" "max_load" "integration_type" Order objects by field To specify descending order, prefix the field name with a minus sign ("-"). Example: To order by "created_at" in descending order, use "-created_at". |
team | string Filter vehicles by team (team slug or title) |
name | string Filter vehicles by name (verbose_name) |
slug | string Filter vehicles by slug |
category | string Filter vehicles by category (category slug or title) |
[- {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "title": "Floating Flamingo",
- "slug": "floating-flamingo",
- "is_global": false,
- "max_load": 100,
- "dimensions": [
- 100,
- 140,
- 80
], - "container_dimensions": [
- 100,
- 140,
- 80
], - "vehicle_type": "amr",
- "extra_details": { }
}
]
Create a new vehicle category for the organization
required | string or string UUID or SLUG of the target resource |
title | string |
max_load | number The maximum load of the vehicle category in Kg |
dimensions | Array of numbers The dimensions of the vehicle category |
container_dimensions | Array of numbers The container dimensions of the vehicle category |
vehicle_type | string Enum: "amr" "agv" The type of the vehicle category |
extra_details | object Extra details of the vehicle category |
{- "title": "Floating Flamingo",
- "max_load": 100,
- "dimensions": [
- 100,
- 140,
- 80
], - "container_dimensions": [
- 100,
- 140,
- 80
], - "vehicle_type": "amr",
- "extra_details": { }
}
{- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "title": "Floating Flamingo",
- "slug": "floating-flamingo",
- "is_global": false,
- "max_load": 100,
- "dimensions": [
- 100,
- 140,
- 80
], - "container_dimensions": [
- 100,
- 140,
- 80
], - "vehicle_type": "amr",
- "extra_details": { }
}
Return a list of all vehicles in the team's fleet
required | string or string UUID or SLUG of the target resource |
name | string Filter vehicles by name (verbose_name) |
slug | string Filter vehicles by slug |
category | string Examples: category=category_slug category=category_title Filter vehicles by category |
[- {
- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "external_identifier": "Warehouse Left Wing Warrior",
- "verbose_name": "Floating Flamingo",
- "slug": "floating-flamingo",
- "vehicle_type": "amr",
- "environment_type": "inside",
- "vehicle_serial_number": "fe9fc7b5d6ef40d5b0b73fa85a378456",
- "active": true,
- "category": "c2bfb3237b874e238a7efa727d8485f8",
- "category_name": "TurtleBot",
- "team": "4c310b85696e4ffe9283f9bdfe2337f1",
- "team_name": "Warehouse team 1",
- "full_battery": null,
- "emergency_battery_level": null,
- "emergency_distance": null,
- "use_team_battery_defaults": true,
- "manufacturer": null,
- "custom_manufacturer": "meili",
- "batch_tasks": true,
- "battery_management_enabled": true,
- "working_battery_level": 25,
- "dimensions": [
- 100,
- 100,
- 100
], - "executing_looped_task": false,
- "message_frequency": 1,
- "traffic_control_delay": 0,
- "is_collision_detected": false,
- "collision_type": null,
- "integration_type": "ROS",
- "initial_position": {
- "x": null,
- "y": null,
- "theta": null
}, - "vehicle_state": "ready",
- "battery_configured": true,
- "inherit_category_topics": true,
- "drivable_distance": 2000
}
]
Remove a vehicle to fleet
required | string or string UUID or SLUG of the target resource |
uuid | string <uuid> |
slug | string |
{- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "slug": "floating-flamingo"
}
Update vehicle fleet profile
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
team | string <uuid> |
purge_vehicle_profile | boolean If set to false, it will keep the values set on the profile |
active | boolean If marked false, it will taken out of the calculations for task assignment |
{- "team": "7cf6aabb5116431fbab78efea4b783f0",
- "purge_vehicle_profile": true,
- "active": true
}
{- "team": "7cf6aabb5116431fbab78efea4b783f0",
- "active": true
}
Update a vehicle category
required | string or string UUID or SLUG of the target resource |
title | string |
max_load | number The maximum load of the vehicle category in Kg |
dimensions | Array of numbers The dimensions of the vehicle category |
container_dimensions | Array of numbers The container dimensions of the vehicle category |
vehicle_type | string Enum: "amr" "agv" The type of the vehicle category |
extra_details | object Extra details of the vehicle category |
{- "title": "Floating Flamingo",
- "max_load": 100,
- "dimensions": [
- 100,
- 140,
- 80
], - "container_dimensions": [
- 100,
- 140,
- 80
], - "vehicle_type": "amr",
- "extra_details": { }
}
{- "uuid": "49ced169d8f44808b0422cf5317d9e45",
- "title": "Floating Flamingo",
- "slug": "floating-flamingo",
- "is_global": false,
- "max_load": 100,
- "dimensions": [
- 100,
- 140,
- 80
], - "container_dimensions": [
- 100,
- 140,
- 80
], - "vehicle_type": "amr",
- "extra_details": { }
}
Request a vehicle factsheet. This is only available for VDA5050 vehicles. Vehcile dimensions and vehcile specific action definitions will be added
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
Create a webhook for the organization
url required | string |
scope | string |
active | boolean |
note | string |
Array of objects | |
action_list required | Array of strings Items Enum: "vehicle.connected" "vehicle.disconnected" "task.started" "task.completed" "task.stuck" "task.failed" "task.timeout" "task.disconnected" "fleet.connected" "fleet.disconnected" |
{- "scope": "organization",
- "active": true,
- "note": "This is a note",
- "headers": [
- {
- "key": "X-API-Key",
- "value": 1234567890
}
], - "action_list": [
- "vehicle.connected",
- "task.stuck",
- "fleet.disconnected"
]
}
{- "uuid": "17fdb48466104825b800d791c6a813d7",
- "scope": "organization",
- "active": true,
- "note": "This is a note",
- "headers": [
- {
- "key": "X-API-Key",
- "value": 1234567890
}
], - "action_list": [
- "vehicle.connected",
- "task.stuck",
- "fleet.disconnected"
]
}
List webhooks for the organization
required | string or string UUID or SLUG of the target resource |
ordering | string Enum: "created_at" "team" "url" "scope" "active" Order objects by field To specify descending order, prefix the field name with a minus sign ("-"). Example: To order by "created_at" in descending order, use "-created_at". |
team | string Filter webhooks by team (team slug or title) |
url | string Filter webhooks by url |
scope | string Filter webhooks by scope |
active | string Filter webhooks by active status (true or false) |
[- {
- "uuid": "17fdb48466104825b800d791c6a813d7",
- "scope": "organization",
- "active": true,
- "note": "This is a note",
- "headers": [
- {
- "key": "X-API-Key",
- "value": 1234567890
}
], - "action_list": [
- "vehicle.connected",
- "task.stuck",
- "fleet.disconnected"
]
}
]
Create a webhook for the team
url required | string |
scope | string |
active | boolean |
note | string |
Array of objects | |
action_list required | Array of strings Items Enum: "vehicle.connected" "vehicle.disconnected" "task.started" "task.completed" "task.stuck" "task.failed" "task.timeout" "task.disconnected" "fleet.connected" "fleet.disconnected" |
{- "scope": "organization",
- "active": true,
- "note": "This is a note",
- "headers": [
- {
- "key": "X-API-Key",
- "value": 1234567890
}
], - "action_list": [
- "vehicle.connected",
- "task.stuck",
- "fleet.disconnected"
]
}
{- "uuid": "17fdb48466104825b800d791c6a813d7",
- "scope": "organization",
- "active": true,
- "note": "This is a note",
- "headers": [
- {
- "key": "X-API-Key",
- "value": 1234567890
}
], - "action_list": [
- "vehicle.connected",
- "task.stuck",
- "fleet.disconnected"
]
}
[- {
- "uuid": "17fdb48466104825b800d791c6a813d7",
- "scope": "organization",
- "active": true,
- "note": "This is a note",
- "headers": [
- {
- "key": "X-API-Key",
- "value": 1234567890
}
], - "action_list": [
- "vehicle.connected",
- "task.stuck",
- "fleet.disconnected"
]
}
]
Get a webhook
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "17fdb48466104825b800d791c6a813d7",
- "scope": "organization",
- "active": true,
- "note": "This is a note",
- "headers": [
- {
- "key": "X-API-Key",
- "value": 1234567890
}
], - "action_list": [
- "vehicle.connected",
- "task.stuck",
- "fleet.disconnected"
]
}
When updating, only actions in actions_list will be set.
Omit the action_list parameter if you want to keep the current actions.
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
url required | string |
scope | string |
active | boolean |
note | string |
Array of objects | |
action_list required | Array of strings Items Enum: "vehicle.connected" "vehicle.disconnected" "task.started" "task.completed" "task.stuck" "task.failed" "task.timeout" "task.disconnected" "fleet.connected" "fleet.disconnected" |
{- "scope": "organization",
- "active": true,
- "note": "This is a note",
- "headers": [
- {
- "key": "X-API-Key",
- "value": 1234567890
}
], - "action_list": [
- "vehicle.connected",
- "task.stuck",
- "fleet.disconnected"
]
}
{- "uuid": "17fdb48466104825b800d791c6a813d7",
- "scope": "organization",
- "active": true,
- "note": "This is a note",
- "headers": [
- {
- "key": "X-API-Key",
- "value": 1234567890
}
], - "action_list": [
- "vehicle.connected",
- "task.stuck",
- "fleet.disconnected"
]
}
Activate deactivated webhook
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "17fdb48466104825b800d791c6a813d7",
- "scope": "organization",
- "active": true,
- "note": "This is a note",
- "headers": [
- {
- "key": "X-API-Key",
- "value": 1234567890
}
], - "action_list": [
- "vehicle.connected",
- "task.stuck",
- "fleet.disconnected"
]
}
This section of our API documentation will document everything related to websocket communication
How we structure this part?
OpenAPI does not come with Websocket capabilities out of the box, therefore this is the part where we took the liberty to improvise and make it our own.
All GET requests are the data received from websocket, post data that is sent to websocket
{- "type": "task",
- "vehicle": "49ced169d8f44808b0422cf5317d9e45",
- "data": {
- "uuid": "11495b9cca374e41a1cda9604169235b",
- "number": "20220113_0543",
- "location": {
- "uuid": "36ee0ac1e01045758b52cef09451e908",
- "x": 10,
- "y": 10,
- "rotation": 35.5,
- "metric": {
- "x": 1.42,
- "y": 1.42
}, - "preset": "f7e0568514c14357a974cb716ea88c2d"
}, - "metric_waypoints": [
- [
- 0.56,
- 0.72
], - [
- 1.42,
- 1.42
]
], - "preset": "f7e0568514c14357a974cb716ea88c2d",
- "scheduled_task": "aaa25487c17b4ddeaabf06cf4c5b2cf8"
}
}
Return a list of team triggers
required | string or string UUID or SLUG of the target resource |
[- {
- "uuid": "ffbee424bcd24e98847a257f8bb81ab3",
- "verbose_name": "Production line confirmation trigger",
- "token": "4c68a5d45c3eef408ac5a297c4682ad7429f3f17",
- "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
- "use_http": true,
- "use_mqtt": false,
- "station": "36ee0ac1e01045758b52cef09451e908",
- "mqtt_id": "meili-trigger-c6650d45-5972-4bfd-9f22-5cb6cfd5cd4f",
- "use_token_authentication": false,
- "use_ip_authentication": false,
- "ip_whitelist": [
- "127.0.0.1"
], - "action": "location_confirm"
}
]
Create a new trigger for the team
required | string or string UUID or SLUG of the target resource |
verbose_name required | string |
url | string <url> |
use_http | boolean If selected, it will allow triggering actions via the HTTP URL provided |
use_mqtt | boolean If selected, it will allow triggering actions to the MQTT topic |
station | string <uuid> |
use_token_authentication | boolean If selected, it will require to pass token via X-MEILI-TRIGGER-TOKEN HTTP header |
use_ip_authentication | boolean If selected, will only allow triggering actions for request coming from the whitelisted IPs |
ip_whitelist | Array of strings |
action | string Enum: "location_confirm" "location_fail" "task_launch" |
{- "verbose_name": "Production line confirmation trigger",
- "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
- "use_http": true,
- "use_mqtt": false,
- "station": "36ee0ac1e01045758b52cef09451e908",
- "use_token_authentication": false,
- "use_ip_authentication": false,
- "ip_whitelist": [
- "127.0.0.1"
], - "action": "location_confirm"
}
{- "uuid": "ffbee424bcd24e98847a257f8bb81ab3",
- "verbose_name": "Production line confirmation trigger",
- "token": "4c68a5d45c3eef408ac5a297c4682ad7429f3f17",
- "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
- "use_http": true,
- "use_mqtt": false,
- "station": "36ee0ac1e01045758b52cef09451e908",
- "mqtt_id": "meili-trigger-c6650d45-5972-4bfd-9f22-5cb6cfd5cd4f",
- "use_token_authentication": false,
- "use_ip_authentication": false,
- "ip_whitelist": [
- "127.0.0.1"
], - "action": "location_confirm"
}
Return trigger
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "ffbee424bcd24e98847a257f8bb81ab3",
- "verbose_name": "Production line confirmation trigger",
- "token": "4c68a5d45c3eef408ac5a297c4682ad7429f3f17",
- "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
- "use_http": true,
- "use_mqtt": false,
- "station": "36ee0ac1e01045758b52cef09451e908",
- "mqtt_id": "meili-trigger-c6650d45-5972-4bfd-9f22-5cb6cfd5cd4f",
- "use_token_authentication": false,
- "use_ip_authentication": false,
- "ip_whitelist": [
- "127.0.0.1"
], - "action": "location_confirm"
}
Update trigger
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
verbose_name required | string |
url | string <url> |
use_http | boolean If selected, it will allow triggering actions via the HTTP URL provided |
use_mqtt | boolean If selected, it will allow triggering actions to the MQTT topic |
station | string <uuid> |
use_token_authentication | boolean If selected, it will require to pass token via X-MEILI-TRIGGER-TOKEN HTTP header |
use_ip_authentication | boolean If selected, will only allow triggering actions for request coming from the whitelisted IPs |
ip_whitelist | Array of strings |
action | string Enum: "location_confirm" "location_fail" "task_launch" |
{- "verbose_name": "Production line confirmation trigger",
- "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
- "use_http": true,
- "use_mqtt": false,
- "station": "36ee0ac1e01045758b52cef09451e908",
- "use_token_authentication": false,
- "use_ip_authentication": false,
- "ip_whitelist": [
- "127.0.0.1"
], - "action": "location_confirm"
}
{- "uuid": "ffbee424bcd24e98847a257f8bb81ab3",
- "verbose_name": "Production line confirmation trigger",
- "token": "4c68a5d45c3eef408ac5a297c4682ad7429f3f17",
- "url": "app.meilirobots.com/workflows/triggers/ae04bde46a085cf643543859c92cd2f2e9fd7cfbe0b4eda3aaf348a03139e11cf27809624567360f/",
- "use_http": true,
- "use_mqtt": false,
- "station": "36ee0ac1e01045758b52cef09451e908",
- "mqtt_id": "meili-trigger-c6650d45-5972-4bfd-9f22-5cb6cfd5cd4f",
- "use_token_authentication": false,
- "use_ip_authentication": false,
- "ip_whitelist": [
- "127.0.0.1"
], - "action": "location_confirm"
}
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
zone-type required | string Enum: "charging" "resting" "waiting" "forbidden" "tag" "action" Type of the area zones to return/create |
is_active | string Enum: true false Filter zones by active state |
[- {
- "title": "Charging Zone 1",
- "points": [
- [
- 100,
- 100
], - [
- 100,
- 0
], - [
- 0,
- 0
], - [
- 0,
- 100
], - [
- 100,
- 100
]
], - "zone_type": "area",
- "uuid": "11495b9cca374e41a1cda9604169235b",
- "zone_dimensions": [
- 100,
- 140,
- 80
], - "safety_parameter": 0.5,
- "speed_limit": 2.5,
- "zone_vehicle_limit": 1,
- "is_active": false,
- "priority": 5,
- "allowed_vehicle_categories": [
- "c2bfb3237b874e238a7efa727d8485f8"
], - "entry_preset": "287c54aeaa534b71bc2cfd7762018ba4",
- "exit_preset": "4b24bf57518f4eeea5265b961c261a4f"
}
]
Using this endpoint, you can create zones inside the area one-by-one or in batch
Note that in batch update/create zones of type specified in the URL that are not in request body will be automatically deleted
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
zone-type required | string Enum: "charging" "resting" "waiting" "forbidden" "tag" "action" Type of the area zones to return/create |
title | string The title of the zone |
initial_point | Array of numbers The initial point of the zone |
points | Array of numbers[ items ] The points defining the zone |
zone_type | string Enum: "area" "charging" "resting" "forbidden" "restricted" "action" The type of the zone |
zone_dimensions | Array of numbers The dimensions of the zone |
safety_parameter | number <float> The safety parameter of the zone (in meters) |
speed_limit | number <float> The speed limit of the zone (in meters/s) |
zone_vehicle_limit | number The vehicle limit of the zone |
is_active | boolean Default: true Indicates if the zone is active |
priority | number or null [ 0 .. 5 ] Default: 0 Indicates if the zone should have priority over other zones (default is 0 as no priority). The higher the number, the higher the priority. |
allowed_vehicle_categories | Array of strings <uuid> |
entry_preset | string <uuid> If specified, the path planing algorithm will integrate the zone entry preset when a vehicle path enters the zone |
exit_preset | string <uuid> If specified, the path planing algorithm will integrate the zone exit preset when a vehicle path exits the zone |
{- "title": "Charging Zone 1",
- "initial_point": [
- 0,
- 0
], - "points": [
- [
- 100,
- 100
], - [
- 100,
- 0
], - [
- 0,
- 0
], - [
- 0,
- 100
], - [
- 100,
- 100
]
], - "zone_type": "area",
- "zone_dimensions": [
- 100,
- 140,
- 80
], - "safety_parameter": 0.5,
- "speed_limit": 2.5,
- "zone_vehicle_limit": 1,
- "is_active": false,
- "priority": 5,
- "allowed_vehicle_categories": [
- "c2bfb3237b874e238a7efa727d8485f8"
], - "entry_preset": "287c54aeaa534b71bc2cfd7762018ba4",
- "exit_preset": "4b24bf57518f4eeea5265b961c261a4f"
}
{- "title": "Charging Zone 1",
- "points": [
- [
- 100,
- 100
], - [
- 100,
- 0
], - [
- 0,
- 0
], - [
- 0,
- 100
], - [
- 100,
- 100
]
], - "zone_type": "area",
- "uuid": "11495b9cca374e41a1cda9604169235b",
- "zone_dimensions": [
- 100,
- 140,
- 80
], - "safety_parameter": 0.5,
- "speed_limit": 2.5,
- "zone_vehicle_limit": 1,
- "is_active": false,
- "priority": 5,
- "allowed_vehicle_categories": [
- "c2bfb3237b874e238a7efa727d8485f8"
], - "entry_preset": "287c54aeaa534b71bc2cfd7762018ba4",
- "exit_preset": "4b24bf57518f4eeea5265b961c261a4f"
}
Using this endpoint, you can create zones inside the area in batch
Zone_type must be sent with the object payload
Note that in batch update zones of type specified in the URL that are not in request body will be automatically deleted
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
title | string The title of the zone |
initial_point | Array of numbers The initial point of the zone |
points | Array of numbers[ items ] The points defining the zone |
zone_type required | string Enum: "area" "charging" "resting" "forbidden" "restricted" "action" The type of the zone |
uuid required | string <uuid> The UUID of the zone to be updated |
{- "title": "Charging Zone 1",
- "initial_point": [
- 0,
- 0
], - "points": [
- [
- 100,
- 100
], - [
- 100,
- 0
], - [
- 0,
- 0
], - [
- 0,
- 100
], - [
- 100,
- 100
]
], - "zone_type": "area",
- "uuid": "11495b9cca374e41a1cda9604169235b"
}
[- {
- "title": "Charging Zone 1",
- "points": [
- [
- 100,
- 100
], - [
- 100,
- 0
], - [
- 0,
- 0
], - [
- 0,
- 100
], - [
- 100,
- 100
]
], - "zone_type": "area",
- "uuid": "11495b9cca374e41a1cda9604169235b",
- "zone_dimensions": [
- 100,
- 140,
- 80
], - "safety_parameter": 0.5,
- "speed_limit": 2.5,
- "zone_vehicle_limit": 1,
- "is_active": false,
- "priority": 5,
- "allowed_vehicle_categories": [
- "c2bfb3237b874e238a7efa727d8485f8"
], - "entry_preset": "287c54aeaa534b71bc2cfd7762018ba4",
- "exit_preset": "4b24bf57518f4eeea5265b961c261a4f"
}
]
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
[- {
- "title": "Charging Zone 1",
- "points": [
- [
- 100,
- 100
], - [
- 100,
- 0
], - [
- 0,
- 0
], - [
- 0,
- 100
], - [
- 100,
- 100
]
], - "zone_type": "area",
- "uuid": "11495b9cca374e41a1cda9604169235b",
- "zone_dimensions": [
- 100,
- 140,
- 80
], - "safety_parameter": 0.5,
- "speed_limit": 2.5,
- "zone_vehicle_limit": 1,
- "is_active": false,
- "priority": 5,
- "allowed_vehicle_categories": [
- "c2bfb3237b874e238a7efa727d8485f8"
], - "entry_preset": "287c54aeaa534b71bc2cfd7762018ba4",
- "exit_preset": "4b24bf57518f4eeea5265b961c261a4f"
}
]
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
title | string The title of the zone |
initial_point | Array of numbers The initial point of the zone |
points | Array of numbers[ items ] The points defining the zone |
zone_type | string Enum: "area" "charging" "resting" "forbidden" "restricted" "action" The type of the zone |
zone_dimensions | Array of numbers The dimensions of the zone |
safety_parameter | number <float> The safety parameter of the zone (in meters) |
speed_limit | number <float> The speed limit of the zone (in meters/s) |
zone_vehicle_limit | number The vehicle limit of the zone |
is_active | boolean Default: true Indicates if the zone is active |
priority | number or null [ 0 .. 5 ] Default: 0 Indicates if the zone should have priority over other zones (default is 0 as no priority). The higher the number, the higher the priority. |
allowed_vehicle_categories | Array of strings <uuid> |
entry_preset | string <uuid> If specified, the path planing algorithm will integrate the zone entry preset when a vehicle path enters the zone |
exit_preset | string <uuid> If specified, the path planing algorithm will integrate the zone exit preset when a vehicle path exits the zone |
{- "title": "Charging Zone 1",
- "initial_point": [
- 0,
- 0
], - "points": [
- [
- 100,
- 100
], - [
- 100,
- 0
], - [
- 0,
- 0
], - [
- 0,
- 100
], - [
- 100,
- 100
]
], - "zone_type": "area",
- "zone_dimensions": [
- 100,
- 140,
- 80
], - "safety_parameter": 0.5,
- "speed_limit": 2.5,
- "zone_vehicle_limit": 1,
- "is_active": false,
- "priority": 5,
- "allowed_vehicle_categories": [
- "c2bfb3237b874e238a7efa727d8485f8"
], - "entry_preset": "287c54aeaa534b71bc2cfd7762018ba4",
- "exit_preset": "4b24bf57518f4eeea5265b961c261a4f"
}
{- "title": "Charging Zone 1",
- "points": [
- [
- 100,
- 100
], - [
- 100,
- 0
], - [
- 0,
- 0
], - [
- 0,
- 100
], - [
- 100,
- 100
]
], - "zone_type": "area",
- "uuid": "11495b9cca374e41a1cda9604169235b",
- "zone_dimensions": [
- 100,
- 140,
- 80
], - "safety_parameter": 0.5,
- "speed_limit": 2.5,
- "zone_vehicle_limit": 1,
- "is_active": false,
- "priority": 5,
- "allowed_vehicle_categories": [
- "c2bfb3237b874e238a7efa727d8485f8"
], - "entry_preset": "287c54aeaa534b71bc2cfd7762018ba4",
- "exit_preset": "4b24bf57518f4eeea5265b961c261a4f"
}
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
ordering | string Enum: "name" "created_at" "updated_at" Example: ordering=-name Ordering of the results. Default is name. Accepts multiple values separated by comma. Use -name to reverse order. |
[- {
- "uuid": "86992415878c4af992df1d2e05815284",
- "title": "Charging Station 1",
- "station_type": "resting",
- "points": [
- 5,
- 5
], - "rotation": 90,
- "allowed_vehicle_categories": [
- "c2bfb3237b874e238a7efa727d8485f8"
], - "icon_color": "#FF0000"
}
]
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
title | string |
station_type | string (ZonesStationType) Enum: "resting" "charging" "traversal" "default" |
points | Array of numbers |
rotation | number <float> |
allowed_vehicle_categories | Array of strings <uuid> |
icon_color | string or null The color of the icon, when null the default color will be used |
{- "title": "Charging Station 1",
- "station_type": "resting",
- "points": [
- 5,
- 5
], - "rotation": 90,
- "allowed_vehicle_categories": [
- "c2bfb3237b874e238a7efa727d8485f8"
], - "icon_color": "#FF0000"
}
{- "uuid": "86992415878c4af992df1d2e05815284",
- "title": "Charging Station 1",
- "station_type": "resting",
- "points": [
- 5,
- 5
], - "rotation": 90,
- "allowed_vehicle_categories": [
- "c2bfb3237b874e238a7efa727d8485f8"
], - "icon_color": "#FF0000"
}
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "86992415878c4af992df1d2e05815284",
- "title": "Charging Station 1",
- "station_type": "resting",
- "points": [
- 5,
- 5
], - "rotation": 90,
- "allowed_vehicle_categories": [
- "c2bfb3237b874e238a7efa727d8485f8"
], - "icon_color": "#FF0000"
}
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
title | string |
station_type | string (ZonesStationType) Enum: "resting" "charging" "traversal" "default" |
points | Array of numbers |
rotation | number <float> |
allowed_vehicle_categories | Array of strings <uuid> |
icon_color | string or null The color of the icon, when null the default color will be used |
{- "title": "Charging Station 1",
- "station_type": "resting",
- "points": [
- 5,
- 5
], - "rotation": 90,
- "allowed_vehicle_categories": [
- "c2bfb3237b874e238a7efa727d8485f8"
], - "icon_color": "#FF0000"
}
{- "uuid": "86992415878c4af992df1d2e05815284",
- "title": "Charging Station 1",
- "station_type": "resting",
- "points": [
- 5,
- 5
], - "rotation": 90,
- "allowed_vehicle_categories": [
- "c2bfb3237b874e238a7efa727d8485f8"
], - "icon_color": "#FF0000"
}
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "28efb1c889124304baa48dc195a04fce",
- "source_point": "86992415878c4af992df1d2e0581599b",
- "destination_point": "86992415878c4af992df1d2e05815284",
- "points": [
- [
- 20,
- 20
], - [
- 30,
- 20
], - [
- 30,
- 30
]
], - "distance": 2.66,
- "is_active": false,
- "speed_limit": 0.5
}
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
source_point required | string <uuid> |
destination_point required | string <uuid> |
points | Array of numbers[ items ] |
is_active | boolean Default: true |
speed_limit | float Default: -1 |
{- "source_point": "86992415878c4af992df1d2e0581599b",
- "destination_point": "86992415878c4af992df1d2e05815284",
- "points": [
- [
- 20,
- 20
], - [
- 30,
- 20
], - [
- 30,
- 30
]
], - "is_active": false,
- "speed_limit": 0.5
}
{- "uuid": "28efb1c889124304baa48dc195a04fce",
- "source_point": "86992415878c4af992df1d2e0581599b",
- "destination_point": "86992415878c4af992df1d2e05815284",
- "points": [
- [
- 20,
- 20
], - [
- 30,
- 20
], - [
- 30,
- 30
]
], - "distance": 2.66,
- "is_active": false,
- "speed_limit": 0.5
}
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
{- "uuid": "86992415878c4af992df1d2e05815284",
- "title": "Charging Station 1",
- "station_type": "resting",
- "points": [
- 5,
- 5
], - "rotation": 90,
- "allowed_vehicle_categories": [
- "c2bfb3237b874e238a7efa727d8485f8"
], - "icon_color": "#FF0000"
}
uuid required | string <uuid> Example: 123e4567e89b12d3a456426614174000 UUID of the target resource |
title | string |
station_type | string (ZonesStationType) Enum: "resting" "charging" "traversal" "default" |
points | Array of numbers |
rotation | number <float> |
allowed_vehicle_categories | Array of strings <uuid> |
icon_color | string or null The color of the icon, when null the default color will be used |
{- "title": "Charging Station 1",
- "station_type": "resting",
- "points": [
- 5,
- 5
], - "rotation": 90,
- "allowed_vehicle_categories": [
- "c2bfb3237b874e238a7efa727d8485f8"
], - "icon_color": "#FF0000"
}
{- "uuid": "86992415878c4af992df1d2e05815284",
- "title": "Charging Station 1",
- "station_type": "resting",
- "points": [
- 5,
- 5
], - "rotation": 90,
- "allowed_vehicle_categories": [
- "c2bfb3237b874e238a7efa727d8485f8"
], - "icon_color": "#FF0000"
}