Ця сторінка ще не перекладена українською. Показано англійську версію. Переглянути англійською

Команди адміністрування

Виконуйте масові операції з управління користувачами в облікових записах ACC/BIM 360. Ці команди забезпечують ефективне додавання, видалення та управління правами доступу у великих масштабах.

Примітка: Команди адміністрування потребують 3-legged OAuth з правами адміністратора облікового запису. Спочатку виконайте raps auth login.

Огляд команд

КомандаОпис
raps admin user addДодати користувача до кількох проєктів
raps admin user removeВидалити користувача з проєктів
raps admin user update-roleОновити роль користувача в проєктах
raps admin folder set-permissionsОновити права доступу до папок
raps admin project listПоказати список проєктів з фільтрацією
raps admin operation statusПереглянути прогрес операції
raps admin operation resumeВідновити перервану операцію
raps admin operation cancelСкасувати активну операцію
raps admin operation listПоказати список усіх операцій
raps admin user listПоказати список користувачів облікового запису або проєкту
raps admin user importІмпортувати користувачів до проєкту з CSV
raps admin project createСтворити новий проєкт
raps admin project updateОновити налаштування проєкту
raps admin project archiveАрхівувати проєкт
raps admin company-listПоказати список компаній облікового запису

Команди користувачів

raps admin user add

Додавання користувача до кількох проєктів із зазначеною роллю.

raps admin user add <ACCOUNT_ID> <EMAIL> --role <ROLE> [OPTIONS]

Аргументи:

  • ACCOUNT_ID - Ідентифікатор облікового запису ACC/BIM 360
  • EMAIL - Адреса електронної пошти користувача

Опції:

  • --role <ROLE> - Роль для призначення (обов’язково)
    • account_admin, project_admin, project_manager, viewer
  • --filter <REGEX> - Фільтрувати проєкти за шаблоном назви
  • --dry-run - Попередній перегляд змін без виконання
  • --output <FORMAT> - Формат виводу (json, table)

Приклад:

$ raps admin user add "acc-123" "user@company.com" --role project_admin
Adding user to projects...
[████████████████████████████████████████] 100/100

Results:
┌──────────────┬───────┐
│ Status       │ Count │
├──────────────┼───────┤
│ Succeeded    │ 95    │
│ Skipped      │ 3     │
│ Failed       │ 2     │
└──────────────┴───────┘

raps admin user remove

Видалення користувача з кількох проєктів.

raps admin user remove <ACCOUNT_ID> <EMAIL> [OPTIONS]

Аргументи:

  • ACCOUNT_ID - Ідентифікатор облікового запису ACC/BIM 360
  • EMAIL - Адреса електронної пошти користувача для видалення

Опції:

  • --filter <REGEX> - Фільтрувати проєкти за шаблоном назви
  • --dry-run - Попередній перегляд змін без виконання
  • --output <FORMAT> - Формат виводу

Приклад:

$ raps admin user remove "acc-123" "departed@company.com"
Removing user from projects...
[████████████████████████████████████████] 100/100

Results:
┌──────────────┬───────┐
│ Status       │ Count │
├──────────────┼───────┤
│ Succeeded    │ 45    │
│ Skipped      │ 55    │
└──────────────┴───────┘

raps admin user update-role

Оновлення ролі користувача в кількох проєктах.

raps admin user update-role <ACCOUNT_ID> <EMAIL> --role <ROLE> [OPTIONS]

Аргументи:

  • ACCOUNT_ID - Ідентифікатор облікового запису ACC/BIM 360
  • EMAIL - Адреса електронної пошти користувача

Опції:

  • --role <ROLE> - Нова роль для призначення (обов’язково)
  • --filter <REGEX> - Фільтрувати проєкти за шаблоном назви
  • --dry-run - Попередній перегляд змін без виконання
  • --output <FORMAT> - Формат виводу

Приклад:

$ raps admin user update-role "acc-123" "user@company.com" --role viewer
Updating user role...
[████████████████████████████████████████] 50/50

Results:
┌──────────────┬───────┐
│ Status       │ Count │
├──────────────┼───────┤
│ Succeeded    │ 48    │
│ Skipped      │ 2     │
└──────────────┴───────┘

raps admin user list

Показати список користувачів облікового запису або конкретного проєкту.

raps admin user list [OPTIONS]

Опції:

  • --account, -a - Ідентифікатор облікового запису (за замовчуванням: APS_ACCOUNT_ID)
  • --project, -p - Показати користувачів лише конкретного проєкту
  • --role - Фільтрувати за назвою ролі
  • --status - Фільтрувати за статусом (active, inactive, not_invited)
  • --search - Пошук за email або іменем

Приклад:

$ raps admin user list --account "acc-123" --status active

raps admin user import

Імпорт користувачів до проєкту з CSV-файлу.

raps admin user import --project <PROJECT_ID> --from-csv <FILE>

Опції:

  • --project, -p - Ідентифікатор проєкту для імпорту (обов’язково)
  • --from-csv - Шлях до CSV-файлу зі стовпцями: email, role_id

Приклад:

$ raps admin user import --project "proj-123" --from-csv users.csv

Команди папок

raps admin folder set-permissions

Оновлення прав доступу до папок для користувача в кількох проєктах.

raps admin folder set-permissions <ACCOUNT_ID> <EMAIL> --permission <LEVEL> --folder <TYPE> [OPTIONS]

Аргументи:

  • ACCOUNT_ID - Ідентифікатор облікового запису ACC/BIM 360
  • EMAIL - Адреса електронної пошти користувача

Опції:

  • --permission <LEVEL> - Рівень доступу (обов’язково)
    • view, view_download, upload, edit, control
  • --folder <TYPE> - Тип папки (обов’язково)
    • project_files, plans або URN папки для довільної папки
  • --filter <REGEX> - Фільтрувати проєкти за шаблоном назви
  • --dry-run - Попередній перегляд змін без виконання
  • --output <FORMAT> - Формат виводу

Приклад:

$ raps admin folder set-permissions "acc-123" "contractor@partner.com" \
    --permission edit --folder project_files
Updating folder permissions...
[████████████████████████████████████████] 75/75

Results:
┌──────────────┬───────┐
│ Status       │ Count │
├──────────────┼───────┤
│ Succeeded    │ 72    │
│ Failed       │ 3     │
└──────────────┴───────┘

Команди компаній (нове у v4.5)

raps admin company-list

Показати список компаній, зареєстрованих в обліковому записі.

raps admin company-list [OPTIONS]

Опції:

  • --account, -a - Ідентифікатор облікового запису (за замовчуванням: APS_ACCOUNT_ID)

Приклад:

$ raps admin company-list --account "acc-123"

Команди проєктів

raps admin project list

Показати список проєктів в обліковому записі з можливістю фільтрації.

raps admin project list <ACCOUNT_ID> [OPTIONS]

Аргументи:

  • ACCOUNT_ID - Ідентифікатор облікового запису ACC/BIM 360

Опції:

  • --filter <REGEX> - Фільтрувати за назвою проєкту
  • --status <STATUS> - Фільтрувати за статусом (active, archived, pending)
  • --platform <PLATFORM> - Фільтрувати за платформою (acc, bim360)
  • --limit <N> - Обмежити кількість результатів
  • --output <FORMAT> - Формат виводу

Приклад:

$ raps admin project list "acc-123" --status active --limit 5
Projects:
┌────────────────────────────────────────┬─────────────────────────┬─────────┬──────────┐
│ ID                                     │ Name                    │ Status  │ Platform │
├────────────────────────────────────────┼─────────────────────────┼─────────┼──────────┤
│ b.proj-001                             │ Downtown Tower          │ active  │ ACC      │
│ b.proj-002                             │ Hospital Wing           │ active  │ ACC      │
│ b.proj-003                             │ University Library      │ active  │ ACC      │
│ b.proj-004                             │ Retail Plaza            │ active  │ BIM360   │
│ b.proj-005                             │ Office Complex          │ active  │ ACC      │
└────────────────────────────────────────┴─────────────────────────┴─────────┴──────────┘

raps admin project create

Створення нового проєкту в обліковому записі.

raps admin project create [OPTIONS]

Опції:

  • --account, -a - Ідентифікатор облікового запису
  • --name, -n - Назва проєкту (обов’язково)
  • --type, -t - Тип проєкту
  • --classification - Класифікація проєкту (production, template, component, sample)
  • --start-date - Дата початку (ISO 8601)
  • --end-date - Дата закінчення (ISO 8601)
  • --timezone - Часовий пояс (наприклад, “America/New_York”)

Приклад:

$ raps admin project create --account "acc-123" --name "New Hospital Wing" --classification production

raps admin project update

Оновлення налаштувань проєкту.

raps admin project update [OPTIONS]

Опції:

  • --account, -a - Ідентифікатор облікового запису
  • --project, -p - Ідентифікатор проєкту (обов’язково)
  • --name, -n - Нова назва проєкту
  • --status - Новий статус (active, archived, suspended)
  • --start-date - Нова дата початку
  • --end-date - Нова дата закінчення

Приклад:

$ raps admin project update --account "acc-123" --project "proj-123" --status archived

raps admin project archive

Архівування проєкту (скорочення для зміни статусу на archived).

raps admin project archive --account <ACCOUNT_ID> --project <PROJECT_ID>

Приклад:

$ raps admin project archive --account "acc-123" --project "proj-123"

Команди операцій

raps admin operation status

Перегляд статусу та прогресу операції.

raps admin operation status [OPTIONS]

Опції:

  • --id <UUID> - Ідентифікатор конкретної операції (за замовчуванням: остання)
  • --output <FORMAT> - Формат виводу

Приклад:

$ raps admin operation status
Operation: 550e8400-e29b-41d4-a716-446655440000
Type: AddUser
Status: InProgress

Progress:
[████████████████████░░░░░░░░░░░░░░░░░░░░] 50/100

Results so far:
┌──────────────┬───────┐
│ Status       │ Count │
├──────────────┼───────┤
│ Succeeded    │ 45    │
│ Skipped      │ 3     │
│ Failed       │ 2     │
│ Pending      │ 50    │
└──────────────┴───────┘

raps admin operation resume

Відновлення перерваної операції.

raps admin operation resume [OPTIONS]

Опції:

  • --id <UUID> - Ідентифікатор операції для відновлення (за замовчуванням: остання активна)

Приклад:

$ raps admin operation resume
Resuming operation: 550e8400-e29b-41d4-a716-446655440000
Continuing from project 51 of 100...
[████████████████████████████████████████] 100/100

Operation completed successfully!

raps admin operation cancel

Скасування активної операції.

raps admin operation cancel [OPTIONS]

Опції:

  • --id <UUID> - Ідентифікатор операції для скасування (за замовчуванням: остання активна)

Приклад:

$ raps admin operation cancel
Cancelling operation: 550e8400-e29b-41d4-a716-446655440000
Operation cancelled. 50 projects were processed before cancellation.

raps admin operation list

Показати список усіх операцій з можливістю фільтрації.

raps admin operation list [OPTIONS]

Опції:

  • --status <STATUS> - Фільтрувати за статусом (pending, in_progress, completed, failed, cancelled)
  • --limit <N> - Обмежити кількість результатів
  • --output <FORMAT> - Формат виводу

Приклад:

$ raps admin operation list
Operations:
┌──────────────────────────────────────┬────────────┬─────────────┬───────┬─────────┬────────┐
│ ID                                   │ Type       │ Status      │ Total │ Success │ Failed │
├──────────────────────────────────────┼────────────┼─────────────┼───────┼─────────┼────────┤
│ 550e8400-e29b-41d4-a716-446655440000 │ AddUser    │ Completed   │ 100   │ 95      │ 2      │
│ 661f9511-f3ac-52e5-b827-557766551111 │ RemoveUser │ InProgress  │ 50    │ 25      │ 0      │
│ 772a0622-a4bd-63f6-c938-668877662222 │ UpdateRole │ Cancelled   │ 75    │ 30      │ 1      │
└──────────────────────────────────────┴────────────┴─────────────┴───────┴─────────┴────────┘

Типові робочі процеси

Додавання нового члена команди

# 1. Попередній перегляд проєктів, на які вплине операція
raps admin user add "$ACCOUNT_ID" "new@company.com" \
  --role project_admin --dry-run

# 2. Додати користувача до всіх проєктів
raps admin user add "$ACCOUNT_ID" "new@company.com" \
  --role project_admin

# 3. Надати права доступу до папок
raps admin folder set-permissions "$ACCOUNT_ID" "new@company.com" \
  --permission edit --folder project_files

Видалення працівника, що звільняється

# 1. Видалити з усіх проєктів
raps admin user remove "$ACCOUNT_ID" "departed@company.com"

# 2. Перевірити видалення
raps admin operation status

Масове оновлення ролей

# Оновити роль до project_admin для активних проєктів 2024 року
raps admin user update-role "$ACCOUNT_ID" "user@company.com" \
  --role project_admin --filter "^2024-"

Коди завершення

КодОпис
0Усі операції виконано успішно
1Частковий успіх (деякі елементи не вдалися)
2Не вдалося запустити операцію
3Користувач скасував операцію

Наступні кроки