Fusion Middleware Documentation
Advanced Search


Developing Applications and Introspection Plug-ins for Oracle Virtual Assembly Builder
Close Window

Table of Contents

Show All | Collapse

3 API Reference: Administrative Operations

The following sections describes administrative operations in the Oracle Virtual Assembly Builder Deployer Web Service API:

3.1 Parameters in HTTP Query String

The following designations apply to parameters in the "Other Parameters in HTTP Query String" sections of each operation:

  • 1..1 : Parameter is required, and can have exactly one occurrence.

  • 1..* : Parameter is required, and can have multiple occurrences.

  • 0..1 : Parameter is optional, and can have exactly one occurrence, if provided.

  • 0..* : Parameter is optional, and can have multiple occurrences, if provided.

3.2 Response Content

The response types for the operations correspond to definitions in the Web service schema. See Appendix A, "Web Service Schema".

3.3 AddTargetUser

This operation adds user configuration information for the named user to the target. The purpose of AddTargetUser, in addition to indicating that a user will be using the target, is to supply user specific information to be used when interacting with the target, if required.

For the Deployer which is used with Oracle VM, AddTargetUser is called by the Cloud Administrator to grant access to the target. In this case, no other properties are provided because the Cloud Administrator provides credentials for the virtualization environment when the target is created. Application Administrators are not allowed to call this operation for the generic Deployer because the credentials must be protected.

Other Parameters in HTTP Query String

target 1..1

user 1..1

Other parameters are used as properties for the user

HTTP Method

POST

Request Content

N/A

Response Content

text/xml Element: AddTargetUserResult

Required Role and Authorization

In the Oracle VM Deployer, only the Cloud Administrator is allowed to call AddTargetUser. The credentials are provided in the target configuration and must be protected.

A Cloud Administrator who calls this operation can specify a username other than their own.

3.4 CreateTarget

This operation creates a target for deployment operations. The call includes configuration information that defines the connection information. Credentials are supply for the Oracle VM target.

Other Parameters in HTTP Query String

name 1..1

type 1..1

default 0..1 (default value is false)

Other parameters are used as properties for the target

HTTP Method

POST

Request Content

N/A

Response Content

text/xml Element: CreateTargetResult

Required Role and Authorization

This operation can only be called by the Cloud Admin.

3.5 DeleteTarget

This operation deletes the deployment target and all configuration information. If this target was a default for a user or all users, then that default is unset.

Other Parameters in HTTP Query String

name 1..1

HTTP Method

POST

Request Content

N/A

Response Content

text/xml Element: DeleteTargetResult

Required Role and Authorization

This operation can only be called by the Cloud Admin.

3.6 DescribeTargetConfigurations

This operation describes configuration information for a target.

Other Parameters in HTTP Query String

target 1..1

HTTP Method

GET

Request Content

N/A

Response Content

text/xml Element: DescribeTargetConfigurationsResult

Required Role and Authorization

This operation can only be called by the Cloud Admin.

3.7 DescribeTargetNames

This operation lists created targets for deployment operations for the given type.

Other Parameters in HTTP Query String

type 1..1

HTTP Method

GET

Request Content

N/A

Response Content

text/xml Element: ListTargetsResult

Required Role and Authorization

This operation can be called by the Application Admin or Cloud Admin.

3.8 DescribeTargetUsers

This operation lists users for the given target.

Other Parameters in HTTP Query String

target 1..1

HTTP Method

GET

Request Content

N/A

Response Content

text/xml Element: DescribeTargetUsersResult

Required Role and Authorization

This operation can be called by the Application Admin or Cloud Admin.

3.9 DescribeUserTargets

This operation lists targets for the given user.

Other Parameters in HTTP Query String

user 1..1

HTTP Method

GET

Request Content

N/A

Response Content

text/xml Element: DescribeUserTargetsResult

Required Role and Authorization

This operation can be called by the Application Admin or Cloud Admin.

3.10 GetDefaultTarget

This operation gets the default target of that type for all users.

Other Parameters in HTTP Query String

type 1..1

HTTP Method

GET

Request Content

N/A

Response Content

text/xml Element: GetDefaultTargetResult

Required Role and Authorization

This operation can be called by the Application Admin or Cloud Admin.

3.11 GetTargetType

This operation gets the target type for the given target name.

Other Parameters in HTTP Query String

target 1..1

HTTP Method

GET

Request Content

N/A

Response Content

text/xml Element: GetTargetTypeResult

Required Role and Authorization

This operation can be called by the Application Admin or Cloud Admin.

3.12 RemoveTargetUsers

This operation removes a user from a target.

Other Parameters in HTTP Query String

target 1..1

user 1..*

HTTP Method

POST

Request Content

N/A

Response Content

text/xml Element: RemoveTargetUsersResult

Required Role and Authorization

This operation can be called by the Application Admin or Cloud Admin.

A caller holding the Cloud Admin role can call the method and specify a username other than their own. A non-admin user can only specify their own username.

3.13 SetDefaultTarget

This operation sets the target type of the given name as the default target for all targets of that type for all users. The specified target is used if the user calls an Oracle Virtual Assembly Builder operation and has neither specified a target nor has previously called setUserDefaultTarget for the target type.

Other Parameters in HTTP Query String

name 1..1

HTTP Method

POST

Request Content

N/A

Response Content

text/xml Element: SetDefaultTargetResult

Required Role and Authorization

This operation can only be called by the Cloud Admin.