Using GraphQL to View All Module Items

After @wdransfield ‌'s excellent Canvas Developer Session at INSTCON19 I was inspired to try out GraphQL and see whether we can simplify / speed up our API-based integrations.

We're creating a tool to allow us to quickly assess whether our courses are ready to be published. I'd like to make sure that every module contains a page that starts with "Overview".

I can quite easily pull a list of all modules and the moduleitem IDs for each. It works very well - far easier than combining many API calls.

query MyQuery {<BR />  course(id: 738) {<BR />    name<BR />    modulesConnection {<BR />      nodes {<BR />        moduleItems {<BR />          _id<BR />        }<BR />        name<BR />      }<BR />    }<BR />  }<BR />}‍‍‍‍‍‍‍‍‍‍‍‍‍

If I try to go any further - for example - pull the titles of each Page - the script fails. Attempts to use the "content" attribute fail reliably.

query MyQuery {<BR />  course(id: 738) {<BR />    name<BR />    modulesConnection {<BR />      nodes {<BR />        moduleItems {<BR />          _id<BR />          content {<BR />            ... on Page {<BR />              title<BR />              _id<BR />            }<BR />          }<BR />        }<BR />        name<BR />      }<BR />    }<BR />  }<BR />}<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

Message:

Error: Request failed with status code 500
at LYNF.e.exports (https://du11hjcvx0uqb.cloudfront.net/br/dist/webpack-production/main-e-154b446262.js:1693:37)
at Rn+g.e.exports (https://du11hjcvx0uqb.cloudfront.net/br/dist/webpack-production/main-e-154b446262.js:1984:29)
at XMLHttpRequest.h. (https://du11hjcvx0uqb.cloudfront.net/br/dist/webpack-production/main-e-154b446262.js:7382:1)

Is the content attribute not yet production-ready?

Thanks!

Find more posts tagged with

Accepted answers

All comments

James

@jpinto ,

That was the session I wanted to get into but they closed the doors as I was getting there. I'm anxiously awaiting that video.

I pasted your code into my graphiql and changed the course ID to one of my courses and it worked.

Since Canvas has announced that GraphQL is the future of API, I need to learn this stuff. Thank you for providing some real working applications. I was getting a similar error with some of the stuff I was trying last night so it was good to get something that actually worked.

I don't doubt that you're getting the error, though, as I'm able to get it with a different request by including content.

This works.

query MyQuery <SPAN class="punctuation token">{</SPAN><BR />  allCourses <SPAN class="punctuation token">{</SPAN><BR />    modulesConnection <SPAN class="punctuation token">{</SPAN><BR />      nodes <SPAN class="punctuation token">{</SPAN><BR />        name<BR />        moduleItems <SPAN class="punctuation token">{</SPAN><BR />          _id<BR />        <SPAN class="punctuation token">}</SPAN><BR />      <SPAN class="punctuation token">}</SPAN><BR />    <SPAN class="punctuation token">}</SPAN><BR />  <SPAN class="punctuation token">}</SPAN><BR /><SPAN class="punctuation token">}</SPAN><BR /><SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

Adding the content doesn't.

query MyQuery <SPAN class="punctuation token">{</SPAN><BR />  allCourses <SPAN class="punctuation token">{</SPAN><BR />    modulesConnection <SPAN class="punctuation token">{</SPAN><BR />      nodes <SPAN class="punctuation token">{</SPAN><BR />        name<BR />        moduleItems <SPAN class="punctuation token">{</SPAN><BR />          _id<BR />          content <SPAN class="punctuation token">{</SPAN><BR />            <SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN> on Page <SPAN class="punctuation token">{</SPAN><BR />              title<BR />            <SPAN class="punctuation token">}</SPAN><BR />          <SPAN class="punctuation token">}</SPAN><BR />        <SPAN class="punctuation token">}</SPAN><BR />      <SPAN class="punctuation token">}</SPAN><BR />    <SPAN class="punctuation token">}</SPAN><BR />  <SPAN class="punctuation token">}</SPAN><BR /><SPAN class="punctuation token">}</SPAN><BR /><SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

It generates the same error you got.

Error: Request failed with status code 500<BR />    at LYNF.e.exports (https://du11hjcvx0uqb.cloudfront.net/br/dist/webpack-production/main-e-154b446262.js:1693:37)<BR />    at Rn+g.e.exports (https://du11hjcvx0uqb.cloudfront.net/br/dist/webpack-production/main-e-154b446262.js:1984:29)<BR />    at XMLHttpRequest.h.<computed> (https://du11hjcvx0uqb.cloudfront.net/br/dist/webpack-production/main-e-154b446262.js:7382:1)<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

jpinto

Update from our CSM:

The team just merged a fix for the error you're seeing. It will go out in the next release. They also said we're using it in production and that module items are a recent addition but overall you should feel free to use it.

Unanswered Questions

UI for weekly progression idea
UI for weekly progression idea that rest in the Schedule tab of the **K-12 UI** of Canvas it's incomplete and I really would not take it and push it into instance but I am going to post it here because in the past people like @James && @robotcars || @Steve_25 have had terrific input in the past... maybe w/their eyes and…
add `desc` or `asc` to a few api calls that are already sorted by date\time\index such as `due_at`
A case for this argument: I live in thee K-12 realm which means we have way too many assignments... which means that at times a simple last 10 assignments of a course question(last 10 date wise) will take us 300 assignments to answer Solution for this example in particular: I would love to make this modified version of an…
Integrate a React App (Not Canvas) to be Canvas LMS SSO.
Hey Community: I want to ask first if Canvas LMS as a Identity provider is only supported with SAML? What other protocols are supported? My use case is that I have a React App hosted on cloud provider (AWS) and SpringBoot as a backend (Service provider). I want to integrate Canvas SSO as a Identity provider (IdP). I…
Why are instructions and quiz_settings null in the New Quizzes API?
I make requests to this endpoint: GET /api/quiz/v1/courses/:course_id/quizzes In the list I get back, sometimes instructions and quiz_settings are null. Why? How do I prevent this? Here is an example where quiz #3 does not have instructions nor settings: [ { "id": "2893842", "title": "In Class Exercise #2", "instructions":…
Getting Canvas LTI Data
I am attempting to programmatically access the LTI usage data presented in the Canvas Apps Dashboard (total launches, unique users, subaccounts, courses over time). Could anyone advise on the best method to replicate this information by using the Canvas Rest API calls or Canvas Data 2?