RemoteGymp · API v1

خواندن داده‌ها

شرکت‌ها، دستگاه‌ها، موجودی و هشدارها را پیدا کنید، سپس نتایج را مرور کنید.

  1. آنچه را که نیاز دارید پیدا کنید

    با GET /v1/companies شروع کنید، سپس GET /v1/companies/{companyId}/sites و GET /v1/devices?companyId={companyId}. شناسه‌ها را از این پاسخ‌ها کپی کنید. GET /v1/devices/{deviceId} یک دستگاه مدیریت‌شده را می‌خواند؛ GET /v1/groups/{groupId}/devices اعضای گروه را فهرست می‌کند.

  2. نتایج را محدود کنید

    دستگاه‌ها را بر اساس companyId، siteId، وضعیت و نام فیلتر کنید. فیلترها فقط آنچه را که اعتبارنامه شما از قبل می‌تواند ببیند محدود می‌کنند. برای لیست‌های مبتنی بر مکان‌نما، مقدار next برگشتی را به عنوان after ارسال کنید، همان فیلترها را نگه دارید و وقتی next برابر با null شد، متوقف شوید. GET /v1/operations/capabilities آنچه را که اعتبارنامه شما می‌تواند ببیند نشان می‌دهد. انجام دهید.

  3. خواندن موجودی و هشدارها

    GET /v1/devices/{deviceId}/inventory و /نرم‌افزار گزارش‌های ذخیره شده را برمی‌گردانند: مهر زمانی آنها را بررسی کنید. تهی به معنای ناشناخته است؛ یک لیست جمع‌آوری‌شده خالی به معنای چیزی یافت نشده است. برای موجودی دقیق، از /v1/devices/{deviceId}/inventory/manifest شروع کنید و نام بخش‌ها و nextOffset را دنبال کنید. GET /v1/alerts به طور پیش‌فرض شامل هشدارهای باز و تأیید شده است؛ از state=all برای شامل کردن هشدارهای حل‌شده استفاده کنید.

مرجع API →

بازنگری محتوا 3f225a253 · OpenAPI SHA-256: b12c42306a89