REST API - get

esx hcl compatibility data: get

Provides information about the compatibility data located on the vCenter Appliance.

Request:

HTTP request

GET https://{server}/api/esx/hcl/compatibility-data/status

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "updated_at""2015-01-01T22:13:05.651Z",
    "notifications"{
        "warnings"[
            {
                "id""string",
                "time""2015-01-01T22:13:05.651Z",
                "message"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "resolution"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            },
            {
                "id""string",
                "time""2015-01-01T22:13:05.651Z",
                "message"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "resolution"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        ],
        "errors"[
            {
                "id""string",
                "time""2015-01-01T22:13:05.651Z",
                "message"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "resolution"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            },
            {
                "id""string",
                "time""2015-01-01T22:13:05.651Z",
                "message"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "resolution"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        ],
        "info"[
            {
                "id""string",
                "time""2015-01-01T22:13:05.651Z",
                "message"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "resolution"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            },
            {
                "id""string",
                "time""2015-01-01T22:13:05.651Z",
                "message"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "resolution"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        ]
    }
}

Headers:

None

Type:

Name Type Description
bold = required
- status Information about the compatibility data.
-.updated_at date_time Indicates when the data was last updated.

-.notifications notifications Notifications returned by the operation.

-.notifications.info notification[] Info notification messages reported.

Optional. Only set if an info was reported by the task.

-.notifications.info[].id string The notification id.

-.notifications.info[].time date_time The time the notification was raised/found.

-.notifications.info[].message localizable_message The notification message.

-.notifications.info[].message.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.

-.notifications.info[].message.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.

-.notifications.info[].message.args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.

-.notifications.warnings notification[] Warning notification messages reported.

Optional. Only set if an warning was reported by the task.

-.notifications.errors notification[] Error notification messages reported.

Optional. Only set if an error was reported by the task.

Errors:

HTTP Status Code Type Description
400 not_allowed_in_current_state if there is no compatibility data on the vCenter executing the operation.
401 unauthenticated if the caller is not authenticated.
500 resource_inaccessible if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).
500 error If there is some unknown error. The accompanying error message will give more details about the failure.