getResponseActionStatus: хариу арга хэмжээний төлөвийг лавлах API арга

Энэ аргыг хариу арга хэмжээний (response action) төлөв болон үр дүнг лавлахад ашиглана.

Параметрүүд

• actionId — createResponseAction аргаас буцаасан арга хэмжээний ID; хүсэлтэд заавал орно; төрөл: String; утга нь 24 тэмдэгтийн арван зургаатын (hexadecimal) мөр байх ёстой. Жишээ: "actionId": "6912758f88df334ddbfb7e1a"

Бүх public API аргад нийтлэг параметрүүд

• id — хүсэлтийг хариутай нь холбох таниулагч. Хүлээн авагч хариунд ижил утгыг буцаадаг тул дуудлагыг амархан мөрдөнө; хүсэлтэд заавал орно; төрөл: String; нэмэлт шаардлага байхгүй. Жишээ: "id": "ad12cb61-52b3-4209-a87a-93a8530d91cb"
• method — хүсэлт илгээж буй аргын нэр; хүсэлтэд заавал орно; төрөл: String; зөв аргын нэр байх ёстой. Жишээ: "method": "methodName"
• jsonrpc — хүсэлт ба хариуд хэрэглэх JSON-RPC-ийн хувилбар; хүсэлтэд заавал орно; төрөл: String; цорын ганц боломжит утга нь 2.0. Жишээ: "jsonrpc": "2.0"
• params — хүсэлтийн тохиргоог агуулсан объект; хүсэлтэд заавал орно; төрөл: Object; нэмэлт шаардлага байхгүй. Жишээ: "params": {...}

Буцаах утга

• type — Integer; авсан арга хэмжээний төрөл болон түүнийг ямар төрлийн хэрэглэгчид хэрэглэснийг заана. Боломжит арга хэмжээ:

- 1 - Microsoft 365 (Office 365) эсвэл Entra ID (Azure AD) хэрэглэгчийн нэвтрэх мэдээллийг шинэчлэх.
- 2 - Active Directory хэрэглэгчийн нэвтрэх мэдээллийг шинэчлэх.
- 3 - Microsoft 365 (Office 365) эсвэл Entra ID (Azure AD) хэрэглэгчийг идэвхгүй болгох.
- 4 - Байгууллагын дотоод (on-premises) Active Directory хэрэглэгчийг идэвхгүй болгох.
- 5 - Microsoft 365 (Office 365) эсвэл Entra ID (Azure AD) хэрэглэгчийг эвдэрсэн (compromised) гэж тэмдэглэх.
- 6 - Microsoft 365 (Office 365) хэрэглэгчийн и-мэйлийг устгах.
- 8 - Google хэрэглэгчийг идэвхгүй болгох.
- 9 - Google хэрэглэгчийн нэвтрэх мэдээллийг шинэчлэх.
- 10 - Microsoft 365 (Office 365) OneDrive эсвэл SharePoint файлыг устгах.
- 11 - Microsoft 365 (Office 365) хэрэглэгчээс жишиг и-мэйлтэй төстэй и-мэйлүүдийг устгах.
- 12 - AWS хэрэглэгчийг идэвхгүй болгох.

• generatedOn — String; хариу арга хэмжээг үүсгэсэн цаг.
• status — Integer; хариу арга хэмжээний төлөв. Боломжит утгууд:

- 0 - Эхлээгүй (Not started)
- 1 - Гүйцэтгэхээр хүлээгдэж буй (To be executed)
- 2 - Хүлээгдэж буй (Pending)
- 3 - Гүйцэтгэж буй (In execution)
- 4 - Амжилттай гүйцэтгэсэн (Execution success)
- 5 - Гүйцэтгэл амжилтгүй (Execution failed)
- 6 - Татгалзсан (Dismissed)
- 7 - Гадны арга хэмжээ шаардлагатай (External action needed)
- 8 - Гаднаас хийгдсэн (Done externally)

• errorId — Integer; хариу арга хэмжээ амжилтгүй болсон бол алдааны код.
• errorDescription — String; хариу арга хэмжээ амжилтгүй болсон бол алдааны мессежийн тайлбар.
• incidentId — String; хэрэглэгчийн node-ууд харъяалагдах осол (incident)-ын ID (байвал).
• companyId — String; арга хэмжээ хийгдэж буй компанийн ID.
• userId — String; хариу арга хэмжээг хүссэн хэрэглэгчийн ID.
• userName — String; хариу арга хэмжээг хүссэн хүний хэрэглэгчийн нэр.
• targetUserId — String; хариу арга хэмжээ хэрэглэгдсэн хэрэглэгчийн ID (байвал).
• targetUserName — String; хариу арга хэмжээ хэрэглэгдсэн хэрэглэгчийн нэр (байвал).
• targetEmailId — String; хариу арга хэмжээ авсан и-мэйлийн ID (хамаарах бол).
• outcome — Object; зөвхөн type нь 11 арга хэмжээнд байна. Аль и-мэйлийг амжилттай устгасан, аль устгал түр зуур эсвэл бүрмөсөн амжилтгүй болсныг заах ба тохиолдсон бүх алдааны мэдээллийг агуулна. Дэлгэрэнгүйг доорх outcome хэсгээс үзнэ үү.

Объектууд

outcome

• failedRetriableIds — Array of Strings; эрх хүрэлцэхгүй, эсвэл эрхийн түлхүүр буруу зэрэг шалтгаанаар устгаж чадаагүй и-мэйлүүдийн ID. Эдгээр и-мэйлд Delete similar emails үйлдлийг дахин оролдож болно.
• failedPermanentIds — Array of Strings; и-мэйл байхаа больсон зэрэг байнгын шалтгаанаар устгаж чадаагүй и-мэйлүүдийн ID. Эдгээр и-мэйлд Delete similar emails үйлдлийг дахин оролдсон нь нөлөөгүй.
• succeededIds — Array of Strings; амжилттай устгасан и-мэйлүүдийн ID.
• errors — Array of Objects; объект бүр дараах тохиргоог агуулж болно:

- errorCode (Integer) - алдааны код.
- errorMessage (String) - алдааны мессеж.
- count (Integer) - тухайн алдаа гарсан и-мэйлийн тоо.

Жишээнүүд

Хүсэлт

{
     "params": {
         "actionId": "6912758f88df334ddbfb7e1a"
     },
     "jsonrpc": "2.0",
     "method": "getResponseActionStatus",
     "id": "7d2864e9-c67b-48a2-9ba3-0a11d47e83c8"
 }

Хариу

 {
     "id": "7d2864e9-c67b-48a2-9ba3-0a11d47e83c8",
     "jsonrpc": "2.0",
     "result": {
         "type": 5,
         "generatedOn": "2023-08-06T23:43:27",
         "status": 3,
         "errorId": null,
         "errorDescription": null,
         "incidentId": "6682758b1f3a95f78dd4cc08",
         "companyId": "5b680f6fb1a43d860a7b23c8",
         "userId": "66b9fd2985ecb7506a0ef3e3",
         "userName": "user@bitdefender.com",
         "targetUserId": "66b9fd2985ecb7506a0ef3ex",
         "targetUserName": "username",
         "targetEmailId": "7d2864e9-c67b-48a2-9ba3-0a11d47e83c8"
     }
 }

{
    "id": "7d2864e9-c67b-48a2-9ba3-0a11d47e83c8",
    "jsonrpc": "2.0",
    "result": {
        "type": 11,
        "generatedOn": "2025-11-07T14:18:28",
        "status": 5,
        "errorId": 916,
        "errorDescription": "Failed to delete all 1 email(s): 0 retriable, 1 permanent",
        "incidentId": "690dfcf70e2bb4042f612f99",
        "companyId": "6837077785c907e4ca044812",
        "userId": "6837077d85c907e4ca044822",
        "userName": "user@bitdefender.com",
        "targetUserId": null,
        "targetUserName": null,
        "targetEmailId": null,
        "outcome": {
            "failedRetriableIds": [],
            "failedPermanentIds": [
                "BBNDADhkNTIyNjYzLTQ1ZmYtNDZlNi1iMjExLWVmZjhlYWRjYzIxNABGAAAAAAB7fiYJE372QbIC-lf_MXEHBwAJPJXoGMjpRYZoFcE4nZMWAAAAAAEPAAAJPJXoGMjpRYZoFcE4nZMWAAPF9SdyAAA="
            ],
            "succeededIds": [],
            "errors": [
                {
                    "errorCode": 916,
                    "errorMessage": "Email not found - may have been already deleted or never existed",
                    "count": 1
                }
            ]
        }
    }
}