{"url":"/api-reference/robot-webservice/robots-map-filter-image","method":"POST","path":"/api/robot/getMapFilterImage","tag":"Robot Webservice","title":"Robot's map filter image","operation":{"description":"A PGM mask of a filter the robot applies on its currently assigned map. Same dimensions as the map image.","operationId":"getMapFilterImage","parameters":[{"description":"Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.","example":"api-token","in":"header","name":"x-auth-scheme","required":true,"schema":{"default":"api-token","enum":["api-token","api","partner-api-token","partner-api"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Robot_GetRobotMapFilterImageWSRequest"}}}},"responses":{"200":{"content":{"*/*":{},"image/x-portable-graymap":{}},"description":"OK"}},"summary":"Robot's map filter image","tags":["Robot Webservice"]},"auth":{"headers":[{"description":"Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints).","in":"header","name":"x-auth-apikey","type":"apiKey"}]},"components":{"schemas":{"Robot_GetRobotMapFilterImageWSRequest":{"description":"Request for the mask image of a map filter the robot applies.","properties":{"deviceUuid":{"description":"base 64 (url-safe) uuid string","example":"AAAAAAAAAAAAAAAAAAAAAA","format":"RUUID","nullable":true,"type":"string"},"mapFilterUuid":{"description":"base 64 (url-safe) uuid string","example":"AAAAAAAAAAAAAAAAAAAAAA","format":"RUUID","nullable":true,"type":"string"}},"type":"object"}},"securitySchemes":{"ApiKeyAuth":{"description":"Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints).","in":"header","name":"x-auth-apikey","type":"apiKey"},"oauth2":{"description":"OAuth 2.0 authorization code flow with PKCE (`S256`). Send the access token as `Authorization: Bearer <token>`. Each operation lists the scopes it requires; a token without them is refused 403 with `WWW-Authenticate: Bearer error=\"insufficient_scope\"`.","flows":{"authorizationCode":{"authorizationUrl":"https://console.rhombus.com/oauth/authorize","refreshUrl":"https://auth-web.rhombussystems.com/oauth/token","scopes":{"physical":"Unlock doors and elevators, lockdown, alarms, speakers and robots","read":"View cameras, footage and settings","write":"Change settings and data"},"tokenUrl":"https://auth-web.rhombussystems.com/oauth/token"}},"type":"oauth2"}}},"highlight":{"samples":{"cURL":[["text-code-function","curl"],[""," "],["text-code-string","--request"],[""," "],["text-code-string","POST"],[""," \\\n  "],["text-code-string","--url"],[""," "],["text-code-punctuation","'"],["text-code-string","https://api2.rhombussystems.com/api/robot/getMapFilterImage"],["text-code-punctuation","'"],[""," \\\n  "],["text-code-string","--header"],[""," "],["text-code-punctuation","'"],["text-code-string","x-auth-scheme: api-token"],["text-code-punctuation","'"],[""," \\\n  "],["text-code-string","--header"],[""," "],["text-code-punctuation","'"],["text-code-string","x-auth-apikey: YOUR_API_KEY"],["text-code-punctuation","'"],[""," \\\n  "],["text-code-string","--header"],[""," "],["text-code-punctuation","'"],["text-code-string","Content-Type: application/json"],["text-code-punctuation","'"],[""," \\\n  "],["text-code-string","--data"],[""," "],["text-code-punctuation","'"],["text-code-string","{"],["","\n"],["text-code-string","    \"deviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\","],["","\n"],["text-code-string","    \"mapFilterUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\""],["","\n"],["text-code-string","  }"],["text-code-punctuation","'"],[""," \\\n  "],["text-code-string","--output"],[""," "],["text-code-string","output.bin"]],"Python":[["text-code-keyword","import"],[""," requests\n\nurl "],["text-code-punctuation","="],[""," "],["text-code-punctuation","\""],["text-code-string","https://api2.rhombussystems.com/api/robot/getMapFilterImage"],["text-code-punctuation","\""],["","\nheaders "],["text-code-punctuation","="],[""," "],["text-code-punctuation","{"],["","\n    "],["text-code-punctuation","\""],["text-code-string","x-auth-scheme"],["text-code-punctuation","\":"],[""," "],["text-code-punctuation","\""],["text-code-string","api-token"],["text-code-punctuation","\","],["","\n    "],["text-code-punctuation","\""],["text-code-string","x-auth-apikey"],["text-code-punctuation","\":"],[""," "],["text-code-punctuation","\""],["text-code-string","YOUR_API_KEY"],["text-code-punctuation","\","],["","\n    "],["text-code-punctuation","\""],["text-code-string","Content-Type"],["text-code-punctuation","\":"],[""," "],["text-code-punctuation","\""],["text-code-string","application/json"],["text-code-punctuation","\","],["","\n"],["text-code-punctuation","}"],["","\npayload "],["text-code-punctuation","="],[""," "],["text-code-punctuation","{"],["","\n    "],["text-code-punctuation","\""],["text-code-string","deviceUuid"],["text-code-punctuation","\":"],[""," "],["text-code-punctuation","\""],["text-code-string","AAAAAAAAAAAAAAAAAAAAAA"],["text-code-punctuation","\","],["","\n    "],["text-code-punctuation","\""],["text-code-string","mapFilterUuid"],["text-code-punctuation","\":"],[""," "],["text-code-punctuation","\""],["text-code-string","AAAAAAAAAAAAAAAAAAAAAA"],["text-code-punctuation","\""],["","\n"],["text-code-punctuation","}"],["","\n\nresponse "],["text-code-punctuation","="],[""," requests"],["text-code-punctuation","."],["text-code-function","post"],["text-code-punctuation","("],["text-code-function","url"],["text-code-punctuation",","],["text-code-function"," "],["","headers"],["text-code-punctuation","="],["text-code-function","headers"],["text-code-punctuation",","],["text-code-function"," "],["","json"],["text-code-punctuation","="],["text-code-function","payload"],["text-code-punctuation",")"],["","\nresponse"],["text-code-punctuation","."],["text-code-function","raise_for_status"],["text-code-punctuation","()"],["","\n"],["text-code-keyword","with"],[""," "],["text-code-function","open"],["text-code-punctuation","(\""],["text-code-string","output.bin"],["text-code-punctuation","\","],["text-code-function"," "],["text-code-punctuation","\""],["text-code-string","wb"],["text-code-punctuation","\")"],[""," "],["text-code-keyword","as"],[""," f"],["text-code-punctuation",":"],["","\n    f"],["text-code-punctuation","."],["text-code-function","write"],["text-code-punctuation","("],["text-code-function","response"],["text-code-punctuation","."],["text-code-function","content"],["text-code-punctuation",")"]],"JavaScript":[["text-code-keyword","const"],[""," response "],["text-code-punctuation","="],[""," "],["text-code-keyword","await"],[""," "],["text-code-function","fetch"],["text-code-punctuation","('"],["text-code-string","https://api2.rhombussystems.com/api/robot/getMapFilterImage"],["text-code-punctuation","',"],[""," "],["text-code-punctuation","{"],["","\n  "],["text-code-property","method"],["text-code-punctuation",":"],[""," "],["text-code-punctuation","'"],["text-code-string","POST"],["text-code-punctuation","',"],["","\n  "],["text-code-property","headers"],["text-code-punctuation",":"],[""," "],["text-code-punctuation","{"],["","\n    "],["text-code-punctuation","'"],["text-code-string","x-auth-scheme"],["text-code-punctuation","':"],[""," "],["text-code-punctuation","'"],["text-code-string","api-token"],["text-code-punctuation","',"],["","\n    "],["text-code-punctuation","'"],["text-code-string","x-auth-apikey"],["text-code-punctuation","':"],[""," "],["text-code-punctuation","'"],["text-code-string","YOUR_API_KEY"],["text-code-punctuation","',"],["","\n    "],["text-code-punctuation","'"],["text-code-string","Content-Type"],["text-code-punctuation","':"],[""," "],["text-code-punctuation","'"],["text-code-string","application/json"],["text-code-punctuation","',"],["","\n  "],["text-code-punctuation","},"],["","\n  "],["text-code-property","body"],["text-code-punctuation",":"],[""," JSON"],["text-code-punctuation","."],["text-code-function","stringify"],["text-code-punctuation","({"],["","\n    "],["text-code-punctuation","\""],["text-code-string","deviceUuid"],["text-code-punctuation","\":"],[""," "],["text-code-punctuation","\""],["text-code-string","AAAAAAAAAAAAAAAAAAAAAA"],["text-code-punctuation","\","],["","\n    "],["text-code-punctuation","\""],["text-code-string","mapFilterUuid"],["text-code-punctuation","\":"],[""," "],["text-code-punctuation","\""],["text-code-string","AAAAAAAAAAAAAAAAAAAAAA"],["text-code-punctuation","\""],["","\n  "],["text-code-punctuation","}),"],["","\n"],["text-code-punctuation","});"],["","\n"],["text-code-keyword","if"],[""," "],["text-code-punctuation","(!"],["","response"],["text-code-punctuation","."],["text-code-property","ok"],["text-code-punctuation",")"],[""," "],["text-code-keyword","throw"],[""," "],["text-code-keyword","new"],[""," "],["text-code-function","Error"],["text-code-punctuation","(`${"],["","response"],["text-code-punctuation","."],["text-code-property","status"],["text-code-punctuation","}"],["text-code-string",": "],["text-code-punctuation","${"],["text-code-keyword","await"],["text-code-string"," "],["","response"],["text-code-punctuation","."],["text-code-function","text"],["text-code-punctuation","()}`);"],["","\n\n"],["text-code-keyword","const"],[""," blob "],["text-code-punctuation","="],[""," "],["text-code-keyword","await"],[""," response"],["text-code-punctuation","."],["text-code-function","blob"],["text-code-punctuation","();"],[""," "],["text-code-comment italic","// */*"]],"Java":[["text-code-keyword","import"],[""," "],["text-code-keyword","java"],["text-code-punctuation","."],["text-code-keyword","net"],["text-code-punctuation","."],["text-code-keyword","URI"],["text-code-punctuation",";"],["","\n"],["text-code-keyword","import"],[""," "],["text-code-keyword","java"],["text-code-punctuation","."],["text-code-keyword","net"],["text-code-punctuation","."],["text-code-keyword","http"],["text-code-punctuation","."],["text-code-keyword","HttpClient"],["text-code-punctuation",";"],["","\n"],["text-code-keyword","import"],[""," "],["text-code-keyword","java"],["text-code-punctuation","."],["text-code-keyword","net"],["text-code-punctuation","."],["text-code-keyword","http"],["text-code-punctuation","."],["text-code-keyword","HttpRequest"],["text-code-punctuation",";"],["","\n"],["text-code-keyword","import"],[""," "],["text-code-keyword","java"],["text-code-punctuation","."],["text-code-keyword","net"],["text-code-punctuation","."],["text-code-keyword","http"],["text-code-punctuation","."],["text-code-keyword","HttpResponse"],["text-code-punctuation",";"],["","\n"],["text-code-keyword","import"],[""," "],["text-code-keyword","java"],["text-code-punctuation","."],["text-code-keyword","nio"],["text-code-punctuation","."],["text-code-keyword","file"],["text-code-punctuation","."],["text-code-keyword","Path"],["text-code-punctuation",";"],["","\n\n"],["text-code-keyword","public"],[""," "],["text-code-keyword","class"],[""," Example "],["text-code-punctuation","{"],["","\n    "],["text-code-keyword","public"],[""," "],["text-code-keyword","static"],[""," "],["text-code-keyword","void"],[""," "],["text-code-function","main"],["text-code-punctuation","("],["text-code-keyword","String"],["text-code-punctuation","[]"],[""," args"],["text-code-punctuation",")"],[""," "],["text-code-keyword","throws"],[""," "],["text-code-keyword","Exception"],[""," "],["text-code-punctuation","{"],["","\n        "],["text-code-keyword","String"],[""," body "],["text-code-punctuation","="],[""," "],["text-code-punctuation","\"\"\""],["","\n"],["text-code-string","            {"],["","\n"],["text-code-string","              \"deviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\","],["","\n"],["text-code-string","              \"mapFilterUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\""],["","\n"],["text-code-string","            }"],["","\n"],["text-code-string","            "],["text-code-punctuation","\"\"\";"],["","\n        "],["text-code-keyword","HttpRequest"],[""," request "],["text-code-punctuation","="],[""," HttpRequest"],["text-code-punctuation","."],["text-code-function","newBuilder"],["text-code-punctuation","()"],["","\n            "],["text-code-punctuation","."],["text-code-function","uri"],["text-code-punctuation","("],["","URI"],["text-code-punctuation","."],["text-code-function","create"],["text-code-punctuation","(\""],["text-code-string","https://api2.rhombussystems.com/api/robot/getMapFilterImage"],["text-code-punctuation","\"))"],["","\n            "],["text-code-punctuation","."],["text-code-function","header"],["text-code-punctuation","(\""],["text-code-string","x-auth-scheme"],["text-code-punctuation","\","],[""," "],["text-code-punctuation","\""],["text-code-string","api-token"],["text-code-punctuation","\")"],["","\n            "],["text-code-punctuation","."],["text-code-function","header"],["text-code-punctuation","(\""],["text-code-string","x-auth-apikey"],["text-code-punctuation","\","],[""," "],["text-code-punctuation","\""],["text-code-string","YOUR_API_KEY"],["text-code-punctuation","\")"],["","\n            "],["text-code-punctuation","."],["text-code-function","header"],["text-code-punctuation","(\""],["text-code-string","Content-Type"],["text-code-punctuation","\","],[""," "],["text-code-punctuation","\""],["text-code-string","application/json"],["text-code-punctuation","\")"],["","\n            "],["text-code-punctuation","."],["text-code-function","method"],["text-code-punctuation","(\""],["text-code-string","POST"],["text-code-punctuation","\","],[""," HttpRequest"],["text-code-punctuation","."],["","BodyPublishers"],["text-code-punctuation","."],["text-code-function","ofString"],["text-code-punctuation","("],["","body"],["text-code-punctuation","))"],["","\n            "],["text-code-punctuation","."],["text-code-function","build"],["text-code-punctuation","();"],["","\n        "],["text-code-keyword","HttpResponse"],["text-code-punctuation","<"],["text-code-keyword","Path"],["text-code-punctuation",">"],[""," response "],["text-code-punctuation","="],[""," HttpClient"],["text-code-punctuation","."],["text-code-function","newHttpClient"],["text-code-punctuation","()"],["","\n            "],["text-code-punctuation","."],["text-code-function","send"],["text-code-punctuation","("],["","request"],["text-code-punctuation",","],[""," HttpResponse"],["text-code-punctuation","."],["","BodyHandlers"],["text-code-punctuation","."],["text-code-function","ofFile"],["text-code-punctuation","("],["","Path"],["text-code-punctuation","."],["text-code-function","of"],["text-code-punctuation","(\""],["text-code-string","output.bin"],["text-code-punctuation","\")));"],["","\n        System"],["text-code-punctuation","."],["","out"],["text-code-punctuation","."],["text-code-function","println"],["text-code-punctuation","("],["","response"],["text-code-punctuation","."],["text-code-function","statusCode"],["text-code-punctuation","()"],[""," "],["text-code-punctuation","+"],[""," "],["text-code-punctuation","\""],["text-code-string"," "],["text-code-punctuation","\""],[""," "],["text-code-punctuation","+"],[""," response"],["text-code-punctuation","."],["text-code-function","body"],["text-code-punctuation","());"],["","\n    "],["text-code-punctuation","}"],["","\n"],["text-code-punctuation","}"]]},"responses":{}}}