REST API - get

vcenter deployment question: get

Get the question that was raised during the configuration. This operation was added in vSphere API 6.7

Request:

HTTP request

GET https://{server}/rest/vcenter/deployment/question

No request parameters

Response:

HTTP Status Code: 200

Representation:

JSON

{
    "value": {
        "questions": [
            {
                "default_answer": "string",
                "id": "string",
                "possible_answers": [
                    "string",
                    "string"
                ],
                "question": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "type": "YES_NO"
            },
            {
                "default_answer": "string",
                "id": "string",
                "possible_answers": [
                    "string",
                    "string"
                ],
                "question": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "type": "YES_NO"
            }
        ]
    }
}

Response Type:

Name	Type	Description
bold = required
value	info	Info structure containing the question.
value.questions	question[]	One or more questions raised during the deployment. This attribute was added in vSphere API 6.7
value.questions[].id	string	Id of the question raised. This attribute was added in vSphere API 6.7
value.questions[].question	localizable_message	Message describing the question. This attribute was added in vSphere API 6.7
value.questions[].question.id	string	Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.questions[].question.default_message	string	The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.questions[].question.args	string[]	Arguments to be substituted into a message template.
value.questions[].type	string	Type of the question raised. This attribute was added in vSphere API 6.7 Defines the type of the question raised. This enumeration was added in vSphere API 6.7 Value is one of: YES_NO: Question with answer values Yes/No. This constant was added in vSphere API 6.7 OK_CANCEL: Question with answer values Ok/Cancel. This constant was added in vSphere API 6.7 ABORT_RETRY_IGNORE: Question with answer values Abort/Retry/Ignore. This constant was added in vSphere API 6.7
value.questions[].default_answer	string	Default answer value. This attribute was added in vSphere API 6.7
value.questions[].possible_answers	string[]	Possible answers values. This attribute was added in vSphere API 6.7

Errors:

HTTP Status Code	Type	Description
401	unauthenticated	if the caller is not authenticated.
400	not_allowed_in_current_state	if the appliance is not in QUESTION_RAISED state.
500	internal_server_error	if questions could not be retrieved although the appliance is in QUESTION_RAISED state.