com.vmware.vapi.metadata.metamodel.service.operation

The operation service provides operations to retrieve metamodel information of an operation element in the interface definition language.

get

POST /com/vmware/vapi/metadata/metamodel/service/operation/id:{service_id}?~action=get
POST /com/vmware/vapi/metadata/metamodel/service/operation?~action=get
GET /com/vmware/vapi/metadata/metamodel/service/operation/id:{service_id}/id:{operation_id}

Retrieves the metamodel information about an operation element corresponding to operation_id contained in the service element corresponding to service_id.
Request:
Representations:
{
    "operation_id": "obj-103",
    "service_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:Get-Input xmlns:ns0="http://vmware.com/vapi/metadata/metamodel/service/operation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <service_id>obj-103</service_id>
  <operation_id>obj-103</operation_id>
</ns0:Get-Input>
POST /com/vmware/vapi/metadata/metamodel/service/operation?~action=get
&service_id=obj-103
&operation_id=obj-103

Parameters:
Name Type Required Description
service_id
 *
 ID Yes Identifier of the service element. Id of type com.vmware.vapi.service.
operation_id
 *
 ID Yes Identifier of the operation element. Id of type com.vmware.vapi.operation.

Response:
Representations:
{
    "value": {
        "documentation": "string",
        "errors": [
            {
                "documentation": "string",
                "structure_id": "obj-103"
            },
            {
                "documentation": "string",
                "structure_id": "obj-103"
            }
        ],
        "metadata": [
            {
                "key": "string",
                "value": {
                    "elements": [
                        {
                            "key": "string",
                            "value": {
                                "list_value": [
                                    "string",
                                    "string"
                                ],
                                "long_value": 10,
                                "string_value": "string",
                                "structure_id": "obj-103",
                                "structure_ids": [
                                    "obj-103",
                                    "obj-103"
                                ],
                                "type": "LONG"
                            }
                        }
                    ]
                }
            }
        ],
        "name": "string",
        "output": {
            "documentation": "string",
            "metadata": [
                {
                    "key": "string",
                    "value": {
                        "elements": [
                            {
                                "key": "string",
                                "value": {
                                    "list_value": [
                                        "string",
                                        "string"
                                    ],
                                    "long_value": 10,
                                    "string_value": "string",
                                    "structure_id": "obj-103",
                                    "structure_ids": [
                                        "obj-103",
                                        "obj-103"
                                    ],
                                    "type": "LONG"
                                }
                            }
                        ]
                    }
                }
            ],
            "type": {
                "builtin_type": "VOID",
                "category": "BUILTIN",
                "generic_instantiation": {
                    "element_type": {
                        "builtin_type": "VOID",
                        "category": "BUILTIN",
                        "generic_instantiation": {
                            "generic_type": "LIST"
                        },
                        "user_defined_type": {
                            "resource_id": "obj-103",
                            "resource_type": "string"
                        }
                    },
                    "generic_type": "LIST"
                },
                "user_defined_type": {
                    "resource_id": "obj-103",
                    "resource_type": "string"
                }
            }
        },
        "params": [
            {
                "documentation": "string",
                "metadata": [
                    {
                        "key": "string",
                        "value": {
                            "elements": [
                                {
                                    "key": "string",
                                    "value": {
                                        "list_value": [
                                            "string",
                                            "string"
                                        ],
                                        "long_value": 10,
                                        "string_value": "string",
                                        "structure_id": "obj-103",
                                        "structure_ids": [
                                            "obj-103",
                                            "obj-103"
                                        ],
                                        "type": "LONG"
                                    }
                                }
                            ]
                        }
                    }
                ],
                "name": "string",
                "type": {
                    "builtin_type": "VOID",
                    "category": "BUILTIN",
                    "generic_instantiation": {
                        "element_type": {
                            "builtin_type": "VOID",
                            "category": "BUILTIN",
                            "generic_instantiation": {
                                "generic_type": "LIST"
                            },
                            "user_defined_type": {
                                "resource_id": "obj-103",
                                "resource_type": "string"
                            }
                        },
                        "generic_type": "LIST"
                    },
                    "user_defined_type": {
                        "resource_id": "obj-103",
                        "resource_type": "string"
                    }
                }
            },
            {
                "documentation": "string",
                "metadata": [
                    {
                        "key": "string",
                        "value": {
                            "elements": [
                                {
                                    "key": "string",
                                    "value": {
                                        "list_value": [
                                            "string",
                                            "string"
                                        ],
                                        "long_value": 10,
                                        "string_value": "string",
                                        "structure_id": "obj-103",
                                        "structure_ids": [
                                            "obj-103",
                                            "obj-103"
                                        ],
                                        "type": "LONG"
                                    }
                                }
                            ]
                        }
                    }
                ],
                "name": "string",
                "type": {
                    "builtin_type": "VOID",
                    "category": "BUILTIN",
                    "generic_instantiation": {
                        "element_type": {
                            "builtin_type": "VOID",
                            "category": "BUILTIN",
                            "generic_instantiation": {
                                "generic_type": "LIST"
                            },
                            "user_defined_type": {
                                "resource_id": "obj-103",
                                "resource_type": "string"
                            }
                        },
                        "generic_type": "LIST"
                    },
                    "user_defined_type": {
                        "resource_id": "obj-103",
                        "resource_type": "string"
                    }
                }
            }
        ]
    }
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/vapi/metadata/metamodel/service/operation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <errors-array>
      <array-item>
        <documentation>string</documentation>
        <structure_id>obj-103</structure_id>
      </array-item>
      <array-item>
        <documentation>string</documentation>
        <structure_id>obj-103</structure_id>
      </array-item>
    </errors-array>
    <name>string</name>
    <documentation>string</documentation>
    <params-array>
      <array-item>
        <name>string</name>
        <documentation>string</documentation>
        <type>
          <user_defined_type>
            <resource_id>obj-103</resource_id>
            <resource_type>string</resource_type>
          </user_defined_type>
          <category>BUILTIN</category>
          <generic_instantiation>
            <generic_type>LIST</generic_type>
            <element_type>
              <user_defined_type>
                <resource_id>obj-103</resource_id>
                <resource_type>string</resource_type>
              </user_defined_type>
              <category>BUILTIN</category>
              <generic_instantiation>
                <generic_type>LIST</generic_type>
              </generic_instantiation>
              <builtin_type>VOID</builtin_type>
            </element_type>
          </generic_instantiation>
          <builtin_type>VOID</builtin_type>
        </type>
        <metadata-array>
          <array-item>
            <value>
              <elements-array>
                <array-item>
                  <value>
                    <long_value>10</long_value>
                    <list_value-array>
                      <array-item>string</array-item>
                      <array-item>string</array-item>
                    </list_value-array>
                    <structure_id>obj-103</structure_id>
                    <structure_ids-array>
                      <array-item>obj-103</array-item>
                      <array-item>obj-103</array-item>
                    </structure_ids-array>
                    <string_value>string</string_value>
                    <type>LONG</type>
                  </value>
                  <key>string</key>
                </array-item>
              </elements-array>
            </value>
            <key>string</key>
          </array-item>
        </metadata-array>
      </array-item>
      <array-item>
        <name>string</name>
        <documentation>string</documentation>
        <type>
          <user_defined_type>
            <resource_id>obj-103</resource_id>
            <resource_type>string</resource_type>
          </user_defined_type>
          <category>BUILTIN</category>
          <generic_instantiation>
            <generic_type>LIST</generic_type>
            <element_type>
              <user_defined_type>
                <resource_id>obj-103</resource_id>
                <resource_type>string</resource_type>
              </user_defined_type>
              <category>BUILTIN</category>
              <generic_instantiation>
                <generic_type>LIST</generic_type>
              </generic_instantiation>
              <builtin_type>VOID</builtin_type>
            </element_type>
          </generic_instantiation>
          <builtin_type>VOID</builtin_type>
        </type>
        <metadata-array>
          <array-item>
            <value>
              <elements-array>
                <array-item>
                  <value>
                    <long_value>10</long_value>
                    <list_value-array>
                      <array-item>string</array-item>
                      <array-item>string</array-item>
                    </list_value-array>
                    <structure_id>obj-103</structure_id>
                    <structure_ids-array>
                      <array-item>obj-103</array-item>
                      <array-item>obj-103</array-item>
                    </structure_ids-array>
                    <string_value>string</string_value>
                    <type>LONG</type>
                  </value>
                  <key>string</key>
                </array-item>
              </elements-array>
            </value>
            <key>string</key>
          </array-item>
        </metadata-array>
      </array-item>
    </params-array>
    <output>
      <documentation>string</documentation>
      <type>
        <user_defined_type>
          <resource_id>obj-103</resource_id>
          <resource_type>string</resource_type>
        </user_defined_type>
        <category>BUILTIN</category>
        <generic_instantiation>
          <generic_type>LIST</generic_type>
          <element_type>
            <user_defined_type>
              <resource_id>obj-103</resource_id>
              <resource_type>string</resource_type>
            </user_defined_type>
            <category>BUILTIN</category>
            <generic_instantiation>
              <generic_type>LIST</generic_type>
            </generic_instantiation>
            <builtin_type>VOID</builtin_type>
          </element_type>
        </generic_instantiation>
        <builtin_type>VOID</builtin_type>
      </type>
      <metadata-array>
        <array-item>
          <value>
            <elements-array>
              <array-item>
                <value>
                  <long_value>10</long_value>
                  <list_value-array>
                    <array-item>string</array-item>
                    <array-item>string</array-item>
                  </list_value-array>
                  <structure_id>obj-103</structure_id>
                  <structure_ids-array>
                    <array-item>obj-103</array-item>
                    <array-item>obj-103</array-item>
                  </structure_ids-array>
                  <string_value>string</string_value>
                  <type>LONG</type>
                </value>
                <key>string</key>
              </array-item>
            </elements-array>
          </value>
          <key>string</key>
        </array-item>
      </metadata-array>
    </output>
    <metadata-array>
      <array-item>
        <value>
          <elements-array>
            <array-item>
              <value>
                <long_value>10</long_value>
                <list_value-array>
                  <array-item>string</array-item>
                  <array-item>string</array-item>
                </list_value-array>
                <structure_id>obj-103</structure_id>
                <structure_ids-array>
                  <array-item>obj-103</array-item>
                  <array-item>obj-103</array-item>
                </structure_ids-array>
                <string_value>string</string_value>
                <type>LONG</type>
              </value>
              <key>string</key>
            </array-item>
          </elements-array>
        </value>
        <key>string</key>
      </array-item>
    </metadata-array>
  </value>
</ns0:Get-Result>

Parameters:
Name Type Required Description
result operation_info Yes The com.vmware.vapi.metadata.metamodel.operation_info instance that corresponds to operation_id defined in scope service_id.

Errors:
Type Description HTTP Status Code
not_found if the service element associated with service_id does not exist in any of the package elements. 404

Copyright © 2014. All Rights Reserved.