Organization and Project Tutorial
Feature Introduction
page fixed to 1, total = list length); if client-side pagination is needed, please slice based on the full result set.Interface Usage Flow
Load Organization / Project Basic Information
1.
Get Organization Details (GET /openapi/v2.0/manage/api/v1/organizations/{uuid}). To modify organization name / Logo / industry / introduction / unit system / fence configuration, etc., use Update Organization Info (PUT /openapi/v2.0/manage/api/v1/organizations/{uuid}).2.
uuid of all projects under the organization via Query Organization Project List (GET /openapi/v2.0/manage/api/v1/organizations/{uuid}/projects). When usage=simple, return a simplified list (no pagination); otherwise, return paginated by page/page_size.3.
Get Project Details (GET /openapi/v2.0/manage/api/v1/projects/{uuid}) on the project of interest to load details; in the returned fields, is_project_updatable marks whether the current user can edit this project, and project_fast_join.code is returned only when project edit permission is held.Create / Update / Delete Project
1.
Create Project (POST /openapi/v2.0/manage/api/v1/organizations/{uuid}/projects). The body can simultaneously initialize project users, project devices, project fast join, project coordinate system, dock rotation, weather blocking, media sharing, and other configurations (project initialization completed in one interface).2.
Update Project Info (PUT /openapi/v2.0/manage/api/v1/projects/{uuid}).3.
Delete Project (DELETE /openapi/v2.0/manage/api/v1/projects/{uuid}) will also clean up members in the project, project device topology (setting the work project field to empty), project notifications and subscriptions; the response data field returns the last snapshot of the deleted project (GetProjectRsp).Fast Join Project
1.
Query Fast Join Project Info (GET /openapi/v2.0/manage/api/v1/projects/fast-join). Required query: project_id (project UUID), project_fast_join_code (fast join code); Optional query: association_drone_device_sn (SN of the drone to be associated). Returns project name, organization name, recommended project callsign; if a drone SN is passed in, also returns the recommended callsign of the drone in this project.2.
Join Project via Fast Join Code (POST /openapi/v2.0/manage/api/v1/projects/fast-join) to submit the join. Request body form:project_fast_join (required): { project_id, project_fast_join_code, user_project_callsign? }, where if user_project_callsign is not passed, the server automatically uses the account name or organization nickname.association_drone (optional): { drone_device_sn, drone_project_callsign?, drone_model_key? }, associate a drone simultaneously when joining the project.Member and Permission Management
1.
Query Current User's Identity and Config in This Organization (GET /openapi/v2.0/manage/api/v1/organizations/{uuid}/users/current) to fetch the organization-level role, subscription, unit, MFA, gray release, and other configurations of the user corresponding to the Token, as the permission context for subsequent operations.2.
Query Organization Member List (GET /openapi/v2.0/manage/api/v1/organizations/{uuid}/users), supports filtering by user_role (enum: organization-super-admin / organization-admin / organization-device-manager / organization-member / organization-temporary-member / organization-visitor) / source_type; if project_uuid (query parameter) is specified, requires the caller to be editable in that project.Batch Add Organization Members (POST /openapi/v2.0/manage/api/v1/organizations/{uuid}/users), accounts must be registered in the user center.Batch Update Organization Member Info (PUT /openapi/v2.0/manage/api/v1/organizations/{uuid}/users), can modify role / enabled status.Batch Remove Organization Members (DELETE /openapi/v2.0/manage/api/v1/organizations/{uuid}/users), matched by user_id / account, will simultaneously clean up the user's member identity and subscriptions in all projects of the organization; failed items are returned as error code + failed user list.3.
Get Project Team Members (Online) (GET /openapi/v2.0/manage/api/v1/projects/{uuid}/members), assembles currently online users by web / app / RC platform classification.Get Project User List (GET /openapi/v2.0/manage/api/v1/projects/{uuid}/users), supports filtering by prj_user_role, sorting by nickname; when called by non-project members, falls back to organization management permission verification.4.
Update Current User's Organization Callsign (PUT /openapi/v2.0/manage/api/v1/organizations/{uuid}/users/current). Note: When the passed-in callsign duplicates an existing user in the organization, the server will automatically append a suffix to ensure uniqueness (will not reject with an error code); the actually effective callsign is subject to the response.Update Current User's Project Callsign (PUT /openapi/v2.0/manage/api/v1/projects/{uuid}/users/current), returns complete project role info.Current User Exits Organization (PUT /openapi/v2.0/manage/api/v1/organizations/{uuid}/users/current/operation).Update Current User Subscription Settings (POST /openapi/v2.0/manage/api/v1/organizations/{uuid}/users/current/subscription) controls subscription switch, subscription project scope, whether to auto-subscribe to newly joined projects, and receiving channel.Project Role and Permission Management
1.
Get Project Permission Tree Definition (GET /openapi/v2.0/manage/api/v1/organizations/{uuid}/permissions) returns the initialization project permission tree of the current organization (type only supports project).2.
Query Project Role List in Organization (GET /openapi/v2.0/manage/api/v1/organizations/{uuid}/roles) paginated query, including preset roles and custom roles.3.
Batch Create Project-level Custom Roles (POST /openapi/v2.0/manage/api/v1/organizations/{uuid}/roles).Update Custom Role (PUT /openapi/v2.0/manage/api/v1/organizations/{uuid}/roles/{role_id}), preset role permissions cannot be modified.Delete Organization Custom Role (DELETE /openapi/v2.0/manage/api/v1/organizations/{uuid}/roles/{role_id}), before deletion, verifies that the role belongs to this organization and has not been used by any user.4.
Query Role Permission Mapping (Role ID → Permission List) (GET /openapi/v2.0/manage/api/v1/organizations/{uuid}/roles/permissions); when role_id is not passed, returns all project roles in the current organization and the complete permission tree.Project Auto-recording Configuration
1.
Get Project Auto-recording Config (GET /openapi/v2.0/drc/api/v2/projects/{project_id}/auto_record/configs).2.
Configure Project Auto-recording Rules (POST /openapi/v2.0/drc/api/v2/projects/{project_id}/auto_record/configs). Request body fields:recording_items (required, array): List of recording rules. Each item { sn, camera_index | camera_sn }: sn is the drone SN; camera_index is the camera index (consistent with device thing model camera, format like 52-0-0); camera_sn is the camera SN, one of the two is required (backend IsValid() verification).auto_cleaning_time (effectively required, integer): Auto-cleanup duration of recording files, unit days, value range 7–90, missing or out-of-range will be rejected by the backend binding verification.disable_dock_recording / disable_drone_recording / disable_base_station_recording (boolean): Disable recording at the dock / drone / base station end respectively.Typical Scenario: Create a Project and Bring Users and Devices Under Management
A scenario consistent with the V0.9 On-Premises "Create Project / Add Device API Call Guide", adapted to the V2.0 paths.
Modified at 2026-06-15 14:33:55