Request

Response

    Objects

    Exchange

    GraphQL: Object

    A specific collection of Elements.


    Fields

    id*
    ID! non-null
    Globally unique identifier.
    elements*
    Elements! non-null
    Get Elements within an Exchange.
    nameName of the Exchange Container.
    propertyDefinitions*Get metadata about PropertyGroups.
    versionSpecific version of this Exchange.
    lineage*
    Lineage! non-null
    Version lineage for this Exchange. This field is deprecated. Use versionHistory instead.
    versionHistory*Version history for this elementGroup
    createdByUser responsible for creating this Exchange
    createdOnTimestamp of Exchange creation
    lastModifiedByLatest user who modified this Exchange
    lastModifiedOnLatest timestamp when this Exchange was modified
    alternativeRepresentationsAlternative identifiers for this Exchange Note: This field is deprecated. Use alternativeIdentifiers instead.
    alternativeIdentifiersAlternative identifiers for this element
    * Required


    Where Used

    UsageUsed ByDescription
    Field Of Exchanges Contains a list of Exchanges returned in response to a query.
    Field Of CreateExchangeResult Represents the result of creating an exchange.
    Field Of ExchangeCreationStatus Represents the creation status of an exchange.
    Query By exchange Retrieves a single exchange.
    Query By exchangeByVersions Retrieves a list of Elements in an exchange by version.
    Query By exchangeByFileId Retrieves a single exchange by exchangeFileId. Note: This query is deprecated. Use exchangeByFileUrn query instead.
    Query By exchangeByFileUrn Retrieves a single exchange by externalProjectId and fileUrn.