Page tree
Skip to end of metadata
Go to start of metadata

The full list of queryable FQL fields for each object is set out below.

Filter keys for APIKeyUser object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

customername

String

The name of the customer that owns the resource.

customeruuid

String

The UUID of the customer that owns the resource.

email

String

The email address associated with the user / contact

firstname

String

The first name of the contact

lastlogintime

Date

The last login time associated with the user / contact

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

lastname

String

The last name of the contact

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

usertype

UserType

The type of user represented by this object.

Filter keys for BillingEntity object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

billingtype

BillingType

The type of the billing entity

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

parentname

String

The name of the immediate parent billing entity of this billing entity

parentuuid

String

The UUID of the immediate parent billing entity of this billing entity

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

Filter keys for BillingEntityDetails object

Name

Data type

Description

admincontrolpanelurl

String

The admin control panel URL of the Billing Entity

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

billingtype

BillingType

The type of the billing entity

brand

long

The numeric ID of the brand associated with the Billing Entity

controlpanelurl

String

The public facing URL of the control panel for the Billing Entity

description

String

The textual description of the Billing Entity

enableuserediting

boolean

Flag to enable editing of users

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

no3ds28dayspendlimit

double

The default monthly spend limit (in currency terms) associated with the Billing Entity for a non-3DS transaction

overall28dayspendlimit

double

The default overall monthly spend limit (in currency terms) associated with the Billing Entity

parentname

String

The name of the immediate parent billing entity of this billing entity

parentuuid

String

The UUID of the immediate parent billing entity of this billing entity

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

vatnumber

String

The VAT number / tax reference of the Billing Entity

Filter keys for BillingMethod object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

description

String

Longform description of the billing method, populated from the FDL code block.

fdlname

String

The name of the FDL Code Block that contains the function

fdluuid

String

UUID of the FDL code block to which the Billing Method is linked.

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

Filter keys for Blob object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

providers

String

The config provider values

publicresource

Boolean

State if the Blob is a public resource, and availabel to the Open API services

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sha256

String

The SHA_256 of the value to which the blob relates

sortorder

Integer

The sort order value for the given resource

Filter keys for Cluster object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clusterip

String

The endpoint of the XVP service

clusterport

int

The port for the service

createdefaultvdc

Boolean

To create a default VDC on creation of a customer

hypervisor

HypervisorType

The hypervisor of the cluster

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

macaddressprefix

String

The mac address prefix for the cluster

password

String

The password for the XVP service

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

ucsintegration

Boolean

The type of integration used by the cluster - 0 - none, 1 - UCS

username

String

The usename for the XVP service

vlanendinnertag

Integer

The maximum VLAN tag to be allocated

vlanendoutertag

Integer

In the QinQ mode maximum outer tag which can be allocated

vlanqinqmode

Boolean

Indicates if QinQ mode is active

vlanrestrictedinnertags

String

The tags which are restricted - a comma seperated list

vlanrestrictedoutertags

String

The tags which are restricted in QinQ mode - a comma seperated list

vlanstartinnertag

Integer

The minimum VLAN tag to be allocated

vlanstartoutertag

Integer

When VLAN allocation is runing in the QinQ mode this will be used as the start tag

Filter keys for ClusterPluggableResource object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providergroup

String

The group of the Pluggable Resource Provider that defined the Pluggable Resource

providericon

String

The icon of the Pluggable Resource Provider that defined the Pluggable Resource

providername

String

The name of the Pluggable Resource Provider that defined the Pluggable Resource

providers

String

The config provider values

providertype

String

The type of the Pluggable Resource Provider that defined the Pluggable Resource

provideruuid

String

The UUID of the Pluggable Resource Provider that defined the Pluggable Resource

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

Filter keys for ConfigurationProvider object

Name

Data type

Description

associatedresourcetypes

String

A list of associated resource types

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

fdldescription

String

The description of the function

fdlname

String

The name of the FDL Code Block that contains the provider

fdluuid

String

The UUID of FDL Code Block that contains the provider

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

productcomponenttypes.billingentityname

String

The Name of the Billing Entity to which the resource belongs

productcomponenttypes.billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

productcomponenttypes.lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

productcomponenttypes.providers

String

The config provider values

productcomponenttypes.referencefield

String

The user friendly unique refernce given to the PCT

productcomponenttypes.resourcecreatedate

Date

The creation date of the resource

productcomponenttypes.resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

productcomponenttypes.resourcekey.name

String

The name of the key

productcomponenttypes.resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

productcomponenttypes.resourcekey.type

ResourceKeyType

The type of the key (system or user)

productcomponenttypes.resourcekey.value

String

The value set on the key

productcomponenttypes.resourcekey.weight

double

The affinity weight of the key (zero means none)

productcomponenttypes.resourcename

String

The name of the resource

productcomponenttypes.resourcestate

ResourceState

The state of the resource

productcomponenttypes.resourcetype

ResourceType

The type of the resource

productcomponenttypes.resourceuuid

String

The UUID of the resource (read-only)

productcomponenttypes.sortorder

Integer

The sort order value for the given resource

providerdata.allowcustomeredit

Boolean

State if the customer should be allowed to edit the provider settings

providerdata.productcomponenttypes.billingentityname

String

The Name of the Billing Entity to which the resource belongs

providerdata.productcomponenttypes.billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

providerdata.productcomponenttypes.lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

providerdata.productcomponenttypes.providers

String

The config provider values

providerdata.productcomponenttypes.referencefield

String

The user friendly unique refernce given to the PCT

providerdata.productcomponenttypes.resourcecreatedate

Date

The creation date of the resource

providerdata.productcomponenttypes.resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

providerdata.productcomponenttypes.resourcekey.name

String

The name of the key

providerdata.productcomponenttypes.resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

providerdata.productcomponenttypes.resourcekey.type

ResourceKeyType

The type of the key (system or user)

providerdata.productcomponenttypes.resourcekey.value

String

The value set on the key

providerdata.productcomponenttypes.resourcekey.weight

double

The affinity weight of the key (zero means none)

providerdata.productcomponenttypes.resourcename

String

The name of the resource

providerdata.productcomponenttypes.resourcestate

ResourceState

The state of the resource

providerdata.productcomponenttypes.resourcetype

ResourceType

The type of the resource

providerdata.productcomponenttypes.resourceuuid

String

The UUID of the resource (read-only)

providerdata.productcomponenttypes.sortorder

Integer

The sort order value for the given resource

providerdata.resourcetype

String

The associated resource type

providerdata.usewithbilling

boolean

State if the provider should be used with the billing system

providergroup

String

The grouping of the provider

providericon

String

The icon of the provider

providers

String

The config provider values

providertype

String

The type of the provider

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

Filter keys for CreditNote object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

billingentityvatno

String

The VAT number or tax reference of the billing entity / invoicing party

creditnote

boolean

The boolean to indicate credit note

customername

String

The name associated with the invoice

customeruuid

String

The UUID of the customer

customervatno

String

The VAT number or tax reference of the customer / recipient of the invoice

cutoffdate

Long

The invoice cut off date (UNIX TIMESTAMP)

duedate

Long

The invoice due date (UNIX TIMESTAMP)

invoicedate

Long

The date of the invoice as printed on the invoice

invoiceitems.description

String

The invoice line description

invoiceitems.invoiceitemtaxamt

double

The amount of tax associated with the invoice line

invoiceitems.invoiceitemtotalexc

double

The value associated with the invoice line (excluding tax)

invoiceitems.invoiceuuid

String

The UUID of the invoice

invoiceitems.productpurchaseuuid

String

Purcshase UUID is the invoice item is linked with a purchase

invoiceitems.quantity

long

The quantity associated with the invoice item

invoiceitems.taxrate

double

The tax rate

invoiceitems.unitprice

double

The unit price associated with the invoice item

invoiceno

long

The invoice number

invoicetaxamt

double

The amount of tax associated with the invoice

invoicetotalexc

double

The invoice total excluding tax

invoicetotalinc

double

The invoice total including tax

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

paiddate

Long

The UNIX TIMESTAMP when invoice was paid

paymentmethodinstancename

String

The name of the associated FDL code Payment Method

paymentmethodinstanceuuid

String

The payment method instance uuid

pdf

String

The pdf format of the invoice

pdfref

String

The PDF reference of the invoice

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

status

InvoiceStatus

The invoice status

taxrate

double

The tax rate of the invoice

testmode

boolean

The test mode

transactionuuid

String

The UUID of the transaction

Filter keys for Currency object

Name

Data type

Description

code

String

The currency code

decimalplace

int

The number of decimal places used by the currency

description

String

The currency description

symbol

String

The currency symbol

Filter keys for Customer object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

carryoverbalance

double

The customer's current carry-over unit balance

creditcustomer

PaymentType

A flag to indicate whether the customer has a credit account

customeruuid

String

The UUID of the customer (which will be the same as the resource UUID)

exceedcreditlimit

Boolean

Boolean indicating if customer exceeds the credit limit

exceedcutofflimit

Boolean

Boolean indicating if customer exceeds the cuoff limit

instancekey

long

A field to help managing billing of customers

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

noncarryoverbalance

double

The customer's current non-carry-over unit balance

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

promotionname

String

The name of the promotion last associated with the resource

promotionuuid

String

The UUID of the promotion last associated with the resource

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

status

Status

The status of the customer (determining whether it is active etc.)

Filter keys for CustomerDetails object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

carryoverbalance

double

The customer's current carry-over unit balance

creditcustomer

PaymentType

A flag to indicate whether the customer has a credit account

customercardcheck

boolean

A flag to indicate whether the customer requires credit card checks

customeruuid

String

The UUID of the customer (which will be the same as the resource UUID)

email

String

The email address associated with the user / contact

exceedcreditlimit

Boolean

Boolean indicating if customer exceeds the credit limit

exceedcutofflimit

Boolean

Boolean indicating if customer exceeds the cuoff limit

instancekey

long

A field to help managing billing of customers

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

noncarryoverbalance

double

The customer's current non-carry-over unit balance

organisationname

String

The organisation name for the customer

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

promotionname

String

The name of the promotion last associated with the resource

promotionuuid

String

The UUID of the promotion last associated with the resource

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

status

Status

The status of the customer (determining whether it is active etc.)

timezone

String

The timezone associated with the customer

users.billingentityname

String

The Name of the Billing Entity to which the resource belongs

users.billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

users.daytimenumber

String

The daytime telephone number associated with the user / contact

users.email

String

The email address associated with the user / contact

users.eveningnumber

String

The evening telephone number associated with the user / contact

users.faxnumber

String

The fax number associated with the user / contact

users.firstname

String

The first name of the contact

users.lastlogintime

Date

The last login time associated with the user / contact

users.lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

users.lastname

String

The last name of the contact

users.mobilenumber

String

The mobile number associated with the user / contact

users.organisation

String

The organisation name associated with the user / contact

users.providers

String

The config provider values

users.resourcecreatedate

Date

The creation date of the resource

users.resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

users.resourcekey.name

String

The name of the key

users.resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

users.resourcekey.type

ResourceKeyType

The type of the key (system or user)

users.resourcekey.value

String

The value set on the key

users.resourcekey.weight

double

The affinity weight of the key (zero means none)

users.resourcename

String

The name of the resource

users.resourcestate

ResourceState

The state of the resource

users.resourcetype

ResourceType

The type of the resource

users.resourceuuid

String

The UUID of the resource (read-only)

users.sortorder

Integer

The sort order value for the given resource

users.usertype

UserType

The type of user represented by this object.

vatexempt

boolean

The VAT exemption status of the customer

vatnumber

String

The VAT number or tax reference for the customer

warninglevel

double

The unit level below which which a low balance warning should be sent

warningsent

boolean

A flag to indicate the low balance warning has already been sent

zerosent

boolean

A flag to indicate that a zero balance notification has already been sent

Filter keys for CustomerResource object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

Filter keys for DeploymentInstance object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

deploymentinstancename

String

The name of the deployment instance the resource is created from

deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

deploymenttemplatename

String

The name of the template from which its been instantiated

deploymenttemplateuuid

String

The UUID of the template

instancechargeproductoffername

String

The name of the product offer used to charge for the deployment instance on deploy

instancechargeproductofferuuid

String

The UUID of the product offer used to charge for the deployment instance on deploy

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

ownerpermission

TemplateProtectionPermission

The owner template permissions

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providers

String

The config provider values

publishedto.resourcename

String

the name of the resource to whom publication is made

publishedto.resourcetype

ResourceType

the type of the resource to whom publication is made

publishedto.resourceuuid

String

the UUID of the resource to whom publication is made (either a customer, or a billing entity, or NULL for the platform as a whole)

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

status

DeploymentInstanceStatus

The UUID of the deployment instance

templatekey

String

The server key of the server (for image/server cryptographic validation)

templateowneruuid

String

The owner customer of the template

userpermission

TemplateProtectionPermission

The user permission

vdcname

String

The name of the VDC in which the resource is contained

vdcuuid

String

The UUID of the VDC in which the resource is contained

Filter keys for DeploymentTemplate object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

deploymentinstancename

String

The name of the deployment instance the resource is created from

deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

instancechargeproductoffername

String

The name of the product offer used to charge for the deployment instance on deploy

instancechargeproductofferuuid

String

The UUID of the product offer used to charge for the deployment instance on deploy

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providers

String

The config provider values

publishedto.resourcename

String

the name of the resource to whom publication is made

publishedto.resourcetype

ResourceType

the type of the resource to whom publication is made

publishedto.resourceuuid

String

the UUID of the resource to whom publication is made (either a customer, or a billing entity, or NULL for the platform as a whole)

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

vdcname

String

The name of the VDC in which the resource is contained

vdcuuid

String

The UUID of the VDC in which the resource is contained

Filter keys for Disk object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

deploymentinstancename

String

The name of the deployment instance the resource is created from

deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

imagename

String

The name of the OS image from which the disk was derived

imageuuid

String

The UUID of the OS Image from which the disk was derived

index

int

The index of the disk (zero-based) specifying its position within the server to which it is attached

iso

boolean

Indicate if the disk in a iso or not

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

servername

String

The name of the server to which the disk is attached

serveruuid

String

The UUID of the server to which the disk is attached

size

long

The capacity of the disk

snapshotname

String

The name of the snapshot from which the disk was derived

snapshotuuid

String

The UUID of the snapshot from which the disk was derived

sortorder

Integer

The sort order value for the given resource

status

DiskStatus

The status of the disk

storagegroupname

String

The storage group Name

storagegroupuuid

String

The storage group UUID

storageunitname

String

The name of the storage unit, This will only be accessible to MBE admins

storageunituuid

String

The UUID of the storage unit, This will only be accessible to MBE admins

vdcname

String

The name of the VDC in which the resource is contained

vdcuuid

String

The UUID of the VDC in which the resource is contained

Filter keys for FDLCodeBlock object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

editable

boolean

Indicates whether the code block may be modified

fdlhash

String

A unique hash representing the current state of the FDL Code Block

fdlproviderinfo

String

A map of the provider information for the FDL Code Block

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

signatoryuuid

String

Holds the UUID of the customer which initiated the signing of the code block

signingtimestamp

Date

Holds the timestamp at which the code was signed

sortorder

Integer

The sort order value for the given resource

Filter keys for Firewall object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

deploymentinstancename

String

The name of the deployment instance the resource is created from

deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

ipaddress

String

the IP address to which the firewall is attached

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

templatename

String

the name of the firewall template

templateuuid

String

the UUID of the firewall template

vdcname

String

The name of the VDC in which the resource is contained

vdcuuid

String

The UUID of the VDC in which the resource is contained

Filter keys for FirewallRule object

Name

Data type

Description

action

FirewallRuleAction

the firewall action

connstate

FirewallConnectionState

the connection state

icmpparam

ICMPParam

the ICMP type

ipaddress

String

the remote IP address

ipcidrmask

int

the remote IP address mask

localport

int

the local port (i.e. the port on the server)

name

String

the name of the rule within the FirewallTemplate

protocol

FirewallProtocol

the IP protocol being filtered

remoteport

int

the remote port (i.e. the port on the other end of the connection)

Filter keys for FirewallTemplate object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

defaultinaction

FirewallRuleAction

The default inbound firewall policy when no rules are matched

defaultoutaction

FirewallRuleAction

The default outbound firewall policy when no rules are matched

deploymentinstancename

String

The name of the deployment instance the resource is created from

deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

servicenetworkuuid

String

The UUID of the associated service network, if applicable

sortorder

Integer

The sort order value for the given resource

type

IPType

Whether the firewall is IPv4 or IPv6

vdcname

String

The name of the VDC in which the resource is contained

vdcuuid

String

The UUID of the VDC in which the resource is contained

Filter keys for Group object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

deploymentinstancename

String

The name of the deployment instance the resource is created from

deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

type

GroupType

The type of the group concerned

users

String

A collection of UUIDs of users that are members of this group

vdcname

String

The name of the VDC in which the resource is contained

vdcuuid

String

The UUID of the VDC in which the resource is contained

Filter keys for IP object

Name

Data type

Description

auto

boolean

A flag indicating whether the IP address is to be automatically assigned to the server (by DHCP or SLAAC)

gatewayaddress

String

The default gateway address

ipaddress

String

The IP address

nicuuid

String

The UUID of the NIC to which the IP address is attached

prefixlength

Integer

The prefix length of the ip

subnetuuid

String

The UUID of the subnet object in which the IP address is located

type

IPType

The type of the IP address (IPv4 or IPv6)

Filter keys for Image object

Name

Data type

Description

basename

String

The name of the resource from which the image was derived

baseuuid

String

The UUID of the resource from which the image was derived

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

ctsupport

Boolean

Indicate if the image supports containers

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

customervalidstring

String

The image's customer validation data

defaultuser

String

The default user for a server created using this image

deploymentinstancename

String

The name of the deployment instance the resource is created from

deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

genpassword

boolean

A flag indicating whether a password should be generated when this image is used

imagetype

ImageType

The type of image concerned (disk or server)

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

oschargeproductoffername

String

The name of the product offer used to charge for the image

oschargeproductofferuuid

String

The UUID of the product offer used to charge for the image

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providers

String

The config provider values

publishedto.resourcename

String

the name of the resource to whom publication is made

publishedto.resourcetype

ResourceType

the type of the resource to whom publication is made

publishedto.resourceuuid

String

the UUID of the resource to whom publication is made (either a customer, or a billing entity, or NULL for the platform as a whole)

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

size

long

The size of the image

sortorder

Integer

The sort order value for the given resource

vdcname

String

The name of the VDC in which the resource is contained

vdcuuid

String

The UUID of the VDC in which the resource is contained

vmsupport

Boolean

Indicate if the image supports virtual machines

Filter keys for Invoice object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

billingentityvatno

String

The VAT number or tax reference of the billing entity / invoicing party

creditnote

boolean

The boolean to indicate credit note

customername

String

The name associated with the invoice

customeruuid

String

The UUID of the customer

customervatno

String

The VAT number or tax reference of the customer / recipient of the invoice

cutoffdate

Long

The invoice cut off date (UNIX TIMESTAMP)

duedate

Long

The invoice due date (UNIX TIMESTAMP)

invoicedate

Long

The date of the invoice as printed on the invoice

invoiceitems.description

String

The invoice line description

invoiceitems.invoiceitemtaxamt

double

The amount of tax associated with the invoice line

invoiceitems.invoiceitemtotalexc

double

The value associated with the invoice line (excluding tax)

invoiceitems.invoiceuuid

String

The UUID of the invoice

invoiceitems.productpurchaseuuid

String

Purcshase UUID is the invoice item is linked with a purchase

invoiceitems.quantity

long

The quantity associated with the invoice item

invoiceitems.taxrate

double

The tax rate

invoiceitems.unitprice

double

The unit price associated with the invoice item

invoiceno

long

The invoice number

invoicetaxamt

double

The amount of tax associated with the invoice

invoicetotalexc

double

The invoice total excluding tax

invoicetotalinc

double

The invoice total including tax

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

paiddate

Long

The UNIX TIMESTAMP when invoice was paid

paymentmethodinstancename

String

The name of the associated FDL code Payment Method

paymentmethodinstanceuuid

String

The payment method instance uuid

pdf

String

The pdf format of the invoice

pdfref

String

The PDF reference of the invoice

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

status

InvoiceStatus

The invoice status

taxrate

double

The tax rate of the invoice

testmode

boolean

The test mode

transactionuuid

String

The UUID of the transaction

Filter keys for InvoiceItem object

Name

Data type

Description

description

String

The invoice line description

invoiceitemtaxamt

double

The amount of tax associated with the invoice line

invoiceitemtotalexc

double

The value associated with the invoice line (excluding tax)

invoiceuuid

String

The UUID of the invoice

productpurchaseuuid

String

Purcshase UUID is the invoice item is linked with a purchase

quantity

long

The quantity associated with the invoice item

taxrate

double

The tax rate

unitprice

double

The unit price associated with the invoice item

Filter keys for Job object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

deploymentinstancename

String

The name of the deployment instance the resource is created from

deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

endtime

Date

The end time of the job, required=true

errorcode

String

Holds the error code of the Error which was thrown while processing the job or null if the job was successful or has not yet completed

extendedtype

String

Pluggable resource type for jobs on pluggable resources

instanceuuid

String

Holds the uuid of the Jade's instance handling it

itemdescription

String

The description of the item

itemname

String

The name of the job item

itemtype

ResourceType

The type of the job item

itemuuid

String

The UUID of the resource to which the job relates

jobtype

JobType

The type of the job

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

parentjobuuid

String

The UUID of the parent job

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

scheduled

boolean

Whether the job is scheduled to run at a future date

sortorder

Integer

The sort order value for the given resource

starttime

Date

The start time of the job

status

JobStatus

The current status of the job

username

String

The name of the user that created the job

useruuid

String

The UUID of the user that created the job

vdcname

String

The name of the VDC in which the resource is contained

vdcuuid

String

The UUID of the VDC in which the resource is contained

Filter keys for MeasuredValue object

Name

Data type

Description

billingentityuuid

String

The UUID of the billing entity owning the customer

customeruuid

String

The UUID of the customer owning the resource

measuredresourcename

String

The name of the resource from which the measurement was taken

measuredresourcetype

ResourceType

The type of the resource from which the measurement was taken

measurekey

String

The unique name identifying the measurement taken and acting as a key

measurement

double

The numeric representation of the measurement value, if appropropriate

measurementstring

String

The string representation of the measurement value

measurementtype

MeasureType

The type of the measured value

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource from which the measurement was taken

timestamp

long

The measurement timestamp (as a Unix time stamp, seconds from 1 Jan 1970)

Filter keys for MeasurementFunction object

Name

Data type

Description

associatedtype

ResourceType

The measured type

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

extendedtype

String

The pluggable provider type associated with Pluggable Resource measurement function

fdldescription

String

The long form description of the FDL function.

fdlname

String

The name of the FDL Code Block that contains the function

fdluuid

String

The UUID of the FDL Code Block that contains the function.

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

measuredvalues

String

A map of measured values

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

waittime

long

The wait time

Filter keys for Network object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

deploymentinstancename

String

The name of the deployment instance the resource is created from

deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

ipv6routingenabled

boolean

A flag to indicate whether IPv6 should be routedby the routing element of the network (if any)

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

networktype

NetworkType

The type of the network

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

subnets.billingentityname

String

The Name of the Billing Entity to which the resource belongs

subnets.billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

subnets.broadcastaddress

String

The broadcast address (i.e. last, or all ones address) within the subnet

subnets.clustername

String

The name of the cluster in which the resource is located

subnets.clusteruuid

String

The UUID of the cluster in which the resource is located

subnets.customername

String

The name of the customer that owns the resource

subnets.customeruuid

String

The UUID of the customer that owns the resource

subnets.defaultgatewayaddress

String

The default gateway

subnets.deploymentinstancename

String

The name of the deployment instance the resource is created from

subnets.deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

subnets.firstusableaddress

String

The first usable address within the subnet

subnets.lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

subnets.mask

int

The CIDR length of the subnet mask

subnets.networkaddress

String

The network address (i.e. first, or all zeroes address) within the subnet

subnets.networkname

String

The name of the network on which the subnet resides

subnets.networktype

NetworkType

The type of network on which the subnet resides

subnets.networkuuid

String

The UUID of the network on which the subnet resides

subnets.productoffername

String

The name of the product offer associated with the resource

subnets.productofferuuid

String

The UUID of the product offer associated with the resource

subnets.providers

String

The config provider values

subnets.resourcecreatedate

Date

The creation date of the resource

subnets.resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

subnets.resourcekey.name

String

The name of the key

subnets.resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

subnets.resourcekey.type

ResourceKeyType

The type of the key (system or user)

subnets.resourcekey.value

String

The value set on the key

subnets.resourcekey.weight

double

The affinity weight of the key (zero means none)

subnets.resourcename

String

The name of the resource

subnets.resourcestate

ResourceState

The state of the resource

subnets.resourcetype

ResourceType

The type of the resource

subnets.resourceuuid

String

The UUID of the resource (read-only)

subnets.sortorder

Integer

The sort order value for the given resource

subnets.subnettype

IPType

The type of the subnet (i.e. IPv4 or IPv6)

subnets.systemallocated

Boolean

Indicates whether the subnet is allocated by the system or imported

subnets.vdcname

String

The name of the VDC in which the resource is contained

subnets.vdcuuid

String

The UUID of the VDC in which the resource is contained

vdcname

String

The name of the VDC in which the resource is contained

vdcuuid

String

The UUID of the VDC in which the resource is contained

Filter keys for Nic object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

deploymentinstancename

String

The name of the deployment instance the resource is created from

deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

index

int

The zero-based index of the NIC within the server to which the NIC is attached

ipaddresses.auto

boolean

A flag indicating whether the IP address is to be automatically assigned to the server (by DHCP or SLAAC)

ipaddresses.gatewayaddress

String

The default gateway address

ipaddresses.ipaddress

String

The IP address

ipaddresses.nicuuid

String

The UUID of the NIC to which the IP address is attached

ipaddresses.prefixlength

Integer

The prefix length of the ip

ipaddresses.subnetuuid

String

The UUID of the subnet object in which the IP address is located

ipaddresses.type

IPType

The type of the IP address (IPv4 or IPv6)

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

macaddress

String

The MAC address of the NIC

networkname

String

The name of the network to which the NIC is attached

networktype

NetworkType

The type of the network to which the Nic is attached

networkuuid

String

The UUID of the network to which the NIC is attached

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

servername

String

The name of the server to which the NIC is attached

serveruuid

String

The UUID of the server to which the NIC is attached

sortorder

Integer

The sort order value for the given resource

vdcname

String

The name of the VDC in which the resource is contained

vdcuuid

String

The UUID of the VDC in which the resource is contained

Filter keys for Node object

Name

Data type

Description

availablecpu

int

 

availableram

int

 

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

cpucontention

double

 

currentload

double

 

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

managementip

String

 

nodestate

NodeState

 

nodetype

NodeType

 

noncontentionfreeram

long

 

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providergroup

String

The group of the Pluggable Resource Provider that defined the Pluggable Resource

providericon

String

The icon of the Pluggable Resource Provider that defined the Pluggable Resource

providername

String

The name of the Pluggable Resource Provider that defined the Pluggable Resource

providers

String

The config provider values

providertype

String

The type of the Pluggable Resource Provider that defined the Pluggable Resource

provideruuid

String

The UUID of the Pluggable Resource Provider that defined the Pluggable Resource

ramcontention

double

 

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

routerstate

NodeRouterState

 

sortorder

Integer

The sort order value for the given resource

vnodeip

String

 

vnodestate

NodeState

 

Filter keys for PaymentCard object

Name

Data type

Description

authcode

String

The payment provider's authentication for the card concerned

avsdetail

String

Address verification details

avspassed

boolean

A flag indicating whether address verification has succeeded

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

carddefault

boolean

Flag indicating whether the card is the default card

customeruuid

String

UUID of the customer associated with the card

declinedtransaction

int

Number of declined transactions

dschecked

boolean

A flag indicating whether secondary authentication (e.g. 3DS) has been performed

dspassed

boolean

A flag indicating whether secondary authentication (e.g. 3DS) has succeeded

expirydate

String

The expiry date in MM/YY format

hash

String

Hash of card details

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

paymentmethoduuid

String

UUID of the payment method associated with the card

providers

String

The config provider values

reference

String

The payment provider's reference for the card concerned

registrationtime

String

[What is this and what is its format?]

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

scheme

String

The card type (allowable values defined by the payment processor)

sortorder

Integer

The sort order value for the given resource

Filter keys for PaymentMethod object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

configured

Boolean

State if the payment method has been successfully configured

consolidateinvoices

boolean

State if the collection loop will consolidate invoices if this is the selected payment method

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

paymentprovidername

String

The name of the associated payment provider

paymentprovideruuid

String

The UUID of the associated payment provider

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

Filter keys for PaymentMethodInstance object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

configuredvalues

Value

A list of the configured values for the payment method instance

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

isdefault

boolean

State if this is the default payment method instance for the associated customer

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

noninteractivepay

Boolean

State if the payment method instance can support non-interactive payments

paymentmethodname

String

The name of the associated payment method

paymentmethoduuid

String

The UUID of the associated payment method

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

Filter keys for PaymentProvider object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

description

String

Longform description of the payment method, populated from the FDL code block.

fdlname

String

The name of the associated FDL code block

fdlpaymentref

String

The reference for the payment provider from the FDL code block.

fdluuid

String

UUID of the FDL code block to which the Payment Method is linked.

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

pmconfigurablelist

Value

List of Configurable Values for the payment provider relating to the payment method. This field cannot be selected using FQL

pmiconfigurablelist

Value

List of Configurable Values for the payment provider relating to the payment method instance. This field cannot be selected using FQL

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

Filter keys for Permission object

Name

Data type

Description

capability

Capability

The capability concerned (i.e. the action which this permission tuple mediates)

permitted

boolean

Whether the action is to be permitted or denied

permittedresource.billingentityname

String

The Name of the Billing Entity to which the resource belongs

permittedresource.billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

permittedresource.lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

permittedresource.providers

String

The config provider values

permittedresource.resourcecreatedate

Date

The creation date of the resource

permittedresource.resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

permittedresource.resourcekey.name

String

The name of the key

permittedresource.resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

permittedresource.resourcekey.type

ResourceKeyType

The type of the key (system or user)

permittedresource.resourcekey.value

String

The value set on the key

permittedresource.resourcekey.weight

double

The affinity weight of the key (zero means none)

permittedresource.resourcename

String

The name of the resource

permittedresource.resourcestate

ResourceState

The state of the resource

permittedresource.resourcetype

ResourceType

The type of the resource

permittedresource.resourceuuid

String

The UUID of the resource (read-only)

permittedresource.sortorder

Integer

The sort order value for the given resource

permittedto.resourcename

String

the name of the resource

permittedto.resourcetype

ResourceType

the type of the resource

permittedto.resourceuuid

String

the UUID of the resource

Filter keys for PluggableResource object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providergroup

String

The group of the Pluggable Resource Provider that defined the Pluggable Resource

providericon

String

The icon of the Pluggable Resource Provider that defined the Pluggable Resource

providername

String

The name of the Pluggable Resource Provider that defined the Pluggable Resource

providers

String

The config provider values

providertype

String

The type of the Pluggable Resource Provider that defined the Pluggable Resource

provideruuid

String

The UUID of the Pluggable Resource Provider that defined the Pluggable Resource

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

Filter keys for PluggableResourceProvider object

Name

Data type

Description

associatedresourcetypes

String

A list of associated resource types

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

fdldescription

String

The description of the function

fdlname

String

The name of the FDL Code Block that contains the provider

fdluuid

String

The UUID of FDL Code Block that contains the provider

inuse

Boolean

State if the provider is in use

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

productcomponenttypes.billingentityname

String

The Name of the Billing Entity to which the resource belongs

productcomponenttypes.billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

productcomponenttypes.lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

productcomponenttypes.providers

String

The config provider values

productcomponenttypes.referencefield

String

The user friendly unique refernce given to the PCT

productcomponenttypes.resourcecreatedate

Date

The creation date of the resource

productcomponenttypes.resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

productcomponenttypes.resourcekey.name

String

The name of the key

productcomponenttypes.resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

productcomponenttypes.resourcekey.type

ResourceKeyType

The type of the key (system or user)

productcomponenttypes.resourcekey.value

String

The value set on the key

productcomponenttypes.resourcekey.weight

double

The affinity weight of the key (zero means none)

productcomponenttypes.resourcename

String

The name of the resource

productcomponenttypes.resourcestate

ResourceState

The state of the resource

productcomponenttypes.resourcetype

ResourceType

The type of the resource

productcomponenttypes.resourceuuid

String

The UUID of the resource (read-only)

productcomponenttypes.sortorder

Integer

The sort order value for the given resource

providerdata.allowcustomeredit

Boolean

State if the customer should be allowed to edit the provider settings

providerdata.productcomponenttypes.billingentityname

String

The Name of the Billing Entity to which the resource belongs

providerdata.productcomponenttypes.billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

providerdata.productcomponenttypes.lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

providerdata.productcomponenttypes.providers

String

The config provider values

providerdata.productcomponenttypes.referencefield

String

The user friendly unique refernce given to the PCT

providerdata.productcomponenttypes.resourcecreatedate

Date

The creation date of the resource

providerdata.productcomponenttypes.resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

providerdata.productcomponenttypes.resourcekey.name

String

The name of the key

providerdata.productcomponenttypes.resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

providerdata.productcomponenttypes.resourcekey.type

ResourceKeyType

The type of the key (system or user)

providerdata.productcomponenttypes.resourcekey.value

String

The value set on the key

providerdata.productcomponenttypes.resourcekey.weight

double

The affinity weight of the key (zero means none)

providerdata.productcomponenttypes.resourcename

String

The name of the resource

providerdata.productcomponenttypes.resourcestate

ResourceState

The state of the resource

providerdata.productcomponenttypes.resourcetype

ResourceType

The type of the resource

providerdata.productcomponenttypes.resourceuuid

String

The UUID of the resource (read-only)

providerdata.productcomponenttypes.sortorder

Integer

The sort order value for the given resource

providerdata.resourcetype

String

The associated resource type

providerdata.usewithbilling

boolean

State if the provider should be used with the billing system

providergroup

String

The grouping of the provider

providericon

String

The icon of the provider

providers

String

The config provider values

providertype

String

The type of the provider

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

Filter keys for Product object

Name

Data type

Description

associatedtype

ResourceType

The associated resource type (or pseudo-resource type) that the product builds when purchased

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

components.billingentityname

String

The Name of the Billing Entity to which the resource belongs

components.billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

components.lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

components.providers

String

The config provider values

components.referencefield

String

The user friendly unique refernce given to the PCT

components.resourcecreatedate

Date

The creation date of the resource

components.resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

components.resourcekey.name

String

The name of the key

components.resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

components.resourcekey.type

ResourceKeyType

The type of the key (system or user)

components.resourcekey.value

String

The value set on the key

components.resourcekey.weight

double

The affinity weight of the key (zero means none)

components.resourcename

String

The name of the resource

components.resourcestate

ResourceState

The state of the resource

components.resourcetype

ResourceType

The type of the resource

components.resourceuuid

String

The UUID of the resource (read-only)

components.sortorder

Integer

The sort order value for the given resource

extendedtype

String

The pluggable provider type associated with Pluggable Resource product

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

Filter keys for ProductComponentType object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

providers

String

The config provider values

referencefield

String

The user friendly unique refernce given to the PCT

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

Filter keys for ProductOffer object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

billingperiod

BillingPeriod

The billing period associated with the product offer (i.e how often a billing line is generated)

inuse

Boolean

Indicates if purchases already exists for this product offer

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

product.associatedtype

ResourceType

The associated resource type (or pseudo-resource type) that the product builds when purchased

product.billingentityname

String

The Name of the Billing Entity to which the resource belongs

product.billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

product.components.billingentityname

String

The Name of the Billing Entity to which the resource belongs

product.components.billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

product.components.lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

product.components.providers

String

The config provider values

product.components.referencefield

String

The user friendly unique refernce given to the PCT

product.components.resourcecreatedate

Date

The creation date of the resource

product.components.resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

product.components.resourcekey.name

String

The name of the key

product.components.resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

product.components.resourcekey.type

ResourceKeyType

The type of the key (system or user)

product.components.resourcekey.value

String

The value set on the key

product.components.resourcekey.weight

double

The affinity weight of the key (zero means none)

product.components.resourcename

String

The name of the resource

product.components.resourcestate

ResourceState

The state of the resource

product.components.resourcetype

ResourceType

The type of the resource

product.components.resourceuuid

String

The UUID of the resource (read-only)

product.components.sortorder

Integer

The sort order value for the given resource

product.extendedtype

String

The pluggable provider type associated with Pluggable Resource product

product.lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

product.providers

String

The config provider values

product.resourcecreatedate

Date

The creation date of the resource

product.resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

product.resourcekey.name

String

The name of the key

product.resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

product.resourcekey.type

ResourceKeyType

The type of the key (system or user)

product.resourcekey.value

String

The value set on the key

product.resourcekey.weight

double

The affinity weight of the key (zero means none)

product.resourcename

String

The name of the resource

product.resourcestate

ResourceState

The state of the resource

product.resourcetype

ResourceType

The type of the resource

product.resourceuuid

String

The UUID of the resource (read-only)

product.sortorder

Integer

The sort order value for the given resource

productassociatedtype

ResourceType

The accociated resource type of the linked product

productextendedtype

String

The accociated extended type of the linked product

productname

String

Holds the name of the product

productuuid

String

Holds the UUID of the linked product

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

unittype

UnitType

The type of units associated with the product offer

Filter keys for ProductPurchase object

Name

Data type

Description

active

boolean

A flag indicating whether the product purchase is currently active

associatedextendedtype

String

The extended type of the associated resource

associatedresourcetype

ResourceType

The resource type of the associated resource

billingentityuuid

String

The UUID of the billing entity associated with the product purchase

customeruuid

String

The UUID of the customer associated with the product purchase

description

String

A textual description of the product purchase

donotrebill

boolean

A flag to indicate billing further billing periods should not be run

enddate

Date

The end date/time of the product period

instancekey

long

A field to help managing billing of products purchased

lastbillperiod

Date

The end date/time of the last billing period

nextbillperiod

Date

The start date/time of the next billing period

productid

long

The underlying productid of the product offer which linked with the current purchase

productofferuuid

String

The UUID of the associated product offer

purchasedate

Date

The date/time the product purchase was made

purchaseuuid

String

The UUID of the product purchase

referenceuuid

String

The UUID of the product purchase (deprecated please use purchaseUUID )

resourceuuid

String

The UUID of the resource associated with the product purchase

startdate

Date

The start date/time of the product purchase

vdcuuid

String

The UUID of the VDC associated with the product purchase

Filter keys for PromoCode object

Name

Data type

Description

promocode

String

The promotion code

promotionuuid

String

The promotion UUID

reuse

boolean

A flag to indicate whether the promotion code can be reused

used

boolean

A flag to indicate the promotion code has been used

Filter keys for Promotion object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

enddate

Date

The end date of the promotion code type

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

nocardcheck

boolean

A flag to indicate whether a card check can be skipped with the promotion code

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The numeric product offer ID associated with the promotion code

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

startdate

Date

The start date of the promotion code type

Filter keys for ProviderData object

Name

Data type

Description

allowcustomeredit

Boolean

State if the customer should be allowed to edit the provider settings

productcomponenttypes.billingentityname

String

The Name of the Billing Entity to which the resource belongs

productcomponenttypes.billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

productcomponenttypes.lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

productcomponenttypes.providers

String

The config provider values

productcomponenttypes.referencefield

String

The user friendly unique refernce given to the PCT

productcomponenttypes.resourcecreatedate

Date

The creation date of the resource

productcomponenttypes.resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

productcomponenttypes.resourcekey.name

String

The name of the key

productcomponenttypes.resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

productcomponenttypes.resourcekey.type

ResourceKeyType

The type of the key (system or user)

productcomponenttypes.resourcekey.value

String

The value set on the key

productcomponenttypes.resourcekey.weight

double

The affinity weight of the key (zero means none)

productcomponenttypes.resourcename

String

The name of the resource

productcomponenttypes.resourcestate

ResourceState

The state of the resource

productcomponenttypes.resourcetype

ResourceType

The type of the resource

productcomponenttypes.resourceuuid

String

The UUID of the resource (read-only)

productcomponenttypes.sortorder

Integer

The sort order value for the given resource

resourcetype

String

The associated resource type

usewithbilling

boolean

State if the provider should be used with the billing system

Filter keys for PseudoResource object

Name

Data type

Description

resourcetype

ResourceType

The type of the resource

Filter keys for PublishTo object

Name

Data type

Description

resourcename

String

the name of the resource to whom publication is made

resourcetype

ResourceType

the type of the resource to whom publication is made

resourceuuid

String

the UUID of the resource to whom publication is made (either a customer, or a billing entity, or NULL for the platform as a whole)

Filter keys for PurchasedUnits object

Name

Data type

Description

billingentityuuid

String

The UUID of the Billing Entity

customeruuid

String

The UUID of the customer associated with the unit purchase

date

Date

The date of the unit purchase

unitspurchased

double

The number of units purchased

Filter keys for ReferralPromoCode object

Name

Data type

Description

emailaddress

String

The email address associated with the promo code

expirydate

Date

The expiry date of the promo code

inviteecustomeruuid

String

The invitee's customer UUID with which it is associated

invitorcustomeruuid

String

The invitor's customer UUID with which it is associated

promocode

String

The promotion code

promotionuuid

String

The promotion UUID

reuse

boolean

A flag to indicate whether the promotion code can be reused

status

ReferralStatus

The referral status of the promo code

used

boolean

A flag to indicate the promotion code has been used

Filter keys for ReferralPromotion object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

enddate

Date

The end date of the promotion code type

inviteeminimumpurchase

int

The minimum unit purchase by the invitee to achieve successful completion

invitorproductofferuuid

String

The number of units the invitor receives on successful completion

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

maxoutstanding

int

The maximum number of outstanding instances of this referral promotion

nocardcheck

boolean

A flag to indicate whether a card check can be skipped with the promotion code

priority

int

The priority of the referral scheme

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The numeric product offer ID associated with the promotion code

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

startdate

Date

The start date of the promotion code type

unitcost

double

The cost to the invitor's outstanding invitation balance

Filter keys for ReportMethod object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

fdldescription

String

The long form description of the FDL function.

fdlname

String

The name of the FDL Code Block that contains the function

fdlreference

String

The unique reference of the report method entry point in the FDL Code Block

fdluuid

String

The UUID of the FDL Code Block that contains the report method.

inputvalues

Value

A list of configured values which represent the required input for the report method

invocationlevel

InvocationLevel

The level of authentication required to access the report method

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

supportedreportcharttypes

ReportChartType

A set of report chart types whcih are supported by the report method.

Filter keys for Resource object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

Filter keys for ResourceKey object

Name

Data type

Description

extraflag

Integer

Extra flag to indicate whether key is a sticky key

name

String

The name of the key

resourceuuid

String

The UUID of the resource to which the key is attached

type

ResourceKeyType

The type of the key (system or user)

value

String

The value set on the key

weight

double

The affinity weight of the key (zero means none)

Filter keys for SSHKey object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

deploymentinstancename

String

The name of the deployment instance the resource is created from

deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

globalkey

boolean

States if the SHHKey is a global key

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

linkedservers

String

The UUID of the server to which the ssh key is attached

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providers

String

The config provider values

publickey

String

The public key in the same format as a line from authorized_keys

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

username

String

The username to which the ssh key applies (or none to make it apply to the default initial user)

vdcname

String

The name of the VDC in which the resource is contained

vdcuuid

String

The UUID of the VDC in which the resource is contained

Filter keys for Server object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

cpu

int

The number of virtual CPU cores assigned to the server

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

deploymentinstancename

String

The name of the deployment instance the resource is created from

deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

disableemulateddevices

boolean

Instruct the hypervisor running the server to disable emulated devices or not. This will only work if the cluster has the DISABLE_EMULATED_DEVICE feature set. If the emulated devices are set to be disabled (default setting) the the server will be only presenetd with the para-virtualized devices. Any change to this value will need a server stop start

disks.billingentityname

String

The Name of the Billing Entity to which the resource belongs

disks.billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

disks.clustername

String

The name of the cluster in which the resource is located

disks.clusteruuid

String

The UUID of the cluster in which the resource is located

disks.customername

String

The name of the customer that owns the resource

disks.customeruuid

String

The UUID of the customer that owns the resource

disks.deploymentinstancename

String

The name of the deployment instance the resource is created from

disks.deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

disks.imagename

String

The name of the OS image from which the disk was derived

disks.imageuuid

String

The UUID of the OS Image from which the disk was derived

disks.index

int

The index of the disk (zero-based) specifying its position within the server to which it is attached

disks.iso

boolean

Indicate if the disk in a iso or not

disks.lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

disks.productoffername

String

The name of the product offer associated with the resource

disks.productofferuuid

String

The UUID of the product offer associated with the resource

disks.providers

String

The config provider values

disks.resourcecreatedate

Date

The creation date of the resource

disks.resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

disks.resourcekey.name

String

The name of the key

disks.resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

disks.resourcekey.type

ResourceKeyType

The type of the key (system or user)

disks.resourcekey.value

String

The value set on the key

disks.resourcekey.weight

double

The affinity weight of the key (zero means none)

disks.resourcename

String

The name of the resource

disks.resourcestate

ResourceState

The state of the resource

disks.resourcetype

ResourceType

The type of the resource

disks.resourceuuid

String

The UUID of the resource (read-only)

disks.servername

String

The name of the server to which the disk is attached

disks.serveruuid

String

The UUID of the server to which the disk is attached

disks.size

long

The capacity of the disk

disks.snapshotname

String

The name of the snapshot from which the disk was derived

disks.snapshotuuid

String

The UUID of the snapshot from which the disk was derived

disks.sortorder

Integer

The sort order value for the given resource

disks.status

DiskStatus

The status of the disk

disks.storagegroupname

String

The storage group Name

disks.storagegroupuuid

String

The storage group UUID

disks.storageunitname

String

The name of the storage unit, This will only be accessible to MBE admins

disks.storageunituuid

String

The UUID of the storage unit, This will only be accessible to MBE admins

disks.vdcname

String

The name of the VDC in which the resource is contained

disks.vdcuuid

String

The UUID of the VDC in which the resource is contained

imagename

String

The name of the image from which the server was built

imageuuid

String

The UUID of the image from which the server was built

initialpassword

String

The initial user name associated with the server (passed by metadata so a first boot process can initialise the operating system image)

initialuser

String

The initial user name associated with the server (passed by metadata so a first boot process can initialise the operating system image)

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

nics.billingentityname

String

The Name of the Billing Entity to which the resource belongs

nics.billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

nics.clustername

String

The name of the cluster in which the resource is located

nics.clusteruuid

String

The UUID of the cluster in which the resource is located

nics.customername

String

The name of the customer that owns the resource

nics.customeruuid

String

The UUID of the customer that owns the resource

nics.deploymentinstancename

String

The name of the deployment instance the resource is created from

nics.deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

nics.index

int

The zero-based index of the NIC within the server to which the NIC is attached

nics.ipaddresses.auto

boolean

A flag indicating whether the IP address is to be automatically assigned to the server (by DHCP or SLAAC)

nics.ipaddresses.gatewayaddress

String

The default gateway address

nics.ipaddresses.ipaddress

String

The IP address

nics.ipaddresses.nicuuid

String

The UUID of the NIC to which the IP address is attached

nics.ipaddresses.prefixlength

Integer

The prefix length of the ip

nics.ipaddresses.subnetuuid

String

The UUID of the subnet object in which the IP address is located

nics.ipaddresses.type

IPType

The type of the IP address (IPv4 or IPv6)

nics.lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

nics.macaddress

String

The MAC address of the NIC

nics.networkname

String

The name of the network to which the NIC is attached

nics.networktype

NetworkType

The type of the network to which the Nic is attached

nics.networkuuid

String

The UUID of the network to which the NIC is attached

nics.productoffername

String

The name of the product offer associated with the resource

nics.productofferuuid

String

The UUID of the product offer associated with the resource

nics.providers

String

The config provider values

nics.resourcecreatedate

Date

The creation date of the resource

nics.resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

nics.resourcekey.name

String

The name of the key

nics.resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

nics.resourcekey.type

ResourceKeyType

The type of the key (system or user)

nics.resourcekey.value

String

The value set on the key

nics.resourcekey.weight

double

The affinity weight of the key (zero means none)

nics.resourcename

String

The name of the resource

nics.resourcestate

ResourceState

The state of the resource

nics.resourcetype

ResourceType

The type of the resource

nics.resourceuuid

String

The UUID of the resource (read-only)

nics.servername

String

The name of the server to which the NIC is attached

nics.serveruuid

String

The UUID of the server to which the NIC is attached

nics.sortorder

Integer

The sort order value for the given resource

nics.vdcname

String

The name of the VDC in which the resource is contained

nics.vdcuuid

String

The UUID of the VDC in which the resource is contained

nodeip

String

The IP of the associated node for a running server

nodename

String

The Name of the associated node for a running server

nodeuuid

String

The UUID of the associated node for a running server

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providers

String

The config provider values

ram

int

The amount of memory assigned to the server

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

serverkey

String

The server key of the server (for image/server cryptographic validation)

snapshotuuid

String

The UUID of the snapshot from which the server was cloned

sortorder

Integer

The sort order value for the given resource

sshkeys.billingentityname

String

The Name of the Billing Entity to which the resource belongs

sshkeys.billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

sshkeys.clustername

String

The name of the cluster in which the resource is located

sshkeys.clusteruuid

String

The UUID of the cluster in which the resource is located

sshkeys.customername

String

The name of the customer that owns the resource

sshkeys.customeruuid

String

The UUID of the customer that owns the resource

sshkeys.deploymentinstancename

String

The name of the deployment instance the resource is created from

sshkeys.deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

sshkeys.globalkey

boolean

States if the SHHKey is a global key

sshkeys.lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

sshkeys.linkedservers

String

The UUID of the server to which the ssh key is attached

sshkeys.productoffername

String

The name of the product offer associated with the resource

sshkeys.productofferuuid

String

The UUID of the product offer associated with the resource

sshkeys.providers

String

The config provider values

sshkeys.publickey

String

The public key in the same format as a line from authorized_keys

sshkeys.resourcecreatedate

Date

The creation date of the resource

sshkeys.resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

sshkeys.resourcekey.name

String

The name of the key

sshkeys.resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

sshkeys.resourcekey.type

ResourceKeyType

The type of the key (system or user)

sshkeys.resourcekey.value

String

The value set on the key

sshkeys.resourcekey.weight

double

The affinity weight of the key (zero means none)

sshkeys.resourcename

String

The name of the resource

sshkeys.resourcestate

ResourceState

The state of the resource

sshkeys.resourcetype

ResourceType

The type of the resource

sshkeys.resourceuuid

String

The UUID of the resource (read-only)

sshkeys.sortorder

Integer

The sort order value for the given resource

sshkeys.username

String

The username to which the ssh key applies (or none to make it apply to the default initial user)

sshkeys.vdcname

String

The name of the VDC in which the resource is contained

sshkeys.vdcuuid

String

The UUID of the VDC in which the resource is contained

status

ServerStatus

The status of the server (e.g. whether it is running or stopped)

vdcname

String

The name of the VDC in which the resource is contained

vdcuuid

String

The UUID of the VDC in which the resource is contained

virtualizationtype

VirtualizationType

The virtualization type of the server

Filter keys for SimpleResource object

Name

Data type

Description

resourcename

String

the name of the resource

resourcetype

ResourceType

the type of the resource

resourceuuid

String

the UUID of the resource

Filter keys for Snapshot object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

deploymentinstancename

String

The name of the deployment instance the resource is created from

deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

parentname

String

The name of the object which was snapshotted

parentproductofferuuid

String

The UUID of the product offer of the parent which was snapshotted

parenttype

ResourceType

The type of the object which was snapshotted

parentuuid

String

The UUID of the object which was snapshotted

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

type

SnapshotType

The type of the snapshot (disk or server)

vdcname

String

The name of the VDC in which the resource is contained

vdcuuid

String

The UUID of the VDC in which the resource is contained

Filter keys for StatementDetail object

Name

Data type

Description

balancetodate

double

The balance of the customer when the statement detail was created.

creditamount

double

The credit amount for the statement detail.

customeruuid

String

The UUID of the customer associated with the statement detail.

debitamount

double

The debit amount for the statement detail.

description

String

The description of the statement detail.

lastbalance

double

The balance of the customer before the statement detail was created.

recordtype

StatementType

The type of statement detail.

reference

String

The UUID of the invoice, transaction or credit note associated with the statement detail.

timestamp

long

The date/time the statement detail was created.

Filter keys for StorageGroup object

Name

Data type

Description

allocatedstoragespace

long

The allocated storage space in GB of the whole group

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

freestoragespace

long

The free storage space in GB of the whole group

hasstorageunit

boolean

State if this storage group has an assigned stoage unit

isdefaultgroup

boolean

State if this is the default storage group

isimagegroup

boolean

State if this is an image storage group

islocalgroup

boolean

State if this is a local storage group

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

totalstoragespace

long

The totaal storage space in GB of the whole group

Filter keys for StorageUnit object

Name

Data type

Description

allocatedspace

double

The allocated space of the storage unit.

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

freespace

double

The free space available.

islocalstorage

boolean

State if the storage unit is local storage

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providergroup

String

The group of the Pluggable Resource Provider that defined the Pluggable Resource

providericon

String

The icon of the Pluggable Resource Provider that defined the Pluggable Resource

providername

String

The name of the Pluggable Resource Provider that defined the Pluggable Resource

providers

String

The config provider values

providertype

String

The type of the Pluggable Resource Provider that defined the Pluggable Resource

provideruuid

String

The UUID of the Pluggable Resource Provider that defined the Pluggable Resource

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

storagegroupname

String

The linked storage Unit Group name

storagegroupuuid

String

The linked storage Unit Group UUID

storageunittype

StorageUnitType

The type of storage unit.

totalspace

double

The total space available.

Filter keys for Subnet object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

broadcastaddress

String

The broadcast address (i.e. last, or all ones address) within the subnet

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

defaultgatewayaddress

String

The default gateway

deploymentinstancename

String

The name of the deployment instance the resource is created from

deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

firstusableaddress

String

The first usable address within the subnet

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

mask

int

The CIDR length of the subnet mask

networkaddress

String

The network address (i.e. first, or all zeroes address) within the subnet

networkname

String

The name of the network on which the subnet resides

networktype

NetworkType

The type of network on which the subnet resides

networkuuid

String

The UUID of the network on which the subnet resides

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

subnettype

IPType

The type of the subnet (i.e. IPv4 or IPv6)

systemallocated

Boolean

Indicates whether the subnet is allocated by the system or imported

vdcname

String

The name of the VDC in which the resource is contained

vdcuuid

String

The UUID of the VDC in which the resource is contained

Filter keys for Transaction object

Name

Data type

Description

allowinteractive

boolean

State if the transaction allows interactivity

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

currencycode

String

The currency code associated with the transaction

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

endtimestamp

long

A timestamp that represents the time the transaction ended.

errorcode

String

The error code associated with the transaction

errorreason

String

The error reason associated with the transaction

interactiveurl

String

The interactive url used by the transaction

invoiceuuidlist

String

A list of UUID of associated invoices or credit notes

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

linkedtransaction

String

The UUID of a linked transaction.

merchantdescription

String

A description of the transaction.

paymentamount

double

The amount associated with the transaction

paymentmethodinstancename

String

The name of the associated payment method instance

paymentmethodinstanceuuid

String

The UUID of the associated with the transaction

providerreference

String

The transaction reference from the associated payment provider

providers

String

The config provider values

publicdata

String

Public data associated with the transaction

redirectdata

String

A map of redirect data used by the transaction

redirectmethod

RedirectMethod

The redirect method used by the transaction

redirecturl

String

The redirect url used by the transaction

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

starttimestamp

long

A timestamp that represents the time the transaction started.

state

TransactionState

The state of the transaction

transactionfunction

PaymentFunction

The function that created the transaction

Filter keys for TransactionLog object

Name

Data type

Description

billingentityuuid

String

The UUID of billing entity to which the transaction relates

customeruuid

String

The UUID of customer to which the transaction relates

lastmodified

Date

The date at which the transaction was last modified

reference

String

The textual reference of the transaction as used by the payment processing module

request

String

The payment request as used by the payment processing module

response

String

The payment response as used by the payment processing module

Filter keys for Translation object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

editable

boolean

State if the Translation is editable.

language

String

The language code associated with the translation

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

parenttranslationname

String

The name of the parent translation.

parenttranslationuuid

String

The UUID of the parent translation.

providers

String

The config provider values

region

String

The region code associated with the translation

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

values

String

The un-compiled translation values

valueshash

String

The value of the hashed TranslationItem list

Filter keys for TriggerMethod object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

fdldescription

String

Longform description of the trigger method, populated by the FDL code block.

fdlname

String

The name of the FDL Code Block that contains the function

fdlpriority

int

Order in which the trigger method will be executed. Triggers are called in ascending order of priority.

fdltriggeroptions

String

The trigger type option that the trigger method will be invoked for. Example: for a POST_MODIFY trigger type with the option ANYwill be invoked by any resource which is modified, if resource type was set to CUSTOMER only Customer objects would invoke the trigger method.

fdltriggertype

TriggerType

The type of trigger this trigger method represents.

fdluuid

String

UUID of the FDL code block to which the trigger method is linked.

instancekey

long

A field used by scheduled triggers to manage multiple jade instances.

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

nextscheduledinvoke

long

The next scheduled invoke of this trigger method. Only valid for a SCHEDULED TriggerType TriggerMethod

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

scheduledrepeatfrequency

long

The frequency at which a scheduled invoke will occur. Only valid for a SCHEDULED TriggerType TriggerMethod

sortorder

Integer

The sort order value for the given resource

Filter keys for UnitTransaction object

Name

Data type

Description

billingentityuuid

String

Billing Entity UUID of the customer

chargedfromdate

Date

The start of the period to which the subject matter of the transaction relates

chargedtodate

Date

The end of the period to which the subject matter of the transaction relates

closingbalance

double

The closing balance after the unit transaction

customeruuid

String

The UUID of the customer

description

String

The textual description of the transaction

descriptiondetail

String

The textual description of the detail of the transaction

linkedextendedtype

String

The extended type of the resource linked with the unit tranaction

linkedpurchase.active

boolean

A flag indicating whether the product purchase is currently active

linkedpurchase.associatedextendedtype

String

The extended type of the associated resource

linkedpurchase.associatedresourcetype

ResourceType

The resource type of the associated resource

linkedpurchase.billingentityuuid

String

The UUID of the billing entity associated with the product purchase

linkedpurchase.customeruuid

String

The UUID of the customer associated with the product purchase

linkedpurchase.description

String

A textual description of the product purchase

linkedpurchase.donotrebill

boolean

A flag to indicate billing further billing periods should not be run

linkedpurchase.enddate

Date

The end date/time of the product period

linkedpurchase.instancekey

long

A field to help managing billing of products purchased

linkedpurchase.lastbillperiod

Date

The end date/time of the last billing period

linkedpurchase.nextbillperiod

Date

The start date/time of the next billing period

linkedpurchase.productid

long

The underlying productid of the product offer which linked with the current purchase

linkedpurchase.productofferuuid

String

The UUID of the associated product offer

linkedpurchase.purchasedate

Date

The date/time the product purchase was made

linkedpurchase.purchaseuuid

String

The UUID of the product purchase

linkedpurchase.referenceuuid

String

The UUID of the product purchase (deprecated please use purchaseUUID )

linkedpurchase.resourceuuid

String

The UUID of the resource associated with the product purchase

linkedpurchase.startdate

Date

The start date/time of the product purchase

linkedpurchase.vdcuuid

String

The UUID of the VDC associated with the product purchase

linkedresourcename

String

The name of the resource linked with the unit tranaction

linkedresourcetype

ResourceType

The resource type of the resource linked with the unit tranaction

linkedresourceuuid

String

The UUID of the resource linked with the unit tranaction

linkedservername

String

The name of the server linked with the unit tranaction

linkedserveruuid

String

The server UUID, if the link resource was part of a server at that time

openingbalance

double

The open balance before the unit transaction

resourcetype

ResourceType

The type of the resource

transactionamount

double

The amount of the unit transaction

transactiondate

Date

The date on which the unit transaction occurred

unitstype

UnitType

The unit type associated with the unit transaction

vdcuuid

String

The UUID of the vdc which is linked with the transaction

Filter keys for UnitTransactionSummary object

Name

Data type

Description

billingentityuuid

String

Billing Entity UUID of the customer

customername

String

The name of the customer associated with the transaction summary

customeruuid

String

The UUID associated with the transaction summary

freeunits

double

The total free units within the summary period

resourcetype

ResourceType

The type of the resource

transactiondate

Date

The date associated with the transaction summary

unitcredits

double

The total credits within the summary period

unitdebits

double

The total debits within the summary period

Filter keys for User object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

email

String

The email address associated with the user / contact

firstname

String

The first name of the contact

lastlogintime

Date

The last login time associated with the user / contact

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

lastname

String

The last name of the contact

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

usertype

UserType

The type of user represented by this object.

Filter keys for UserDetails object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

daytimenumber

String

The daytime telephone number associated with the user / contact

email

String

The email address associated with the user / contact

eveningnumber

String

The evening telephone number associated with the user / contact

faxnumber

String

The fax number associated with the user / contact

firstname

String

The first name of the contact

lastlogintime

Date

The last login time associated with the user / contact

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

lastname

String

The last name of the contact

mobilenumber

String

The mobile number associated with the user / contact

organisation

String

The organisation name associated with the user / contact

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

usertype

UserType

The type of user represented by this object.

Filter keys for VDC object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

deploymentinstancename

String

The name of the deployment instance the resource is created from

deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

vdcname

String

The name of the VDC in which the resource is contained

vdcuuid

String

The UUID of the VDC in which the resource is contained

Filter keys for VirtualResource object

Name

Data type

Description

billingentityname

String

The Name of the Billing Entity to which the resource belongs

billingentityuuid

String

The UUID of the Billing Entity to which the resource belongs

clustername

String

The name of the cluster in which the resource is located

clusteruuid

String

The UUID of the cluster in which the resource is located

customername

String

The name of the customer that owns the resource

customeruuid

String

The UUID of the customer that owns the resource

deploymentinstancename

String

The name of the deployment instance the resource is created from

deploymentinstanceuuid

String

The uuid of the deployment instance the resource is created from

lastmodifiedtime

Long

The time, in milliseconds from epoch, when the resource was last modified.

productoffername

String

The name of the product offer associated with the resource

productofferuuid

String

The UUID of the product offer associated with the resource

providers

String

The config provider values

resourcecreatedate

Date

The creation date of the resource

resourcekey.extraflag

Integer

Extra flag to indicate whether key is a sticky key

resourcekey.name

String

The name of the key

resourcekey.resourceuuid

String

The UUID of the resource to which the key is attached

resourcekey.type

ResourceKeyType

The type of the key (system or user)

resourcekey.value

String

The value set on the key

resourcekey.weight

double

The affinity weight of the key (zero means none)

resourcename

String

The name of the resource

resourcestate

ResourceState

The state of the resource

resourcetype

ResourceType

The type of the resource

resourceuuid

String

The UUID of the resource (read-only)

sortorder

Integer

The sort order value for the given resource

vdcname

String

The name of the VDC in which the resource is contained

vdcuuid

String

The UUID of the VDC in which the resource is contained

  • No labels