Transcoder Transcode

Transcoder Transcode

Transcodes and validates the integrity of a JSON or XML serialized data object.

Transcoding is available from JSON to XML and vice versa. Additionally, the same encoding type can be used both for input and output, which is useful for schema validation as the transcoder service always does schema validation. Accordingly, requests with data objects that do not match the selected {release} are rejected.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/transcoder
COPY
Path Parameters
string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Query Parameters
string
target_release
Optional

The target vSphere release.

The optional target_release query parameter can be used to downgrade the data object to a previous release. According to the rules for backward compatibility, this is achieved by removing all fields that were not present in the target release - and upcasting in case the data object is introduced after the target release.

Request Body

The XML or JSON object to be transcoded. Should be a valid representation of Data Object defined in the 'vim' namespace.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Operation doesn't return any data structure

400

ViTranscoderErrorResponse with error_type InvalidArgument - thrown when invalid header or query params are supplied.

ViTranscoderErrorResponse with error_type InvalidRequest - thrown when an invalid data object is passed as a body parameter.

Returns ViTranscoderErrorResponse of type(s) application/json 
{
    "error_type": "string",
    "error_message": "string"
}
string
error_type
Optional

The type of the error. One of {InvalidArgument, InvalidRequest, SecurityError}.

string
error_message
Optional

The error message.


401

ViTranscoderErrorResponse with error_type SecurityError - thrown when the user is not authenticated.

Returns ViTranscoderErrorResponse of type(s) application/json 
{
    "error_type": "string",
    "error_message": "string"
}
string
error_type
Optional

The type of the error. One of {InvalidArgument, InvalidRequest, SecurityError}.

string
error_message
Optional

The error message.


Availability
Added in vSphere API Release 8.0.2.0
On This Page
Wire Format Transcoder Operations
POST
Transcoder Transcode