Skip to main content

onPremiseResources Query

Returns a Relay Connection to a collection of OnPremiseResource objects.

Access is permitted when any of the following condition(s) are met: 1. The signed-in User has any of the following permissions for the associated Organization: [org_admin_customer_permissions, org_manage_customers, org_crud_customers, org_view_customers]. 2. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_view, customer_edit, customer_remove, customer_admin_users, customer_view_users, customer_admin_instance_permissions, customer_view_instances, customer_manage_marketplace_integrations, customer_access_marketplace_integrations].

Input fields

ArgumentTypeDescription
beforeStringSpecifies a cursor for use in combination with last to implement backward pagination.
afterStringSpecifies a cursor for use in combination with first to implement forward pagination.
firstIntA non-negative integer that specifies to return at most first edges after the after cursor.
lastIntA non-negative integer that specifies to return at most last edges before the before cursor.
offsetInt
name_IcontainsStringFilter for objects where name contains the specified value (case insensitive).
customerIDFilter for objects where customer matches the specified ID.
customer_IsnullBooleanFilter for objects where customer is NULL.
statusStringFilter for objects where status matches the specified value.
orderByOnPremiseResourceOrderDEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy[OnPremiseResourceOrder]Allows specifying many field and direction pairs to sort results by.

Return fields (OnPremiseResourceConnection!)

edges ([OnPremiseResourceEdge]!)

List of edges containing the nodes in this connection.

nodes ([OnPremiseResource]!)

List of nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total count of nodes available.