View API
|
| Local Methods | ||
| Service Types | Data Object Types | All Properties | All Methods |
Service - AdvancedSettings
Service Description
Provides the ability to set advanced settings for View.Methods
| Methods defined in this Service |
|---|
| AdvancedSettings_Get, AdvancedSettings_Perform, AdvancedSettings_Set |
AdvancedSettings_Get
Gets advanced settings for an entity.Privileges
| Privilege | Description |
|---|---|
| ADMINISTRATOR_VIEW | Administrator (read-only) is required to get advanced settings. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the AdvancedSettings used to make the method call. |
| id | EntityId |
The (optional) ID of the entity to manage.
|
| keys | xsd:string[] |
The keys of the settings to retrieve.
|
Return Value
| Type | Description |
|---|---|
| MapEntry[] | A map from key to value of the requested advanced settings. |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition
AdvancedSettings_Perform
Performs an advanced operation.Privileges
| Privilege | Description |
|---|---|
| ADMINISTRATOR | Administrator is required to perform advanced operations. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the AdvancedSettings used to make the method call. |
| id | EntityId |
The entity to set advanced settings on.
|
| operationName | xsd:string |
The name of the operation to perform.
|
| parameters | MapEntry[] |
A map from key to value of the parameters of the
operation.
|
Return Value
| Type | Description |
|---|---|
| xsd:anyType | The result of the operation. The type of this return will vary. |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition
AdvancedSettings_Set
Sets advanced settings on an entity.Privileges
| Privilege | Description |
|---|---|
| ADMINISTRATOR | Administrator is required to set advanced settings. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the AdvancedSettings used to make the method call. |
| id | EntityId |
The entity to set advanced settings on.
|
| values | MapEntry[] |
The settings to set.
|
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition
| Top of page | Local Methods | ||
| Service Types | Data Object Types | All Properties | All Methods |