• Tools
Tools
  • Tools
loading...
No Results
  • ActiveCampaign
  • AirDroid Business
    • Index
    • Batch Resolve Device and Group IDs by Name
    • Batch Resolve Device IDs by Name
    • Batch Resolve Group IDs by Name
    • Batch Get Devices by Device or Group IDs
    • Clear app data and cache
    • Create a group
    • Delete groups
    • Delete Provisioning Templates
    • Disable lost mode
    • Error codes
    • Enable lost mode
    • Field reference
    • Get average screen time
    • Get account activities
    • Get a Configuration
    • Get a device by name
    • Get a device app by name
    • Get a group
    • Get a group id by group name
    • Get a Provisioning Template
    • Get an activity log
    • Get all devices
    • Get all device apps
    • Get all devices with filter
    • Get Config File Deployment Status
    • Get device info push
    • Get device location report
    • Get device network connection history
    • Get device application usage duration
    • Get device application report
    • Get device online status report
    • Get device remote access report
    • Get data usage overview and trends
    • Get tag ids by tag names
    • Get top 10 apps by usage duration
    • Get top 10 data usage apps
    • Generate Device Owner Enrollment QR for Template
    • List Groups
    • List Policy and Kiosk Configurations
    • List Provisioning Templates
    • Lock a device
    • Move devices to a group
    • Open app to foreground
    • Power off a device
    • Reboot device
    • Remote operation
    • Search Groups
    • Set tags
    • Turn off device screen
    • Unenroll a device
    • Update a device name
    • Update a device remark
    • Update a group name
    • Update a group remark
    • Retry Organization App Library Distribution
    • Search Organization App Library Applications
    • Batch Set Device Tags
    • Search Batch Operation Activity Logs
    • Search File Batch Delete Results
    • Search File Batch Send Results
    • Batch Delete Files
    • Batch Send Files
    • Batch Clear App Data and Cache
    • Move Groups to a Group
    • List Organization App Library Distribution Status
    • Get Application Uninstall Result
    • Get Device Daemon Permissions
    • Create Tags
    • Uninstall Application
    • List Organization App Library Applications
    • Delete Tag
    • Batch Upload Qiniu Files
    • Search File Batch Upload Results
    • Retry Batch Qiniu File Upload
  • Adalo
  • Appstore
  • Asana
  • AWS Lambda
  • AWS-S3
  • BambooHR
  • Bitbucket
  • Brevo
  • Clockify
  • Coda
  • ConvertKit
  • DingTalk
  • Discord
  • Discourse
  • Dropbox
  • Elasticsearch
  • Elastic Security
  • FeiShu
  • Firecrawl
  • Freshdesk
  • Freshservice
  • Freshworks CRM
  • Gerrit
  • Github
  • Gitlab
  • Google Ads
  • Google Analytics
  • Google Calendar
  • Google Developer
  • Google Docs
  • Google Drive
  • Google Gmail
  • Google Sheets
  • Grafana
  • Hacker News
  • HaloPSA
  • Harvest
  • Help Scout
  • Hubspot
  • Intercom
  • Jenkins
  • Jira
  • Kafka
  • Lemlist
  • Linear
  • Magento
  • MailChimp
  • Mautic
  • Metabase
  • Microsoft Excel
  • Microsoft OneDrive
  • Microsoft Outlook
  • Microsoft Sharepoint
  • Microsoft Teams
  • Microsoft To Do
  • monday.com
  • MySQL
  • Nextcloud
  • Notion
  • Odoo
  • Okta
  • OpenAI
  • Ortto
  • Paddle
  • PayPal
  • Pipedrive
  • PostgreSQL
  • PostHog
  • Qdrant
  • QuickBooks
  • Redis
  • Segment
  • SendGrid
  • ServiceNow
  • Shopify
  • Slack
  • Splunk
  • Spotify
  • Strapi
  • Stripe
  • System Tools
    • Code
    • CSV
    • Crypto
    • Data Shaping
    • Date & Time
    • Delay
    • Documents
    • QRCode
    • Search&Crawl
    • Text
    • Xml
  • Teambition
  • Telegram
  • Todoist
  • Trello
  • Twilio
  • Webflow
  • Wekan
  • Wikipedia
  • WooCommerce
  • WordPress
  • X
  • YouTube
  • Zammad
  • Zendesk
  • Zoho CRM
  • Zoom
  • Zulip
Home > Tools > AirDroid Business

Search File Batch Delete Results

Tool Name: airdroid_business_file_batch_delete_result_search

Risk Level: Low Risk

Execution Mode: Synchronous

Category: File Management

Quick Start

In one sentence: Read one page of per-device deletion results for an existing batch-delete task.

What you need: TaskId returned by Batch Delete Files. It must be an 8-4-4-4-12 hexadecimal UUID with hyphens.

Success criteria: ErrorMessage is empty. Also inspect every returned Devices[].status; accepted deletion is not proof that every device deleted the requested path.

What to do next: If Pagination.page_index < Pagination.last_page, request the next page with a larger PageIndex; otherwise inspect result rows that are not Success.

Minimal request example:

{
  "TaskId": "6a4d712e-ec25-4f58-9a52-1b0ac97b840d"
}

Minimal response example:

{
  "Task": {
    "task_id": "6a4d712e-ec25-4f58-9a52-1b0ac97b840d",
    "task_name": "Remove superseded price list",
    "created_at": "2026-07-20 11:20:08",
    "summary": {
      "succeeded": 2,
      "failed": 0,
      "distributing": 0,
      "warned": 0
    }
  },
  "Devices": [
    {
      "device_id": "a8f3d91c72b44e5fa103c892d0b74561",
      "device_name": "Chicago Warehouse Tablet 01",
      "status": "Success",
      "pushed_at": "2026-07-20 11:20:16"
    }
  ],
  "Pagination": {
    "total": 2,
    "page_size": 100,
    "page_index": 1,
    "last_page": 1
  },
  "Hint": "",
  "Retryable": false,
  "OriginalStatusCode": 200,
  "StatusCode": 200,
  "ErrorMessage": ""
}

Recipes

Recipe 1: Read the First Result Page

When to use: Batch Delete Files returned an accepted TaskId and you need the current per-device deletion rows.

{
  "TaskId": "6a4d712e-ec25-4f58-9a52-1b0ac97b840d",
  "PageIndex": 1,
  "PageSize": 100,
  "Filter": {}
}

Recipe 2: Request the Next Page

When to use: A prior successful response reports Pagination.page_index lower than Pagination.last_page.

{
  "TaskId": "6a4d712e-ec25-4f58-9a52-1b0ac97b840d",
  "PageIndex": 2,
  "PageSize": 100,
  "Filter": {}
}

Use the same task and filter with the next 1-based page number. A PageIndex greater than the returned last_page is rejected with StatusCode -1; the tool does not clamp it.

Recipe 3: Inspect Devices Whose Paths Cannot Be Found

When to use: You want the rows whose deletion status is exactly Can't find files path.

{
  "TaskId": "6a4d712e-ec25-4f58-9a52-1b0ac97b840d",
  "PageIndex": 1,
  "PageSize": 100,
  "Filter": {
    "status": "Can't find files path"
  }
}

1. Overview

1.1 Description

This read-only tool returns a paginated snapshot of per-device deletion results for one batch-delete task. It does not create, cancel, or run a batch delete.

1.2 When to Use

  • Check the current deletion results for a batch-delete task.
  • Find devices in a supported deletion status, such as Processing or Can't find files path.
  • Read additional result pages for the same task.

Do not use this tool to start a delete or to query another task type.

1.3 Execution Mode and Response

This is a synchronous read. It returns the current Task, one page of Devices, and Pagination immediately. It does not automatically retrieve every page.

1.4 Prerequisites

Condition Description
Credential The AirDroid Business credential must be available and authorized for the query.
Matching task TaskId must come from the accepted response of Batch Delete Files.

1.5 Prerequisite Tool

Tool Purpose Required
Batch Delete Files Creates the batch-delete task and returns TaskId. Yes

1.6 Scope

Use this tool only with the TaskId from a batch-delete task.

2. Inputs

2.1 Parameter List

Parameter Type Required Default Description
TaskId string Yes "" UUID returned by Batch Delete Files.
PageIndex number No 1 1-based result-page index.
PageSize number No 100 Number of rows per page, from 1 through 200.
Filter object No Not defined Optional structured result filter. The runtime also accepts a JSON-encoded object string.

2.2 Parameter Details

`TaskId`

Use the TaskId field returned by Batch Delete Files after task acceptance.

  • Type: string
  • Format: UUID with 8-4-4-4-12 hexadecimal groups separated by hyphens
  • Invalid format: returns StatusCode -1
  • No matching delete task: returns a non-empty ErrorMessage; it can still have StatusCode 200

`PageIndex`

PageIndex is 1-based and defaults to 1. It must be a whole number greater than or equal to 1. Zero, negative, decimal, and non-integer values return StatusCode -1.

`PageSize`

PageSize defaults to 100 and must be a whole number from 1 through 200. Values outside that range, decimal values, and invalid values return StatusCode -1; they are not silently replaced by the default.

`Filter`

The DSL type is object. The runtime accepts either an object or a string containing a JSON object. Omit it, use {}, or use an empty string for no filter; results remain paginated. Its fields narrow the request only and are not added to Devices[].

For a string value, malformed JSON returns StatusCode -1, ErrorMessage Filter must be a JSON object., and Retryable false. A JSON-encoded value that decodes to a non-object (such as []) is treated as no filter, not as a validation error. A raw value that is neither a string nor an object returns the same Filter must be a JSON object. validation error. An object that cannot be JSON-serialized returns Filter is not JSON-serializable. with StatusCode -1.

Supported fields are status, device_id, device_name, group_id, and group_name.

  • Use a plain value, eq, or in for status.
  • Use eq for one exact value.
  • Use in for status or ID lists.
  • Use like for a case-insensitive name substring on device_name or group_name.
  • A bare value such as {"device_name":"Kiosk"} is an exact match, not a fuzzy match.
  • status must exactly match a device row status, not console labels such as Succeeded, Distributing, Warned, or Path Not Found.
  • All removes status filtering.

Supported status values:

Value
Success
Processing
Files/Folders do not exist
Failed
Failed to connect device
Unknown error, please contact the support team
Can't find files path
Storage permission has not been granted to Biz Daemon
Cannot delete files from Android 4.4 devices
No SD card

Examples:

{
  "device_name": {
    "like": "Kiosk"
  },
  "group_name": {
    "eq": "Warehouse"
  }
}

2.3 Parameter Combination Logic

TaskId is required. PageIndex, PageSize, and Filter are optional. Filtered results are still paginated. When a successful response has more pages, increment PageIndex while keeping the same task and intended filter.

3. Outputs

3.1 Response Examples

The Quick Start response is a successful query response.

Validation error response:

{
  "Task": {},
  "Devices": [],
  "Pagination": {},
  "OriginalStatusCode": 0,
  "StatusCode": -1,
  "ErrorMessage": "TaskId format is invalid.",
  "Hint": "Use the UUID TaskId returned by 'Batch Delete Files' (8-4-4-4-12 hex with hyphens).",
  "Retryable": false
}

3.2 Field Descriptions

Field Type Description
Task object Batch-delete task summary.
Task.task_id string Batch-delete task identifier.
Task.task_name string Batch-delete task name.
Task.created_at string Task creation time string.
Task.summary.succeeded number Succeeded device count.
Task.summary.failed number Failed device count.
Task.summary.distributing number Distributing device count.
Task.summary.warned number Warned device count.
Devices object-array Result rows for the requested page.
Devices[].device_id string Unique identifier of the device.
Devices[].device_name string Device name.
Devices[].status string One of the delete-result statuses listed below.
Devices[].pushed_at string Command push time string, or an empty string when unavailable.
Pagination object Pagination metadata.
Hint string Recommended next action after a failure; empty on success.
Retryable bool Whether the same request may be retried after a failure.
OriginalStatusCode number Upstream HTTP status; 0 means no response was received.
StatusCode number Tool result status; always check ErrorMessage as well.
ErrorMessage string Empty when the query succeeds; non-empty on failure.

Devices[] does not include group_id or group_name.

3.3 Status Values

Devices[].status uses the exact values listed for Filter.status in Filter. Do not substitute console labels such as Succeeded, Distributing, Warned, or Path Not Found.

3.4 Pagination

Field Description
Pagination.total Total matching rows.
Pagination.page_size Page size returned by the service.
Pagination.page_index Current 1-based page index.
Pagination.last_page Last available 1-based page index.

Request the next page only when page_index < last_page. PageIndex greater than last_page returns StatusCode -1 with Task, Devices, and Pagination cleared.

4. Examples

4.1 Basic Example: Successful Deletions

{
  "TaskId": "6a4d712e-ec25-4f58-9a52-1b0ac97b840d",
  "PageIndex": 1,
  "PageSize": 100,
  "Filter": {
    "status": "Success"
  }
}

An empty ErrorMessage means the query completed. The Success filter does not prove that unreturned pages or nonmatching devices also deleted their requested paths.

4.2 Advanced Example: Filter by Group Name

{
  "TaskId": "6a4d712e-ec25-4f58-9a52-1b0ac97b840d",
  "PageIndex": 1,
  "PageSize": 100,
  "Filter": {
    "group_name": {
      "eq": "Warehouse"
    }
  }
}

group_name narrows the device list server-side but is not returned in Devices[].

4.3 Error Example: Wrong Task Type or Unknown Task

Use only the UUID returned by Batch Delete Files. A UUID that does not identify a matching delete task returns empty Task, Devices, and Pagination, with a non-empty ErrorMessage and a Hint. This business failure can have StatusCode 200, so do not treat StatusCode alone as success.

5. Error Handling

5.1 StatusCode Semantics

StatusCode Meaning Agent action
-1 Input validation failed. Correct the request; do not retry it unchanged.
200 with empty ErrorMessage The query succeeded. Inspect the current page and its pagination.
200 with non-empty ErrorMessage A business failure, including a task that does not exist. Follow Hint; correct the task or access condition before retrying.
500 Upstream HTTP, timeout, network, or unexpected tool failure. Use Retryable and Hint to decide whether to retry.

5.2 Caller-Visible Errors

StatusCode and ErrorMessage Cause Caller-visible recovery
-1; access_token is required. The credential is missing or blank. Hint is Re-authorize the AirDroid Business credential.; Retryable is false and OriginalStatusCode remains 0.
-1; TaskId is required. No task ID was supplied. Provide the TaskId from Batch Delete Files.
-1; TaskId must be a string. The task ID is not text. Provide the UUID as a string.
-1; TaskId format is invalid. The value is not a UUID in the required format. Use the returned Batch Delete Files UUID.
-1; PageIndex is invalid. The page index is not a whole positive number. Use a 1-based whole number.
-1; PageSize is invalid. The page size is not a whole number in range. Use a whole number from 1 through 200.
-1; PageSize <value> exceeds the maximum (200). PageSize is a whole number above the maximum. Use a value from 1 through 200; Retryable is false.
-1; Filter must be a JSON object. Filter is malformed JSON or is a raw value other than a string or object. Provide an object or a JSON-encoded object string such as {"status":"Success"}; Retryable is false.
-1; Filter is not JSON-serializable. An object filter has non-JSON-compatible keys or values. Use string keys and JSON-compatible values; Retryable is false.
-1; PageIndex <value> exceeds last_page (<value>). The requested page is past the returned last page. Use a page from 1 through Pagination.last_page; Task, Devices, and Pagination are cleared.
200; The specified task does not exist. or a service-provided task-not-found message The task is missing or is not a matching batch-delete task. Read Hint, use the returned TaskId from Batch Delete Files, and do not retry unchanged; Retryable is false.
200; You do not have permission to perform this action. or a service-provided permission message The credential lacks required permission or resource scope. Read Hint, request the required permission or scope, then retry; Retryable is false.
200; The file batch service could not complete this query. or another service-provided business error message The service returned a business failure. Read Hint; retry only when its Retryable field permits it.
500; Upstream HTTP <status>. The upstream service returned a non-200 HTTP response. Read Hint. Retryable is true only for HTTP 429, 500, 502, 503, or 504; it is false for other statuses. OriginalStatusCode is the upstream status.
500; Request timed out after 60 seconds. The request timed out. Hint requests a retry and connectivity check; Retryable is true and OriginalStatusCode is 0.
500; Network request failed before a usable response was received. The network request failed before a usable response. Hint requests a retry and connectivity check; Retryable is true and OriginalStatusCode is 0.
500; Unexpected tool error. An unexpected tool failure occurred, including an unusable success-body shape. Follow Hint; Retryable is false.

5.3 Retry Decision

This read-only query is idempotent. Do not infer retry eligibility from StatusCode alone: use the returned Retryable and Hint. A wrong TaskId or a task-not-found result is not retryable.

6. Best Practices

6.1 Preserve the Accepted TaskId

Store the TaskId from the Batch Delete Files acceptance response and use it unchanged as text. Task creation is not proof that a path was deleted.

6.2 Keep Responses Focused

Use Filter and a suitable PageSize within 1 through 200 to retrieve only the result rows needed for inspection. The tool always returns one page.

6.3 Interpret Results Per Device

Treat Task.summary as counts and Devices[].status as the per-device result. Inspect the complete intended page set before concluding a batch-wide outcome.

7. Related Tools

Tool Purpose
Batch Delete Files Creates the batch-delete task and returns the required TaskId.

No additional related-tool chain is defined for this query.

8. Tool Chains

8.1 Submit and Inspect Deletion Results

Batch Delete Files -> Search File Batch Delete Results

Pass Batch Delete Files.TaskId to this tool, then inspect the paginated Devices[] deletion rows.

Updated on: Aug 5, 2026
Was This Page Helpful?
Prev Search Batch Operation Activity Logs
Next Search File Batch Send Results
Discussion

Leave a Reply. Cancel reply

Your email address will not be published. Required fields are marked*

Product-related questions?Contact Our Support Team to Get a Quick Solution>
On this page
  • Quick Start
  • Recipes
    • Recipe 1: Read the First Result Page
    • Recipe 2: Request the Next Page
    • Recipe 3: Inspect Devices Whose Paths Cannot Be Found
  • 1. Overview
    • 1.1 Description
    • 1.2 When to Use
    • 1.3 Execution Mode and Response
    • 1.4 Prerequisites
    • 1.5 Prerequisite Tool
    • 1.6 Scope
  • 2. Inputs
    • 2.1 Parameter List
    • 2.2 Parameter Details
    • 2.3 Parameter Combination Logic
  • 3. Outputs
    • 3.1 Response Examples
    • 3.2 Field Descriptions
    • 3.3 Status Values
    • 3.4 Pagination
  • 4. Examples
    • 4.1 Basic Example: Successful Deletions
    • 4.2 Advanced Example: Filter by Group Name
    • 4.3 Error Example: Wrong Task Type or Unknown Task
  • 5. Error Handling
    • 5.1 StatusCode Semantics
    • 5.2 Caller-Visible Errors
    • 5.3 Retry Decision
  • 6. Best Practices
    • 6.1 Preserve the Accepted TaskId
    • 6.2 Keep Responses Focused
    • 6.3 Interpret Results Per Device
  • 7. Related Tools
  • 8. Tool Chains
    • 8.1 Submit and Inspect Deletion Results
loading...
No Results