Alarm Get Available Field

List of custom field definitions that are valid for the object's type.

The fields are sorted by name.

Required privileges: System.View

Request

URI

GET

https://{vcenter-host}/sdk/vim25/{release}/Alarm/{moId}/availableField

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case Alarm/{moId}.

string

release

Required

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

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns Array of CustomFieldDef of type(s) application/json

[
    {
        "_typeName": "string",
        "key": 0,
        "name": "string",
        "type": "string",
        "managedObjectType": "string",
        "fieldDefPrivileges": {
            "_typeName": "string",
            "createPrivilege": "string",
            "readPrivilege": "string",
            "updatePrivilege": "string",
            "deletePrivilege": "string"
        },
        "fieldInstancePrivileges": {
            "_typeName": "string",
            "createPrivilege": "string",
            "readPrivilege": "string",
            "updatePrivilege": "string",
            "deletePrivilege": "string"
        }
    }
]

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Alarm Operations

GET

Alarm Get Available Field

GET

Alarm Get Info