Skip to main content

Robots Management

This section outlines the APIs available for managing and retrieving information about robots in the system.

List Robot​

Retrieves a list of all robot IDs, along with basic information and their online status

Endpoint​

GET /robots

Response​

Header:
{
     "Authorization":"bearer": "..."
}

Description​

This endpoint returns a list of all robots in the system. Each robot entry contains its unique identifier, name, and online status.

Response example​

{
    "RobotDataList":
        [
        {"BasicData":{"Id":"11111111-2122-1122-2233-555555319861","Name":"test1"},"IsOnline":true},
        {"BasicData":{"Id":"11111111-2122-1122-2233-555555319862","Name":"test2"},"IsOnline":true}
        ]
}

Robot’s Details​

Fetch Robot Details by ID​

Retrieves detailed information for a specific robot by its ID.

Endpoint​


    GET /robot/{robotId}

Request Headers​

{
  "Authorization": "bearer <access_token>"
}

Path Parameters​

  • robotId (string): The unique identifier of the robot for which details are requested.

Description​

This endpoint fetches details for a specific robot using its unique ID. The response includes the robot's basic information, online status, associated fleet, organization name, last seen timestamp, and user permissions.

Response example​

{
    "RobotData": {
        "BasicData": {
            "Id": "11111111-2122-1122-2233-555555319864",
            "Name": "AMR-Qualcomm-RB5"
        },
        "IsOnline": false
    },
    "FleetName": "2222222",
    "OrganizationName": "Cogniteam",
    "LastTimeSeen": "2024-09-29T13:07:27.211444Z",
    "Members": {
        "OrgAdmins": {
            "OrgAdmins": [
                "user@cogniteam.com",
                ...
            ]
        },
        "SharedUsers": {
            "UserPermissions": [
                {
                    "UserId": "QA_user2@cogniteam.com",
                    "PermissionType": 1
                },
                ....
            ]
        }
    }
    }