Get Application Uninstall Result

Tool Name: Not defined in the current tool contract

Risk Level: Read

Execution Mode: Synchronous

Category: Device Management

Quick Start (Copy & Use)

Summary: Read a paginated, per-device snapshot for an application uninstall task.

Prerequisites: Positive integer HistoryId returned by Uninstall Application.

Success Criteria: Succeeded == true and ErrorMessage is empty. This confirms a valid result page, but devices may still be Processing.

What to Do Next: Read later pages when Pagination.page_index < Pagination.last_page; poll PageIndex 1 while Counts.processing_count is nonzero.

Minimal Request Example:

{
  "HistoryId": 710245,
  "PageIndex": 1,
  "PageSize": 20
}

Minimal Response Example:

{
  "HistoryId": 710245,
  "Counts": {"target_count": 1, "processing_count": 1, "succeeded_count": 0, "failed_count": 0},
  "Results": [{"device": {"device_id": "a8f3d91c72b44e5fa103c892d0b74561", "name": "Warehouse Tablet 01", "group_id": 4103, "model": "DT200", "platform": "Android", "online": "Online"}, "status": "Processing", "failure_reason": null, "updated_at": null}],
  "Pagination": {"total": 1, "page_size": 20, "page_index": 1, "last_page": 1},
  "Succeeded": true,
  "ErrorCode": "",
  "Hint": "",
  "Retryable": false,
  "OriginalStatusCode": 200,
  "StatusCode": 200,
  "ErrorMessage": ""
}

Recipes (Common Recipes)

Recipe 1: First Result Page

When to use: Immediately after Uninstall Application returns an accepted HistoryId.

{
  "HistoryId": 710245,
  "PageIndex": 1,
  "PageSize": 20
}

Recipe 2: Next Page

When to use: The first response has page_index < last_page.

{
  "HistoryId": 710245,
  "PageIndex": 2,
  "PageSize": 20
}

Recipe 3: Poll Active Devices

When to use: Counts.processing_count is greater than zero.

{
  "HistoryId": 710245,
  "PageIndex": 1,
  "PageSize": 20
}

The contract's polling guidance is to read page 1 after 5 seconds, then after 10, 20, and 30 seconds; stop when processing_count is zero or after 10 minutes.

1. Overview

1.1 Description

Reads per-device application uninstall results for one accepted task with explicit pagination.

1.2 When to Use

• Track device-side completion after Uninstall Application.
• Identify Failed rows and their failure_reason.
• Read every result page for a large active-device snapshot.

1.3 Execution Mode and Response

This is a synchronous, idempotent read. Succeeded=true means a valid page was returned, not that every device succeeded. Counts and Results are active-device snapshots and can change while devices report progress.

1.4 Prerequisites

1.5 Prerequisite Tools

1.6 Similar Tools

Do not use this tool for Organization App Library distribution status; use List Organization App Library Distribution Status for that different workflow.

2. Inputs

2.1 Parameter List

2.2 Parameter Details

`HistoryId`

Pass the positive task receipt from Uninstall Application. A task that is not found or not visible returns ErrorCode UNINSTALL_TASK_NOT_FOUND.

`PageIndex` and `PageSize`

Both must be positive integers. Use Pagination.last_page from a successful response to request further pages. PageSize greater than 100 is invalid.

2.3 Parameter Combination Logic

Use the same HistoryId across pages. Results are sorted by device.device_id ascending, while counts describe the visible active-device snapshot for the task.

3. Outputs

3.1 Response Examples

The Quick Start response shows a valid page that still has a Processing device.

Invalid page size:

{
  "HistoryId": 0,
  "Counts": {},
  "Results": [],
  "Pagination": {},
  "Succeeded": false,
  "ErrorCode": "INVALID_REQUEST",
  "Hint": "Use PageIndex >= 1 and PageSize from 1 to 100.",
  "Retryable": false,
  "OriginalStatusCode": 0,
  "StatusCode": -1,
  "ErrorMessage": "PageIndex or PageSize is invalid."
}

3.2 Field Descriptions

3.3 Status and ErrorCode Values

Results[].status is exactly Processing, Success, or Failed. Possible non-empty ErrorCode values are AUTHENTICATION_FAILED, INVALID_REQUEST, UNINSTALL_TASK_NOT_FOUND, DEVICE_APP_PERMISSION_DENIED, FEATURE_UNAVAILABLE, ACCOUNT_UNAVAILABLE, DEVICE_LIMIT_REACHED, RATE_LIMITED, UNKNOWN_UPSTREAM_ERROR, UPSTREAM_HTTP_ERROR, UPSTREAM_RESPONSE_INVALID, NETWORK_ERROR, and INTERNAL_ERROR.

4. Examples

4.1 Completion Decision

Treat all devices as complete only when Counts.processing_count is 0; then inspect whether Counts.failed_count is also 0.

4.2 Failed Device

A row with status Failed always has a non-empty failure_reason. Use that reason rather than treating Succeeded=true as a device-success signal.

4.3 Active Snapshot

target_count is the visible active-device count at read time. It can change while the task progresses, so do not assume counts from earlier polls are final.

5. Error Handling

5.1 StatusCode Semantics

5.2 Common Error Identities

5.3 Retry Decision

This is read-only and idempotent. Follow Retryable; network errors return NETWORK_ERROR with Retryable=true.

6. Best Practices

6.1 Pagination

Read all pages when last_page exceeds page_index. Do not substitute a different page's result count for the top-level snapshot counts.

6.2 Completion Checks

Use Succeeded to validate the read, processing_count to determine whether devices remain active, and failed_count plus per-device rows to determine outcome quality.

6.3 Idempotency

Idempotent. Repeating an identical successful or retryable read does not alter the uninstall task.

7. Related Tools

8. Tool Chains

8.1 Submit and Poll Per-Device Status

Uninstall Application -> Get Application Uninstall Result

Pass HistoryId from the submission, poll page 1 while processing remains, and paginate any additional result pages.