Skip to content

o365SharepointObjectList

Returns the sharepoint objects after filtering on the object types and includeEntireHierarchy.

Arguments

Argument Type Description
first Int Returns the first n elements from the list.
after String An opaque cursor returned from a previous query's endCursor field. Pass this value verbatim to retrieve the next page of results.
last Int Returns the last n elements from the list.
before String An opaque cursor returned from a previous query's startCursor field. Pass this value verbatim to retrieve the previous page of results.
sortBy HierarchySortByField Sort hierarchy objects according to the hierarchy field.
sortOrder SortOrder Sorts the order of results.
filter [Filter!] Hierarchy object filter.
objectTypeFilter [String!] Types of objects to include.
fid (required) UUID! FID of the parent O365 org or SharePoint site.
includeEntireHierarchy (required) Boolean! If true, the entire hierarchy will be searched.

Returns

O365SharepointObjectConnection!

Sample

query O365SharepointObjectList($fid: UUID!, $includeEntireHierarchy: Boolean!) {
  o365SharepointObjectList(
    fid: $fid
    includeEntireHierarchy: $includeEntireHierarchy
    first: 10
  ) {
    nodes {
      objectId
      parentId
      preferredDataLocation
      siteChildId
      title
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "fid": "00000000-0000-0000-0000-000000000000",
  "includeEntireHierarchy": true
}

{
  "data": {
    "o365SharepointObjectList": {
      "nodes": [
        [
          {
            "objectId": "example-string",
            "parentId": "example-string",
            "preferredDataLocation": "example-string",
            "siteChildId": "example-string",
            "title": "example-string"
          }
        ]
      ],
      "pageInfo": {
        "endCursor": "example-string",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example-string"
      }
    }
  }
}