[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Batch Delete

Description

Delete a batch of templates

Request

Request

URL

URL


delete
https://cloud.vmwarehorizon.com/admin/v2/batch/templates
Copy

Query Parameters

Query Parameters

boolean
force Optional

If true, deletes despite potential clean-up errors


string
org_id Optional

Organization ID: non-super users can only access their own organization


Request Body

Request Body

TemplateQueryTOV1 of mimetype */* Required

templateQueryV1

{
	"orgId": "string"
}
string
orgId Required

The org ID of templates to query. This is required


array of string
ids Optional

List of template IDs to query. Use this, or ‘search’


string
search Optional

Standard syntax search for querying templates. Use this, or ‘ids’

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

200 OK Response Body>

Response Body

200 OK

Returns TemplateBatchResponseTO of type */*
{
    "errors": "templateId, ErrorDetail",
    "results": "templateId, TemplateTOV2"
}
map of ErrorDetail
errors Optional

Templates where action was unsuccessful


map of TemplateTOV2
results Optional

Templates where action was successful


202 Accepted Response Body>

Response Body

202 Accepted

Returns TemplateBatchResponseTO of type */*

Accepted the request to delete the templates without any issues. Response holds the templates with modified status.

{
    "errors": "templateId, ErrorDetail",
    "results": "templateId, TemplateTOV2"
}
map of ErrorDetail
errors Optional

Templates where action was unsuccessful


map of TemplateTOV2
results Optional

Templates where action was successful


204 No Content

No Content


207 Response Body>

Response Body

207

Returns TemplateBatchResponseTO of type */*

Mixed results. Response holds successful templates as well as failed templates.

{
    "errors": "templateId, ErrorDetail",
    "results": "templateId, TemplateTOV2"
}
map of ErrorDetail
errors Optional

Templates where action was unsuccessful


map of TemplateTOV2
results Optional

Templates where action was successful

Errors

Errors

400

Bad request


401

Unauthorized


403

Forbidden

Code Samples

Code Samples

cURL Command

curl -X DELETE -H "Content-Type: */*" -d '{"ids":["string"],"orgId":"string","search":"string"}' https://cloud.vmwarehorizon.com/admin/v2/batch/templates
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: templateQueryV1


Feedback

Was this page helpful?