Skip to main content

component Query

Returns the specified Component object.

Access is permitted when any of the following condition(s) are met: 1. The object's 'public' attribute equals: True. 2. The signed-in User has any of the following permissions for the associated Organization: [org_admin_component_permissions, org_manage_components, org_view_components]. 3. The signed-in User has any of the following permissions for any version of the object: [component_view, component_edit, component_remove, component_admin_permissions, component_publish_new_version]. 4. The signed-in User has any of the following permissions for the associated Customer: [customer_view_org_components].

Input fields#

idID!The ID of the Component object.

Return fields (Component)#

actions (ActionConnection!)#

The Component to which this Action is associated.

allowManageAttachments (Boolean)#

Specifies whether the signed-in User can manage Attachments related to this record.

allowRemove (Boolean!)#

Specifies whether the signed-in User can remove the Component.

allowUpdate (Boolean!)#

Specifies whether the signed-in User can update the Component.

attachments ([Attachment])#

A JSON list of objects where each object has a key for name and URL that together describe the Attachment.

category (String)#

A string that specifies the category of the Component.

connections (ConnectionConnection!)#

The Component to which this Connection is associated.

customer (Customer)#

The Customer the Component belongs to, if any. If this is NULL then the Component belongs to the Organization.

description (String!)#

Additional notes about the Component.

documentationUrl (String)#

The URL associated with the documentation of a Component.

iconUrl (String)#

The URL that specifies where the Component icon exists.

id (ID!)#

The ID of the object

key (String!)#

A string that uniquely identifies the Component.

label (String!)#

The name of the Component.

labels ([String!])#

The labels that are associated with the object.

public (Boolean!)#

Specifies whether the Component is publicly available or whether it's private to the Organization.

searchTerms (String)#

A combination of the Component label, Component description, and every Action label and Action description for the Component to be used for searching.

signature (String!)#

The hex-encoded SHA1 hash of the uploaded Component package.

starred (Boolean)#

Indicates whether the record is starred by the signed-in User.

versionComment (String)#

Additional comments about this version.

versionCreatedAt (DateTime)#

Timestamp of the creation of this version.

versionCreatedBy (User)#

User that created this version.

versionIsAvailable (Boolean!)#

Indicates if the version is available for use.

versionIsLatest (Boolean!)#

Marked if this record is the latest version of this sequence.

versionNumber (Int!)#

Sequential number identifying this version.

versionSequence (ComponentConnection!)#

Sequence of versions of this Component

versionSequenceId (UUID)#

Identifier for this version sequence.

versions (VersionConnection)#

The Versions of the Component that are available.