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

Batch Perform Action

Description

Perform an action on a batch of templates

Request

Request

URL

URL


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

Query Parameters

Query Parameters

string
action Required

Action to perform. Ex: RESYNC, RETRY_PROVISIONING


Request Body

Request Body

TemplateQueryTOV1 of mimetype application/json Required

queryV1TO

{
	"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


201 Created

Created


202 Accepted Response Body>

Response Body

202 Accepted

Returns TemplateBatchResponseTO of type */*

Accepted the request to perform action on 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


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

ErrorResponse
400

Bad request


ErrorResponse
401

Unauthorized


ErrorResponse
403

Forbidden


404

Not Found

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"ids":["string"],"orgId":"string","search":"string"}' https://cloud.vmwarehorizon.com/admin/v2/batch/templates?action=string
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?