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.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
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.
The XML or JSON object to be transcoded. Should be a valid representation of Data Object defined in the 'vim' namespace.
OK
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.
{
"error_type": "string",
"error_message": "string"
}
The type of the error. One of {InvalidArgument, InvalidRequest, SecurityError}.
The error message.
ViTranscoderErrorResponse with error_type
SecurityError
- thrown when the user is not authenticated.
{
"error_type": "string",
"error_message": "string"
}
The type of the error. One of {InvalidArgument, InvalidRequest, SecurityError}.
The error message.