Developer Documentation

REST API Operations Index

All available vAPI REST API Operations.


Metadata

Authentication Component
get List Authentication Component
Returns the identifiers for the component elements that have authentication information.
get Get Authentication Component
Retrieves authentication information about the component element corresponding to componentId. The ComponentData contains the authentication information about the component element and it's fingerprint. It contains information about all the package elements that belong to this component element.
post Fingerprint Authentication Component
Retrieves the fingerprint computed from the authentication metadata of the component element corresponding to componentId. The fingerprint provides clients an efficient way to check if the metadata for a particular component has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of Component.get.
Authentication Package
get List Authentication Package
Returns the identifiers for the package elements that have authentication information.
get Get Authentication Package
Retrieves authentication information about the package element corresponding to packageId.
Authentication Service
get List Authentication Service
Returns the identifiers for the service elements that have authentication information.
get Get Authentication Service
Retrieves authentication information about the service element corresponding to serviceId.
Authentication Service Operation
get List Authentication Service Operation
Returns the identifiers for the operation elements contained in the service element corresponding to serviceId that have authentication information.
get Get Authentication Service Operation
Retrieves the authentication information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.
CLI Command
get List CLI Command
Returns the identifiers of all commands, or commands in a specific namespace.
post Fingerprint CLI Command
Returns the aggregate fingerprint of all the command metadata from all the metadata sources. The fingerprint provides clients an efficient way to check if the metadata for commands has been modified on the server.
get Get CLI Command
Retrieves information about a command including information about how to execute that command.
CLI Namespace
get List CLI Namespace
Returns the identifiers of all namespaces registered with the infrastructure.
post Fingerprint CLI Namespace
Returns the aggregate fingerprint of all the namespace metadata from all the metadata sources. The fingerprint provides clients an efficient way to check if the metadata for namespaces has been modified on the server.
get Get CLI Namespace
Retreives information about a namespace including information about children of that namespace.
Metamodel Component
get List Metamodel Component
Returns the identifiers for the component elements that are registered with the infrastructure.
get Get Metamodel Component
Retrieves metamodel information about the component element corresponding to componentId. The ComponentData contains the metamodel information about the component and it's fingerprint. It contains information about all the package elements that are contained in this component element.
post Fingerprint Metamodel Component
Retrieves the fingerprint computed from the metamodel metadata of the component element corresponding to componentId. The fingerprint provides clients an efficient way to check if the metadata for a particular component element has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of Component.get.
Metamodel Enumeration
get List Metamodel Enumeration
Returns the identifiers for the enumeration elements that are contained in all the package elements, service elements and structure elements.
get Get Metamodel Enumeration
Retrieves information about the enumeration element corresponding to enumerationId. The EnumerationInfo contains the metamodel information about the enumeration value element contained in the enumeration element.
Metamodel Package
get List Metamodel Package
Returns the identifiers for the packages elements that are contained in all the registered component elements.
get Get Metamodel Package
Retrieves information about the package element corresponding to packageId.
Metamodel Resource
get List Metamodel Resource
Returns the set of resource types present across all the service elements contained in all the package elements.
Metamodel Service
get List Metamodel Service
Returns the identifiers for the service elements that are currently registered with the infrastructure. The list of service elements is an aggregate list of all the service elements contained in all the package elements.
get Get Metamodel Service
Retrieves information about the service element corresponding to serviceId. The ServiceInfo contains the metamodel information for the operation elements, structure elements and enumeration elements contained in the service element.
Metamodel Structure
get List Metamodel Structure
Returns the identifiers for the structure elements that are contained in all the package elements and service elements.
get Get Metamodel Structure
Retrieves information about the structure element corresponding to structureId. The StructureInfo contains the metamodel information about the structure element. It contains information about all the field elements and enumeration elements contained in this structure element.
Metamodel Resource Model
get List Metamodel Resource Model
Returns the set of identifiers for the structure elements that are models for the resource type corresponding to resourceId. The Structure service provides operations to retrieve more details about the structure elements corresponding to the identifiers returned by this operation.
Metamodel Service Operation
get List Metamodel Service Operation
Returns the identifiers for the operation elements that are defined in the scope of serviceId.
get Get Metamodel Service Operation
Retrieves the metamodel information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.
Privilege Component
get List Privilege Component
Returns the identifiers for the component elements that have privilege information.
get Get Privilege Component
Retrieves privilege information about the component element corresponding to componentId. The ComponentData contains the privilege information about the component element and its fingerprint. It contains information about all the package elements that belong to this component element.
post Fingerprint Privilege Component
Retrieves the fingerprint computed from the privilege metadata of the component element corresponding to componentId. The fingerprint provides clients an efficient way to check if the metadata for a particular component has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of Component.get.
Privilege Package
get List Privilege Package
Returns the identifiers for the package elements that have privilege information.
get Get Privilege Package
Retrieves privilege information about the package element corresponding to packageId.
Privilege Service
get List Privilege Service
Returns the identifiers for the service elements that have privilege information.
get Get Privilege Service
Retrieves privilege information about the service element corresponding to serviceId.
Privilege Service Operation
get List Privilege Service Operation
Returns the identifiers for the operation elements contained in the service element corresponding to serviceId that have privilege information.
get Get Privilege Service Operation
Retrieves the privilege information about an operation element corresponding to operationId contained in the service element corresponding to serviceId.
Feedback

Was this page helpful?