Obtain Waypoints List

2022-06-24
No Rating

GET /wayline/api/v1/workspaces/{workspace_id}/waylines

Parameters

NameInTypeRequiredDescription
workspace_idpathstringtrueworkspace id
favoritedquerybooleanfalsewhether to favorite
order_byquerystringfalseorder(xxx_column desc or xxx_column asc
pagequeryintegerfalsecurrent page
page_sizequeryintegerfalsepage size
template_typequeryarray[integer]falsewaypoints template type collection
x-auth-tokenheaderstringtrueaccess token

Responses

StatusMeaningDescriptionSchema
200OKopen in new windowOKwayline.GetWaylinesOutput

Example responses

{
    "code":0,
    "message":"success",
    "data":{
        "list":[
            {
                "id":"uuid",
                "drone_model_key":"0-67-0",
                "favorited":false,
                "name":"新建航线1",
                "payload_model_keys":[
                    "1-53-0"
                ],
                "template_types":[
                    0
                ],
                "update_time":1637158501230,
                "user_name":"string"
            }
        ],
        "pagination":{
            "page":1,
            "page_size":9,
            "total":10
        }
    }
}

Schemas

wayline.GetWaylinesOutput

{
  "code": 0,
  "data": {
    "list": [
      {
        "drone_model_key": "string",
        "favorited": true,
        "id": "string",
        "name": "string",
        "payload_model_keys": [
          "string"
        ],
        "template_types": [
          0
        ],
        "update_time": 0,
        "user_name": "string"
      }
    ],
    "pagination": {
      "page": 0,
      "page_size": 0,
      "total": 0
    }
  },
  "message": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
codeintegerfalsenoneerror code
datawayline.GetWaylinesOutputDatafalsenonenone
messagestringfalsenonedescription

wayline.GetWaylinesOutputData

{
  "list": [
    {
      "drone_model_key": "string",
      "favorited": true,
      "id": "string",
      "name": "string",
      "payload_model_keys": [
        "string"
      ],
      "template_types": [
        0
      ],
      "update_time": 0,
      "user_name": "string"
    }
  ],
  "pagination": {
    "page": 0,
    "page_size": 0,
    "total": 0
  }
}

Properties

NameTypeRequiredRestrictionsDescription
list[wayline.AppFileItem]falsenonenone
paginationapi_render.PagyInfofalsenonenone

wayline.AppFileItem

{
  "drone_model_key": "string",
  "favorited": true,
  "id": "string",
  "name": "string",
  "payload_model_keys": [
    "string"
  ],
  "template_types": [
    0
  ],
  "update_time": 0,
  "user_name": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
drone_model_keystringfalsenonedrone device product enum
favoritedbooleanfalsenonewhether to favorite
idstringfalsenonewaypoints file id
namestringfalsenonewaypoints file name
payload_model_keys[string]falsenonepayload device product enum
template_types[integer]falsenonewaypoints template collection
update_timeintegerfalsenoneupdate time(millisecond)
user_namestringfalsenoneuploader

api_render.PagyInfo

{
  "page": 0,
  "page_size": 0,
  "total": 0
}

Properties

NameTypeRequiredRestrictionsDescription
pageintegerfalsenonecurrent page
page_sizeintegerfalsenonepage size
totalintegerfalsenonetotal