送出機械人任務(beta)
const url = 'https://api.example.yas/v1/robots/tasks';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"partnerId":"partner","schemaVersion":"2026-11","sourceSystem":"partner-export","robotId":"rbt_example","taskInstanceId":"task_1001","taskId":"patrol_12","taskType":"patrol","keywords":["shared_space","night"],"executeStart":"2026-10-15T10:00:00.000Z","timezone":"Asia/Hong_Kong","status":"complete"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.example.yas/v1/robots/tasks \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "partnerId": "partner", "schemaVersion": "2026-11", "sourceSystem": "partner-export", "robotId": "rbt_example", "taskInstanceId": "task_1001", "taskId": "patrol_12", "taskType": "patrol", "keywords": [ "shared_space", "night" ], "executeStart": "2026-10-15T10:00:00.000Z", "timezone": "Asia/Hong_Kong", "status": "complete" }'Beta。用 server key 建立或取代一筆任務。請送 partnerId、schemaVersion、sourceSystem、robotId、taskInstanceId、executeStart 與 timezone。這台機械人必須已存在於這個 partnerId。未知的 robotId 是 404。之後用同一個 partnerId、robotId 與 taskInstanceId 再送,會蓋掉舊內容。選填欄位不送就會清掉。taskType 的例子是 patrol 與 charging。keywords 的例子是 shared_space、night 與 heavy_traffic。其他詞也會保存。不送 keywords 就會清掉。空清單不會保存任何詞。updatedAt 是 ISO-8601 UTC。
Authorizations
小節:AuthorizationsRequest Bodyrequired
小節:Request Bodyrequiredobject
合作夥伴 id。必須與 server key 相符。
這次內容的 schema 版本。例子:2026-11。
送出這次內容的系統名稱。例子:partner-export。
機械人 id。這台機械人必須已經存在。
這次任務執行的 id。同一合作夥伴、機械人與任務實例再送,會蓋掉舊內容。
任務開始的時間,ISO-8601。
IANA 時區。例子:Asia/Hong_Kong。
合作夥伴的任務定義 id。例子:patrol_12。
機械人在做什麼。例子:patrol、charging。
描述這次任務的詞。YAS 日後用這些詞把相近的任務歸在一起。例子:shared_space、night、heavy_traffic。其他詞也會保存。
任務結束的時間,ISO-8601。
任務狀態。其他值會被拒絕。
誰結束任務:robot、operator 或 partner。
機械人到達目標時為 true。
路線 id。
這次任務的行走距離,單位是米。
這次任務的時長,單位是秒。
開始時的電量,以百分比計。
結束時的電量,以百分比計。
這次任務中的人工介入次數。
任務為何異常。
場地 id。
任務在與人共用的空間進行時為 true。
任務如何結束:complete、interrupted 或 aborted。
送出時的韌體版本。
合作夥伴的額外欄位。照送出的內容保存。
object
Example
{ "partnerId": "partner", "schemaVersion": "2026-11", "sourceSystem": "partner-export", "robotId": "rbt_example", "taskInstanceId": "task_1001", "taskId": "patrol_12", "taskType": "patrol", "keywords": [ "shared_space", "night" ], "executeStart": "2026-10-15T10:00:00.000Z", "timezone": "Asia/Hong_Kong", "status": "complete"}Responses
小節:Responses200
小節:200任務已保存。之後用同一個任務實例再送,會蓋掉它。updatedAt 是 ISO-8601 UTC。
object
Example
{ "robotId": "rbt_example", "taskInstanceId": "task_1001", "updatedAt": "2026-10-15T10:45:00.000Z"}400缺少必填欄位,或 `status`、`closer`、`outcome` 不在允許的值內。
object
穩定的錯誤代碼。沒有 stack trace。
Example
{ "error": "invalid_body"}401沒有 server key,或 server key 不正確。
object
穩定的錯誤代碼。沒有 stack trace。
Example
{ "error": "invalid_credentials"}403server key 可以只限車輛、只限機械人,或兩者都可以。超出範圍的呼叫是 403 `forbidden`,而且不會保存。`identity_mismatch` 表示 `partnerId` 與 server key 不符。
object
穩定的錯誤代碼。沒有 stack trace。
Example
{ "error": "forbidden"}404未知的 `robotId`。這次什麼都不會存。
object
穩定的錯誤代碼。沒有 stack trace。
Example
{ "error": "not_found"}