AppOffering Object

Root Connection

All AppOffering objects of an account are accessible by a query on the root connection appOfferings. Such a query will return a AppOfferingConnection!, which contains the AppOffering objects in its nodes field.

appOfferings (AppOfferingConnection!)

Root connection for retrieving AppOffering records.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.
before String

Returns the elements in the list that come before the specified cursor.
filter AppOfferingFilter

Filter to determine which AppOffering records are returned.
first Int

Returns the first n elements from the list.
last Int

Returns the last n elements from the list.
order [AppOfferingOrder!]

Order of the AppOffering records returned.
view AppOfferingView

View name.

The default value is current_account.

Fields

The fields in this section list which values can be retrieved when querying AppOffering records.

account (Account)

The account this record belongs to.

cardDescription (String)

Short description of the app offering to be shown on the card in the App store.

compliance (String)

Compliance description of the app offering.

configurationUriTemplate (String)

The URI where the app can be configured. The placeholder {account} can be used to include the customer account id in the URI.

createdAt (ISO8601Timestamp)

The date and time at which the record was created.

description (String)

Description of the app offering.

disabled (Boolean)

Whether the app offering may not be used for new instances.

features (String)

Feature description of the app offering.

id (ID!)

Unique identifier of the record.

latest (Boolean)

Whether this is the latest published version of the app offering or the current draft.

name (String)

Name of the app offering.

oauthAuthorizationEndpoints ([String!])

The endpoints for the OAuth application that will be created for this app to use in the Authorization Code Grant flow.

pictureUri (String)

The hyperlink to the image file for the record.

policyJwtAlg (WebhookPolicyJwtAlg)

The algorithm used for generating the policy for the app's webhook.

policyJwtAudience (String)

The audience for the policy for the app's webhook.

policyJwtClaimExpiresIn (Int)

The claim expiry time for the policy for the app's webhook.

published (Boolean)

Whether this app offering is published or draft.

reference (String)

This reference can be used to link the app offering to an instance using the Xurrent APIs or the Xurrent Import functionality.

requiresEnabledOauthPerson (Boolean)

This app requires an enabled OAuth person.

scopes ([AppOfferingScope!])

Scopes of this app offering.

serviceInstance (ServiceInstance)

Service instance that is linked to the app offering.

source (String)

An identifier for the client application submitting the resource or the name of an external system.

sourceID (String)

The unique identifier of the resource in an external system.

uiExtensionVersion (UiExtensionVersion)

UI extension version that is linked to the app offering.

updatedAt (ISO8601Timestamp)

The date and time of the last update of the record. If the record has no updates it contains the createdAt value.

webhookUriTemplate (String)

The URI for the app's webhook. The placeholder {account} can be used to include the customer account id in the URI.

Connections

The connection fields in this section allow (paged) access to objects related to a specific AppOffering record. The actual objects will be in the nodes field of the connection.

appInstances (AppInstanceConnection)

Instances of this app.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.
before String

Returns the elements in the list that come before the specified cursor.
first Int

Returns the first n elements from the list.
last Int

Returns the last n elements from the list.
automationRules (AppOfferingAutomationRuleConnection)

Automation rules of this app offering.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.
before String

Returns the elements in the list that come before the specified cursor.
first Int

Returns the first n elements from the list.
last Int

Returns the last n elements from the list.
complianceAttachments (AttachmentConnection)

Files and inline images linked to the Compliance field.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.
before String

Returns the elements in the list that come before the specified cursor.
first Int

Returns the first n elements from the list.
last Int

Returns the last n elements from the list.
descriptionAttachments (AttachmentConnection)

Files and inline images linked to the Description field.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.
before String

Returns the elements in the list that come before the specified cursor.
first Int

Returns the first n elements from the list.
last Int

Returns the last n elements from the list.
featuresAttachments (AttachmentConnection)

Files and inline images linked to the Features field.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.
before String

Returns the elements in the list that come before the specified cursor.
first Int

Returns the first n elements from the list.
last Int

Returns the last n elements from the list.

Implements

AppOffering implements the following interfaces. This means that fragments defined on these interfaces may be used in queries returning a AppOffering.