REST API - list

REST API - list

com.vmware.vapi.metadata.authentication.service.operation

The operation service provides operations to retrieve authentication information of an operation element.

An operation element is said to contain authentication information if authentication schemes are specified in the authentication definition file.

list

GET /com/vmware/vapi/metadata/authentication/service/operation
POST /com/vmware/vapi/metadata/authentication/service/operation/id:{service_id}?~action=list
POST /com/vmware/vapi/metadata/authentication/service/operation?~action=list

Returns the identifiers for the operation elements contained in the service element corresponding to service_id that have authentication information.
Request:
Representations:
{
    "service_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:List-Input xmlns:ns0="http://vmware.com/vapi/metadata/authentication/service/operation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <service_id>obj-103</service_id>
</ns0:List-Input>
GET /com/vmware/vapi/metadata/authentication/service/operation
?service_id=obj-103

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

Response:
Representations:
{
    "value": [
        "obj-103",
        "obj-103"
    ]
}
<?xml version="1.0" ?>
<ns0:List-Result xmlns:ns0="http://vmware.com/vapi/metadata/authentication/service/operation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value-array>
    <array-item>obj-103</array-item>
    <array-item>obj-103</array-item>
  </value-array>
</ns0:List-Result>

Parameters:
Name Type Required Description
result List<ID> Yes List of identifiers for the operation elements contained in the service element that have authentication information. Id of type com.vmware.vapi.operation.

Errors:
Type Description HTTP Status Code
not_found if the service element associated with service_id does not have any operation elements that have authentication information. 404

Copyright © 2014. All Rights Reserved.