marketplaceIntegration Query
Returns the specified Integration object.
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_integration_permissions, org_manage_integrations, org_view_integrations]. 2. The signed-in User has any of the following permissions for any version of the object: [integration_admin_permissions, integration_view, integration_edit, integration_remove]. 3. The signed-in User has any of the following permissions for the associated Customer of Integrations available in the Marketplace: [customer_admin_instance_deploy, customer_manage_marketplace_integrations]. 4. The signed-in User has any of the following permissions for the associated Customer of Integrations available in the Marketplace: [customer_access_marketplace_integrations]. 5. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_admin_integration_permissions, customer_manage_integrations, customer_view_integrations]. 6. The Customer User has any of the following permissions for the Customer and the Objects Attribute template_configuration is AVAILABLE OR CUSTOMER_AVAILABLE: [customer_admin_integration_permissions, customer_manage_integrations, customer_view_integrations].
#
Input fieldsArgument | Type | Description |
---|---|---|
id | ID! | The ID of the Integration object. |
Integration)#
Return fields (IntegrationActionConnection!)#
actions (The Integration to which the IntegrationAction is associated via the IntegrationFlow.
Boolean!)#
allowFork (Specifies whether the signed-in User can fork the Integration.
Boolean)#
allowManageAttachments (Specifies whether the signed-in User can manage Attachments related to this record.
Boolean!)#
allowMultipleMarketplaceInstances (Specifies whether multiple Instances of this Integration may be created from the Marketplace.
Boolean!)#
allowPublish (Specifies whether the signed-in User can publish the Integration.
Boolean!)#
allowRemove (Specifies whether the signed-in User can remove the Integration.
Boolean!)#
allowUpdate (Specifies whether the signed-in User can update the Integration.
[Attachment])#
attachments (A JSON list of objects where each object has a key for name and URL that together describe the Attachment.
String)#
avatarUrl (The URL for the avatar image.
String)#
category (Specifies the category of the Integration.
ComponentConnection!)#
components (Components associated with this Integration
JSONString!)#
configPages (A JSON string that represents deployment configuration pages.
DateTime!)#
createdAt (The timestamp at which the object was created.
Customer)#
customer (The Customer the Integration belongs to, if any. If this is NULL then the Integration belongs to the Organization.
String)#
definition (The YAML that is the declarative definition for the Integration. Suitable for using to re-import the Integration.
String)#
description (Additional notes about the Integration.
String)#
documentation (Rich text documentation to accompany the Integration.
String)#
endpointConfigTestContentType (Content type of the payload for testing the endpoint configuration for this Integration.
JSONString)#
endpointConfigTestHeaders (A JSON string of key/value pairs that will be sent as headers when testing the endpoint configuration for this Integration.
String)#
endpointConfigTestPayload (Data payload for testing the endpoint configuration for this Integration.
String!)#
endpointConfigTestUrl (The URL of the endpoint that allows testing the endpoint configuration of the Integration.
IntegrationEndpointType)#
endpointType (Specifies whether endpoint URLs for Instances of this Integration are unique to the flow, unique to the Instance, or if all Instances share a URL.
IntegrationFlowConnection!)#
flows (The Integration of which the IntegrationFlow is a part.
Boolean!)#
hasOutdatedComponents (Specifies whether the Integration uses outdated Components
Boolean!)#
hasUnpublishedChanges (Specifies whether the Integration definition has changes that have not yet been published.
ID!)#
id (The ID of the object
InstanceConnection!)#
instances (The Integration that has been deployed for the Instance.
Boolean)#
isCustomerDeployable (Specifies whether the Integration can be deployed by the signed-in User.
[String!])#
labels (The labels that are associated with the object.
DateTime)#
lastExecutedAt (The timestamp at which this Integration was most recently executed as part of an Instance.
MarketplaceConfiguration!)#
marketplaceConfiguration (Specifies whether an Integration will be available in the Integration Marketplace and if the Integration is deployable by a Customer User.
[String!])#
marketplaceTabConfiguration (The Marketplace Tabs available to Customer Users for configuring this Integration.
String!)#
name (The name of the Integration.
String)#
overview (Specifies an Overview of the Integration to describe its functionality for use in the Integration Marketplace.
Integration)#
parent (Parent Integration this Integration was forked from, if any
String)#
preprocessFlowName (The name of a Flow in the Integration that will be executed as a preprocessing step prior to any other Flow executions.
RequiredConfigVariableConnection!)#
requiredConfigVariables (Boolean)#
starred (Indicates whether the record is starred by the signed-in User.
IntegrationStoreConfiguration)#
storeConfiguration (Specifies whether an Integration will be available in the Integration Store and if the Integration is deployable by a Customer User.
Instance!)#
systemInstance (System Instance backing this Integration.
IntegrationTemplateConfiguration!)#
templateConfiguration (Specifies whether the latest published version of this Integration may be used as a template to create new Integrations.
InstanceConfigVariableConnection!)#
testConfigVariables (Config Variables that are used for testing during Integration design.
Boolean!)#
useAsTemplate (Specifies whether the latest published version of this Integration may be used as a template to create new Integrations.
Boolean!)#
userLevelConfigured (Specifies whether this Integration uses User Level Configs.
Integration)#
versionAt (Object data at specified version
String)#
versionComment (Additional comments about this version.
DateTime)#
versionCreatedAt (Timestamp of the creation of this version.
User)#
versionCreatedBy (User that created this version.
Boolean!)#
versionIsAvailable (Indicates if the version is available for use.
Boolean!)#
versionIsLatest (Marked if this record is the latest version of this sequence.
Int!)#
versionNumber (Sequential number identifying this version.
IntegrationConnection!)#
versionSequence (Sequence of versions of this Integration
UUID)#
versionSequenceId (Identifier for this version sequence.
VersionConnection!)#
versions (The Versions of the Integration that are available.