Request

Response

    Queries

    diffElementByVersionWithLatest

    GraphQL: Query

    Returns the element difference from target element. No support with extension element groups currently.

    Template for Query:

    query GetDiffElementByVersionWithLatest($elementId: ID!, $versionFilter: VersionFilterInput, $startElementGroupVersion: Int) {
      diffElementByVersionWithLatest(elementId: $elementId, versionFilter: $versionFilter, startElementGroupVersion: $startElementGroupVersion) {
        # DiffElementByVersionWithLatest Fields
      }
    }
    

    Template for Query Variables:

    {
      "elementId" : "<SOME-ID-TYPE-SCALAR-VALUE>",
      "versionFilter" : "<SOME-VERSIONFILTER-INPUT-TYPE-VALUE>",
      "startElementGroupVersion" : "<SOME-INT-TYPE-SCALAR-VALUE>"
    }
    


    Arguments

    elementId*
    ID! non-null
    ElementId to retrieve element difference of.
    versionFilterOptional. Specifies version resolution behavior (e.g. whether startElementGroupVersion refers to a PUBLISHED or WIP version). Defaults to PUBLISHED if not provided.
    startElementGroupVersionThe version to get the element differences from against the latest.
    * Required

    Possible Returns

    Value TypeDescription
    ElementDifference Represents an Element Difference type