vapi std introspection operation: get
Returns the vapi.std.introspection.operation.info for a given vAPI operation.
Request:
HTTP request
POST https://{server}/rest/com/vmware/vapi/std/introspection/operation/id:{service_id}?~action=get
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| service_id | string | service identifier. |
Request Body Structure:
{
"operation_id" : "obj-103"
}
"operation_id" : "obj-103"
}
Request Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| operation_id | string | operation identifier. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : {
"error_definitions" : [
{
"element_definition" : {
"name" : "string",
"type" : "BINARY",
"fields" : [
{
"key" : "string"
}
]
},
"name" : "string",
"type" : "BINARY",
"fields" : [
{
"key" : "string"
}
]
},
{
"element_definition" : {
"name" : "string",
"type" : "BINARY",
"fields" : [
{
"key" : "string"
}
]
},
"name" : "string",
"type" : "BINARY",
"fields" : [
{
"key" : "string"
}
]
}
],
"input_definition" : {
"element_definition" : {
"name" : "string",
"type" : "BINARY",
"fields" : [
{
"key" : "string"
}
]
},
"name" : "string",
"type" : "BINARY",
"fields" : [
{
"key" : "string"
}
]
},
"output_definition" : {
"element_definition" : {
"name" : "string",
"type" : "BINARY",
"fields" : [
{
"key" : "string"
}
]
},
"name" : "string",
"type" : "BINARY",
"fields" : [
{
"key" : "string"
}
]
}
}
}
"value" : {
"error_definitions" : [
{
"element_definition" : {
"name" : "string",
"type" : "BINARY",
"fields" : [
{
"key" : "string"
}
]
},
"name" : "string",
"type" : "BINARY",
"fields" : [
{
"key" : "string"
}
]
},
{
"element_definition" : {
"name" : "string",
"type" : "BINARY",
"fields" : [
{
"key" : "string"
}
]
},
"name" : "string",
"type" : "BINARY",
"fields" : [
{
"key" : "string"
}
]
}
],
"input_definition" : {
"element_definition" : {
"name" : "string",
"type" : "BINARY",
"fields" : [
{
"key" : "string"
}
]
},
"name" : "string",
"type" : "BINARY",
"fields" : [
{
"key" : "string"
}
]
},
"output_definition" : {
"element_definition" : {
"name" : "string",
"type" : "BINARY",
"fields" : [
{
"key" : "string"
}
]
},
"name" : "string",
"type" : "BINARY",
"fields" : [
{
"key" : "string"
}
]
}
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | info | vapi.std.introspection.operation.info for a given vAPI operation. |
| value.input_definition | data_definition | vapi.std.introspection.operation.data_definition describing the operation input. The vapi.std.introspection.operation.data_definition.type of this field will be STRUCTURE. The keys of vapi.std.introspection.operation.data_definition.fields are the names of the operation parameters, and the values of vapi.std.introspection.operation.data_definition.fields describe the type of the operation parameters. |
| value.input_definition.type | string | Data type of the value. The vapi.std.introspection.operation.data_definition.data_type enumeration provides values representing the data types supported by the vAPI infrastructure. Value is one of: BINARY: Indicates the value is a binary type. BOOLEAN: Indicates the value is a boolean type. The possible values are True and False equivalent of the language used to invoke this operation. DOUBLE: Indicates the value is a double type. It is a 64 bit floating point number. DYNAMIC_STRUCTURE: Indicates the value is a dynamic structure. This means, any data of type STRUCTURE can be used. ERROR: Indicates the value is a specific error type. ANY_ERROR: Indicates the value is arbitrary error type. This means, any data of type ERROR can be used. LIST: Indicates the value is a list data type. Any value of this type can have zero or more elements in the list. LONG: Indicates the value is a long data type. It is a 64 bit signed integer number. OPAQUE: Indicates the value is an opaque type. This means, data of any vapi.std.introspection.operation.data_definition.data_type can be used. OPTIONAL: Indicates the value is an optional data type. Any value of this type can be null. SECRET: Indicates the value is a secret data type. This is used for sensitive information. The server will not log any data of this type and if possible wipe the data from the memory after usage. STRING: Indicates the value is a string data type. This is a unicode string. STRUCTURE: Indicates the value is a structure data type. A structure has string identifier and a set of fields with corresponding values. STRUCTURE_REF: Indicates the value is a structure reference. This is used to break circular dependencies in the type references. This just has a string identifier of the structure. Clients have to maintain a list of structures already visited and use that to resolve this reference. VOID: Indicates the value is a void data type. |
| value.input_definition.element_definition | data_definition | Contains the element definition for generic data types like List and Optional. Optional. It is only relevant when type has value [OPTIONAL, LIST]. This field is optional and it is only relevant when the value of type is one of OPTIONAL or LIST. |
| value.input_definition.name | string | Fully qualified name of the structure. Optional. It is only relevant when type has value [STRUCTURE, STRUCTURE_REF, ERROR]. This field is optional and it is only relevant when the value of type is one of STRUCTURE, STRUCTURE_REF, or ERROR. |
| value.input_definition.fields | list | Fields of the structure type. The key of the map is the canonical name of the field and the value is the vapi.std.introspection.operation.data_definition for the field. The order of the structure fields defined in IDL is not maintained by the vapi.std.introspection.operation service. Optional. It is only relevant when type has value [STRUCTURE, ERROR]. This field is optional and it is only relevant when the value of type is one of STRUCTURE or ERROR.List of {"key": string, "value": data_definition} |
| value.input_definition.fields[].key | string | |
| value.input_definition.fields[].value | data_definition | |
| value.input_definition.fields[].value.type | string | Data type of the value. The vapi.std.introspection.operation.data_definition.data_type enumeration provides values representing the data types supported by the vAPI infrastructure. Value is one of: BINARY: Indicates the value is a binary type. BOOLEAN: Indicates the value is a boolean type. The possible values are True and False equivalent of the language used to invoke this operation. DOUBLE: Indicates the value is a double type. It is a 64 bit floating point number. DYNAMIC_STRUCTURE: Indicates the value is a dynamic structure. This means, any data of type STRUCTURE can be used. ERROR: Indicates the value is a specific error type. ANY_ERROR: Indicates the value is arbitrary error type. This means, any data of type ERROR can be used. LIST: Indicates the value is a list data type. Any value of this type can have zero or more elements in the list. LONG: Indicates the value is a long data type. It is a 64 bit signed integer number. OPAQUE: Indicates the value is an opaque type. This means, data of any vapi.std.introspection.operation.data_definition.data_type can be used. OPTIONAL: Indicates the value is an optional data type. Any value of this type can be null. SECRET: Indicates the value is a secret data type. This is used for sensitive information. The server will not log any data of this type and if possible wipe the data from the memory after usage. STRING: Indicates the value is a string data type. This is a unicode string. STRUCTURE: Indicates the value is a structure data type. A structure has string identifier and a set of fields with corresponding values. STRUCTURE_REF: Indicates the value is a structure reference. This is used to break circular dependencies in the type references. This just has a string identifier of the structure. Clients have to maintain a list of structures already visited and use that to resolve this reference. VOID: Indicates the value is a void data type. |
| value.input_definition.fields[].value.element_definition | data_definition | Contains the element definition for generic data types like List and Optional. Optional. It is only relevant when type has value [OPTIONAL, LIST]. This field is optional and it is only relevant when the value of type is one of OPTIONAL or LIST. |
| value.input_definition.fields[].value.name | string | Fully qualified name of the structure. Optional. It is only relevant when type has value [STRUCTURE, STRUCTURE_REF, ERROR]. This field is optional and it is only relevant when the value of type is one of STRUCTURE, STRUCTURE_REF, or ERROR. |
| value.input_definition.fields[].value.fields | list | Fields of the structure type. The key of the map is the canonical name of the field and the value is the vapi.std.introspection.operation.data_definition for the field. The order of the structure fields defined in IDL is not maintained by the vapi.std.introspection.operation service. Optional. It is only relevant when type has value [STRUCTURE, ERROR]. This field is optional and it is only relevant when the value of type is one of STRUCTURE or ERROR.List of {"key": string, "value": data_definition} |
| value.output_definition | data_definition | vapi.std.introspection.operation.data_definition describing the operation output. |
| value.output_definition.type | string | Data type of the value. The vapi.std.introspection.operation.data_definition.data_type enumeration provides values representing the data types supported by the vAPI infrastructure. Value is one of: BINARY: Indicates the value is a binary type. BOOLEAN: Indicates the value is a boolean type. The possible values are True and False equivalent of the language used to invoke this operation. DOUBLE: Indicates the value is a double type. It is a 64 bit floating point number. DYNAMIC_STRUCTURE: Indicates the value is a dynamic structure. This means, any data of type STRUCTURE can be used. ERROR: Indicates the value is a specific error type. ANY_ERROR: Indicates the value is arbitrary error type. This means, any data of type ERROR can be used. LIST: Indicates the value is a list data type. Any value of this type can have zero or more elements in the list. LONG: Indicates the value is a long data type. It is a 64 bit signed integer number. OPAQUE: Indicates the value is an opaque type. This means, data of any vapi.std.introspection.operation.data_definition.data_type can be used. OPTIONAL: Indicates the value is an optional data type. Any value of this type can be null. SECRET: Indicates the value is a secret data type. This is used for sensitive information. The server will not log any data of this type and if possible wipe the data from the memory after usage. STRING: Indicates the value is a string data type. This is a unicode string. STRUCTURE: Indicates the value is a structure data type. A structure has string identifier and a set of fields with corresponding values. STRUCTURE_REF: Indicates the value is a structure reference. This is used to break circular dependencies in the type references. This just has a string identifier of the structure. Clients have to maintain a list of structures already visited and use that to resolve this reference. VOID: Indicates the value is a void data type. |
| value.output_definition.element_definition | data_definition | Contains the element definition for generic data types like List and Optional. Optional. It is only relevant when type has value [OPTIONAL, LIST]. This field is optional and it is only relevant when the value of type is one of OPTIONAL or LIST. |
| value.output_definition.name | string | Fully qualified name of the structure. Optional. It is only relevant when type has value [STRUCTURE, STRUCTURE_REF, ERROR]. This field is optional and it is only relevant when the value of type is one of STRUCTURE, STRUCTURE_REF, or ERROR. |
| value.output_definition.fields | list | Fields of the structure type. The key of the map is the canonical name of the field and the value is the vapi.std.introspection.operation.data_definition for the field. The order of the structure fields defined in IDL is not maintained by the vapi.std.introspection.operation service. Optional. It is only relevant when type has value [STRUCTURE, ERROR]. This field is optional and it is only relevant when the value of type is one of STRUCTURE or ERROR.List of {"key": string, "value": data_definition} |
| value.error_definitions | data_definition[] | List of vapi.std.introspection.operation.data_definition describing the errors that the operation might report. The vapi.std.introspection.operation.data_definition.type of every element in this list will be ERROR. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 404 | not_found | If the operation identifier does not exist. |