{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/log","auth":"required","examples":{"codes":[{"code":"{\n  \"expCode\": \"vehicleA\",\n  \"routeLogs\": [\n    {\n      \"type\": \"Route\",\n      \"driver\": {\n        \"id\": \"d1\",\n        \"maxCapacity\": {\n          \"data\": {\n            \"Volume\": 1000000.0\n          }\n        },\n        \"startLocation\": {\n          \"labels\": [],\n          \"x\": 128.1,\n          \"y\": 37.1\n        },\n        \"endLocation\": {\n          \"labels\": [],\n          \"x\": 128.1,\n          \"y\": 37.1\n        },\n        \"startTime\": {\n          \"epoch\": 1455340000\n        },\n        \"endTime\": {\n          \"epoch\": 1455370000\n        },\n        \"skillLevel\": 0,\n        \"vehicleFeatures\": []\n      },\n      \"jobs\": [\n        {\n          \"id\": \"j1\",\n          \"tasks\": [\n            {\n              \"id\": \"t1\",\n              \"jobId\": \"j1\",\n              \"taskType\": \"DepotDelivery\",\n              \"location\": {\n                \"labels\": [],\n                \"x\": 126.9,\n                \"y\": 37.3\n              },\n              \"capacity\": {\n                \"data\": {\n                  \"Volume\": 100.0\n                }\n              },\n              \"taskDuration\": {\n                \"seconds\": 300\n              },\n              \"timeWindow\": {\n                \"start\": {\n                  \"epoch\": 1455354000\n                },\n                \"end\": {\n                  \"epoch\": 1455364800\n                }\n              },\n              \"difficulty\": 0\n            }\n          ],\n          \"partialOrder\": []\n        }\n      ],\n      \"tasks\": [\n        {\n          \"id\": \"t1\",\n          \"jobId\": \"j1\",\n          \"taskType\": \"DepotDelivery\",\n          \"location\": {\n            \"labels\": [],\n            \"x\": 126.9,\n            \"y\": 37.3\n          },\n          \"capacity\": {\n            \"data\": {\n              \"Volume\": 100.0\n            }\n          },\n          \"taskDuration\": {\n            \"seconds\": 300\n          },\n          \"timeWindow\": {\n            \"start\": {\n              \"epoch\": 1455354000\n            },\n            \"end\": {\n              \"epoch\": 1455364800\n            }\n          },\n          \"difficulty\": 0\n        }\n      ]\n    },\n    {\n      \"type\": \"Route\",\n      \"driver\": {\n        \"id\": \"d2\",\n        \"maxCapacity\": {\n          \"data\": {\n            \"Volume\": 1000000.0\n          }\n        },\n        \"startLocation\": {\n          \"labels\": [],\n          \"x\": 128.1,\n          \"y\": 37.1\n        },\n        \"endLocation\": {\n          \"labels\": [],\n          \"x\": 128.1,\n          \"y\": 37.1\n        },\n        \"startTime\": {\n          \"epoch\": 1455340000\n        },\n        \"endTime\": {\n          \"epoch\": 1455370000\n        },\n        \"skillLevel\": 0,\n        \"vehicleFeatures\": []\n      },\n      \"jobs\": [\n        {\n          \"id\": \"j2\",\n          \"tasks\": [\n            {\n              \"id\": \"t2\",\n              \"jobId\": \"j2\",\n              \"taskType\": \"DepotDelivery\",\n              \"location\": {\n                \"labels\": [],\n                \"x\": 126.9,\n                \"y\": 37.3\n              },\n              \"capacity\": {\n                \"data\": {\n                  \"Volume\": 100.0\n                }\n              },\n              \"taskDuration\": {\n                \"seconds\": 300\n              },\n              \"timeWindow\": {\n                \"start\": {\n                  \"epoch\": 1455354000\n                },\n                \"end\": {\n                  \"epoch\": 1455364800\n                }\n              },\n              \"difficulty\": 0\n            }\n          ],\n          \"partialOrder\": []\n        }\n      ],\n      \"tasks\": [\n        {\n          \"id\": \"t2\",\n          \"jobId\": \"j2\",\n          \"taskType\": \"DepotDelivery\",\n          \"location\": {\n            \"labels\": [],\n            \"x\": 126.9,\n            \"y\": 37.3\n          },\n          \"capacity\": {\n            \"data\": {\n              \"Volume\": 100.0\n            }\n          },\n          \"taskDuration\": {\n            \"seconds\": 300\n          },\n          \"timeWindow\": {\n            \"start\": {\n              \"epoch\": 1455354000\n            },\n            \"end\": {\n              \"epoch\": 1455364800\n            }\n          },\n          \"difficulty\": 0\n        }\n      ]\n    }\n  ]\n}","language":"json","name":"request - body"},{"language":"text","code":"2 route logs are inserted.","name":"response - success"},{"code":"{\n  \"error\": \"Failed to parse Json for [RouteLog]\",\n  \"errorCode\": \"4001\"\n}","language":"json","name":"response - error"}]},"method":"post","params":[{"name":"expCode","type":"string","default":"","desc":"An identifier for the set of the logs. Refer to \"Experience Mining\" section for more information.","required":true,"in":"body","ref":"","_id":"57451c0ec067580e0056b08c"},{"name":"routeLogs","type":"array_object","default":"","desc":"An array of route logs to add to the server. Refer to \"Data Schema\" and \"Experience Mining\" sections for more information.","required":true,"in":"body","ref":"","_id":"57451c0ec067580e0056b08b"},{"name":"x-api-key","type":"string","default":"","desc":"An API key.","required":false,"in":"header","ref":"","_id":"57a084371435850e00dfbc30"}],"results":{"codes":[{"code":"{numRouteLogs} route logs are inserted.","name":"","status":"2XX","language":"text"},{"status":"4XX","language":"json","code":"{\n  \"error\": String,\n  \"errorCode\": String\n}","name":""}]},"settings":"576a36aadd4f320e0060b806"},"next":{"description":"","pages":[]},"title":"/log","type":"endpoint","slug":"logging-the-routes","excerpt":"Log given routes for rule minings","body":"","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"57451aa8e33ef10e00e1a9b6","user":"57061c3e21cfed0e00e8c640","version":{"version":"1.0.17","version_clean":"1.0.17","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["5706099c21cfed0e00e8c60f","573548f4afab4417007239cf","57354970fc5f1e0e001a463c","573549791f16241700c89fc9","57441052583f470e000a7947","57a068f90c933e0e00249bae"],"_id":"5706099c21cfed0e00e8c60e","createdAt":"2016-04-07T07:17:48.808Z","hasDoc":true,"project":"5706099c21cfed0e00e8c60b","__v":6,"hasReference":true,"releaseDate":"2016-04-07T07:17:48.808Z"},"editedParams":true,"githubsync":"","project":"5706099c21cfed0e00e8c60b","createdAt":"2016-05-25T03:23:20.864Z","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Experience Mining API","slug":"experience-mining-api","order":9999,"from_sync":false,"reference":false,"_id":"57441052583f470e000a7947","createdAt":"2016-05-24T08:26:58.716Z","__v":0,"project":"5706099c21cfed0e00e8c60b","version":"5706099c21cfed0e00e8c60e"},"editedParams2":true,"parentDoc":null,"__v":4}

post/log

Log given routes for rule minings

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

expCode:
required
string
An identifier for the set of the logs. Refer to "Experience Mining" section for more information.
routeLogs:
required
array of objects
An array of route logs to add to the server. Refer to "Data Schema" and "Experience Mining" sections for more information.

Headers

x-api-key:
string
An API key.

Examples


Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}