components Query

Returns a Relay Connection to a collection of Component 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_component_permissions, org_manage_components, org_view_components]. 2. The signed-in User has any of the following permissions for the object: [component_admin_permissions, component_view, component_edit, component_remove].

Input fields

Argument	Type	Description
allVersions	Boolean	Return all versions instead of only the latest
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
orderBy	ComponentOrder	Allows specifying which field and direction to order by.
label_Icontains	String	Filter for objects where label contains the specified value (case insensitive).
description_Icontains	String	Filter for objects where description contains the specified value (case insensitive).
key	String	Filter for objects where key matches the specified value.
key_In	[String]	Filter for objects where key is contained in the list of specified values.
category	String	Filter for objects where category matches the specified value.
searchTerms_Icontains	String	Filter for objects where searchTerms contains the specified value (case insensitive).
versionSequenceId	UUID	Filter for objects where versionSequenceId matches the specified value.
versionNumber	Int	Filter for objects where versionNumber matches the specified value.
versionIsAvailable	Boolean	Filter for objects where versionIsAvailable matches the specified value.
labels_Icontains	String	Filter for objects where labels contains the specified value (case insensitive).

Return fields (ComponentConnection!)

pageInfo (PageInfo!)

Pagination data for this connection.

nodes ([Component]!)

List of nodes in this connection.

edges ([ComponentEdge]!)

List of edges containing the nodes in this connection.

totalCount (Int!)

Total count of nodes available.