Request

Response

    Queries

    diffElementGroupByVersionWithLatest

    GraphQL: Query

    Returns a list of element differences and their difference type from target elementGroup. No support with extension element groups currently.

    Template for Query:

    query GetDiffElementGroupByVersionWithLatest($elementGroupId: ID!, $startVersion: Int, $versionFilter: VersionFilterInput, $changeFilter: [DifferenceType], $pagination: PaginationInput) {
      diffElementGroupByVersionWithLatest(elementGroupId: $elementGroupId, startVersion: $startVersion, versionFilter: $versionFilter, changeFilter: $changeFilter, pagination: $pagination) {
        # DiffElementGroupByVersionWithLatest Fields
      }
    }
    

    Template for Query Variables:

    {
      "elementGroupId" : "<SOME-ID-TYPE-SCALAR-VALUE>",
      "startVersion" : "<SOME-INT-TYPE-SCALAR-VALUE>",
      "versionFilter" : "<SOME-VERSIONFILTER-INPUT-TYPE-VALUE>",
      "changeFilter" : "<SOME-[DIFFERENCETYPE]-TYPE-SCALAR-VALUE>",
      "pagination" : "<SOME-PAGINATION-INPUT-TYPE-VALUE>"
    }
    


    Arguments

    elementGroupId*
    ID! non-null
    ElementGroup to retrieve element differences of.
    startVersionThe version to get the element differences from against the latest.
    versionFilterOptional. Specifies version resolution behavior (e.g. whether startVersion refers to a PUBLISHED or WIP version). Defaults to PUBLISHED if not provided.
    changeFilterThe type of change to filter the element differences by.
    paginationSpecifies how to split the response into multiple pages.
    * Required

    Possible Returns

    Value TypeDescription
    ElementGroupDifference Contains a list of ElementDifferences returned in response to a query.