Child pages
  • Admin API Complex Types
195 more child pages

This documentation is for a previous version of Flexiant Cloud Orchestrator. The most recent version is v5.0. For the most recent documentation please see here

Skip to end of metadata
Go to start of metadata

Complex Types

Name

Description

addKey

Input parameters for method addKey

addKeyResponse

Output result for method addKey

address

The Address class holds the details of each address.

addUserToCustomer

Input parameters for method addUserToCustomer

addUserToCustomerResponse

Output result for method addUserToCustomer

aggregationField

The Aggregation class specifies a aggregation function that can be executed in a complex database query.

aggregationFilter

The AggregationFilter class specifies a filter that can be run on a aggregation function in a complex database query.

billingEntity

The BillingEntity class is a virtual resource holding data for each Billing Entity

billingEntityDetails

The BillingEntityDetails class holds the base data for each Billing Entity.

cluster

The Cluster class is a virtual resource that represents a cluster.

createBillingEntity

Input parameters for method createBillingEntity

createBillingEntityResponse

Output result for method createBillingEntity

createCluster

Input parameters for method createCluster

createClusterResponse

Output result for method createCluster

createCustomer

Input parameters for method createCustomer

createCustomerResponse

Output result for method createCustomer

createInterworkingNetwork

Input parameters for method createInterworkingNetwork

createInterworkingNetworkResponse

Output result for method createInterworkingNetwork

createInvoice

Input parameters for method createInvoice

createInvoiceResponse

Output result for method createInvoice

createPaymentCardDetails

Input parameters for method createPaymentCardDetails

createPaymentCardDetailsResponse

Output result for method createPaymentCardDetails

createPaymentMethod

Input parameters for method createPaymentMethod

createPaymentMethodResponse

Output result for method createPaymentMethod

createProduct

Input parameters for method createProduct

createProductOffer

Input parameters for method createProductOffer

createProductOfferResponse

Output result for method createProductOffer

createProductResponse

Output result for method createProduct

createPromotion

Input parameters for method createPromotion

createPromotionCode

Input parameters for method createPromotionCode

createPromotionCodeResponse

Output result for method createPromotionCode

createPromotionResponse

Output result for method createPromotion

createReferralPromoCode

Input parameters for method createReferralPromoCode

createReferralPromoCodeResponse

Output result for method createReferralPromoCode

createReferralPromotion

Input parameters for method createReferralPromotion

createReferralPromotionResponse

Output result for method createReferralPromotion

createStorageUnit

Input parameters for method createStorageUnit

createStorageUnitResponse

Output result for method createStorageUnit

createTransactionLog

Input parameters for method createTransactionLog

createTransactionLogResponse

Output result for method createTransactionLog

createUser

Input parameters for method createUser

createUserResponse

Output result for method createUser

currency

The Country class holds the base data for each country.

customer

The Customer class is a virtual resource holding the data for each customer.

customerDetails

The Customer Details class holds the details for each customer.

customerEmail

The CustomerEmail class holds the base data for each email sent to a customer.

deleteCluster

Input parameters for method deleteCluster

deleteClusterResponse

Output result for method deleteCluster

deletePromoCode

Input parameters for method deletePromoCode

deletePromoCodeResponse

Output result for method deletePromoCode

deleteReferralPromoCode

Input parameters for method deleteReferralPromoCode

deleteReferralPromoCodeResponse

Output result for method deleteReferralPromoCode

deleteResource

Input parameters for method deleteResource

deleteResourceResponse

Output result for method deleteResource

deleteTransactionLogs

Input parameters for method deleteTransactionLogs

deleteTransactionLogsResponse

Output result for method deleteTransactionLogs

disk

The Disk class is a virtual resource holding the data for each disk.

doQuery

Input parameters for method doQuery

doQueryResponse

Output result for method doQuery

doUnitTransaction

Input parameters for method doUnitTransaction

doUnitTransactionResponse

Output result for method doUnitTransaction

emailBlock

The EmailBlock class holds an email block.

emailTemplate

The EmailTemplate class holds the base data for each email template.

extilityExceptionInfo

The ExtilityExceptionInfo class gives information about an exception within Extility.

filterCondition

The filterCondition class holds the base data for each filter condition.

firewall

The Firewall class is a virtual resource holding data for a firewall instance.

firewallRule

the FirewallRule class contains an individual firewall rule within a FirewallTemplate

firewallTemplate

The FirewallTemplate class is a virtual resource representing a template for firewalls which may be attached to one or more IP addresses

getCustomer

Input parameters for method getCustomer

getCustomerResponse

Output result for method getCustomer

getPurchasedUnits

Input parameters for method getPurchasedUnits

getPurchasedUnitsResponse

Output result for method getPurchasedUnits

getUser

Input parameters for method getUser

getUserResponse

Output result for method getUser

group

The Group class is a virtual resource representing a group.

image

The Image class is a virtual resource holding data about a server or disk image

imagePermission

The ImagePermission class specifies the permissions on a given image

invoice

The Invoice class holds the base data for each invoice.

invoiceItem

The InvoiceItem class holds the base data for each line item on a invoice.

ip

The IP class holds the data about an IP address

job

The Job class is a virtual resource representing a job

listBillingEntities

Input parameters for method listBillingEntities

listBillingEntitiesResponse

Output result for method listBillingEntities

listCurrencies

Input parameters for method listCurrencies

listCurrenciesResponse

Output result for method listCurrencies

listCustomer

Input parameters for method listCustomer

listCustomerResponse

Output result for method listCustomer

listInvoices

Input parameters for method listInvoices

listInvoicesResponse

Output result for method listInvoices

listProductOffers

Input parameters for method listProductOffers

listProductOffersResponse

Output result for method listProductOffers

listProductPurchases

Input parameters for method listProductPurchases

listProductPurchasesResponse

Output result for method listProductPurchases

listProducts

Input parameters for method listProducts

listProductsResponse

Output result for method listProducts

listPromoCode

Input parameters for method listPromoCode

listPromoCodeResponse

Output result for method listPromoCode

listReferralPromoCode

Input parameters for method listReferralPromoCode

listReferralPromoCodeResponse

Output result for method listReferralPromoCode

listResources

Input parameters for method listResources

listResourcesResponse

Output result for method listResources

listResult

The ListResult class represents the result of a list call

listTransactionLogs

Input parameters for method listTransactionLogs

listTransactionLogsResponse

Output result for method listTransactionLogs

listUnitTransactions

Input parameters for method listUnitTransactions

listUnitTransactionsResponse

Output result for method listUnitTransactions

listUnitTransactionSummary

Input parameters for method listUnitTransactionSummary

listUnitTransactionSummaryResponse

Output result for method listUnitTransactionSummary

listUser

Input parameters for method listUser

listUserResponse

Output result for method listUser

lockUser

Input parameters for method lockUser

lockUserResponse

Output result for method lockUser

markInvoiceStatus

Input parameters for method markInvoiceStatus

markInvoiceStatusResponse

Output result for method markInvoiceStatus

markProductPurchaseInactive

Input parameters for method markProductPurchaseInactive

markProductPurchaseInactiveResponse

Output result for method markProductPurchaseInactive

modifyCluster

Input parameters for method modifyCluster

modifyClusterResponse

Output result for method modifyCluster

modifyPaymentMethod

Input parameters for method modifyPaymentMethod

modifyPaymentMethodResponse

Output result for method modifyPaymentMethod

modifyProduct

Input parameters for method modifyProduct

modifyProductOffer

Input parameters for method modifyProductOffer

modifyProductOfferResponse

Output result for method modifyProductOffer

modifyProductResponse

Output result for method modifyProduct

network

The Network class is a virtual object representing a layer 2 link between virtual NICs and (possibly) virtual routing devices

nic

The Nic object is a virtual resource representing a virtual Network Interface Card (or NIC).

orderedField

The orderedField class holds a field to order a query by, together with the direction of the ordering.

paymentCard

The PaymentCard object represents a payment card (e.g. credit card)

paymentMethod

 

product

The Product class holds the base data for each product.

productComponent

The ProductComponent class represents the components of a product

productOffer

The ProductOffer class holds the base data for each product offer.

productPurchase

The ProductPurchase class holds the base data for each product purchase.

promoCode

The PromoCode class holds the base data for each promo code.

promotion

The Promotion class holds the base data for each promotion.

publishImage

Input parameters for method publishImage

publishImageResponse

Output result for method publishImage

publishTo

The PublishTo class defines to whom a resource should be published.

purchasedUnits

The PurchasedUnits class holds the base data for each purchase of units.

purchaseProduct

Input parameters for method purchaseProduct

purchaseProductResponse

Output result for method purchaseProduct

query

The Query class specifies a complex database query.

queryLimit

The QueryLimit class holds the base data for each query limit.

queryResult

The QueryResult class contains the result of a complex query.

referralPromoCode

The ReferralPromoCode class holds the base data for each referral promo code.

referralPromotion

The ReferralScheme class holds the base data for each referral scheme.

removeCluster

Input parameters for method removeCluster

removeClusterResponse

Output result for method removeCluster

removeKey

Input parameters for method removeKey

removeKeyResponse

Output result for method removeKey

removeStorageUnit

Input parameters for method removeStorageUnit

removeStorageUnitResponse

Output result for method removeStorageUnit

removeUserFromCustomer

Input parameters for method removeUserFromCustomer

removeUserFromCustomerResponse

Output result for method removeUserFromCustomer

resource

The Resource class is a base class which is the fundamental building block from which all resources in the system are derived.

resourceKey

The ResourceKey class provides a key which can be attached to a given resource.

resourceMetadata

The ResourceMetadata class implements metadata which can be attached to resources

resultRow

The ResultRow class contains a row of the result of a complex query.

revokeImage

Input parameters for method revokeImage

revokeImageResponse

Output result for method revokeImage

searchFilter

The searchFilter class holds the base data for each search filter.

sendEmail

Input parameters for method sendEmail

sendEmailResponse

Output result for method sendEmail

server

The Server class is a virtual resource representing a server.

setOSProductOffer

Input parameters for method setOSProductOffer

setOSProductOfferResponse

Output result for method setOSProductOffer

snapshot

The Snapshot class is a virtual resource representing a snapshot of a disk or a server.

sshKey

The SSHKey class describes an ssh key.

storageUnit

The StorageUnit class represents a storage unit

subnet

The Subnet class is a virtual resource representing an IP subnet.

systemCapabilitySet

The SystemCapabilitySet class describes the capabilities of the system or a subset thereof

transactionLog

 

unitTransaction

The UnitTransaction class holds the base data for a unit transaction.

unitTransactionSummary

The UnitTransactionSummary class holds the base data for each daily unit transaction summary.

unlockUser

Input parameters for method unlockUser

unlockUserResponse

Output result for method unlockUser

updateBillingEntity

Input parameters for method updateBillingEntity

updateBillingEntityResponse

Output result for method updateBillingEntity

updateCustomer

Input parameters for method updateCustomer

updateCustomerResponse

Output result for method updateCustomer

updateEmailTemplate

Input parameters for method updateEmailTemplate

updateEmailTemplateResponse

Output result for method updateEmailTemplate

updatePaymentCardDetails

Input parameters for method updatePaymentCardDetails

updatePaymentCardDetailsResponse

Output result for method updatePaymentCardDetails

updatePromotion

Input parameters for method updatePromotion

updatePromotionResponse

Output result for method updatePromotion

updateReferralPromoCode

Input parameters for method updateReferralPromoCode

updateReferralPromoCodeResponse

Output result for method updateReferralPromoCode

updateReferralPromotion

Input parameters for method updateReferralPromotion

updateReferralPromotionResponse

Output result for method updateReferralPromotion

updateUser

Input parameters for method updateUser

updateUserResponse

Output result for method updateUser

user

The User class holds the base data for each user / contact.

userDetails

The UserDetails class holds the base data for each user / contact.

validateCustomer

Input parameters for method validateCustomer

validateCustomerResponse

Output result for method validateCustomer

vdc

The VirtualDataCentre class is a virtual resource which describes a virtual data centre.

virtualResource

The VirtualResource class is a resource is a base class on which all other virtual resources are based.

  • No labels