Get a Provisioning Template

Tool Name: airdroid_business_provisioning_template_get

Risk Level: 🟢 Low Risk

Execution Mode: ⚡ Synchronous

Category: Provisioning Templates

Quick Start (Copy & Use)

Summary: Retrieve the full configuration of a single provisioning template (enrollment template) by ProvisioningId, including language/timezone presets, group/policy/WiFi associations, pre-installed apps, deployment code, and QR configuration code.

Prerequisites: ProvisioningId (positive integer ≥ 1) — obtain via List Provisioning Templates. A valid OAuth2 AccessToken configured in the GI node Credential.

Success Criteria: StatusCode == 200 and ErrorMessage == ""; the Provisioning object is non-empty.

What to Do Next: Use Provisioning.configuration_code / packapk_progress to decide whether Generate Device Owner Enrollment QR for Template can run; use deploy_code for Windows enrollment.

Minimal Request Example (recommended to copy directly):

{
  "ProvisioningId": 100
}

Minimal Response Example:

{
  "Provisioning": {
    "provisioning_id": 100,
    "owner_id": 10001,
    "account_id": 20001,
    "is_default": "No",
    "name": "Standard Template",
    "description": "Standard provisioning template for field devices",
    "default_language": "en",
    "default_timezone": "America/New_York",
    "release_type": "Group",
    "install_by_wifi": "Yes",
    "enable_system_apps": "No",
    "platform_type": "Android",
    "packapk_progress": "Package ready",
    "group_id": 123,
    "policy_id": 0,
    "wifi_id": 0,
    "group": {
      "id": 123,
      "name": "Field Devices",
      "owner_id": 10001,
      "create_date": "2024-01-01 00:00:00",
      "update_date": "2024-06-15 10:30:00",
      "is_default": "No",
      "deploy_code": "ABC123XYZ",
      "pid": 0,
      "remark": "Field devices group"
    },
    "deploy_code": "DEPLOY001",
    "install_apps": [],
    "configuration_code": "CONFIG001",
    "create_time": "2024-06-15 10:30:00",
    "update_time": "2024-12-01 14:20:00"
  },
  "Hint": "",
  "Retryable": false,
  "OriginalStatusCode": 200,
  "StatusCode": 200,
  "ErrorMessage": ""
}

> ⚠️ Value format: is_default, install_by_wifi, and enable_system_apps return "Yes" or "No" strings (not booleans). release_type returns Group or Policy, and platform_type returns values such as Android or Windows.

Recipes (Common Recipes)

Recipe 1: Inspect a Template's Full Settings

When to use: You have a ProvisioningId from List Provisioning Templates and need the full configuration (language, timezone, WiFi, group/policy association, pre-installed apps).

{
  "ProvisioningId": 17563
}

Recipe 2: Check QR Readiness Before Generating an Enrollment QR

When to use: Before calling Generate Device Owner Enrollment QR for Template, verify that configuration_code is available. Inspect platform_type, packapk_progress, and configuration_code in the response — the QR can only be generated when configuration_code is non-empty (Android templates with packapk_progress = "Package ready").

{
  "ProvisioningId": 100
}

Recipe 3: Verify Template Settings Before Modifying or Deleting

When to use: Confirm the template's name, is_default, and associations before a destructive action such as Delete Provisioning Templates (default templates cannot be deleted).

{
  "ProvisioningId": 17562
}

1. Overview

1.1 Description

Get the full configuration of a single provisioning template by ProvisioningId. A provisioning template is an enrollment template used to pre-configure device settings (language, timezone, WiFi, group or policy association, pre-installed apps) during device enrollment.

1.2 When to Use

• Inspect a template's full settings: language, timezone, WiFi, group/policy association, pre-installed apps
• Verify current settings before modifying them
• Confirm template existence and QR readiness before generating a Device Owner enrollment QR

Don't use when: you don't have the ProvisioningId — call List Provisioning Templates first to obtain it.

1.3 Execution Mode and Response

This operation is synchronous and returns results immediately:

• Provisioning: Template detail object (empty object {} when no matching record is found or the record does not belong to the current enterprise)
• StatusCode / ErrorMessage / Hint / Retryable / OriginalStatusCode: Call status and error information

1.4 Prerequisites

1.5 Prerequisite Tools

1.6 Differences from Similar Tools

2. Inputs

2.1 Parameter List

2.2 Parameter Details

`ProvisioningId`

Provisioning template unique identifier.

• Type: number
• Required: Yes
• Format: Positive integer greater than 0 (minimum value 1). Any other value returns StatusCode = -1 with ErrorMessage = "Invalid provisioning_id, must be a positive integer greater than 0."
• Source: The provisioning_id field of items returned by List Provisioning Templates
• How to fill in GI node:
  • Constant: Enter the numeric ID directly, e.g. 17563
  • Upstream reference: Use ProvisioningList[0].provisioning_id from a List Provisioning Templates node output
• Example:

17563

2.3 Parameter Combination Logic

ProvisioningId is the only business input; there are no combination rules.

3. Outputs

3.1 Response Example

Success response: see the Quick Start minimal response example above.

Error response (template not found):

{
  "Provisioning": {},
  "Hint": "Provisioning template was not found; obtain provisioning_id via 'List Provisioning Templates' and retry.",
  "Retryable": false,
  "OriginalStatusCode": 200,
  "StatusCode": 200,
  "ErrorMessage": "Provisioning template not found."
}

Error response (invalid parameter):

{
  "Provisioning": {},
  "Hint": "Obtain provisioning_id via 'List Provisioning Templates', then provide a valid provisioning_id and retry.",
  "Retryable": false,
  "OriginalStatusCode": 0,
  "StatusCode": -1,
  "ErrorMessage": "Invalid provisioning_id, must be a positive integer greater than 0."
}

3.2 Field Descriptions

3.3 Status Code / Enum Value Mapping

4. Examples

4.1 Basic Example: Get a Template by ID

Request Parameters:

{
  "ProvisioningId": 100
}

Response: see the Quick Start minimal response example.

4.2 Advanced Example: Check QR Readiness

Request Parameters:

{
  "ProvisioningId": 100
}

Decision logic on the response:

• platform_type == "Windows" → no enrollment QR; use deploy_code instead
• platform_type == "Android" and packapk_progress != "Package ready" → wait and re-check; configuration_code will be empty
• configuration_code non-empty → safe to call Generate Device Owner Enrollment QR for Template

4.3 Error Example: Invalid ProvisioningId

Request Parameters (error — zero is not allowed):

{
  "ProvisioningId": 0
}

Response:

{
  "Provisioning": {},
  "Hint": "Obtain provisioning_id via 'List Provisioning Templates', then provide a valid provisioning_id and retry.",
  "Retryable": false,
  "OriginalStatusCode": 0,
  "StatusCode": -1,
  "ErrorMessage": "Invalid provisioning_id, must be a positive integer greater than 0."
}

5. Error Handling

5.1 AB Three-Layer Error Codes

This Action's StatusCode semantics: upstream HTTP errors (including 4xx such as 401/403/404) are returned as StatusCode = 500 with ErrorMessage = "HTTP error: ..." and Retryable = false (only HTTP 500/502/503/504 set Retryable = true; HTTP 429 also maps to 500 with Retryable = true). Use OriginalStatusCode to see the real HTTP code — do not blind-retry on StatusCode = 500.

5.2 Common Errors

5.3 Agent Self-Healing Decision Table

6. Best Practices

6.1 Performance Optimization

• Read operation; response size is bounded by the single template's configuration. No pagination is involved.
• Cache the ProvisioningId from List Provisioning Templates rather than re-listing before every detail call.

6.2 Security Considerations

🟢 Read operation: No destructive side effects. Note that deploy_code and configuration_code are enrollment secrets — anyone with them can enroll devices into your organization, so avoid exposing them in logs or messages unnecessarily.

6.3 Idempotency

Idempotency: Naturally idempotent. Read-only; multiple calls with the same ProvisioningId return the same result (unless the template is modified in between).

7. Related Tools

7.1 Prerequisite Tools

7.2 Follow-up Tools

7.3 Similar Tool Comparison

8. Tool Chains

8.1 Find a Template and Inspect Its Configuration

Scenario: You know part of the template name and need its full settings.

Tool Chain:

List Provisioning Templates → Get a Provisioning Template

Steps:

1. Call List Provisioning Templates with Name = "Standard" to find matching templates
2. Take ProvisioningList[0].provisioning_id
3. Call Get a Provisioning Template with that ID and inspect the full configuration

8.2 Verify QR Readiness Then Generate the Enrollment QR

Scenario: Produce a Device Owner enrollment QR for an Android template.

Tool Chain:

Get a Provisioning Template → Generate Device Owner Enrollment QR for Template

Steps:

1. Call Get a Provisioning Template and check platform_type, packapk_progress, configuration_code
2. If packapk_progress == "Package ready" and configuration_code is non-empty, call Generate Device Owner Enrollment QR for Template with the same ProvisioningId

Appendix Reference:

• Field Reference: ./Field Reference.md
• Error Code Quick Reference: ./Error Codes.md