instances

Returns a Relay Connection to a collection of Instance 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_instance_permissions, org_manage_instances, org_view_instances]. 2. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_admin_instance_permissions, customer_view_instances]. 3. The signed-in User has any of the following permissions for the object: [instance_admin_permissions, instance_view, instance_edit, instance_remove].

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.
orderByInstanceOrderAllows specifying which field and direction to order by.
name_IcontainsStringFilter for objects where name contains the specified value (case insensitive).
description_IcontainsStringFilter for objects where description contains the specified value (case insensitive).
integrationIDFilter for objects where integration matches the specified ID.
customerIDFilter for objects where customer matches the specified ID.
enabledBooleanFilter for objects where enabled matches the specified value.
isSystemBooleanFilter for objects where isSystem matches the specified value.
inFailedStateBooleanFilter for objects where inFailedState matches the specified value.
labels_ContainsStringFilter for objects where labels contains the specified value (case sensitive).

Return fields (InstanceConnection!)

pageInfo (PageInfo!)

Pagination data for this connection.

nodes ([Instance]!)

List of nodes in this connection.

edges ([InstanceEdge]!)

List of edges containing the nodes in this connection.

totalCount (Int!)

Total count of nodes available.

Last updated on