{ "title": "Faro API Catalog", "total": 675, "method_counts": { "GET": 293, "POST": 281, "PUT": 12, "PATCH": 36, "DELETE": 53 }, "endpoints": [ { "method": "POST", "path": "/api/v1/auth/avatar/", "summary": "POST upload_avatar_api", "description": "", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "UploadAvatarApiView", "curl": "curl -X POST \"https://example.com/api/v1/auth/avatar/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/auth/csrf/", "summary": "کوکی CSRF را ست می‌کند. فرانت (Nuxt) قبل از هر درخواست mutating باید این", "description": "کوکی CSRF را ست می‌کند. فرانت (Nuxt) قبل از هر درخواست mutating باید این\n endpoint را صدا بزند تا کوکی csrftoken را داشته باشد و در هدر X-CSRFToken بفرستد.", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "عمومی (بدون نیاز به لاگین)", "source": "Live Route", "view_name": "CsrfCookieApiView", "curl": "curl -X GET \"https://example.com/api/v1/auth/csrf/\" \\\n -H \"Accept: application/json\"" }, { "method": "GET", "path": "/api/v1/auth/devices/", "summary": "GET user_devices_api", "description": "", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "UserDeviceListApiView", "curl": "curl -X GET \"https://example.com/api/v1/auth/devices/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "DELETE", "path": "/api/v1/auth/devices/{device_id}/", "summary": "DELETE user_device_revoke_api", "description": "", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "UserDeviceRevokeApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/auth/devices/{device_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/auth/logout/", "summary": "POST logout_api", "description": "", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "LogoutApiView", "curl": "curl -X POST \"https://example.com/api/v1/auth/logout/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/auth/mobile/logout/", "summary": "POST mobile_logout_api", "description": "", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "MobileLogoutApiView", "curl": "curl -X POST \"https://example.com/api/v1/auth/mobile/logout/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/auth/mobile/refresh/", "summary": "POST mobile_refresh_api", "description": "", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "MobileRefreshApiView", "curl": "curl -X POST \"https://example.com/api/v1/auth/mobile/refresh/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/auth/mobile/verify-otp/", "summary": "POST mobile_verify_otp_api", "description": "", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "عمومی (بدون نیاز به لاگین)", "source": "Live Route", "view_name": "MobileVerifyOtpApiView", "curl": "curl -X POST \"https://example.com/api/v1/auth/mobile/verify-otp/\" \\\n -H \"Accept: application/json\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/auth/profile/", "summary": "GET update_profile_api", "description": "", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "UpdateProfileApiView", "curl": "curl -X GET \"https://example.com/api/v1/auth/profile/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/auth/profile/", "summary": "POST update_profile_api", "description": "", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "UpdateProfileApiView", "curl": "curl -X POST \"https://example.com/api/v1/auth/profile/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/v1/auth/profile/", "summary": "PATCH update_profile_api", "description": "", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "UpdateProfileApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/auth/profile/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/auth/request-otp/", "summary": "POST request_otp_api", "description": "", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "عمومی (بدون نیاز به لاگین)", "source": "Live Route", "view_name": "RequestOtpApiView", "curl": "curl -X POST \"https://example.com/api/v1/auth/request-otp/\" \\\n -H \"Accept: application/json\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/auth/sso/exchange/", "summary": "تبادل توکن موقت SSO و ورود کاربر (پشتیبانی از وب Session و موبایل Bearer).", "description": "تبادل توکن موقت SSO و ورود کاربر (پشتیبانی از وب Session و موبایل Bearer).", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "SsoExchangeApiView", "curl": "curl -X POST \"https://example.com/api/v1/auth/sso/exchange/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/auth/sso/sync/", "summary": "روت همگام‌سازی و اتصال کاربران به سامانه SSO.", "description": "روت همگام‌سازی و اتصال کاربران به سامانه SSO.\n\n پشتیبانی از:\n - همگام‌سازی کاربر جاری (در صورت لاگین بودن بدون ارسال پارامتر)\n - همگام‌سازی کاربر خاص با user_id یا username یا phone\n - همگام‌سازی گروهی کاربران با user_ids\n - همگام‌سازی دسته‌ای تمام کاربران با all=True\n - فیلتر unsynced_only (پیش‌فرض True در حالت all)\n - گزینه force=True جهت همگام‌سازی مجدد کاربرانی که از قبل sso_id دارند\n - گزینه direct_fallback=True جهت ایجاد شناسه جایگزین در صورت قطعی اینترنت سرور SSO\n - احراز هویت: کاربر لاگین‌شده / ادمین و Staff / کلید امنیتی Bearer Token یا هدر X-Admin-Secret", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "SsoSyncUsersApiView", "curl": "curl -X GET \"https://example.com/api/v1/auth/sso/sync/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/auth/sso/sync/", "summary": "روت همگام‌سازی و اتصال کاربران به سامانه SSO.", "description": "روت همگام‌سازی و اتصال کاربران به سامانه SSO.\n\n پشتیبانی از:\n - همگام‌سازی کاربر جاری (در صورت لاگین بودن بدون ارسال پارامتر)\n - همگام‌سازی کاربر خاص با user_id یا username یا phone\n - همگام‌سازی گروهی کاربران با user_ids\n - همگام‌سازی دسته‌ای تمام کاربران با all=True\n - فیلتر unsynced_only (پیش‌فرض True در حالت all)\n - گزینه force=True جهت همگام‌سازی مجدد کاربرانی که از قبل sso_id دارند\n - گزینه direct_fallback=True جهت ایجاد شناسه جایگزین در صورت قطعی اینترنت سرور SSO\n - احراز هویت: کاربر لاگین‌شده / ادمین و Staff / کلید امنیتی Bearer Token یا هدر X-Admin-Secret", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "SsoSyncUsersApiView", "curl": "curl -X POST \"https://example.com/api/v1/auth/sso/sync/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/auth/verify-otp/", "summary": "POST verify_otp_api", "description": "", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "عمومی (بدون نیاز به لاگین)", "source": "Live Route", "view_name": "VerifyOtpApiView", "curl": "curl -X POST \"https://example.com/api/v1/auth/verify-otp/\" \\\n -H \"Accept: application/json\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/users/", "summary": "GET user_directory_api", "description": "", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "UserDirectoryApiView", "curl": "curl -X GET \"https://example.com/api/v1/users/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/users/lookup/", "summary": "GET user_lookup_api", "description": "", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "UserLookupApiView", "curl": "curl -X GET \"https://example.com/api/v1/users/lookup/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/users/sso-sync/", "summary": "روت همگام‌سازی و اتصال کاربران به سامانه SSO.", "description": "روت همگام‌سازی و اتصال کاربران به سامانه SSO.\n\n پشتیبانی از:\n - همگام‌سازی کاربر جاری (در صورت لاگین بودن بدون ارسال پارامتر)\n - همگام‌سازی کاربر خاص با user_id یا username یا phone\n - همگام‌سازی گروهی کاربران با user_ids\n - همگام‌سازی دسته‌ای تمام کاربران با all=True\n - فیلتر unsynced_only (پیش‌فرض True در حالت all)\n - گزینه force=True جهت همگام‌سازی مجدد کاربرانی که از قبل sso_id دارند\n - گزینه direct_fallback=True جهت ایجاد شناسه جایگزین در صورت قطعی اینترنت سرور SSO\n - احراز هویت: کاربر لاگین‌شده / ادمین و Staff / کلید امنیتی Bearer Token یا هدر X-Admin-Secret", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "SsoSyncUsersApiView", "curl": "curl -X GET \"https://example.com/api/v1/users/sso-sync/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/users/sso-sync/", "summary": "روت همگام‌سازی و اتصال کاربران به سامانه SSO.", "description": "روت همگام‌سازی و اتصال کاربران به سامانه SSO.\n\n پشتیبانی از:\n - همگام‌سازی کاربر جاری (در صورت لاگین بودن بدون ارسال پارامتر)\n - همگام‌سازی کاربر خاص با user_id یا username یا phone\n - همگام‌سازی گروهی کاربران با user_ids\n - همگام‌سازی دسته‌ای تمام کاربران با all=True\n - فیلتر unsynced_only (پیش‌فرض True در حالت all)\n - گزینه force=True جهت همگام‌سازی مجدد کاربرانی که از قبل sso_id دارند\n - گزینه direct_fallback=True جهت ایجاد شناسه جایگزین در صورت قطعی اینترنت سرور SSO\n - احراز هویت: کاربر لاگین‌شده / ادمین و Staff / کلید امنیتی Bearer Token یا هدر X-Admin-Secret", "tag": "accounts", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "SsoSyncUsersApiView", "curl": "curl -X POST \"https://example.com/api/v1/users/sso-sync/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/usage/", "summary": "GET ai_usage_list_api", "description": "", "tag": "ai_usage", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AiUsageListApiView", "curl": "curl -X GET \"https://example.com/api/v1/usage/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/usage/stats/", "summary": "GET ai_usage_stats_api", "description": "", "tag": "ai_usage", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AiUsageStatsApiView", "curl": "curl -X GET \"https://example.com/api/v1/usage/stats/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/usage/{log_id}/", "summary": "GET ai_usage_detail_api", "description": "", "tag": "ai_usage", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AiUsageDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/usage/{log_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/b2b-share/", "summary": "GET b2b_share_access_create_api", "description": "", "tag": "b2b", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "b2b_share_access_create_api", "curl": "curl -X GET \"https://example.com/api/v1/b2b-share/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/b2b-share/", "summary": "POST b2b_share_access_create_api", "description": "", "tag": "b2b", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "b2b_share_access_create_api", "curl": "curl -X POST \"https://example.com/api/v1/b2b-share/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/b2b-share/list/", "summary": "اشتراک‌های ساخته‌شده توسط کاربر جاری را برمی‌گرداند.", "description": "اشتراک‌های ساخته‌شده توسط کاربر جاری را برمی‌گرداند.", "tag": "b2b", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "b2b_share_access_list_api", "curl": "curl -X GET \"https://example.com/api/v1/b2b-share/list/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/b2b-share/list/", "summary": "اشتراک‌های ساخته‌شده توسط کاربر جاری را برمی‌گرداند.", "description": "اشتراک‌های ساخته‌شده توسط کاربر جاری را برمی‌گرداند.", "tag": "b2b", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "b2b_share_access_list_api", "curl": "curl -X POST \"https://example.com/api/v1/b2b-share/list/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/b2b-share/{access_id}/", "summary": "GET b2b_share_access_detail_api", "description": "", "tag": "b2b", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "b2b_share_access_detail_api", "curl": "curl -X GET \"https://example.com/api/v1/b2b-share/{access_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/b2b-share/{access_id}/", "summary": "POST b2b_share_access_detail_api", "description": "", "tag": "b2b", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "b2b_share_access_detail_api", "curl": "curl -X POST \"https://example.com/api/v1/b2b-share/{access_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/billing/plans/", "summary": "GET billing_plan_list_api", "description": "", "tag": "billing", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BillingPlanListApiView", "curl": "curl -X GET \"https://example.com/api/v1/billing/plans/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/billing/enterprise-request/", "summary": "ثبت درخواست پلن سازمانی داخل سایت.", "description": "ثبت درخواست پلن سازمانی داخل سایت.", "tag": "billing", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "EnterprisePlanRequestApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/billing/enterprise-request/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/billing/invoices/", "summary": "GET billing_invoice_list_api", "description": "", "tag": "billing", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BillingInvoiceListApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/billing/invoices/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/billing/my-plan/", "summary": "پلن و مصرف یک Business مشخص — هر کسب‌وکار مستقل است.", "description": "پلن و مصرف یک Business مشخص — هر کسب‌وکار مستقل است.", "tag": "billing", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessPlanApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/billing/my-plan/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/billing/subscribe/", "summary": "تغییر پلن یک Business مشخص.", "description": "تغییر پلن یک Business مشخص.", "tag": "billing", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessSubscribeApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/billing/subscribe/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/billing/subscription/", "summary": "GET billing_subscription_api", "description": "", "tag": "billing", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BillingSubscriptionApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/billing/subscription/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/billing/usage/", "summary": "GET billing_usage_api", "description": "", "tag": "billing", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BillingUsageApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/billing/usage/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/me/token-usage/", "summary": "ویجت مصرفِ هدر — مصرفِ کسب‌وکار انتخاب‌شدهٔ کاربر را نشان می‌دهد.", "description": "ویجت مصرفِ هدر — مصرفِ کسب‌وکار انتخاب‌شدهٔ کاربر را نشان می‌دهد.", "tag": "billing", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "MyTokenUsageApiView", "curl": "curl -X GET \"https://example.com/api/v1/me/token-usage/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/businesses/", "summary": "GET business_list_create_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/", "summary": "POST business_list_create_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/invites/", "summary": "GET business_my_invites_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessMyInvitesApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/invites/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/", "summary": "GET business_detail_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PATCH", "path": "/api/v1/businesses/{project_id}/", "summary": "PATCH business_detail_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/businesses/{project_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{project_id}/", "summary": "DELETE business_detail_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{project_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/activate/", "summary": "POST business_activate_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessActivateApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/activate/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/avatar/", "summary": "POST business_avatar_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessAvatarApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/avatar/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{project_id}/avatar/", "summary": "DELETE business_avatar_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessAvatarApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{project_id}/avatar/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/delete/", "summary": "حذف فضای کاری با متد POST (جهت سازگاری با کلاینت‌هایی که بدنه در DELETE ارسال نمی‌کنند).", "description": "حذف فضای کاری با متد POST (جهت سازگاری با کلاینت‌هایی که بدنه در DELETE ارسال نمی‌کنند).", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessDeleteApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/delete/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/delete/", "summary": "حذف فضای کاری با متد POST (جهت سازگاری با کلاینت‌هایی که بدنه در DELETE ارسال نمی‌کنند).", "description": "حذف فضای کاری با متد POST (جهت سازگاری با کلاینت‌هایی که بدنه در DELETE ارسال نمی‌کنند).", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessDeleteApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/delete/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/v1/businesses/{project_id}/delete/", "summary": "حذف فضای کاری با متد POST (جهت سازگاری با کلاینت‌هایی که بدنه در DELETE ارسال نمی‌کنند).", "description": "حذف فضای کاری با متد POST (جهت سازگاری با کلاینت‌هایی که بدنه در DELETE ارسال نمی‌کنند).", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessDeleteApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/businesses/{project_id}/delete/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{project_id}/delete/", "summary": "حذف فضای کاری با متد POST (جهت سازگاری با کلاینت‌هایی که بدنه در DELETE ارسال نمی‌کنند).", "description": "حذف فضای کاری با متد POST (جهت سازگاری با کلاینت‌هایی که بدنه در DELETE ارسال نمی‌کنند).", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessDeleteApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{project_id}/delete/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/delete/request-otp/", "summary": "ارسال کد OTP به مالک فضای کاری جهت تأیید حذف.", "description": "ارسال کد OTP به مالک فضای کاری جهت تأیید حذف.", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "عمومی (بدون نیاز به لاگین)", "source": "Live Route", "view_name": "BusinessDeleteRequestOtpApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/delete/request-otp/\" \\\n -H \"Accept: application/json\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/heartbeat/", "summary": "POST business_heartbeat_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessHeartbeatApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/heartbeat/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/invite/accept/", "summary": "POST business_invite_accept_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessInviteAcceptApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/invite/accept/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/invite/decline/", "summary": "POST business_invite_decline_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessInviteDeclineApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/invite/decline/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/members/", "summary": "GET business_members_add_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessMembersAddApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/members/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/members/", "summary": "POST business_members_add_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessMembersAddApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/members/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{project_id}/members/{user_id}/", "summary": "DELETE business_member_delete_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessMemberDeleteApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{project_id}/members/{user_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "PATCH", "path": "/api/v1/businesses/{project_id}/members/{user_id}/status/", "summary": "PATCH business_member_status_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessMemberStatusApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/businesses/{project_id}/members/{user_id}/status/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/pin/", "summary": "POST business_pin_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessPinApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/pin/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/projects/", "summary": "GET project_list_create_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/projects/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/projects/", "summary": "POST project_list_create_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/projects/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/projects/{project_id}/", "summary": "GET project_detail_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/projects/{project_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PATCH", "path": "/api/v1/projects/{project_id}/", "summary": "PATCH project_detail_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/projects/{project_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/projects/{project_id}/", "summary": "DELETE project_detail_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/projects/{project_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/projects/{project_id}/avatar/", "summary": "POST project_avatar_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessAvatarApiView", "curl": "curl -X POST \"https://example.com/api/v1/projects/{project_id}/avatar/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/projects/{project_id}/avatar/", "summary": "DELETE project_avatar_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessAvatarApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/projects/{project_id}/avatar/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/projects/{project_id}/delete/", "summary": "حذف فضای کاری با متد POST (جهت سازگاری با کلاینت‌هایی که بدنه در DELETE ارسال نمی‌کنند).", "description": "حذف فضای کاری با متد POST (جهت سازگاری با کلاینت‌هایی که بدنه در DELETE ارسال نمی‌کنند).", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessDeleteApiView", "curl": "curl -X GET \"https://example.com/api/v1/projects/{project_id}/delete/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/projects/{project_id}/delete/", "summary": "حذف فضای کاری با متد POST (جهت سازگاری با کلاینت‌هایی که بدنه در DELETE ارسال نمی‌کنند).", "description": "حذف فضای کاری با متد POST (جهت سازگاری با کلاینت‌هایی که بدنه در DELETE ارسال نمی‌کنند).", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessDeleteApiView", "curl": "curl -X POST \"https://example.com/api/v1/projects/{project_id}/delete/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/v1/projects/{project_id}/delete/", "summary": "حذف فضای کاری با متد POST (جهت سازگاری با کلاینت‌هایی که بدنه در DELETE ارسال نمی‌کنند).", "description": "حذف فضای کاری با متد POST (جهت سازگاری با کلاینت‌هایی که بدنه در DELETE ارسال نمی‌کنند).", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessDeleteApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/projects/{project_id}/delete/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/projects/{project_id}/delete/", "summary": "حذف فضای کاری با متد POST (جهت سازگاری با کلاینت‌هایی که بدنه در DELETE ارسال نمی‌کنند).", "description": "حذف فضای کاری با متد POST (جهت سازگاری با کلاینت‌هایی که بدنه در DELETE ارسال نمی‌کنند).", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessDeleteApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/projects/{project_id}/delete/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/projects/{project_id}/delete/request-otp/", "summary": "ارسال کد OTP به مالک فضای کاری جهت تأیید حذف.", "description": "ارسال کد OTP به مالک فضای کاری جهت تأیید حذف.", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "عمومی (بدون نیاز به لاگین)", "source": "Live Route", "view_name": "BusinessDeleteRequestOtpApiView", "curl": "curl -X POST \"https://example.com/api/v1/projects/{project_id}/delete/request-otp/\" \\\n -H \"Accept: application/json\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/projects/{project_id}/members/", "summary": "GET project_members_add_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessMembersAddApiView", "curl": "curl -X GET \"https://example.com/api/v1/projects/{project_id}/members/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/projects/{project_id}/members/", "summary": "POST project_members_add_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessMembersAddApiView", "curl": "curl -X POST \"https://example.com/api/v1/projects/{project_id}/members/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/projects/{project_id}/members/{user_id}/", "summary": "DELETE project_member_delete_api", "description": "", "tag": "businesses", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessMemberDeleteApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/projects/{project_id}/members/{user_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/chat/", "summary": "POST chat_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChatApiView", "curl": "curl -X POST \"https://example.com/api/chat/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/conversations/", "summary": "GET conversation_list_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationListApiView", "curl": "curl -X GET \"https://example.com/api/conversations/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/conversations/new/", "summary": "POST conversation_create_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationCreateApiView", "curl": "curl -X POST \"https://example.com/api/conversations/new/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/conversations/{conversation_id}/", "summary": "GET conversation_detail_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationDetailApiView", "curl": "curl -X GET \"https://example.com/api/conversations/{conversation_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PATCH", "path": "/api/conversations/{conversation_id}/", "summary": "PATCH conversation_detail_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/conversations/{conversation_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/conversations/{conversation_id}/", "summary": "DELETE conversation_detail_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/conversations/{conversation_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/conversations/{conversation_id}/agent/apply-task/", "summary": "اعمال یک پیشنهاد ایجاد وظیفه (faro:task) در بورد پروژهٔ این گفتگو.", "description": "اعمال یک پیشنهاد ایجاد وظیفه (faro:task) در بورد پروژهٔ این گفتگو.", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationTaskApplyApiView", "curl": "curl -X POST \"https://example.com/api/conversations/{conversation_id}/agent/apply-task/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/conversations/{conversation_id}/archive/", "summary": "POST conversation_archive_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationArchiveApiView", "curl": "curl -X POST \"https://example.com/api/conversations/{conversation_id}/archive/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/conversations/{conversation_id}/export/", "summary": "GET conversation_export_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationExportApiView", "curl": "curl -X GET \"https://example.com/api/conversations/{conversation_id}/export/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PATCH", "path": "/api/conversations/{conversation_id}/model/", "summary": "PATCH — مدل انتخابی و تنظیمات (خلاقیت، طول پاسخ، حالت) کاربر را روی مکالمه ذخیره می‌کند.", "description": "PATCH — مدل انتخابی و تنظیمات (خلاقیت، طول پاسخ، حالت) کاربر را روی مکالمه ذخیره می‌کند.", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationModelApiView", "curl": "curl -X PATCH \"https://example.com/api/conversations/{conversation_id}/model/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/conversations/{conversation_id}/participants/", "summary": "GET conv_participant_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConvParticipantApiView", "curl": "curl -X GET \"https://example.com/api/conversations/{conversation_id}/participants/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/conversations/{conversation_id}/participants/", "summary": "POST conv_participant_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConvParticipantApiView", "curl": "curl -X POST \"https://example.com/api/conversations/{conversation_id}/participants/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/conversations/{conversation_id}/pin/", "summary": "POST conversation_pin_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationPinApiView", "curl": "curl -X POST \"https://example.com/api/conversations/{conversation_id}/pin/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/conversations/{conversation_id}/star/", "summary": "POST conversation_star_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationStarApiView", "curl": "curl -X POST \"https://example.com/api/conversations/{conversation_id}/star/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/conversations/{conversation_id}/watch/", "summary": "SSE — پیام‌های جدید مکالمه را real-time به کاربر push می‌کند.", "description": "SSE — پیام‌های جدید مکالمه را real-time به کاربر push می‌کند.\n\n کاربر با ?after_id= آخرین پیامی که دارد را مشخص می‌کند.\n سرور هر 500ms DB را چک می‌کند؛ به محض وجود پیام جدید فوری ارسال می‌کند\n و connection را می‌بندد تا کلاینت بلافاصله دوباره connect کند.\n این الگو (reconnect loop) latency را به ~500ms می‌رساند بدون نیاز به Redis.", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationWatchApiView", "curl": "curl -X GET \"https://example.com/api/conversations/{conversation_id}/watch/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/conversations/{conversation_id}/workspace/", "summary": "تنظیم یا پاک‌کردن پوشهٔ کاری متصل به یک گفتگو.", "description": "تنظیم یا پاک‌کردن پوشهٔ کاری متصل به یک گفتگو.", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationWorkspaceApiView", "curl": "curl -X GET \"https://example.com/api/conversations/{conversation_id}/workspace/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/conversations/{conversation_id}/workspace/", "summary": "تنظیم یا پاک‌کردن پوشهٔ کاری متصل به یک گفتگو.", "description": "تنظیم یا پاک‌کردن پوشهٔ کاری متصل به یک گفتگو.", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationWorkspaceApiView", "curl": "curl -X POST \"https://example.com/api/conversations/{conversation_id}/workspace/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/conversations/{conversation_id}/workspace/apply/", "summary": "اعمال یک پیشنهاد نوشتن (ساخت/ویرایش فایل) در پوشهٔ کاری گفتگو.", "description": "اعمال یک پیشنهاد نوشتن (ساخت/ویرایش فایل) در پوشهٔ کاری گفتگو.", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WorkspaceApplyApiView", "curl": "curl -X POST \"https://example.com/api/conversations/{conversation_id}/workspace/apply/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/guest-chat/", "summary": "چت رایگان و محدود برای کاربر مهمان روی صفحهٔ معرفی.", "description": "چت رایگان و محدود برای کاربر مهمان روی صفحهٔ معرفی.\n\n بدون دیتابیس و بدون Conversation کار می‌کند؛ شمارش پیام‌ها و تاریخچهٔ\n کوتاه در session نگه داشته می‌شود. پس از رسیدن به سقف، پاسخ ۴۰۲ با\n پرچم paywall برمی‌گردد تا فرانت مودال اشتراک را باز کند.", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "GuestChatApiView", "curl": "curl -X POST \"https://example.com/api/guest-chat/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/messages/{message_id}/reactions/", "summary": "POST message_reaction_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "MessageReactionApiView", "curl": "curl -X POST \"https://example.com/api/messages/{message_id}/reactions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/messages/{message_id}/save/", "summary": "POST saved_message_toggle_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "SavedMessageToggleApiView", "curl": "curl -X POST \"https://example.com/api/messages/{message_id}/save/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/models/", "summary": "GET — لیست مدل‌های قابل انتخاب توسط کاربر را برمی‌گرداند.", "description": "GET — لیست مدل‌های قابل انتخاب توسط کاربر را برمی‌گرداند.", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AvailableModelsApiView", "curl": "curl -X GET \"https://example.com/api/models/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/saved-messages/", "summary": "GET saved_messages_list_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "SavedMessagesListApiView", "curl": "curl -X GET \"https://example.com/api/saved-messages/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/chat/", "summary": "POST chat_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChatApiView", "curl": "curl -X POST \"https://example.com/api/v1/chat/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/conversations/", "summary": "GET conversation_list_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationListApiView", "curl": "curl -X GET \"https://example.com/api/v1/conversations/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/conversations/new/", "summary": "POST conversation_create_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/conversations/new/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/conversations/{conversation_id}/", "summary": "GET conversation_detail_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/conversations/{conversation_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PATCH", "path": "/api/v1/conversations/{conversation_id}/", "summary": "PATCH conversation_detail_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/conversations/{conversation_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/conversations/{conversation_id}/", "summary": "DELETE conversation_detail_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/conversations/{conversation_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/conversations/{conversation_id}/agent/apply-task/", "summary": "اعمال یک پیشنهاد ایجاد وظیفه (faro:task) در بورد پروژهٔ این گفتگو.", "description": "اعمال یک پیشنهاد ایجاد وظیفه (faro:task) در بورد پروژهٔ این گفتگو.", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationTaskApplyApiView", "curl": "curl -X POST \"https://example.com/api/v1/conversations/{conversation_id}/agent/apply-task/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/conversations/{conversation_id}/archive/", "summary": "POST conversation_archive_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationArchiveApiView", "curl": "curl -X POST \"https://example.com/api/v1/conversations/{conversation_id}/archive/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/conversations/{conversation_id}/export/", "summary": "GET conversation_export_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationExportApiView", "curl": "curl -X GET \"https://example.com/api/v1/conversations/{conversation_id}/export/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PATCH", "path": "/api/v1/conversations/{conversation_id}/model/", "summary": "PATCH — مدل انتخابی و تنظیمات (خلاقیت، طول پاسخ، حالت) کاربر را روی مکالمه ذخیره می‌کند.", "description": "PATCH — مدل انتخابی و تنظیمات (خلاقیت، طول پاسخ، حالت) کاربر را روی مکالمه ذخیره می‌کند.", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationModelApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/conversations/{conversation_id}/model/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/conversations/{conversation_id}/participants/", "summary": "GET conv_participant_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConvParticipantApiView", "curl": "curl -X GET \"https://example.com/api/v1/conversations/{conversation_id}/participants/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/conversations/{conversation_id}/participants/", "summary": "POST conv_participant_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConvParticipantApiView", "curl": "curl -X POST \"https://example.com/api/v1/conversations/{conversation_id}/participants/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/conversations/{conversation_id}/pin/", "summary": "POST conversation_pin_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationPinApiView", "curl": "curl -X POST \"https://example.com/api/v1/conversations/{conversation_id}/pin/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/conversations/{conversation_id}/star/", "summary": "POST conversation_star_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationStarApiView", "curl": "curl -X POST \"https://example.com/api/v1/conversations/{conversation_id}/star/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/conversations/{conversation_id}/watch/", "summary": "SSE — پیام‌های جدید مکالمه را real-time به کاربر push می‌کند.", "description": "SSE — پیام‌های جدید مکالمه را real-time به کاربر push می‌کند.\n\n کاربر با ?after_id= آخرین پیامی که دارد را مشخص می‌کند.\n سرور هر 500ms DB را چک می‌کند؛ به محض وجود پیام جدید فوری ارسال می‌کند\n و connection را می‌بندد تا کلاینت بلافاصله دوباره connect کند.\n این الگو (reconnect loop) latency را به ~500ms می‌رساند بدون نیاز به Redis.", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationWatchApiView", "curl": "curl -X GET \"https://example.com/api/v1/conversations/{conversation_id}/watch/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/conversations/{conversation_id}/workspace/", "summary": "تنظیم یا پاک‌کردن پوشهٔ کاری متصل به یک گفتگو.", "description": "تنظیم یا پاک‌کردن پوشهٔ کاری متصل به یک گفتگو.", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationWorkspaceApiView", "curl": "curl -X GET \"https://example.com/api/v1/conversations/{conversation_id}/workspace/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/conversations/{conversation_id}/workspace/", "summary": "تنظیم یا پاک‌کردن پوشهٔ کاری متصل به یک گفتگو.", "description": "تنظیم یا پاک‌کردن پوشهٔ کاری متصل به یک گفتگو.", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ConversationWorkspaceApiView", "curl": "curl -X POST \"https://example.com/api/v1/conversations/{conversation_id}/workspace/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/conversations/{conversation_id}/workspace/apply/", "summary": "اعمال یک پیشنهاد نوشتن (ساخت/ویرایش فایل) در پوشهٔ کاری گفتگو.", "description": "اعمال یک پیشنهاد نوشتن (ساخت/ویرایش فایل) در پوشهٔ کاری گفتگو.", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WorkspaceApplyApiView", "curl": "curl -X POST \"https://example.com/api/v1/conversations/{conversation_id}/workspace/apply/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/guest-chat/", "summary": "چت رایگان و محدود برای کاربر مهمان روی صفحهٔ معرفی.", "description": "چت رایگان و محدود برای کاربر مهمان روی صفحهٔ معرفی.\n\n بدون دیتابیس و بدون Conversation کار می‌کند؛ شمارش پیام‌ها و تاریخچهٔ\n کوتاه در session نگه داشته می‌شود. پس از رسیدن به سقف، پاسخ ۴۰۲ با\n پرچم paywall برمی‌گردد تا فرانت مودال اشتراک را باز کند.", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "GuestChatApiView", "curl": "curl -X POST \"https://example.com/api/v1/guest-chat/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/messages/{message_id}/reactions/", "summary": "POST message_reaction_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "MessageReactionApiView", "curl": "curl -X POST \"https://example.com/api/v1/messages/{message_id}/reactions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/messages/{message_id}/save/", "summary": "POST saved_message_toggle_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "SavedMessageToggleApiView", "curl": "curl -X POST \"https://example.com/api/v1/messages/{message_id}/save/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/models/", "summary": "GET — لیست مدل‌های قابل انتخاب توسط کاربر را برمی‌گرداند.", "description": "GET — لیست مدل‌های قابل انتخاب توسط کاربر را برمی‌گرداند.", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AvailableModelsApiView", "curl": "curl -X GET \"https://example.com/api/v1/models/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/saved-messages/", "summary": "GET saved_messages_list_api", "description": "", "tag": "chat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "SavedMessagesListApiView", "curl": "curl -X GET \"https://example.com/api/v1/saved-messages/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/drive/clipboard/paste/", "summary": "انجام عملیات کپی یا کات (انتقال) فایل یا پوشه.", "description": "انجام عملیات کپی یا کات (انتقال) فایل یا پوشه.", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ClipboardPasteApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/drive/clipboard/paste/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/drive/contents/", "summary": "محتویات یک سطح از درایو کاربر و ساخت پوشهٔ جدید.", "description": "محتویات یک سطح از درایو کاربر و ساخت پوشهٔ جدید.", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FolderContentsApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/drive/contents/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/drive/contents/", "summary": "محتویات یک سطح از درایو کاربر و ساخت پوشهٔ جدید.", "description": "محتویات یک سطح از درایو کاربر و ساخت پوشهٔ جدید.", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FolderContentsApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/drive/contents/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/drive/files/create/", "summary": "ساخت یک فایل متنیِ خالی/با محتوا (قابل‌ویرایش).", "description": "ساخت یک فایل متنیِ خالی/با محتوا (قابل‌ویرایش).", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FileCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/drive/files/create/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/drive/files/{file_id}/", "summary": "حذف منطقی فایل.", "description": "حذف منطقی فایل.", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FileDeleteApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/drive/files/{file_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/drive/files/{file_id}/content/", "summary": "خواندن (GET) و ذخیرهٔ (PUT) محتوای متنیِ یک فایل.", "description": "خواندن (GET) و ذخیرهٔ (PUT) محتوای متنیِ یک فایل.", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FileContentApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/drive/files/{file_id}/content/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PUT", "path": "/api/v1/businesses/{business_id}/drive/files/{file_id}/content/", "summary": "خواندن (GET) و ذخیرهٔ (PUT) محتوای متنیِ یک فایل.", "description": "خواندن (GET) و ذخیرهٔ (PUT) محتوای متنیِ یک فایل.", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FileContentApiView", "curl": "curl -X PUT \"https://example.com/api/v1/businesses/{business_id}/drive/files/{file_id}/content/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/drive/files/{file_id}/share/", "summary": "مدیریت اشتراک‌گذاری یک فایل منفرد.", "description": "مدیریت اشتراک‌گذاری یک فایل منفرد.", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FileShareApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/drive/files/{file_id}/share/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/drive/files/{file_id}/share/", "summary": "مدیریت اشتراک‌گذاری یک فایل منفرد.", "description": "مدیریت اشتراک‌گذاری یک فایل منفرد.", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FileShareApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/drive/files/{file_id}/share/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{business_id}/drive/files/{file_id}/share/", "summary": "مدیریت اشتراک‌گذاری یک فایل منفرد.", "description": "مدیریت اشتراک‌گذاری یک فایل منفرد.", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FileShareApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{business_id}/drive/files/{file_id}/share/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/drive/folders/{folder_id}/", "summary": "حذف منطقی پوشه.", "description": "حذف منطقی پوشه.", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FolderDeleteApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/drive/folders/{folder_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/drive/folders/{folder_id}/pin/", "summary": "پین یا آن‌پین کردن یک پوشه برای کاربر فعلی (مخصوص نمای همان کاربر).", "description": "پین یا آن‌پین کردن یک پوشه برای کاربر فعلی (مخصوص نمای همان کاربر).", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FolderPinApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/drive/folders/{folder_id}/pin/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{business_id}/drive/folders/{folder_id}/pin/", "summary": "پین یا آن‌پین کردن یک پوشه برای کاربر فعلی (مخصوص نمای همان کاربر).", "description": "پین یا آن‌پین کردن یک پوشه برای کاربر فعلی (مخصوص نمای همان کاربر).", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FolderPinApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{business_id}/drive/folders/{folder_id}/pin/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/drive/folders/{folder_id}/share/", "summary": "مدیریت اشتراک‌گذاری یک پوشه: لیست، افزودن/به‌روزرسانی و حذف.", "description": "مدیریت اشتراک‌گذاری یک پوشه: لیست، افزودن/به‌روزرسانی و حذف.", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FolderShareApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/drive/folders/{folder_id}/share/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/drive/folders/{folder_id}/share/", "summary": "مدیریت اشتراک‌گذاری یک پوشه: لیست، افزودن/به‌روزرسانی و حذف.", "description": "مدیریت اشتراک‌گذاری یک پوشه: لیست، افزودن/به‌روزرسانی و حذف.", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FolderShareApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/drive/folders/{folder_id}/share/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{business_id}/drive/folders/{folder_id}/share/", "summary": "مدیریت اشتراک‌گذاری یک پوشه: لیست، افزودن/به‌روزرسانی و حذف.", "description": "مدیریت اشتراک‌گذاری یک پوشه: لیست، افزودن/به‌روزرسانی و حذف.", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FolderShareApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{business_id}/drive/folders/{folder_id}/share/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/drive/folders/{folder_id}/update/", "summary": "ویرایش نام، آیکون و رنگ پوشه.", "description": "ویرایش نام، آیکون و رنگ پوشه.", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FolderUpdateApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/drive/folders/{folder_id}/update/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/drive/members/", "summary": "جستجو/لیست اعضای فعال فضای کاری (به‌جز خود کاربر) برای انتخاب در اشتراک‌گذاری.", "description": "جستجو/لیست اعضای فعال فضای کاری (به‌جز خود کاربر) برای انتخاب در اشتراک‌گذاری.\n\n پارامتر اختیاری ``q`` روی نام، نام‌کاربری و شمارهٔ تلفن جستجو می‌کند.", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessMembersApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/drive/members/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/drive/upload/", "summary": "آپلود فایل در درایو.", "description": "آپلود فایل در درایو.", "tag": "drive", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FileUploadApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/drive/upload/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/attachments/upload/", "summary": "آپلود پیوستِ فاروچت.", "description": "آپلود پیوستِ فاروچت.\n\n فایل همیشه در پوشهٔ سیستمیِ «فاروچت» زیر فضای شخصی کاربر ذخیره می‌شود (نه در\n ریشهٔ درایو)، تا فایل‌های ارسالی از چت از فضای شخصی جدا و مرتب بمانند.", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AttachmentUploadApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/attachments/upload/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/farochat/blocks/", "summary": "GET farochat_block_list_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "UserBlockListApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/farochat/blocks/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/blocks/", "summary": "POST farochat_block_list_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "UserBlockListApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/blocks/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/blocks/unblock/", "summary": "POST farochat_unblock_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "UserUnblockApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/blocks/unblock/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/farochat/folders/", "summary": "GET farochat_folder_list_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FolderListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/farochat/folders/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/folders/", "summary": "POST farochat_folder_list_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FolderListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/folders/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/v1/businesses/{business_id}/farochat/folders/{folder_id}/", "summary": "PATCH farochat_folder_detail_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FolderDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/businesses/{business_id}/farochat/folders/{folder_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{business_id}/farochat/folders/{folder_id}/", "summary": "DELETE farochat_folder_detail_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FolderDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{business_id}/farochat/folders/{folder_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/folders/{folder_id}/rooms/", "summary": "POST farochat_folder_room_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FolderRoomApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/folders/{folder_id}/rooms/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{business_id}/farochat/folders/{folder_id}/rooms/", "summary": "DELETE farochat_folder_room_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FolderRoomApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{business_id}/farochat/folders/{folder_id}/rooms/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/farochat/rooms/", "summary": "GET farochat_room_list_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RoomListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/rooms/", "summary": "POST farochat_room_list_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RoomListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/", "summary": "GET farochat_room_detail_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RoomDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PATCH", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/", "summary": "PATCH farochat_room_detail_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RoomDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/", "summary": "DELETE farochat_room_detail_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RoomDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/archive/", "summary": "POST farochat_room_archive_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RoomArchiveApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/archive/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/draft/", "summary": "GET farochat_draft_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DraftApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/draft/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PUT", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/draft/", "summary": "PUT farochat_draft_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DraftApiView", "curl": "curl -X PUT \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/draft/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/invite-links/", "summary": "GET farochat_invite_link_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RoomInviteLinkApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/invite-links/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/invite-links/", "summary": "POST farochat_invite_link_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RoomInviteLinkApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/invite-links/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/invite-links/{link_id}/revoke/", "summary": "POST farochat_invite_link_revoke_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RoomInviteLinkRevokeApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/invite-links/{link_id}/revoke/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/join-requests/", "summary": "GET farochat_join_request_list_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RoomJoinRequestListApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/join-requests/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/join-requests/", "summary": "POST farochat_join_request_list_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RoomJoinRequestListApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/join-requests/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/join-requests/{request_id}/review/", "summary": "POST farochat_join_request_review_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RoomJoinRequestReviewApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/join-requests/{request_id}/review/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/members/", "summary": "GET farochat_member_list_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RoomMemberListApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/members/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/members/", "summary": "POST farochat_member_list_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RoomMemberListApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/members/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/members/{member_id}/", "summary": "PATCH farochat_member_detail_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RoomMemberDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/members/{member_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/members/{member_id}/", "summary": "DELETE farochat_member_detail_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RoomMemberDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/members/{member_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/mentions/mark-read/", "summary": "POST farochat_mention_mark_read_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "MentionMarkReadApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/mentions/mark-read/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/messages/", "summary": "GET farochat_message_list_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "MessageListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/messages/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/messages/", "summary": "POST farochat_message_list_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "MessageListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/messages/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/messages/{message_id}/", "summary": "PATCH farochat_message_detail_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "MessageDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/messages/{message_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/messages/{message_id}/", "summary": "DELETE farochat_message_detail_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "MessageDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/messages/{message_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/messages/{message_id}/attachments/{attachment_id}/download/", "summary": "دانلود پیوست پیام برای اعضای فعال همان اتاق.", "description": "دانلود پیوست پیام برای اعضای فعال همان اتاق.\n\n فایل فیزیکی همچنان در DriveFile ذخیره می‌شود، اما دسترسی این مسیر بر اساس\n membership اتاق فاروچت است تا فایل‌های ارسال‌شده در گروه برای اعضای مجاز قابل\n مشاهده/دانلود باشند.", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AttachmentDownloadApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/messages/{message_id}/attachments/{attachment_id}/download/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/messages/{message_id}/reactions/", "summary": "POST farochat_reaction_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ReactionApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/messages/{message_id}/reactions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/messages/{message_id}/reactions/", "summary": "DELETE farochat_reaction_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ReactionApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/messages/{message_id}/reactions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/pins/", "summary": "GET farochat_pin_list_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PinnedMessageListApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/pins/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/pins/", "summary": "POST farochat_pin_list_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PinnedMessageListApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/pins/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/pins/{pin_id}/", "summary": "DELETE farochat_pin_detail_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PinnedMessageDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/pins/{pin_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/polls/", "summary": "POST farochat_poll_create_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PollCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/polls/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/polls/{poll_id}/close/", "summary": "POST farochat_poll_close_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PollCloseApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/polls/{poll_id}/close/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/polls/{poll_id}/results/", "summary": "GET farochat_poll_results_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PollResultsApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/polls/{poll_id}/results/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/polls/{poll_id}/vote/", "summary": "POST farochat_poll_vote_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PollVoteApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/polls/{poll_id}/vote/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/polls/{poll_id}/vote/", "summary": "DELETE farochat_poll_vote_api", "description": "", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PollVoteApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/polls/{poll_id}/vote/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/read/", "summary": "آپدیت last_read_seq عضویت — برای شمارش unread طبق مقایسه با room.last_seq.", "description": "آپدیت last_read_seq عضویت — برای شمارش unread طبق مقایسه با room.last_seq.", "tag": "farochat", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ReadReceiptApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/farochat/rooms/{room_id}/read/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/feedback/", "summary": "POST feedback_create_api", "description": "", "tag": "feedback", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FeedbackCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/feedback/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/feedback/list/", "summary": "بازخوردهای ثبت‌شده توسط کاربر جاری.", "description": "بازخوردهای ثبت‌شده توسط کاربر جاری.", "tag": "feedback", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FeedbackListApiView", "curl": "curl -X GET \"https://example.com/api/v1/feedback/list/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/feedback/{feedback_id}/", "summary": "جزئیات یک بازخورد — فقط برای صاحب آن.", "description": "جزئیات یک بازخورد — فقط برای صاحب آن.", "tag": "feedback", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "FeedbackDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/feedback/{feedback_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/okr/", "summary": "The default basic root view for DefaultRouter", "description": "The default basic root view for DefaultRouter", "tag": "general", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "APIRootView", "curl": "curl -X GET \"https://example.com/api/okr/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/okr/{format}", "summary": "The default basic root view for DefaultRouter", "description": "The default basic root view for DefaultRouter", "tag": "general", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "APIRootView", "curl": "curl -X GET \"https://example.com/api/okr/{format}\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/okr/", "summary": "The default basic root view for DefaultRouter", "description": "The default basic root view for DefaultRouter", "tag": "general", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "APIRootView", "curl": "curl -X GET \"https://example.com/api/v1/okr/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/okr/{format}", "summary": "The default basic root view for DefaultRouter", "description": "The default basic root view for DefaultRouter", "tag": "general", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "APIRootView", "curl": "curl -X GET \"https://example.com/api/v1/okr/{format}\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/hesabro/connection/", "summary": "وضعیت اتصال یک کسب‌وکار به حسابرو.", "description": "وضعیت اتصال یک کسب‌وکار به حسابرو.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "HesabroConnectionApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/hesabro/connection/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/hesabro/wallet/balance/", "summary": "موجودی کیف پول کاربر جاری در حسابرو.", "description": "موجودی کیف پول کاربر جاری در حسابرو.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WalletBalanceApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/hesabro/wallet/balance/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/hesabro/wallet/charge/", "summary": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "description": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WalletChargeApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/hesabro/wallet/charge/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/hesabro/wallet/charge/", "summary": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "description": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WalletChargeApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/hesabro/wallet/charge/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/hesabro/wallet/charge/{charge_id}/factor/", "summary": "تلاش مجدد برای ثبت سند یک شارژِ پرداخت‌شده (در صورت خطای IPG).", "description": "تلاش مجدد برای ثبت سند یک شارژِ پرداخت‌شده (در صورت خطای IPG).", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WalletFactorRetryView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/hesabro/wallet/charge/{charge_id}/factor/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/hesabro/wallet/history/", "summary": "تاریخچهٔ تراکنش‌های کیف پولِ داخلیِ همین فضای کاری.", "description": "تاریخچهٔ تراکنش‌های کیف پولِ داخلیِ همین فضای کاری.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WalletHistoryApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/hesabro/wallet/history/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/wallet/balance/", "summary": "موجودی کیف پول کاربر جاری در حسابرو.", "description": "موجودی کیف پول کاربر جاری در حسابرو.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WalletBalanceApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/wallet/balance/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/wallet/charge/", "summary": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "description": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WalletChargeApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/wallet/charge/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/wallet/charge/", "summary": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "description": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WalletChargeApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/wallet/charge/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/wallet/charge/{charge_id}/factor/", "summary": "تلاش مجدد برای ثبت سند یک شارژِ پرداخت‌شده (در صورت خطای IPG).", "description": "تلاش مجدد برای ثبت سند یک شارژِ پرداخت‌شده (در صورت خطای IPG).", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WalletFactorRetryView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/wallet/charge/{charge_id}/factor/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/wallet/charges/", "summary": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "description": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WalletChargeApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/wallet/charges/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/wallet/charges/", "summary": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "description": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WalletChargeApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/wallet/charges/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/wallet/charges/{charge_id}/", "summary": "جزئیات یک درخواست شارژ و استعلام وضعیت پرداخت آن.", "description": "جزئیات یک درخواست شارژ و استعلام وضعیت پرداخت آن.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WalletChargeDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/wallet/charges/{charge_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/wallet/charges/{charge_id}/factor/", "summary": "تلاش مجدد برای ثبت سند یک شارژِ پرداخت‌شده (در صورت خطای IPG).", "description": "تلاش مجدد برای ثبت سند یک شارژِ پرداخت‌شده (در صورت خطای IPG).", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WalletFactorRetryView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/wallet/charges/{charge_id}/factor/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/wallet/connection/", "summary": "وضعیت اتصال یک کسب‌وکار به حسابرو.", "description": "وضعیت اتصال یک کسب‌وکار به حسابرو.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "HesabroConnectionApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/wallet/connection/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/wallet/history/", "summary": "تاریخچهٔ تراکنش‌های کیف پولِ داخلیِ همین فضای کاری.", "description": "تاریخچهٔ تراکنش‌های کیف پولِ داخلیِ همین فضای کاری.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WalletHistoryApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/wallet/history/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/wallet/transactions/", "summary": "تاریخچهٔ تراکنش‌های کیف پولِ داخلیِ همین فضای کاری.", "description": "تاریخچهٔ تراکنش‌های کیف پولِ داخلیِ همین فضای کاری.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WalletHistoryApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/wallet/transactions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/hesabro/wallet/callback/{charge_id}/", "summary": "callback عمومی پس از بازگشت کاربر از درگاه پرداخت حسابرو.", "description": "callback عمومی پس از بازگشت کاربر از درگاه پرداخت حسابرو.\n\n عمداً بدون احراز هویت است (مرورگر کاربر بدون session ممکن است برگردد) و\n شارژ را با ``charge_id`` در URL پیدا می‌کند. هم GET (redirect مرورگر) و هم\n POST (نوتیفیکیشن سرور-به-سرور) را می‌پذیرد.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "عمومی (بدون نیاز به لاگین)", "source": "Live Route", "view_name": "WalletCallbackView", "curl": "curl -X GET \"https://example.com/api/v1/hesabro/wallet/callback/{charge_id}/\" \\\n -H \"Accept: application/json\"" }, { "method": "POST", "path": "/api/v1/hesabro/wallet/callback/{charge_id}/", "summary": "callback عمومی پس از بازگشت کاربر از درگاه پرداخت حسابرو.", "description": "callback عمومی پس از بازگشت کاربر از درگاه پرداخت حسابرو.\n\n عمداً بدون احراز هویت است (مرورگر کاربر بدون session ممکن است برگردد) و\n شارژ را با ``charge_id`` در URL پیدا می‌کند. هم GET (redirect مرورگر) و هم\n POST (نوتیفیکیشن سرور-به-سرور) را می‌پذیرد.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "عمومی (بدون نیاز به لاگین)", "source": "Live Route", "view_name": "WalletCallbackView", "curl": "curl -X POST \"https://example.com/api/v1/hesabro/wallet/callback/{charge_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/wallet/balance/", "summary": "موجودی کیف پول کاربر جاری در فضای کاری انتخاب‌شده.", "description": "موجودی کیف پول کاربر جاری در فضای کاری انتخاب‌شده.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AccountWalletBalanceApiView", "curl": "curl -X GET \"https://example.com/api/v1/wallet/balance/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/wallet/charge/", "summary": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "description": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AccountWalletChargeApiView", "curl": "curl -X GET \"https://example.com/api/v1/wallet/charge/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/wallet/charge/", "summary": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "description": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AccountWalletChargeApiView", "curl": "curl -X POST \"https://example.com/api/v1/wallet/charge/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/wallet/charge/{charge_id}/factor/", "summary": "تلاش مجدد برای ثبت سند یک شارژِ پرداخت‌شدهٔ کاربر جاری.", "description": "تلاش مجدد برای ثبت سند یک شارژِ پرداخت‌شدهٔ کاربر جاری.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AccountWalletFactorRetryView", "curl": "curl -X POST \"https://example.com/api/v1/wallet/charge/{charge_id}/factor/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/wallet/charges/", "summary": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "description": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AccountWalletChargeApiView", "curl": "curl -X GET \"https://example.com/api/v1/wallet/charges/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/wallet/charges/", "summary": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "description": "ثبت درخواست شارژ کیف پول کاربر جاری + فهرست درخواست‌های قبلی.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AccountWalletChargeApiView", "curl": "curl -X POST \"https://example.com/api/v1/wallet/charges/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/wallet/charges/{charge_id}/", "summary": "جزئیات یک درخواست شارژ و استعلام وضعیت پرداخت آن.", "description": "جزئیات یک درخواست شارژ و استعلام وضعیت پرداخت آن.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WalletChargeDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/wallet/charges/{charge_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/wallet/charges/{charge_id}/factor/", "summary": "تلاش مجدد برای ثبت سند یک شارژِ پرداخت‌شدهٔ کاربر جاری.", "description": "تلاش مجدد برای ثبت سند یک شارژِ پرداخت‌شدهٔ کاربر جاری.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AccountWalletFactorRetryView", "curl": "curl -X POST \"https://example.com/api/v1/wallet/charges/{charge_id}/factor/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/wallet/connection/", "summary": "وضعیت اتصال کیف پول در سطح حساب کاربری / فضای کاری انتخاب‌شده.", "description": "وضعیت اتصال کیف پول در سطح حساب کاربری / فضای کاری انتخاب‌شده.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AccountWalletConnectionApiView", "curl": "curl -X GET \"https://example.com/api/v1/wallet/connection/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/wallet/history/", "summary": "تاریخچهٔ تراکنش‌های کیف پولِ فضای کاری انتخاب‌شده.", "description": "تاریخچهٔ تراکنش‌های کیف پولِ فضای کاری انتخاب‌شده.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AccountWalletHistoryApiView", "curl": "curl -X GET \"https://example.com/api/v1/wallet/history/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/wallet/personal/", "summary": "GET — وضعیت کیف پول شخص (موجودی، مانده بدهی، سقف مجاز، و مجاز بودن چت).", "description": "GET — وضعیت کیف پول شخص (موجودی، مانده بدهی، سقف مجاز، و مجاز بودن چت).", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PersonalWalletApiView", "curl": "curl -X GET \"https://example.com/api/v1/wallet/personal/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/wallet/personal/settle/", "summary": "POST — تسویه بدهی کیف پول شخص با هدایت به درگاه پرداخت حسابرو.", "description": "POST — تسویه بدهی کیف پول شخص با هدایت به درگاه پرداخت حسابرو.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PersonalWalletSettleApiView", "curl": "curl -X POST \"https://example.com/api/v1/wallet/personal/settle/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/wallet/transactions/", "summary": "تاریخچهٔ تراکنش‌های کیف پولِ فضای کاری انتخاب‌شده.", "description": "تاریخچهٔ تراکنش‌های کیف پولِ فضای کاری انتخاب‌شده.", "tag": "hesabro", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AccountWalletHistoryApiView", "curl": "curl -X GET \"https://example.com/api/v1/wallet/transactions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/letters/", "summary": "لیست نامه‌های یک پوشه + ایجاد نامهٔ جدید.", "description": "لیست نامه‌های یک پوشه + ایجاد نامهٔ جدید.", "tag": "letters", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "LetterListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/letters/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/letters/", "summary": "لیست نامه‌های یک پوشه + ایجاد نامهٔ جدید.", "description": "لیست نامه‌های یک پوشه + ایجاد نامهٔ جدید.", "tag": "letters", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "LetterListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/letters/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/letters/ai-assist/", "summary": "تولید یا ویراستاری متن نامه با هوش مصنوعی بر اساس موضوع یا پیش‌نویس موجود.", "description": "تولید یا ویراستاری متن نامه با هوش مصنوعی بر اساس موضوع یا پیش‌نویس موجود.", "tag": "letters", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "LetterAiAssistApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/letters/ai-assist/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/letters/counts/", "summary": "GET letters_counts_api", "description": "", "tag": "letters", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "LetterCountsApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/letters/counts/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/letters/members/", "summary": "اعضای فعال فضای کاری برای انتخاب گیرندهٔ نامه.", "description": "اعضای فعال فضای کاری برای انتخاب گیرندهٔ نامه.", "tag": "letters", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "LetterMembersApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/letters/members/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/letters/recipients/{recipient_id}/action/", "summary": "عملیات روی یک نامه برای کاربر (خواندن/بایگانی/پاراف/برچسب).", "description": "عملیات روی یک نامه برای کاربر (خواندن/بایگانی/پاراف/برچسب).", "tag": "letters", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "LetterActionApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/letters/recipients/{recipient_id}/action/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{business_id}/letters/{letter_id}/", "summary": "جزئیات کامل یک نامه + رشتهٔ پاسخ‌ها. با باز شدن، خوانده علامت می‌خورد.", "description": "جزئیات کامل یک نامه + رشتهٔ پاسخ‌ها. با باز شدن، خوانده علامت می‌خورد.", "tag": "letters", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "LetterDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{business_id}/letters/{letter_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/letters/{letter_id}/forward/", "summary": "ارجاع نامه به کاربران دیگر (با امکان درخواست پاراف).", "description": "ارجاع نامه به کاربران دیگر (با امکان درخواست پاراف).", "tag": "letters", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "LetterForwardApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/letters/{letter_id}/forward/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/letters/{letter_id}/label/", "summary": "برچسب شخصیِ کاربر روی یک نامه (چه گیرنده باشد چه فرستنده).", "description": "برچسب شخصیِ کاربر روی یک نامه (چه گیرنده باشد چه فرستنده).", "tag": "letters", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "LetterLabelApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/letters/{letter_id}/label/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{business_id}/letters/{letter_id}/reply/", "summary": "پاسخ به یک نامه (به فرستندهٔ اصلی).", "description": "پاسخ به یک نامه (به فرستندهٔ اصلی).", "tag": "letters", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "LetterReplyApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{business_id}/letters/{letter_id}/reply/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/lookup/", "summary": "POST selection_chat", "description": "", "tag": "lookup", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "SelectionChatApiView", "curl": "curl -X POST \"https://example.com/api/v1/lookup/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/manager/ai-action/", "summary": "اجرای اکشن‌های تایید شده توسط مدیر از طریق دستیار هوشمند (ایجاد وظیفه یا ثبت نامه اداری).", "description": "اجرای اکشن‌های تایید شده توسط مدیر از طریق دستیار هوشمند (ایجاد وظیفه یا ثبت نامه اداری).", "tag": "manager", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ManagerAiActionApiView", "curl": "curl -X POST \"https://example.com/api/v1/manager/ai-action/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/manager/ai-chat/", "summary": "دستیار هوش مصنوعی بین‌فضایی ویژه مدیر با استریم SSE.", "description": "دستیار هوش مصنوعی بین‌فضایی ویژه مدیر با استریم SSE.\n مجهز به بافت چند فضایی از تمام شرکت‌های مدیر برای ارائه گزارش‌های مقایسه‌ای و تحلیل‌های یکپارچه.", "tag": "manager", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ManagerAiChatApiView", "curl": "curl -X POST \"https://example.com/api/v1/manager/ai-chat/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/manager/farochat/", "summary": "صندوق پیام‌ها و روم‌های فاروچت از تمام فضاهای کاری.", "description": "صندوق پیام‌ها و روم‌های فاروچت از تمام فضاهای کاری.", "tag": "manager", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ManagerFarochatApiView", "curl": "curl -X GET \"https://example.com/api/v1/manager/farochat/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/manager/letters/", "summary": "کارتابل تجمیعی نامه‌ها در تمام فضاهای کاری با قابلیت فیلتر بر روی یک فضای مشخص.", "description": "کارتابل تجمیعی نامه‌ها در تمام فضاهای کاری با قابلیت فیلتر بر روی یک فضای مشخص.", "tag": "manager", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ManagerLettersApiView", "curl": "curl -X GET \"https://example.com/api/v1/manager/letters/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/manager/summary/", "summary": "متریک‌های کلیدی داشبورد مدیر در سطح کل فضاهای کاری یا یک فضای انتخابی.", "description": "متریک‌های کلیدی داشبورد مدیر در سطح کل فضاهای کاری یا یک فضای انتخابی.", "tag": "manager", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ManagerSummaryApiView", "curl": "curl -X GET \"https://example.com/api/v1/manager/summary/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/manager/tasks/", "summary": "کارتابل تجمیعی وظایف در تمام فضاهای کاری با قابلیت فیلتر بر روی یک فضای مشخص.", "description": "کارتابل تجمیعی وظایف در تمام فضاهای کاری با قابلیت فیلتر بر روی یک فضای مشخص.", "tag": "manager", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ManagerTasksApiView", "curl": "curl -X GET \"https://example.com/api/v1/manager/tasks/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/manager/workspaces/", "summary": "لیست تمام فضاهای کاری فعال مدیر به همراه شمارنده بج‌های هر فضا.", "description": "لیست تمام فضاهای کاری فعال مدیر به همراه شمارنده بج‌های هر فضا.", "tag": "manager", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ManagerWorkspacesApiView", "curl": "curl -X GET \"https://example.com/api/v1/manager/workspaces/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/attachments/{attachment_id}/", "summary": "GET note_attachment_detail_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AttachmentDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/attachments/{attachment_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "DELETE", "path": "/api/v1/businesses/{project_id}/attachments/{attachment_id}/", "summary": "DELETE note_attachment_detail_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AttachmentDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{project_id}/attachments/{attachment_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/attachments/{attachment_id}/download/", "summary": "GET note_attachment_download_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AttachmentDownloadApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/attachments/{attachment_id}/download/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PATCH", "path": "/api/v1/businesses/{project_id}/checklist/{item_id}/", "summary": "PATCH note_checklist_item_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChecklistItemApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/businesses/{project_id}/checklist/{item_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{project_id}/checklist/{item_id}/", "summary": "DELETE note_checklist_item_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChecklistItemApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{project_id}/checklist/{item_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/notes/", "summary": "GET note_list_create_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "NoteListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/notes/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/notes/", "summary": "POST note_list_create_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "NoteListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/notes/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/", "summary": "GET note_detail_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "NoteDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PUT", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/", "summary": "PUT note_detail_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "NoteDetailApiView", "curl": "curl -X PUT \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/", "summary": "PATCH note_detail_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "NoteDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/", "summary": "DELETE note_detail_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "NoteDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/activity/", "summary": "GET note_activity_list_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "NoteActivityListApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/activity/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/archive/", "summary": "POST note_archive_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ArchiveNoteApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/archive/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/archive/", "summary": "DELETE note_archive_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ArchiveNoteApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/archive/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/attachments/", "summary": "GET note_attachment_list_create_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AttachmentListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/attachments/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/attachments/", "summary": "POST note_attachment_list_create_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "AttachmentListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/attachments/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/checklist/", "summary": "GET note_checklist_list_create_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChecklistListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/checklist/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/checklist/", "summary": "POST note_checklist_list_create_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChecklistListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/checklist/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/checklist/reorder/", "summary": "POST note_checklist_reorder_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChecklistReorderApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/checklist/reorder/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/hard-delete/", "summary": "DELETE note_hard_delete_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "HardDeleteNoteApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/hard-delete/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/restore/", "summary": "POST note_restore_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RestoreNoteApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/restore/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/share-to-chat/", "summary": "POST note_share_to_chat", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ShareNoteToChatApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/share-to-chat/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/shares/", "summary": "GET note_share_list_create_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ShareListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/shares/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/shares/", "summary": "POST note_share_list_create_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ShareListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/shares/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/sources/", "summary": "GET note_source_list_create_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "SourceListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/sources/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/notes/{note_id}/sources/", "summary": "POST note_source_list_create_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "SourceListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/notes/{note_id}/sources/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{project_id}/shares/{share_id}/", "summary": "DELETE note_share_detail_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ShareDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{project_id}/shares/{share_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "DELETE", "path": "/api/v1/businesses/{project_id}/sources/{source_id}/", "summary": "DELETE note_source_detail_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "SourceDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{project_id}/sources/{source_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/tags/", "summary": "GET note_tag_list_create_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TagListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/tags/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/tags/", "summary": "POST note_tag_list_create_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TagListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/tags/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/v1/businesses/{project_id}/tags/{tag_id}/", "summary": "PATCH note_tag_detail_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TagDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/businesses/{project_id}/tags/{tag_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{project_id}/tags/{tag_id}/", "summary": "DELETE note_tag_detail_api", "description": "", "tag": "notes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TagDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{project_id}/tags/{tag_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/notifications/", "summary": "GET notification_list_api", "description": "", "tag": "notifications", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "NotificationListApiView", "curl": "curl -X GET \"https://example.com/api/v1/notifications/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/notifications/push/config/", "summary": "GET notification_push_config_api", "description": "", "tag": "notifications", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PushConfigApiView", "curl": "curl -X GET \"https://example.com/api/v1/notifications/push/config/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/notifications/push/subscriptions/", "summary": "POST notification_push_subscription_api", "description": "", "tag": "notifications", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PushSubscriptionApiView", "curl": "curl -X POST \"https://example.com/api/v1/notifications/push/subscriptions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/notifications/push/subscriptions/", "summary": "DELETE notification_push_subscription_api", "description": "", "tag": "notifications", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PushSubscriptionApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/notifications/push/subscriptions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/notifications/push/test/", "summary": "POST notification_push_test_api", "description": "", "tag": "notifications", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PushTestApiView", "curl": "curl -X POST \"https://example.com/api/v1/notifications/push/test/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/notifications/read/", "summary": "POST notification_read_all_api", "description": "", "tag": "notifications", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "NotificationReadApiView", "curl": "curl -X POST \"https://example.com/api/v1/notifications/read/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/notifications/{notification_id}/read/", "summary": "POST notification_read_api", "description": "", "tag": "notifications", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "NotificationReadApiView", "curl": "curl -X POST \"https://example.com/api/v1/notifications/{notification_id}/read/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/analytics/", "summary": "دریافت آمارهای واقعی و شاخص‌های کلیدی برای داشبورد تحلیلی OKR.", "description": "دریافت آمارهای واقعی و شاخص‌های کلیدی برای داشبورد تحلیلی OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "OKRAnalyticsAPIView", "curl": "curl -X GET \"https://example.com/api/okr/analytics/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/okr/check-ins/", "summary": "CRUD برای Check-in‌ها.", "description": "CRUD برای Check-in‌ها.\n - Read: همه کاربران احرازهویت‌شده.\n - Create/Update/Delete: مسئول نتیجه کلیدی یا مشارکت‌کننده هدف کلان (IsContributorOrOwnerForCheckIn).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CheckInViewSet", "curl": "curl -X GET \"https://example.com/api/okr/check-ins/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/check-ins/", "summary": "CRUD برای Check-in‌ها.", "description": "CRUD برای Check-in‌ها.\n - Read: همه کاربران احرازهویت‌شده.\n - Create/Update/Delete: مسئول نتیجه کلیدی یا مشارکت‌کننده هدف کلان (IsContributorOrOwnerForCheckIn).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CheckInViewSet", "curl": "curl -X POST \"https://example.com/api/okr/check-ins/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/check-ins/(?P{pk}[/.]+)/", "summary": "CRUD برای Check-in‌ها.", "description": "CRUD برای Check-in‌ها.\n - Read: همه کاربران احرازهویت‌شده.\n - Create/Update/Delete: مسئول نتیجه کلیدی یا مشارکت‌کننده هدف کلان (IsContributorOrOwnerForCheckIn).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CheckInViewSet", "curl": "curl -X GET \"https://example.com/api/okr/check-ins/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/check-ins/(?P{pk}[/.]+)/", "summary": "CRUD برای Check-in‌ها.", "description": "CRUD برای Check-in‌ها.\n - Read: همه کاربران احرازهویت‌شده.\n - Create/Update/Delete: مسئول نتیجه کلیدی یا مشارکت‌کننده هدف کلان (IsContributorOrOwnerForCheckIn).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CheckInViewSet", "curl": "curl -X POST \"https://example.com/api/okr/check-ins/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/check-ins/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای Check-in‌ها.", "description": "CRUD برای Check-in‌ها.\n - Read: همه کاربران احرازهویت‌شده.\n - Create/Update/Delete: مسئول نتیجه کلیدی یا مشارکت‌کننده هدف کلان (IsContributorOrOwnerForCheckIn).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CheckInViewSet", "curl": "curl -X GET \"https://example.com/api/okr/check-ins/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/check-ins/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای Check-in‌ها.", "description": "CRUD برای Check-in‌ها.\n - Read: همه کاربران احرازهویت‌شده.\n - Create/Update/Delete: مسئول نتیجه کلیدی یا مشارکت‌کننده هدف کلان (IsContributorOrOwnerForCheckIn).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CheckInViewSet", "curl": "curl -X POST \"https://example.com/api/okr/check-ins/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/check-ins\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای Check-in‌ها.", "description": "CRUD برای Check-in‌ها.\n - Read: همه کاربران احرازهویت‌شده.\n - Create/Update/Delete: مسئول نتیجه کلیدی یا مشارکت‌کننده هدف کلان (IsContributorOrOwnerForCheckIn).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CheckInViewSet", "curl": "curl -X GET \"https://example.com/api/okr/check-ins\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/check-ins\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای Check-in‌ها.", "description": "CRUD برای Check-in‌ها.\n - Read: همه کاربران احرازهویت‌شده.\n - Create/Update/Delete: مسئول نتیجه کلیدی یا مشارکت‌کننده هدف کلان (IsContributorOrOwnerForCheckIn).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CheckInViewSet", "curl": "curl -X POST \"https://example.com/api/okr/check-ins\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/conversations/", "summary": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.", "description": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.\n - Read/Write: برگزارکننده (organizer)، شرکت‌کننده (participant) یا مدیران سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrConversationViewSet", "curl": "curl -X GET \"https://example.com/api/okr/conversations/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/conversations/", "summary": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.", "description": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.\n - Read/Write: برگزارکننده (organizer)، شرکت‌کننده (participant) یا مدیران سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrConversationViewSet", "curl": "curl -X POST \"https://example.com/api/okr/conversations/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/conversations/(?P{pk}[/.]+)/", "summary": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.", "description": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.\n - Read/Write: برگزارکننده (organizer)، شرکت‌کننده (participant) یا مدیران سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrConversationViewSet", "curl": "curl -X GET \"https://example.com/api/okr/conversations/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/conversations/(?P{pk}[/.]+)/", "summary": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.", "description": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.\n - Read/Write: برگزارکننده (organizer)، شرکت‌کننده (participant) یا مدیران سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrConversationViewSet", "curl": "curl -X POST \"https://example.com/api/okr/conversations/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/conversations/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.", "description": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.\n - Read/Write: برگزارکننده (organizer)، شرکت‌کننده (participant) یا مدیران سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrConversationViewSet", "curl": "curl -X GET \"https://example.com/api/okr/conversations/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/conversations/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.", "description": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.\n - Read/Write: برگزارکننده (organizer)، شرکت‌کننده (participant) یا مدیران سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrConversationViewSet", "curl": "curl -X POST \"https://example.com/api/okr/conversations/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/conversations\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.", "description": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.\n - Read/Write: برگزارکننده (organizer)، شرکت‌کننده (participant) یا مدیران سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrConversationViewSet", "curl": "curl -X GET \"https://example.com/api/okr/conversations\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/conversations\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.", "description": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.\n - Read/Write: برگزارکننده (organizer)، شرکت‌کننده (participant) یا مدیران سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrConversationViewSet", "curl": "curl -X POST \"https://example.com/api/okr/conversations\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/departments/", "summary": "CRUD برای دپارتمان‌ها.", "description": "CRUD برای دپارتمان‌ها.\n list: همه دپارتمان‌ها (با امکان فیلتر بر اساس ?parent=)\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: مدیران سیستم، مالکان و دارندگان مجوز can_manage_departments.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DepartmentViewSet", "curl": "curl -X GET \"https://example.com/api/okr/departments/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/departments/", "summary": "CRUD برای دپارتمان‌ها.", "description": "CRUD برای دپارتمان‌ها.\n list: همه دپارتمان‌ها (با امکان فیلتر بر اساس ?parent=)\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: مدیران سیستم، مالکان و دارندگان مجوز can_manage_departments.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DepartmentViewSet", "curl": "curl -X POST \"https://example.com/api/okr/departments/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/departments/(?P{pk}[/.]+)/", "summary": "CRUD برای دپارتمان‌ها.", "description": "CRUD برای دپارتمان‌ها.\n list: همه دپارتمان‌ها (با امکان فیلتر بر اساس ?parent=)\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: مدیران سیستم، مالکان و دارندگان مجوز can_manage_departments.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DepartmentViewSet", "curl": "curl -X GET \"https://example.com/api/okr/departments/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/departments/(?P{pk}[/.]+)/", "summary": "CRUD برای دپارتمان‌ها.", "description": "CRUD برای دپارتمان‌ها.\n list: همه دپارتمان‌ها (با امکان فیلتر بر اساس ?parent=)\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: مدیران سیستم، مالکان و دارندگان مجوز can_manage_departments.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DepartmentViewSet", "curl": "curl -X POST \"https://example.com/api/okr/departments/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/departments/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای دپارتمان‌ها.", "description": "CRUD برای دپارتمان‌ها.\n list: همه دپارتمان‌ها (با امکان فیلتر بر اساس ?parent=)\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: مدیران سیستم، مالکان و دارندگان مجوز can_manage_departments.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DepartmentViewSet", "curl": "curl -X GET \"https://example.com/api/okr/departments/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/departments/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای دپارتمان‌ها.", "description": "CRUD برای دپارتمان‌ها.\n list: همه دپارتمان‌ها (با امکان فیلتر بر اساس ?parent=)\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: مدیران سیستم، مالکان و دارندگان مجوز can_manage_departments.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DepartmentViewSet", "curl": "curl -X POST \"https://example.com/api/okr/departments/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/departments\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای دپارتمان‌ها.", "description": "CRUD برای دپارتمان‌ها.\n list: همه دپارتمان‌ها (با امکان فیلتر بر اساس ?parent=)\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: مدیران سیستم، مالکان و دارندگان مجوز can_manage_departments.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DepartmentViewSet", "curl": "curl -X GET \"https://example.com/api/okr/departments\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/departments\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای دپارتمان‌ها.", "description": "CRUD برای دپارتمان‌ها.\n list: همه دپارتمان‌ها (با امکان فیلتر بر اساس ?parent=)\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: مدیران سیستم، مالکان و دارندگان مجوز can_manage_departments.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DepartmentViewSet", "curl": "curl -X POST \"https://example.com/api/okr/departments\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/feedbacks/", "summary": "CRUD برای بازخوردهای CFR.", "description": "CRUD برای بازخوردهای CFR.\n - Read: بازخوردهای عمومی برای همه، بازخوردهای خصوصی فقط برای provider و receiver (IsFeedbackParticipant).\n - Create: مجاز برای کاربران احرازهویت‌شده (ارائه‌دهنده خودکار request.user تنظیم می‌شود).\n - Update/Delete: غیرمجاز برای حفظ یکپارچگی CFR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrFeedbackViewSet", "curl": "curl -X GET \"https://example.com/api/okr/feedbacks/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/feedbacks/", "summary": "CRUD برای بازخوردهای CFR.", "description": "CRUD برای بازخوردهای CFR.\n - Read: بازخوردهای عمومی برای همه، بازخوردهای خصوصی فقط برای provider و receiver (IsFeedbackParticipant).\n - Create: مجاز برای کاربران احرازهویت‌شده (ارائه‌دهنده خودکار request.user تنظیم می‌شود).\n - Update/Delete: غیرمجاز برای حفظ یکپارچگی CFR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrFeedbackViewSet", "curl": "curl -X POST \"https://example.com/api/okr/feedbacks/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/feedbacks/(?P{pk}[/.]+)/", "summary": "CRUD برای بازخوردهای CFR.", "description": "CRUD برای بازخوردهای CFR.\n - Read: بازخوردهای عمومی برای همه، بازخوردهای خصوصی فقط برای provider و receiver (IsFeedbackParticipant).\n - Create: مجاز برای کاربران احرازهویت‌شده (ارائه‌دهنده خودکار request.user تنظیم می‌شود).\n - Update/Delete: غیرمجاز برای حفظ یکپارچگی CFR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrFeedbackViewSet", "curl": "curl -X GET \"https://example.com/api/okr/feedbacks/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/feedbacks/(?P{pk}[/.]+)/", "summary": "CRUD برای بازخوردهای CFR.", "description": "CRUD برای بازخوردهای CFR.\n - Read: بازخوردهای عمومی برای همه، بازخوردهای خصوصی فقط برای provider و receiver (IsFeedbackParticipant).\n - Create: مجاز برای کاربران احرازهویت‌شده (ارائه‌دهنده خودکار request.user تنظیم می‌شود).\n - Update/Delete: غیرمجاز برای حفظ یکپارچگی CFR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrFeedbackViewSet", "curl": "curl -X POST \"https://example.com/api/okr/feedbacks/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/feedbacks/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای بازخوردهای CFR.", "description": "CRUD برای بازخوردهای CFR.\n - Read: بازخوردهای عمومی برای همه، بازخوردهای خصوصی فقط برای provider و receiver (IsFeedbackParticipant).\n - Create: مجاز برای کاربران احرازهویت‌شده (ارائه‌دهنده خودکار request.user تنظیم می‌شود).\n - Update/Delete: غیرمجاز برای حفظ یکپارچگی CFR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrFeedbackViewSet", "curl": "curl -X GET \"https://example.com/api/okr/feedbacks/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/feedbacks/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای بازخوردهای CFR.", "description": "CRUD برای بازخوردهای CFR.\n - Read: بازخوردهای عمومی برای همه، بازخوردهای خصوصی فقط برای provider و receiver (IsFeedbackParticipant).\n - Create: مجاز برای کاربران احرازهویت‌شده (ارائه‌دهنده خودکار request.user تنظیم می‌شود).\n - Update/Delete: غیرمجاز برای حفظ یکپارچگی CFR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrFeedbackViewSet", "curl": "curl -X POST \"https://example.com/api/okr/feedbacks/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/feedbacks\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای بازخوردهای CFR.", "description": "CRUD برای بازخوردهای CFR.\n - Read: بازخوردهای عمومی برای همه، بازخوردهای خصوصی فقط برای provider و receiver (IsFeedbackParticipant).\n - Create: مجاز برای کاربران احرازهویت‌شده (ارائه‌دهنده خودکار request.user تنظیم می‌شود).\n - Update/Delete: غیرمجاز برای حفظ یکپارچگی CFR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrFeedbackViewSet", "curl": "curl -X GET \"https://example.com/api/okr/feedbacks\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/feedbacks\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای بازخوردهای CFR.", "description": "CRUD برای بازخوردهای CFR.\n - Read: بازخوردهای عمومی برای همه، بازخوردهای خصوصی فقط برای provider و receiver (IsFeedbackParticipant).\n - Create: مجاز برای کاربران احرازهویت‌شده (ارائه‌دهنده خودکار request.user تنظیم می‌شود).\n - Update/Delete: غیرمجاز برای حفظ یکپارچگی CFR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrFeedbackViewSet", "curl": "curl -X POST \"https://example.com/api/okr/feedbacks\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/key-results/", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X GET \"https://example.com/api/okr/key-results/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/key-results/", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X POST \"https://example.com/api/okr/key-results/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/key-results/(?P{pk}[/.]+)/", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X GET \"https://example.com/api/okr/key-results/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/key-results/(?P{pk}[/.]+)/", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X POST \"https://example.com/api/okr/key-results/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/key-results/(?P{pk}[/.]+)/sync-project/", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X GET \"https://example.com/api/okr/key-results/(?P{pk}[/.]+)/sync-project/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/key-results/(?P{pk}[/.]+)/sync-project/", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X POST \"https://example.com/api/okr/key-results/(?P{pk}[/.]+)/sync-project/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/key-results/(?P{pk}[/.]+)/sync-project\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X GET \"https://example.com/api/okr/key-results/(?P{pk}[/.]+)/sync-project\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/key-results/(?P{pk}[/.]+)/sync-project\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X POST \"https://example.com/api/okr/key-results/(?P{pk}[/.]+)/sync-project\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/key-results/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X GET \"https://example.com/api/okr/key-results/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/key-results/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X POST \"https://example.com/api/okr/key-results/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/key-results\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X GET \"https://example.com/api/okr/key-results\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/key-results\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X POST \"https://example.com/api/okr/key-results\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/kr-revisions/", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X GET \"https://example.com/api/okr/kr-revisions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/kr-revisions/", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X POST \"https://example.com/api/okr/kr-revisions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/kr-revisions/(?P{pk}[/.]+)/", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X GET \"https://example.com/api/okr/kr-revisions/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/kr-revisions/(?P{pk}[/.]+)/", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X POST \"https://example.com/api/okr/kr-revisions/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/kr-revisions/(?P{pk}[/.]+)/approve/", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X GET \"https://example.com/api/okr/kr-revisions/(?P{pk}[/.]+)/approve/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/kr-revisions/(?P{pk}[/.]+)/approve/", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X POST \"https://example.com/api/okr/kr-revisions/(?P{pk}[/.]+)/approve/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/kr-revisions/(?P{pk}[/.]+)/approve\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X GET \"https://example.com/api/okr/kr-revisions/(?P{pk}[/.]+)/approve\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/kr-revisions/(?P{pk}[/.]+)/approve\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X POST \"https://example.com/api/okr/kr-revisions/(?P{pk}[/.]+)/approve\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/kr-revisions/(?P{pk}[/.]+)/reject/", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X GET \"https://example.com/api/okr/kr-revisions/(?P{pk}[/.]+)/reject/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/kr-revisions/(?P{pk}[/.]+)/reject/", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X POST \"https://example.com/api/okr/kr-revisions/(?P{pk}[/.]+)/reject/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/kr-revisions/(?P{pk}[/.]+)/reject\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X GET \"https://example.com/api/okr/kr-revisions/(?P{pk}[/.]+)/reject\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/kr-revisions/(?P{pk}[/.]+)/reject\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X POST \"https://example.com/api/okr/kr-revisions/(?P{pk}[/.]+)/reject\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/kr-revisions/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X GET \"https://example.com/api/okr/kr-revisions/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/kr-revisions/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X POST \"https://example.com/api/okr/kr-revisions/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/kr-revisions\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X GET \"https://example.com/api/okr/kr-revisions\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/kr-revisions\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X POST \"https://example.com/api/okr/kr-revisions\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/objective-contributors/", "summary": "مدیریت مشارکت‌کنندگان یک هدف.", "description": "مدیریت مشارکت‌کنندگان یک هدف.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveContributorViewSet", "curl": "curl -X GET \"https://example.com/api/okr/objective-contributors/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/objective-contributors/", "summary": "مدیریت مشارکت‌کنندگان یک هدف.", "description": "مدیریت مشارکت‌کنندگان یک هدف.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveContributorViewSet", "curl": "curl -X POST \"https://example.com/api/okr/objective-contributors/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/objective-contributors/(?P{pk}[/.]+)/", "summary": "مدیریت مشارکت‌کنندگان یک هدف.", "description": "مدیریت مشارکت‌کنندگان یک هدف.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveContributorViewSet", "curl": "curl -X GET \"https://example.com/api/okr/objective-contributors/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/objective-contributors/(?P{pk}[/.]+)/", "summary": "مدیریت مشارکت‌کنندگان یک هدف.", "description": "مدیریت مشارکت‌کنندگان یک هدف.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveContributorViewSet", "curl": "curl -X POST \"https://example.com/api/okr/objective-contributors/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/objective-contributors/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "مدیریت مشارکت‌کنندگان یک هدف.", "description": "مدیریت مشارکت‌کنندگان یک هدف.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveContributorViewSet", "curl": "curl -X GET \"https://example.com/api/okr/objective-contributors/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/objective-contributors/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "مدیریت مشارکت‌کنندگان یک هدف.", "description": "مدیریت مشارکت‌کنندگان یک هدف.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveContributorViewSet", "curl": "curl -X POST \"https://example.com/api/okr/objective-contributors/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/objective-contributors\\.(?P{format}[a-z0-9]+)/?", "summary": "مدیریت مشارکت‌کنندگان یک هدف.", "description": "مدیریت مشارکت‌کنندگان یک هدف.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveContributorViewSet", "curl": "curl -X GET \"https://example.com/api/okr/objective-contributors\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/objective-contributors\\.(?P{format}[a-z0-9]+)/?", "summary": "مدیریت مشارکت‌کنندگان یک هدف.", "description": "مدیریت مشارکت‌کنندگان یک هدف.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveContributorViewSet", "curl": "curl -X POST \"https://example.com/api/okr/objective-contributors\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/objectives/", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X GET \"https://example.com/api/okr/objectives/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/objectives/", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X POST \"https://example.com/api/okr/objectives/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/objectives/(?P{pk}[/.]+)/", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X GET \"https://example.com/api/okr/objectives/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/objectives/(?P{pk}[/.]+)/", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X POST \"https://example.com/api/okr/objectives/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/objectives/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X GET \"https://example.com/api/okr/objectives/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/objectives/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X POST \"https://example.com/api/okr/objectives/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/objectives/export-excel/", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X GET \"https://example.com/api/okr/objectives/export-excel/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/objectives/export-excel/", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X POST \"https://example.com/api/okr/objectives/export-excel/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/objectives/export-excel\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X GET \"https://example.com/api/okr/objectives/export-excel\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/objectives/export-excel\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X POST \"https://example.com/api/okr/objectives/export-excel\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/objectives\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X GET \"https://example.com/api/okr/objectives\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/objectives\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X POST \"https://example.com/api/okr/objectives\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/periods/", "summary": "CRUD برای دوره‌های OKR.", "description": "CRUD برای دوره‌های OKR.\n فیلتر: ?is_active=true برای دریافت دوره فعال.\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: فقط ادمین‌ها و سوپریوزرهای سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PeriodViewSet", "curl": "curl -X GET \"https://example.com/api/okr/periods/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/periods/", "summary": "CRUD برای دوره‌های OKR.", "description": "CRUD برای دوره‌های OKR.\n فیلتر: ?is_active=true برای دریافت دوره فعال.\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: فقط ادمین‌ها و سوپریوزرهای سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PeriodViewSet", "curl": "curl -X POST \"https://example.com/api/okr/periods/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/periods/(?P{pk}[/.]+)/", "summary": "CRUD برای دوره‌های OKR.", "description": "CRUD برای دوره‌های OKR.\n فیلتر: ?is_active=true برای دریافت دوره فعال.\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: فقط ادمین‌ها و سوپریوزرهای سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PeriodViewSet", "curl": "curl -X GET \"https://example.com/api/okr/periods/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/periods/(?P{pk}[/.]+)/", "summary": "CRUD برای دوره‌های OKR.", "description": "CRUD برای دوره‌های OKR.\n فیلتر: ?is_active=true برای دریافت دوره فعال.\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: فقط ادمین‌ها و سوپریوزرهای سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PeriodViewSet", "curl": "curl -X POST \"https://example.com/api/okr/periods/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/periods/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای دوره‌های OKR.", "description": "CRUD برای دوره‌های OKR.\n فیلتر: ?is_active=true برای دریافت دوره فعال.\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: فقط ادمین‌ها و سوپریوزرهای سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PeriodViewSet", "curl": "curl -X GET \"https://example.com/api/okr/periods/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/periods/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای دوره‌های OKR.", "description": "CRUD برای دوره‌های OKR.\n فیلتر: ?is_active=true برای دریافت دوره فعال.\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: فقط ادمین‌ها و سوپریوزرهای سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PeriodViewSet", "curl": "curl -X POST \"https://example.com/api/okr/periods/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/periods\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای دوره‌های OKR.", "description": "CRUD برای دوره‌های OKR.\n فیلتر: ?is_active=true برای دریافت دوره فعال.\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: فقط ادمین‌ها و سوپریوزرهای سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PeriodViewSet", "curl": "curl -X GET \"https://example.com/api/okr/periods\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/periods\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای دوره‌های OKR.", "description": "CRUD برای دوره‌های OKR.\n فیلتر: ?is_active=true برای دریافت دوره فعال.\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: فقط ادمین‌ها و سوپریوزرهای سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PeriodViewSet", "curl": "curl -X POST \"https://example.com/api/okr/periods\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/recognitions/", "summary": "CRUD برای قدردانی‌های CFR.", "description": "CRUD برای قدردانی‌های CFR.\n sender به صورت خودکار از request.user تنظیم می‌شود.\n فیلتر: ?receiver=&department=&project=", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrRecognitionViewSet", "curl": "curl -X GET \"https://example.com/api/okr/recognitions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/recognitions/", "summary": "CRUD برای قدردانی‌های CFR.", "description": "CRUD برای قدردانی‌های CFR.\n sender به صورت خودکار از request.user تنظیم می‌شود.\n فیلتر: ?receiver=&department=&project=", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrRecognitionViewSet", "curl": "curl -X POST \"https://example.com/api/okr/recognitions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/recognitions/(?P{pk}[/.]+)/", "summary": "CRUD برای قدردانی‌های CFR.", "description": "CRUD برای قدردانی‌های CFR.\n sender به صورت خودکار از request.user تنظیم می‌شود.\n فیلتر: ?receiver=&department=&project=", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrRecognitionViewSet", "curl": "curl -X GET \"https://example.com/api/okr/recognitions/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/recognitions/(?P{pk}[/.]+)/", "summary": "CRUD برای قدردانی‌های CFR.", "description": "CRUD برای قدردانی‌های CFR.\n sender به صورت خودکار از request.user تنظیم می‌شود.\n فیلتر: ?receiver=&department=&project=", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrRecognitionViewSet", "curl": "curl -X POST \"https://example.com/api/okr/recognitions/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/recognitions/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای قدردانی‌های CFR.", "description": "CRUD برای قدردانی‌های CFR.\n sender به صورت خودکار از request.user تنظیم می‌شود.\n فیلتر: ?receiver=&department=&project=", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrRecognitionViewSet", "curl": "curl -X GET \"https://example.com/api/okr/recognitions/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/recognitions/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای قدردانی‌های CFR.", "description": "CRUD برای قدردانی‌های CFR.\n sender به صورت خودکار از request.user تنظیم می‌شود.\n فیلتر: ?receiver=&department=&project=", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrRecognitionViewSet", "curl": "curl -X POST \"https://example.com/api/okr/recognitions/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/recognitions\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای قدردانی‌های CFR.", "description": "CRUD برای قدردانی‌های CFR.\n sender به صورت خودکار از request.user تنظیم می‌شود.\n فیلتر: ?receiver=&department=&project=", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrRecognitionViewSet", "curl": "curl -X GET \"https://example.com/api/okr/recognitions\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/okr/recognitions\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای قدردانی‌های CFR.", "description": "CRUD برای قدردانی‌های CFR.\n sender به صورت خودکار از request.user تنظیم می‌شود.\n فیلتر: ?receiver=&department=&project=", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrRecognitionViewSet", "curl": "curl -X POST \"https://example.com/api/okr/recognitions\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/okr/scorecard/export/excel/", "summary": "سرویس دریافت فایل اکسل (.xlsx) کارنامه جامع OKR برای فرانت‌اند.", "description": "سرویس دریافت فایل اکسل (.xlsx) کارنامه جامع OKR برای فرانت‌اند.\n شامل دو شیت مجزا:\n 1. خلاصه وضعیت و شاخص‌های کلیدی کارنامه (KPI Cards، توزیع وضعیت‌ها، آمارهای تعاملات CFR)\n 2. ریز اهداف و نتایج کلیدی (جدول تفکیکی تمام Objectives و Key Results، وزن، پیشرفت، وضعیت، مسئول)\n \n پارامترهای فیلتر (Query Params):\n - period: شناسه دوره (UUID) - اختیاری\n - department: شناسه دپارتمان (UUID) یا 'company' - اختیاری\n - user: شناسه کاربر (UUID) برای کارنامه فردی - اختیاری\n - type: نوع OKR (company / department / individual) - اختیاری", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ScorecardExcelExportAPIView", "curl": "curl -X GET \"https://example.com/api/okr/scorecard/export/excel/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/okr/analytics/", "summary": "دریافت آمارهای واقعی و شاخص‌های کلیدی برای داشبورد تحلیلی OKR.", "description": "دریافت آمارهای واقعی و شاخص‌های کلیدی برای داشبورد تحلیلی OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "OKRAnalyticsAPIView", "curl": "curl -X GET \"https://example.com/api/v1/okr/analytics/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/okr/check-ins/", "summary": "CRUD برای Check-in‌ها.", "description": "CRUD برای Check-in‌ها.\n - Read: همه کاربران احرازهویت‌شده.\n - Create/Update/Delete: مسئول نتیجه کلیدی یا مشارکت‌کننده هدف کلان (IsContributorOrOwnerForCheckIn).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CheckInViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/check-ins/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/check-ins/", "summary": "CRUD برای Check-in‌ها.", "description": "CRUD برای Check-in‌ها.\n - Read: همه کاربران احرازهویت‌شده.\n - Create/Update/Delete: مسئول نتیجه کلیدی یا مشارکت‌کننده هدف کلان (IsContributorOrOwnerForCheckIn).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CheckInViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/check-ins/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/check-ins/(?P{pk}[/.]+)/", "summary": "CRUD برای Check-in‌ها.", "description": "CRUD برای Check-in‌ها.\n - Read: همه کاربران احرازهویت‌شده.\n - Create/Update/Delete: مسئول نتیجه کلیدی یا مشارکت‌کننده هدف کلان (IsContributorOrOwnerForCheckIn).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CheckInViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/check-ins/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/check-ins/(?P{pk}[/.]+)/", "summary": "CRUD برای Check-in‌ها.", "description": "CRUD برای Check-in‌ها.\n - Read: همه کاربران احرازهویت‌شده.\n - Create/Update/Delete: مسئول نتیجه کلیدی یا مشارکت‌کننده هدف کلان (IsContributorOrOwnerForCheckIn).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CheckInViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/check-ins/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/check-ins/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای Check-in‌ها.", "description": "CRUD برای Check-in‌ها.\n - Read: همه کاربران احرازهویت‌شده.\n - Create/Update/Delete: مسئول نتیجه کلیدی یا مشارکت‌کننده هدف کلان (IsContributorOrOwnerForCheckIn).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CheckInViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/check-ins/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/check-ins/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای Check-in‌ها.", "description": "CRUD برای Check-in‌ها.\n - Read: همه کاربران احرازهویت‌شده.\n - Create/Update/Delete: مسئول نتیجه کلیدی یا مشارکت‌کننده هدف کلان (IsContributorOrOwnerForCheckIn).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CheckInViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/check-ins/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/check-ins\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای Check-in‌ها.", "description": "CRUD برای Check-in‌ها.\n - Read: همه کاربران احرازهویت‌شده.\n - Create/Update/Delete: مسئول نتیجه کلیدی یا مشارکت‌کننده هدف کلان (IsContributorOrOwnerForCheckIn).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CheckInViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/check-ins\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/check-ins\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای Check-in‌ها.", "description": "CRUD برای Check-in‌ها.\n - Read: همه کاربران احرازهویت‌شده.\n - Create/Update/Delete: مسئول نتیجه کلیدی یا مشارکت‌کننده هدف کلان (IsContributorOrOwnerForCheckIn).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CheckInViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/check-ins\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/conversations/", "summary": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.", "description": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.\n - Read/Write: برگزارکننده (organizer)، شرکت‌کننده (participant) یا مدیران سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrConversationViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/conversations/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/conversations/", "summary": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.", "description": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.\n - Read/Write: برگزارکننده (organizer)، شرکت‌کننده (participant) یا مدیران سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrConversationViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/conversations/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/conversations/(?P{pk}[/.]+)/", "summary": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.", "description": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.\n - Read/Write: برگزارکننده (organizer)، شرکت‌کننده (participant) یا مدیران سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrConversationViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/conversations/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/conversations/(?P{pk}[/.]+)/", "summary": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.", "description": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.\n - Read/Write: برگزارکننده (organizer)، شرکت‌کننده (participant) یا مدیران سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrConversationViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/conversations/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/conversations/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.", "description": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.\n - Read/Write: برگزارکننده (organizer)، شرکت‌کننده (participant) یا مدیران سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrConversationViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/conversations/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/conversations/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.", "description": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.\n - Read/Write: برگزارکننده (organizer)، شرکت‌کننده (participant) یا مدیران سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrConversationViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/conversations/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/conversations\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.", "description": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.\n - Read/Write: برگزارکننده (organizer)، شرکت‌کننده (participant) یا مدیران سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrConversationViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/conversations\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/conversations\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.", "description": "CRUD برای گفتگوهای 1-on-1 در چارچوب CFR.\n - Read/Write: برگزارکننده (organizer)، شرکت‌کننده (participant) یا مدیران سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrConversationViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/conversations\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/departments/", "summary": "CRUD برای دپارتمان‌ها.", "description": "CRUD برای دپارتمان‌ها.\n list: همه دپارتمان‌ها (با امکان فیلتر بر اساس ?parent=)\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: مدیران سیستم، مالکان و دارندگان مجوز can_manage_departments.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DepartmentViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/departments/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/departments/", "summary": "CRUD برای دپارتمان‌ها.", "description": "CRUD برای دپارتمان‌ها.\n list: همه دپارتمان‌ها (با امکان فیلتر بر اساس ?parent=)\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: مدیران سیستم، مالکان و دارندگان مجوز can_manage_departments.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DepartmentViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/departments/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/departments/(?P{pk}[/.]+)/", "summary": "CRUD برای دپارتمان‌ها.", "description": "CRUD برای دپارتمان‌ها.\n list: همه دپارتمان‌ها (با امکان فیلتر بر اساس ?parent=)\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: مدیران سیستم، مالکان و دارندگان مجوز can_manage_departments.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DepartmentViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/departments/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/departments/(?P{pk}[/.]+)/", "summary": "CRUD برای دپارتمان‌ها.", "description": "CRUD برای دپارتمان‌ها.\n list: همه دپارتمان‌ها (با امکان فیلتر بر اساس ?parent=)\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: مدیران سیستم، مالکان و دارندگان مجوز can_manage_departments.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DepartmentViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/departments/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/departments/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای دپارتمان‌ها.", "description": "CRUD برای دپارتمان‌ها.\n list: همه دپارتمان‌ها (با امکان فیلتر بر اساس ?parent=)\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: مدیران سیستم، مالکان و دارندگان مجوز can_manage_departments.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DepartmentViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/departments/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/departments/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای دپارتمان‌ها.", "description": "CRUD برای دپارتمان‌ها.\n list: همه دپارتمان‌ها (با امکان فیلتر بر اساس ?parent=)\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: مدیران سیستم، مالکان و دارندگان مجوز can_manage_departments.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DepartmentViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/departments/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/departments\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای دپارتمان‌ها.", "description": "CRUD برای دپارتمان‌ها.\n list: همه دپارتمان‌ها (با امکان فیلتر بر اساس ?parent=)\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: مدیران سیستم، مالکان و دارندگان مجوز can_manage_departments.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DepartmentViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/departments\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/departments\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای دپارتمان‌ها.", "description": "CRUD برای دپارتمان‌ها.\n list: همه دپارتمان‌ها (با امکان فیلتر بر اساس ?parent=)\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: مدیران سیستم، مالکان و دارندگان مجوز can_manage_departments.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DepartmentViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/departments\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/feedbacks/", "summary": "CRUD برای بازخوردهای CFR.", "description": "CRUD برای بازخوردهای CFR.\n - Read: بازخوردهای عمومی برای همه، بازخوردهای خصوصی فقط برای provider و receiver (IsFeedbackParticipant).\n - Create: مجاز برای کاربران احرازهویت‌شده (ارائه‌دهنده خودکار request.user تنظیم می‌شود).\n - Update/Delete: غیرمجاز برای حفظ یکپارچگی CFR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrFeedbackViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/feedbacks/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/feedbacks/", "summary": "CRUD برای بازخوردهای CFR.", "description": "CRUD برای بازخوردهای CFR.\n - Read: بازخوردهای عمومی برای همه، بازخوردهای خصوصی فقط برای provider و receiver (IsFeedbackParticipant).\n - Create: مجاز برای کاربران احرازهویت‌شده (ارائه‌دهنده خودکار request.user تنظیم می‌شود).\n - Update/Delete: غیرمجاز برای حفظ یکپارچگی CFR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrFeedbackViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/feedbacks/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/feedbacks/(?P{pk}[/.]+)/", "summary": "CRUD برای بازخوردهای CFR.", "description": "CRUD برای بازخوردهای CFR.\n - Read: بازخوردهای عمومی برای همه، بازخوردهای خصوصی فقط برای provider و receiver (IsFeedbackParticipant).\n - Create: مجاز برای کاربران احرازهویت‌شده (ارائه‌دهنده خودکار request.user تنظیم می‌شود).\n - Update/Delete: غیرمجاز برای حفظ یکپارچگی CFR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrFeedbackViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/feedbacks/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/feedbacks/(?P{pk}[/.]+)/", "summary": "CRUD برای بازخوردهای CFR.", "description": "CRUD برای بازخوردهای CFR.\n - Read: بازخوردهای عمومی برای همه، بازخوردهای خصوصی فقط برای provider و receiver (IsFeedbackParticipant).\n - Create: مجاز برای کاربران احرازهویت‌شده (ارائه‌دهنده خودکار request.user تنظیم می‌شود).\n - Update/Delete: غیرمجاز برای حفظ یکپارچگی CFR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrFeedbackViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/feedbacks/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/feedbacks/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای بازخوردهای CFR.", "description": "CRUD برای بازخوردهای CFR.\n - Read: بازخوردهای عمومی برای همه، بازخوردهای خصوصی فقط برای provider و receiver (IsFeedbackParticipant).\n - Create: مجاز برای کاربران احرازهویت‌شده (ارائه‌دهنده خودکار request.user تنظیم می‌شود).\n - Update/Delete: غیرمجاز برای حفظ یکپارچگی CFR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrFeedbackViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/feedbacks/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/feedbacks/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای بازخوردهای CFR.", "description": "CRUD برای بازخوردهای CFR.\n - Read: بازخوردهای عمومی برای همه، بازخوردهای خصوصی فقط برای provider و receiver (IsFeedbackParticipant).\n - Create: مجاز برای کاربران احرازهویت‌شده (ارائه‌دهنده خودکار request.user تنظیم می‌شود).\n - Update/Delete: غیرمجاز برای حفظ یکپارچگی CFR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrFeedbackViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/feedbacks/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/feedbacks\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای بازخوردهای CFR.", "description": "CRUD برای بازخوردهای CFR.\n - Read: بازخوردهای عمومی برای همه، بازخوردهای خصوصی فقط برای provider و receiver (IsFeedbackParticipant).\n - Create: مجاز برای کاربران احرازهویت‌شده (ارائه‌دهنده خودکار request.user تنظیم می‌شود).\n - Update/Delete: غیرمجاز برای حفظ یکپارچگی CFR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrFeedbackViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/feedbacks\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/feedbacks\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای بازخوردهای CFR.", "description": "CRUD برای بازخوردهای CFR.\n - Read: بازخوردهای عمومی برای همه، بازخوردهای خصوصی فقط برای provider و receiver (IsFeedbackParticipant).\n - Create: مجاز برای کاربران احرازهویت‌شده (ارائه‌دهنده خودکار request.user تنظیم می‌شود).\n - Update/Delete: غیرمجاز برای حفظ یکپارچگی CFR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrFeedbackViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/feedbacks\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/key-results/", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/key-results/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/key-results/", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/key-results/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/key-results/(?P{pk}[/.]+)/", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/key-results/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/key-results/(?P{pk}[/.]+)/", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/key-results/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/key-results/(?P{pk}[/.]+)/sync-project/", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/key-results/(?P{pk}[/.]+)/sync-project/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/key-results/(?P{pk}[/.]+)/sync-project/", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/key-results/(?P{pk}[/.]+)/sync-project/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/key-results/(?P{pk}[/.]+)/sync-project\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/key-results/(?P{pk}[/.]+)/sync-project\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/key-results/(?P{pk}[/.]+)/sync-project\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/key-results/(?P{pk}[/.]+)/sync-project\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/key-results/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/key-results/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/key-results/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/key-results/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/key-results\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/key-results\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/key-results\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای نتایج کلیدی.", "description": "CRUD برای نتایج کلیدی.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک نتیجه کلیدی، مالک هدف، یا مدیر بخش مربوطه (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/key-results\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/kr-revisions/", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/kr-revisions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/kr-revisions/", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/kr-revisions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/approve/", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/approve/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/approve/", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/approve/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/approve\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/approve\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/approve\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/approve\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/reject/", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/reject/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/reject/", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/reject/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/reject\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/reject\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/reject\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/kr-revisions/(?P{pk}[/.]+)/reject\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/kr-revisions/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/kr-revisions/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/kr-revisions/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/kr-revisions/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/kr-revisions\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/kr-revisions\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/kr-revisions\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.", "description": "CRUD و جریان تأیید/رد درخواست‌های بازنگری نتیجه کلیدی.\n - Read: کاربران احرازهویت‌شده در همان کسب‌وکار.\n - Create: مسئول نتیجه کلیدی یا مدیران.\n - Approve/Reject: فقط مدیر هدف، مدیر دپارتمان یا ادمین OKR.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KeyResultRevisionRequestViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/kr-revisions\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/objective-contributors/", "summary": "مدیریت مشارکت‌کنندگان یک هدف.", "description": "مدیریت مشارکت‌کنندگان یک هدف.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveContributorViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/objective-contributors/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/objective-contributors/", "summary": "مدیریت مشارکت‌کنندگان یک هدف.", "description": "مدیریت مشارکت‌کنندگان یک هدف.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveContributorViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/objective-contributors/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/objective-contributors/(?P{pk}[/.]+)/", "summary": "مدیریت مشارکت‌کنندگان یک هدف.", "description": "مدیریت مشارکت‌کنندگان یک هدف.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveContributorViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/objective-contributors/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/objective-contributors/(?P{pk}[/.]+)/", "summary": "مدیریت مشارکت‌کنندگان یک هدف.", "description": "مدیریت مشارکت‌کنندگان یک هدف.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveContributorViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/objective-contributors/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/objective-contributors/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "مدیریت مشارکت‌کنندگان یک هدف.", "description": "مدیریت مشارکت‌کنندگان یک هدف.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveContributorViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/objective-contributors/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/objective-contributors/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "مدیریت مشارکت‌کنندگان یک هدف.", "description": "مدیریت مشارکت‌کنندگان یک هدف.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveContributorViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/objective-contributors/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/objective-contributors\\.(?P{format}[a-z0-9]+)/?", "summary": "مدیریت مشارکت‌کنندگان یک هدف.", "description": "مدیریت مشارکت‌کنندگان یک هدف.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveContributorViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/objective-contributors\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/objective-contributors\\.(?P{format}[a-z0-9]+)/?", "summary": "مدیریت مشارکت‌کنندگان یک هدف.", "description": "مدیریت مشارکت‌کنندگان یک هدف.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveContributorViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/objective-contributors\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/objectives/", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/objectives/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/objectives/", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/objectives/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/objectives/(?P{pk}[/.]+)/", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/objectives/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/objectives/(?P{pk}[/.]+)/", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/objectives/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/objectives/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/objectives/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/objectives/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/objectives/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/objectives/export-excel/", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/objectives/export-excel/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/objectives/export-excel/", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/objectives/export-excel/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/objectives/export-excel\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/objectives/export-excel\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/objectives/export-excel\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/objectives/export-excel\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/objectives\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/objectives\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/objectives\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای اهداف کلان.", "description": "CRUD برای اهداف کلان.\n - Read: همه کاربران احرازهویت‌شده (Radical Transparency).\n - Write/Edit/Delete: فقط مالک هدف یا مدیر بخش (IsOwnerOrManager).", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ObjectiveViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/objectives\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/periods/", "summary": "CRUD برای دوره‌های OKR.", "description": "CRUD برای دوره‌های OKR.\n فیلتر: ?is_active=true برای دریافت دوره فعال.\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: فقط ادمین‌ها و سوپریوزرهای سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PeriodViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/periods/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/periods/", "summary": "CRUD برای دوره‌های OKR.", "description": "CRUD برای دوره‌های OKR.\n فیلتر: ?is_active=true برای دریافت دوره فعال.\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: فقط ادمین‌ها و سوپریوزرهای سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PeriodViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/periods/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/periods/(?P{pk}[/.]+)/", "summary": "CRUD برای دوره‌های OKR.", "description": "CRUD برای دوره‌های OKR.\n فیلتر: ?is_active=true برای دریافت دوره فعال.\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: فقط ادمین‌ها و سوپریوزرهای سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PeriodViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/periods/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/periods/(?P{pk}[/.]+)/", "summary": "CRUD برای دوره‌های OKR.", "description": "CRUD برای دوره‌های OKR.\n فیلتر: ?is_active=true برای دریافت دوره فعال.\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: فقط ادمین‌ها و سوپریوزرهای سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PeriodViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/periods/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/periods/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای دوره‌های OKR.", "description": "CRUD برای دوره‌های OKR.\n فیلتر: ?is_active=true برای دریافت دوره فعال.\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: فقط ادمین‌ها و سوپریوزرهای سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PeriodViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/periods/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/periods/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای دوره‌های OKR.", "description": "CRUD برای دوره‌های OKR.\n فیلتر: ?is_active=true برای دریافت دوره فعال.\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: فقط ادمین‌ها و سوپریوزرهای سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PeriodViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/periods/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/periods\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای دوره‌های OKR.", "description": "CRUD برای دوره‌های OKR.\n فیلتر: ?is_active=true برای دریافت دوره فعال.\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: فقط ادمین‌ها و سوپریوزرهای سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PeriodViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/periods\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/periods\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای دوره‌های OKR.", "description": "CRUD برای دوره‌های OKR.\n فیلتر: ?is_active=true برای دریافت دوره فعال.\n - Read: همه کاربران احرازهویت‌شده.\n - Write/Edit/Delete: فقط ادمین‌ها و سوپریوزرهای سیستم.", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PeriodViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/periods\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/recognitions/", "summary": "CRUD برای قدردانی‌های CFR.", "description": "CRUD برای قدردانی‌های CFR.\n sender به صورت خودکار از request.user تنظیم می‌شود.\n فیلتر: ?receiver=&department=&project=", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrRecognitionViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/recognitions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/recognitions/", "summary": "CRUD برای قدردانی‌های CFR.", "description": "CRUD برای قدردانی‌های CFR.\n sender به صورت خودکار از request.user تنظیم می‌شود.\n فیلتر: ?receiver=&department=&project=", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrRecognitionViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/recognitions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/recognitions/(?P{pk}[/.]+)/", "summary": "CRUD برای قدردانی‌های CFR.", "description": "CRUD برای قدردانی‌های CFR.\n sender به صورت خودکار از request.user تنظیم می‌شود.\n فیلتر: ?receiver=&department=&project=", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrRecognitionViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/recognitions/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/recognitions/(?P{pk}[/.]+)/", "summary": "CRUD برای قدردانی‌های CFR.", "description": "CRUD برای قدردانی‌های CFR.\n sender به صورت خودکار از request.user تنظیم می‌شود.\n فیلتر: ?receiver=&department=&project=", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrRecognitionViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/recognitions/(?P{pk}[/.]+)/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/recognitions/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای قدردانی‌های CFR.", "description": "CRUD برای قدردانی‌های CFR.\n sender به صورت خودکار از request.user تنظیم می‌شود.\n فیلتر: ?receiver=&department=&project=", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrRecognitionViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/recognitions/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/recognitions/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای قدردانی‌های CFR.", "description": "CRUD برای قدردانی‌های CFR.\n sender به صورت خودکار از request.user تنظیم می‌شود.\n فیلتر: ?receiver=&department=&project=", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrRecognitionViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/recognitions/(?P{pk}[/.]+)\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/recognitions\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای قدردانی‌های CFR.", "description": "CRUD برای قدردانی‌های CFR.\n sender به صورت خودکار از request.user تنظیم می‌شود.\n فیلتر: ?receiver=&department=&project=", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrRecognitionViewSet", "curl": "curl -X GET \"https://example.com/api/v1/okr/recognitions\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/okr/recognitions\\.(?P{format}[a-z0-9]+)/?", "summary": "CRUD برای قدردانی‌های CFR.", "description": "CRUD برای قدردانی‌های CFR.\n sender به صورت خودکار از request.user تنظیم می‌شود.\n فیلتر: ?receiver=&department=&project=", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CfrRecognitionViewSet", "curl": "curl -X POST \"https://example.com/api/v1/okr/recognitions\\.(?P{format}[a-z0-9]+)/?\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/okr/scorecard/export/excel/", "summary": "سرویس دریافت فایل اکسل (.xlsx) کارنامه جامع OKR برای فرانت‌اند.", "description": "سرویس دریافت فایل اکسل (.xlsx) کارنامه جامع OKR برای فرانت‌اند.\n شامل دو شیت مجزا:\n 1. خلاصه وضعیت و شاخص‌های کلیدی کارنامه (KPI Cards، توزیع وضعیت‌ها، آمارهای تعاملات CFR)\n 2. ریز اهداف و نتایج کلیدی (جدول تفکیکی تمام Objectives و Key Results، وزن، پیشرفت، وضعیت، مسئول)\n \n پارامترهای فیلتر (Query Params):\n - period: شناسه دوره (UUID) - اختیاری\n - department: شناسه دپارتمان (UUID) یا 'company' - اختیاری\n - user: شناسه کاربر (UUID) برای کارنامه فردی - اختیاری\n - type: نوع OKR (company / department / individual) - اختیاری", "tag": "okr", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ScorecardExcelExportAPIView", "curl": "curl -X GET \"https://example.com/api/v1/okr/scorecard/export/excel/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/businesses/{project_id}/projects/", "summary": "GET sub_project_list_create_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectListCreateApiView", "curl": "curl -X GET \"https://example.com/api/businesses/{project_id}/projects/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/businesses/{project_id}/projects/", "summary": "POST sub_project_list_create_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectListCreateApiView", "curl": "curl -X POST \"https://example.com/api/businesses/{project_id}/projects/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/businesses/{project_id}/projects/selectable-members/", "summary": "اعضای فعال workspace برای انتخاب هنگام ساخت پروژه.", "description": "اعضای فعال workspace برای انتخاب هنگام ساخت پروژه.", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectSelectableMembersApiView", "curl": "curl -X GET \"https://example.com/api/businesses/{project_id}/projects/selectable-members/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/businesses/{project_id}/projects/{sub_project_id}/", "summary": "GET sub_project_detail_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectDetailApiView", "curl": "curl -X GET \"https://example.com/api/businesses/{project_id}/projects/{sub_project_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PUT", "path": "/api/businesses/{project_id}/projects/{sub_project_id}/", "summary": "PUT sub_project_detail_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectDetailApiView", "curl": "curl -X PUT \"https://example.com/api/businesses/{project_id}/projects/{sub_project_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/businesses/{project_id}/projects/{sub_project_id}/", "summary": "PATCH sub_project_detail_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/businesses/{project_id}/projects/{sub_project_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/businesses/{project_id}/projects/{sub_project_id}/", "summary": "DELETE sub_project_detail_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/businesses/{project_id}/projects/{sub_project_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/businesses/{project_id}/projects/{sub_project_id}/files/", "summary": "GET sub_project_files_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectFilesApiView", "curl": "curl -X GET \"https://example.com/api/businesses/{project_id}/projects/{sub_project_id}/files/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/businesses/{project_id}/projects/{sub_project_id}/files/", "summary": "POST sub_project_files_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectFilesApiView", "curl": "curl -X POST \"https://example.com/api/businesses/{project_id}/projects/{sub_project_id}/files/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/businesses/{project_id}/projects/{sub_project_id}/members/", "summary": "مدیریت اعضای یک پروژهٔ مشخص (مستقل از عضویت فضای کاری).", "description": "مدیریت اعضای یک پروژهٔ مشخص (مستقل از عضویت فضای کاری).", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectMembersApiView", "curl": "curl -X GET \"https://example.com/api/businesses/{project_id}/projects/{sub_project_id}/members/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/businesses/{project_id}/projects/{sub_project_id}/members/", "summary": "مدیریت اعضای یک پروژهٔ مشخص (مستقل از عضویت فضای کاری).", "description": "مدیریت اعضای یک پروژهٔ مشخص (مستقل از عضویت فضای کاری).", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectMembersApiView", "curl": "curl -X POST \"https://example.com/api/businesses/{project_id}/projects/{sub_project_id}/members/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/businesses/{project_id}/projects/{sub_project_id}/members/{user_id}/", "summary": "DELETE sub_project_member_delete_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectMemberDeleteApiView", "curl": "curl -X DELETE \"https://example.com/api/businesses/{project_id}/projects/{sub_project_id}/members/{user_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/businesses/{project_id}/projects/{sub_project_id}/pin/", "summary": "POST sub_project_pin_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectPinApiView", "curl": "curl -X POST \"https://example.com/api/businesses/{project_id}/projects/{sub_project_id}/pin/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/projects/", "summary": "GET sub_project_list_create_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/projects/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/projects/", "summary": "POST sub_project_list_create_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/projects/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/projects/import/", "summary": "POST sub_project_import_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectImportApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/projects/import/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/projects/selectable-members/", "summary": "اعضای فعال workspace برای انتخاب هنگام ساخت پروژه.", "description": "اعضای فعال workspace برای انتخاب هنگام ساخت پروژه.", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectSelectableMembersApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/projects/selectable-members/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/projects/{sub_project_id}/", "summary": "GET sub_project_detail_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/projects/{sub_project_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PUT", "path": "/api/v1/businesses/{project_id}/projects/{sub_project_id}/", "summary": "PUT sub_project_detail_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectDetailApiView", "curl": "curl -X PUT \"https://example.com/api/v1/businesses/{project_id}/projects/{sub_project_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/v1/businesses/{project_id}/projects/{sub_project_id}/", "summary": "PATCH sub_project_detail_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/businesses/{project_id}/projects/{sub_project_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{project_id}/projects/{sub_project_id}/", "summary": "DELETE sub_project_detail_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{project_id}/projects/{sub_project_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/projects/{sub_project_id}/agent/apply-task/", "summary": "اندپوینت مستقیم برای اعمال تسک پیشنهادی هوش مصنوعی در یک پروژه مشخص.", "description": "اندپوینت مستقیم برای اعمال تسک پیشنهادی هوش مصنوعی در یک پروژه مشخص.", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectAgentApplyTaskApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/projects/{sub_project_id}/agent/apply-task/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/projects/{sub_project_id}/files/", "summary": "GET sub_project_files_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectFilesApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/projects/{sub_project_id}/files/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/projects/{sub_project_id}/files/", "summary": "POST sub_project_files_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectFilesApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/projects/{sub_project_id}/files/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{project_id}/projects/{sub_project_id}/files/{file_id}/", "summary": "حذف یک فایل مشخص از پروژه.", "description": "حذف یک فایل مشخص از پروژه.", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectFileDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{project_id}/projects/{sub_project_id}/files/{file_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/projects/{sub_project_id}/members/", "summary": "مدیریت اعضای یک پروژهٔ مشخص (مستقل از عضویت فضای کاری).", "description": "مدیریت اعضای یک پروژهٔ مشخص (مستقل از عضویت فضای کاری).", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectMembersApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/projects/{sub_project_id}/members/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/projects/{sub_project_id}/members/", "summary": "مدیریت اعضای یک پروژهٔ مشخص (مستقل از عضویت فضای کاری).", "description": "مدیریت اعضای یک پروژهٔ مشخص (مستقل از عضویت فضای کاری).", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectMembersApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/projects/{sub_project_id}/members/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{project_id}/projects/{sub_project_id}/members/{user_id}/", "summary": "DELETE sub_project_member_delete_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectMemberDeleteApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{project_id}/projects/{sub_project_id}/members/{user_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "PATCH", "path": "/api/v1/businesses/{project_id}/projects/{sub_project_id}/members/{user_id}/role/", "summary": "تغییر نقش عضو در پروژه (تعیین مدیر یا تبدیل به عضو عادی).", "description": "تغییر نقش عضو در پروژه (تعیین مدیر یا تبدیل به عضو عادی).", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectMemberRoleApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/businesses/{project_id}/projects/{sub_project_id}/members/{user_id}/role/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/projects/{sub_project_id}/pin/", "summary": "POST sub_project_pin_api", "description": "", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectPinApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/projects/{sub_project_id}/pin/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/projects/{project_id}/agent/apply-task/", "summary": "اندپوینت مستقیم برای اعمال تسک پیشنهادی هوش مصنوعی در یک پروژه مشخص.", "description": "اندپوینت مستقیم برای اعمال تسک پیشنهادی هوش مصنوعی در یک پروژه مشخص.", "tag": "projects", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectAgentApplyTaskApiView", "curl": "curl -X POST \"https://example.com/api/v1/projects/{project_id}/agent/apply-task/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/rag/kbs/", "summary": "GET rag_kb_list_create", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KbListCreateView", "curl": "curl -X GET \"https://example.com/api/v1/rag/kbs/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/rag/kbs/", "summary": "POST rag_kb_list_create", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KbListCreateView", "curl": "curl -X POST \"https://example.com/api/v1/rag/kbs/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/rag/kbs/{kb_id}/", "summary": "GET rag_kb_detail", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KbDetailView", "curl": "curl -X GET \"https://example.com/api/v1/rag/kbs/{kb_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PATCH", "path": "/api/v1/rag/kbs/{kb_id}/", "summary": "PATCH rag_kb_detail", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KbDetailView", "curl": "curl -X PATCH \"https://example.com/api/v1/rag/kbs/{kb_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/rag/kbs/{kb_id}/", "summary": "DELETE rag_kb_detail", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KbDetailView", "curl": "curl -X DELETE \"https://example.com/api/v1/rag/kbs/{kb_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/rag/kbs/{kb_id}/documents/", "summary": "GET rag_doc_list_upload", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DocListUploadView", "curl": "curl -X GET \"https://example.com/api/v1/rag/kbs/{kb_id}/documents/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/rag/kbs/{kb_id}/documents/", "summary": "POST rag_doc_list_upload", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DocListUploadView", "curl": "curl -X POST \"https://example.com/api/v1/rag/kbs/{kb_id}/documents/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/rag/kbs/{kb_id}/documents/{doc_id}/", "summary": "DELETE rag_doc_delete", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "DocDeleteView", "curl": "curl -X DELETE \"https://example.com/api/v1/rag/kbs/{kb_id}/documents/{doc_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/rag/kbs/{kb_id}/keys/", "summary": "GET rag_key_list_create", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ApiKeyListCreateView", "curl": "curl -X GET \"https://example.com/api/v1/rag/kbs/{kb_id}/keys/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/rag/kbs/{kb_id}/keys/", "summary": "POST rag_key_list_create", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ApiKeyListCreateView", "curl": "curl -X POST \"https://example.com/api/v1/rag/kbs/{kb_id}/keys/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/rag/kbs/{kb_id}/keys/{key_id}/", "summary": "DELETE rag_key_revoke", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ApiKeyRevokeView", "curl": "curl -X DELETE \"https://example.com/api/v1/rag/kbs/{kb_id}/keys/{key_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/rag/kbs/{kb_id}/playground/", "summary": "POST rag_playground", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "PlaygroundQueryView", "curl": "curl -X POST \"https://example.com/api/v1/rag/kbs/{kb_id}/playground/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/rag/kbs/{kb_id}/reindex/", "summary": "POST rag_reindex", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ReindexView", "curl": "curl -X POST \"https://example.com/api/v1/rag/kbs/{kb_id}/reindex/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/rag/kbs/{kb_id}/usage/", "summary": "GET rag_usage", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "UsageRollupView", "curl": "curl -X GET \"https://example.com/api/v1/rag/kbs/{kb_id}/usage/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/rag/", "summary": "GET rag_manager", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KbListView", "curl": "curl -X GET \"https://example.com/rag/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/rag/v1/chat/completions", "summary": "POST rag_gw_chat", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "RAG Bearer API Key", "source": "Live Route", "view_name": "ChatCompletionsView", "curl": "curl -X POST \"https://example.com/rag/v1/chat/completions\" \\\n -H \"Accept: application/json\" \\\n -H \"Authorization: Bearer faro_rag_YOUR_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/rag/v1/embeddings", "summary": "POST rag_gw_embeddings", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "RAG Bearer API Key", "source": "Live Route", "view_name": "EmbeddingsView", "curl": "curl -X POST \"https://example.com/rag/v1/embeddings\" \\\n -H \"Accept: application/json\" \\\n -H \"Authorization: Bearer faro_rag_YOUR_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/rag/v1/models", "summary": "GET rag_gw_models", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "RAG Bearer API Key", "source": "Live Route", "view_name": "ModelsView", "curl": "curl -X GET \"https://example.com/rag/v1/models\" \\\n -H \"Accept: application/json\" \\\n -H \"Authorization: Bearer faro_rag_YOUR_KEY\"" }, { "method": "GET", "path": "/rag/{kb_id}/", "summary": "GET rag_detail", "description": "", "tag": "rag", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "KbDetailView", "curl": "curl -X GET \"https://example.com/rag/{kb_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PATCH", "path": "/api/v1/businesses/{project_id}/members/{user_id}/permissions/", "summary": "Grant or revoke a single permission for a member without touching other permissions.", "description": "Grant or revoke a single permission for a member without touching other permissions.", "tag": "rbac", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessMemberPermissionApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/businesses/{project_id}/members/{user_id}/permissions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/v1/businesses/{project_id}/members/{user_id}/role/", "summary": "PATCH business_member_role_api", "description": "", "tag": "rbac", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessMemberRoleApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/businesses/{project_id}/members/{user_id}/role/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/roles/", "summary": "GET business_role_list_create_api", "description": "", "tag": "rbac", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessRoleListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/roles/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/businesses/{project_id}/roles/", "summary": "POST business_role_list_create_api", "description": "", "tag": "rbac", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessRoleListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/businesses/{project_id}/roles/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/businesses/{project_id}/roles/{role_id}/", "summary": "GET business_role_detail_api", "description": "", "tag": "rbac", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessRoleDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/businesses/{project_id}/roles/{role_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PATCH", "path": "/api/v1/businesses/{project_id}/roles/{role_id}/", "summary": "PATCH business_role_detail_api", "description": "", "tag": "rbac", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessRoleDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/businesses/{project_id}/roles/{role_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/businesses/{project_id}/roles/{role_id}/", "summary": "DELETE business_role_detail_api", "description": "", "tag": "rbac", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BusinessRoleDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/businesses/{project_id}/roles/{role_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/avapardaz/faro/changelog/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/avapardaz/faro/changelog/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/avapardaz/faro/changelog/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/avapardaz/faro/changelog/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/avapardaz/faro/changelog/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X GET \"https://example.com/api/avapardaz/faro/changelog/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/avapardaz/faro/changelog/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X POST \"https://example.com/api/avapardaz/faro/changelog/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/avapardaz/faro/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X GET \"https://example.com/api/avapardaz/faro/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PUT", "path": "/api/avapardaz/faro/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X PUT \"https://example.com/api/avapardaz/faro/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/avapardaz/faro/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X PATCH \"https://example.com/api/avapardaz/faro/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/avapardaz/faro/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X DELETE \"https://example.com/api/avapardaz/faro/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/avapardaz/faro/changelog/recent-changes/", "summary": "سازگاری با نسخه قبلی /api/v1/recent-changes/", "description": "سازگاری با نسخه قبلی /api/v1/recent-changes/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RecentChangeListApiView", "curl": "curl -X GET \"https://example.com/api/avapardaz/faro/changelog/recent-changes/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/avapardaz/faro/changelog/version/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/avapardaz/faro/changelog/version/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/avapardaz/faro/changelog/version/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/avapardaz/faro/changelog/version/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/avapardaz/faro/changelog/versions/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/avapardaz/faro/changelog/versions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/avapardaz/faro/changelog/versions/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/avapardaz/faro/changelog/versions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/avapardaz/faro/changelog/versions/{version_id}/", "summary": "GET /api//changelog/versions//", "description": "GET /api//changelog/versions//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionDetailApiView", "curl": "curl -X GET \"https://example.com/api/avapardaz/faro/changelog/versions/{version_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/avapardaz/faro/changelog/versions/{version_id}/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X GET \"https://example.com/api/avapardaz/faro/changelog/versions/{version_id}/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/avapardaz/faro/changelog/versions/{version_id}/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X POST \"https://example.com/api/avapardaz/faro/changelog/versions/{version_id}/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/changelog/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/changelog/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/changelog/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/changelog/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/changelog/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X GET \"https://example.com/api/changelog/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/changelog/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X POST \"https://example.com/api/changelog/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X GET \"https://example.com/api/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PUT", "path": "/api/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X PUT \"https://example.com/api/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X PATCH \"https://example.com/api/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X DELETE \"https://example.com/api/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/changelog/recent-changes/", "summary": "سازگاری با نسخه قبلی /api/v1/recent-changes/", "description": "سازگاری با نسخه قبلی /api/v1/recent-changes/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RecentChangeListApiView", "curl": "curl -X GET \"https://example.com/api/changelog/recent-changes/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/changelog/version/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/changelog/version/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/changelog/version/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/changelog/version/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/changelog/versions/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/changelog/versions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/changelog/versions/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/changelog/versions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/changelog/versions/{version_id}/", "summary": "GET /api//changelog/versions//", "description": "GET /api//changelog/versions//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionDetailApiView", "curl": "curl -X GET \"https://example.com/api/changelog/versions/{version_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/changelog/versions/{version_id}/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X GET \"https://example.com/api/changelog/versions/{version_id}/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/changelog/versions/{version_id}/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X POST \"https://example.com/api/changelog/versions/{version_id}/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/changelog/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/changelog/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/changelog/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/changelog/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/changelog/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/changelog/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/changelog/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/changelog/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X GET \"https://example.com/api/v1/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PUT", "path": "/api/v1/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X PUT \"https://example.com/api/v1/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/v1/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/changelog/recent-changes/", "summary": "سازگاری با نسخه قبلی /api/v1/recent-changes/", "description": "سازگاری با نسخه قبلی /api/v1/recent-changes/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RecentChangeListApiView", "curl": "curl -X GET \"https://example.com/api/v1/changelog/recent-changes/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/changelog/version/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/changelog/version/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/changelog/version/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/changelog/version/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/changelog/versions/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/changelog/versions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/changelog/versions/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/changelog/versions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/changelog/versions/{version_id}/", "summary": "GET /api//changelog/versions//", "description": "GET /api//changelog/versions//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/changelog/versions/{version_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/changelog/versions/{version_id}/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/changelog/versions/{version_id}/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/changelog/versions/{version_id}/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/changelog/versions/{version_id}/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X GET \"https://example.com/api/v1/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PUT", "path": "/api/v1/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X PUT \"https://example.com/api/v1/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/v1/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/recent-changes/", "summary": "سازگاری با نسخه قبلی /api/v1/recent-changes/", "description": "سازگاری با نسخه قبلی /api/v1/recent-changes/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RecentChangeListApiView", "curl": "curl -X GET \"https://example.com/api/v1/recent-changes/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/version/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/version/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/version/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/version/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/versions/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/versions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/versions/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/versions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/versions/{version_id}/", "summary": "GET /api//changelog/versions//", "description": "GET /api//changelog/versions//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/versions/{version_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/versions/{version_id}/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/versions/{version_id}/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/versions/{version_id}/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/versions/{version_id}/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/{business_name}/changelog/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/{business_name}/changelog/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/{business_name}/changelog/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/{business_name}/changelog/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/{business_name}/changelog/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X GET \"https://example.com/api/{business_name}/changelog/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/{business_name}/changelog/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X POST \"https://example.com/api/{business_name}/changelog/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/{business_name}/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X GET \"https://example.com/api/{business_name}/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PUT", "path": "/api/{business_name}/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X PUT \"https://example.com/api/{business_name}/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/{business_name}/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X PATCH \"https://example.com/api/{business_name}/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/{business_name}/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X DELETE \"https://example.com/api/{business_name}/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/{business_name}/changelog/recent-changes/", "summary": "سازگاری با نسخه قبلی /api/v1/recent-changes/", "description": "سازگاری با نسخه قبلی /api/v1/recent-changes/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RecentChangeListApiView", "curl": "curl -X GET \"https://example.com/api/{business_name}/changelog/recent-changes/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/{business_name}/changelog/version/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/{business_name}/changelog/version/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/{business_name}/changelog/version/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/{business_name}/changelog/version/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/{business_name}/changelog/versions/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/{business_name}/changelog/versions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/{business_name}/changelog/versions/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/{business_name}/changelog/versions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/{business_name}/changelog/versions/{version_id}/", "summary": "GET /api//changelog/versions//", "description": "GET /api//changelog/versions//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionDetailApiView", "curl": "curl -X GET \"https://example.com/api/{business_name}/changelog/versions/{version_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/{business_name}/changelog/versions/{version_id}/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X GET \"https://example.com/api/{business_name}/changelog/versions/{version_id}/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/{business_name}/changelog/versions/{version_id}/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X POST \"https://example.com/api/{business_name}/changelog/versions/{version_id}/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/{business_name}/{project_slug}/changelog/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/{business_name}/{project_slug}/changelog/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/{business_name}/{project_slug}/changelog/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/{business_name}/{project_slug}/changelog/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/{business_name}/{project_slug}/changelog/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X GET \"https://example.com/api/{business_name}/{project_slug}/changelog/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/{business_name}/{project_slug}/changelog/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X POST \"https://example.com/api/{business_name}/{project_slug}/changelog/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/{business_name}/{project_slug}/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X GET \"https://example.com/api/{business_name}/{project_slug}/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PUT", "path": "/api/{business_name}/{project_slug}/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X PUT \"https://example.com/api/{business_name}/{project_slug}/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/{business_name}/{project_slug}/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X PATCH \"https://example.com/api/{business_name}/{project_slug}/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/{business_name}/{project_slug}/changelog/details/{detail_id}/", "summary": "GET / PUT / PATCH / DELETE /api//changelog/details//", "description": "GET / PUT / PATCH / DELETE /api//changelog/details//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailUpdateDeleteApiView", "curl": "curl -X DELETE \"https://example.com/api/{business_name}/{project_slug}/changelog/details/{detail_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/{business_name}/{project_slug}/changelog/recent-changes/", "summary": "سازگاری با نسخه قبلی /api/v1/recent-changes/", "description": "سازگاری با نسخه قبلی /api/v1/recent-changes/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "RecentChangeListApiView", "curl": "curl -X GET \"https://example.com/api/{business_name}/{project_slug}/changelog/recent-changes/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/{business_name}/{project_slug}/changelog/version/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/{business_name}/{project_slug}/changelog/version/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/{business_name}/{project_slug}/changelog/version/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/{business_name}/{project_slug}/changelog/version/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/{business_name}/{project_slug}/changelog/versions/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X GET \"https://example.com/api/{business_name}/{project_slug}/changelog/versions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/{business_name}/{project_slug}/changelog/versions/", "summary": "GET /api//changelog/versions/", "description": "GET /api//changelog/versions/\n GET /api///changelog/versions/\n POST /api//changelog/versions/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionListCreateApiView", "curl": "curl -X POST \"https://example.com/api/{business_name}/{project_slug}/changelog/versions/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/{business_name}/{project_slug}/changelog/versions/{version_id}/", "summary": "GET /api//changelog/versions//", "description": "GET /api//changelog/versions//", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogVersionDetailApiView", "curl": "curl -X GET \"https://example.com/api/{business_name}/{project_slug}/changelog/versions/{version_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/{business_name}/{project_slug}/changelog/versions/{version_id}/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X GET \"https://example.com/api/{business_name}/{project_slug}/changelog/versions/{version_id}/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/{business_name}/{project_slug}/changelog/versions/{version_id}/details/", "summary": "GET /api//changelog/details/?version_id=1", "description": "GET /api//changelog/details/?version_id=1\n POST /api//changelog/details/\n POST /api//changelog/versions//details/", "tag": "recent_changes", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChangelogDetailListCreateApiView", "curl": "curl -X POST \"https://example.com/api/{business_name}/{project_slug}/changelog/versions/{version_id}/details/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/integrations/hamafzar/webhook/", "summary": "وب‌هوک ورودی هم‌افزار جهت ایجاد یا به‌روزرسانی وظایف در فارو.", "description": "وب‌هوک ورودی هم‌افزار جهت ایجاد یا به‌روزرسانی وظایف در فارو.", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "HamafzarWebhookApiView", "curl": "curl -X POST \"https://example.com/api/v1/integrations/hamafzar/webhook/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/v1/tasks/attachments/{attachment_id}/", "summary": "PATCH task_attachment_detail_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TaskAttachmentDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/tasks/attachments/{attachment_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/tasks/attachments/{attachment_id}/", "summary": "DELETE task_attachment_detail_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TaskAttachmentDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/tasks/attachments/{attachment_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/tasks/boards/", "summary": "GET task_board_list_create_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BoardListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/tasks/boards/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/tasks/boards/", "summary": "POST task_board_list_create_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BoardListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/tasks/boards/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/tasks/boards/{board_id}/", "summary": "GET task_board_detail_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BoardDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/tasks/boards/{board_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PUT", "path": "/api/v1/tasks/boards/{board_id}/", "summary": "PUT task_board_detail_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BoardDetailApiView", "curl": "curl -X PUT \"https://example.com/api/v1/tasks/boards/{board_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/v1/tasks/boards/{board_id}/", "summary": "PATCH task_board_detail_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BoardDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/tasks/boards/{board_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/tasks/boards/{board_id}/", "summary": "DELETE task_board_detail_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "BoardDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/tasks/boards/{board_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/tasks/boards/{board_id}/columns/", "summary": "GET task_column_list_create_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ColumnListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/tasks/boards/{board_id}/columns/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/tasks/boards/{board_id}/columns/", "summary": "POST task_column_list_create_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ColumnListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/tasks/boards/{board_id}/columns/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/tasks/boards/{board_id}/tasks/", "summary": "GET task_list_create_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TaskListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/tasks/boards/{board_id}/tasks/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/tasks/boards/{board_id}/tasks/", "summary": "POST task_list_create_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TaskListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/tasks/boards/{board_id}/tasks/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/v1/tasks/checklist/{item_id}/", "summary": "PATCH task_checklist_detail_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChecklistDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/tasks/checklist/{item_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/tasks/checklist/{item_id}/", "summary": "DELETE task_checklist_detail_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChecklistDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/tasks/checklist/{item_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "PATCH", "path": "/api/v1/tasks/columns/{column_id}/", "summary": "PATCH task_column_detail_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ColumnDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/tasks/columns/{column_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/tasks/columns/{column_id}/", "summary": "DELETE task_column_detail_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ColumnDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/tasks/columns/{column_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "POST", "path": "/api/v1/tasks/columns/{column_id}/move/", "summary": "جابه‌جایی ستون کانبان و مرتب‌سازی مجدد موقعیت ستون‌های بورد.", "description": "جابه‌جایی ستون کانبان و مرتب‌سازی مجدد موقعیت ستون‌های بورد.", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ColumnMoveApiView", "curl": "curl -X POST \"https://example.com/api/v1/tasks/columns/{column_id}/move/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/tasks/comments/{comment_id}/", "summary": "DELETE task_comment_detail_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CommentDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/tasks/comments/{comment_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/tasks/external/", "summary": "وب‌سرویس ایجاد و اتصال وظایف برای سامانه‌های خارجی (External Task API)", "description": "ایجاد تسک با احراز هویت X-API-Key در هدر، بدون نیاز به سشن یا لاگین (مستندات: docs/external-task-api.md)", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Task API Key (Header: X-API-Key)", "source": "Live Route", "view_name": "ExternalTaskCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/tasks/external/\" \\\n -H \"Accept: application/json\" \\\n -H \"X-API-Key: faro_tsk_YOUR_API_KEY\"" }, { "method": "POST", "path": "/api/v1/tasks/external/", "summary": "وب‌سرویس ایجاد و اتصال وظایف برای سامانه‌های خارجی (External Task API)", "description": "ایجاد تسک با احراز هویت X-API-Key در هدر، بدون نیاز به سشن یا لاگین (مستندات: docs/external-task-api.md)", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Task API Key (Header: X-API-Key)", "source": "Live Route", "view_name": "ExternalTaskCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/tasks/external/\" \\\n -H \"Accept: application/json\" \\\n -H \"X-API-Key: faro_tsk_YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/tasks/external/{task_id}/", "summary": "وب‌سرویس ایجاد و اتصال وظایف برای سامانه‌های خارجی (External Task API)", "description": "ایجاد تسک با احراز هویت X-API-Key در هدر، بدون نیاز به سشن یا لاگین (مستندات: docs/external-task-api.md)", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Task API Key (Header: X-API-Key)", "source": "Live Route", "view_name": "ExternalTaskDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/tasks/external/{task_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"X-API-Key: faro_tsk_YOUR_API_KEY\"" }, { "method": "GET", "path": "/api/v1/tasks/feed/", "summary": "فید وظایف برای صفحهٔ تب‌محور. تب، دسته، برچسب و مرتب‌سازی را می‌پذیرد.", "description": "فید وظایف برای صفحهٔ تب‌محور. تب، دسته، برچسب و مرتب‌سازی را می‌پذیرد.", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TaskFeedApiView", "curl": "curl -X GET \"https://example.com/api/v1/tasks/feed/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/tasks/items/", "summary": "ساخت وظیفه در سطح فضای کاری؛ انتخاب پروژه الزامی است و وظیفه در بورد آن پروژه می‌نشیند.", "description": "ساخت وظیفه در سطح فضای کاری؛ انتخاب پروژه الزامی است و وظیفه در بورد آن پروژه می‌نشیند.", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TaskCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/tasks/items/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/tasks/items/{task_id}/", "summary": "GET task_detail_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TaskDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/tasks/items/{task_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "PATCH", "path": "/api/v1/tasks/items/{task_id}/", "summary": "PATCH task_detail_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TaskDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/tasks/items/{task_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/tasks/items/{task_id}/", "summary": "DELETE task_detail_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TaskDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/tasks/items/{task_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/tasks/items/{task_id}/activities/", "summary": "لیست سوابق و تاریخچهٔ تغییرات وظیفه.", "description": "لیست سوابق و تاریخچهٔ تغییرات وظیفه.", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TaskActivityListApiView", "curl": "curl -X GET \"https://example.com/api/v1/tasks/items/{task_id}/activities/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/tasks/items/{task_id}/attachments/", "summary": "GET task_attachment_list_create_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TaskAttachmentListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/tasks/items/{task_id}/attachments/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/tasks/items/{task_id}/attachments/", "summary": "POST task_attachment_list_create_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TaskAttachmentListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/tasks/items/{task_id}/attachments/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/tasks/items/{task_id}/checklist/", "summary": "GET task_checklist_list_create_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChecklistListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/tasks/items/{task_id}/checklist/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/tasks/items/{task_id}/checklist/", "summary": "POST task_checklist_list_create_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ChecklistListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/tasks/items/{task_id}/checklist/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/tasks/items/{task_id}/comments/", "summary": "GET task_comment_list_create_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CommentListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/tasks/items/{task_id}/comments/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/tasks/items/{task_id}/comments/", "summary": "POST task_comment_list_create_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "CommentListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/tasks/items/{task_id}/comments/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/tasks/items/{task_id}/hamafzar/", "summary": "واکشی جزئیات گزارش و کامنت‌های متناظر آن از هم‌افزار برای این وظیفه.", "description": "واکشی جزئیات گزارش و کامنت‌های متناظر آن از هم‌افزار برای این وظیفه.", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TaskHamafzarDetailApiView", "curl": "curl -X GET \"https://example.com/api/v1/tasks/items/{task_id}/hamafzar/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/tasks/items/{task_id}/move/", "summary": "جابه‌جایی وظیفه بین ستون‌های کانبان.", "description": "جابه‌جایی وظیفه بین ستون‌های کانبان.\n\n عمداً جدا از TaskDetailApiView.patch است: این یک تراکنش چندسطری با\n resequence همسایه‌هاست و پاسخش ترتیب کاملِ ستون‌های درگیر را برمی‌گرداند تا\n کلاینت بعد از drop بتواند حالت خوش‌بینانه‌اش را تطبیق دهد.", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TaskMoveApiView", "curl": "curl -X POST \"https://example.com/api/v1/tasks/items/{task_id}/move/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "POST", "path": "/api/v1/tasks/items/{task_id}/sync-hamafzar/", "summary": "همگام‌سازی دستی وظیفه با هم‌افزار.", "description": "همگام‌سازی دستی وظیفه با هم‌افزار.", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TaskSyncHamafzarApiView", "curl": "curl -X POST \"https://example.com/api/v1/tasks/items/{task_id}/sync-hamafzar/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/tasks/labels/", "summary": "GET task_label_list_create_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "LabelListCreateApiView", "curl": "curl -X GET \"https://example.com/api/v1/tasks/labels/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/tasks/labels/", "summary": "POST task_label_list_create_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "LabelListCreateApiView", "curl": "curl -X POST \"https://example.com/api/v1/tasks/labels/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "PATCH", "path": "/api/v1/tasks/labels/{label_id}/", "summary": "PATCH task_label_detail_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "LabelDetailApiView", "curl": "curl -X PATCH \"https://example.com/api/v1/tasks/labels/{label_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "DELETE", "path": "/api/v1/tasks/labels/{label_id}/", "summary": "DELETE task_label_detail_api", "description": "", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "LabelDetailApiView", "curl": "curl -X DELETE \"https://example.com/api/v1/tasks/labels/{label_id}/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\"" }, { "method": "GET", "path": "/api/v1/tasks/members/", "summary": "اعضای فضای کاری برای انتخاب‌گر مسئول.", "description": "اعضای فضای کاری برای انتخاب‌گر مسئول.", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "WorkspaceMembersApiView", "curl": "curl -X GET \"https://example.com/api/v1/tasks/members/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "GET", "path": "/api/v1/tasks/projects/{project_id}/sync-hamafzar/", "summary": "واکشی گزارش‌های هم‌افزار با متد GET و همگام‌سازی آن‌ها به صورت وظیفه در پروژه.", "description": "واکشی گزارش‌های هم‌افزار با متد GET و همگام‌سازی آن‌ها به صورت وظیفه در پروژه.", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectHamafzarSyncApiView", "curl": "curl -X GET \"https://example.com/api/v1/tasks/projects/{project_id}/sync-hamafzar/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/tasks/projects/{project_id}/sync-hamafzar/", "summary": "واکشی گزارش‌های هم‌افزار با متد GET و همگام‌سازی آن‌ها به صورت وظیفه در پروژه.", "description": "واکشی گزارش‌های هم‌افزار با متد GET و همگام‌سازی آن‌ها به صورت وظیفه در پروژه.", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "ProjectHamafzarSyncApiView", "curl": "curl -X POST \"https://example.com/api/v1/tasks/projects/{project_id}/sync-hamafzar/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" }, { "method": "GET", "path": "/api/v1/tasks/quick-capture/", "summary": "اندپوینت ثبت آنی وظیفه و پیوست اسکرین‌شات از طریق افزونه مرورگر.", "description": "اندپوینت ثبت آنی وظیفه و پیوست اسکرین‌شات از طریق افزونه مرورگر.", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TaskQuickCaptureApiView", "curl": "curl -X GET \"https://example.com/api/v1/tasks/quick-capture/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\"" }, { "method": "POST", "path": "/api/v1/tasks/quick-capture/", "summary": "اندپوینت ثبت آنی وظیفه و پیوست اسکرین‌شات از طریق افزونه مرورگر.", "description": "اندپوینت ثبت آنی وظیفه و پیوست اسکرین‌شات از طریق افزونه مرورگر.", "tag": "tasks", "parameters": [], "request_body": {}, "responses": [ { "code": "200", "description": "پاسخ موفق" } ], "auth": "Session (کوکی) / Bearer Token", "source": "Live Route", "view_name": "TaskQuickCaptureApiView", "curl": "curl -X POST \"https://example.com/api/v1/tasks/quick-capture/\" \\\n -H \"Accept: application/json\" \\\n -H \"Cookie: sessionid=YOUR_SESSION_ID\" \\\n -H \"X-CSRFToken: YOUR_CSRF_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"نمونه تستی\"}'" } ] }