> ## Documentation index
> Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt
> Use it to discover all available pages before exploring further.

# Retrieve the robot's map assignment record.

> A snapshot of the ancillary map data at the timeof when the map was assigned to the device.A device can only have one active assignment record. Assignment records are immutable. Only new records can be created

```http
POST https://api2.rhombussystems.com/api/robot/getMapAssignment
```

EU organizations send the same request to `https://api2.eu.rhombussystems.com`.

## Authentication and parameters

- `x-auth-apikey` (header, required): Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints).
- `x-auth-scheme` (header, string, required, default: `api-token`): 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. One of: `api-token`, `api`, `partner-api-token`, `partner-api`.

## Request body

Content type: `application/json`. Retrieve the map assignment information for a device

- `deviceUuid` (string<RUUID> | null): base 64 (url-safe) uuid string

## Response 200

OK. Content type: `application/json`

- `assignmentTimeMs` (integer<int64> | null)
- `assignmentUuid` (string<RUUID> | null): base 64 (url-safe) uuid string
- `error` (boolean | null)
- `errorMsg` (string | null)
- `mapFilters` (array<object> | null)
- `mapMeta` (object)
- `warningMsg` (string | null)

## OpenAPI

````yaml
openapi: 3.0.1
info:
  title: Rhombus API
  version: "1.0"
servers:
  - description: Production Server
    url: https://api2.rhombussystems.com
security:
  - ApiKeyAuth: []
paths:
  /api/robot/getMapAssignment:
    post:
      description: A snapshot of the ancillary map data at the timeof when the map was assigned to the device.A device can only have one active assignment record. Assignment records are immutable. Only new records can be created
      operationId: getMapAssignment
      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_GetMapAssignmentWSRequest"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Robot_GetMapAssignmentWSResponse"
          description: OK
      summary: Retrieve the robot's map assignment record.
      tags:
        - Robot Webservice
components:
  schemas:
    Robot_GetMapAssignmentWSRequest:
      description: Retrieve the map assignment information for a device
      properties:
        deviceUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
      type: object
    Robot_GetMapAssignmentWSResponse:
      description: The robot map assignment information.
      properties:
        assignmentTimeMs:
          format: int64
          nullable: true
          type: integer
        assignmentUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        error:
          nullable: true
          type: boolean
        errorMsg:
          nullable: true
          type: string
        mapFilters:
          items:
            $ref: "#/components/schemas/RobotMapFilter_Public"
          nullable: true
          type: array
        mapMeta:
          $ref: "#/components/schemas/RobotMapMeta_Public"
        warningMsg:
          nullable: true
          type: string
      type: object
    RobotMapFilter_Public:
      properties:
        mapUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        md5:
          nullable: true
          type: string
        name:
          nullable: true
          type: string
        orgUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        type:
          $ref: "#/components/schemas/RobotMapFilterTypeEnum_Public"
        uuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
      type: object
    RobotMapFilterTypeEnum_Public:
      enum:
        - UNKNOWN
        - KEEPOUT
      type: string
    RobotMapMeta_Public:
      properties:
        enabled:
          nullable: true
          type: boolean
        etag:
          nullable: true
          type: string
        floorPlan:
          $ref: "#/components/schemas/RobotFloorPlan_Public"
        freeThresh:
          format: double
          nullable: true
          type: number
        initiatedByDeviceUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        locationUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        negate:
          format: int32
          nullable: true
          type: integer
        occupiedThresh:
          format: double
          nullable: true
          type: number
        orgUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        origin:
          items:
            description: Serialized as [x, y, z]
            format: double
            type: number
          maxItems: 3
          minItems: 3
          nullable: true
          type: array
        resolution:
          format: float
          nullable: true
          type: number
        sizeBytes:
          format: int64
          nullable: true
          type: integer
        uploadState:
          $ref: "#/components/schemas/RobotMapUploadStateEnum_Public"
        uploaded:
          nullable: true
          type: boolean
        uuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
      type: object
    RobotFloorPlan_Public:
      properties:
        eastEdge:
          format: double
          nullable: true
          type: number
        floorNumber:
          format: int32
          nullable: true
          type: integer
        northEdge:
          format: double
          nullable: true
          type: number
        rotation:
          format: double
          nullable: true
          type: number
        southEdge:
          format: double
          nullable: true
          type: number
        westEdge:
          format: double
          nullable: true
          type: number
      type: object
    RobotMapUploadStateEnum_Public:
      enum:
        - UNKNOWN
        - PENDING
        - PROCESSING
        - READY
      type: string
  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
````