create a page using API and update page body

chun_li

Hi,

I am trying to use API to create a Canvas page with page body. I am using the library from https://goo.gl/6j8hzo 

This is in Google Apps Script.

var pageData =
{
"url": "api2",
"title": "api2",
"created_at": "datetime",
"updated_at": "datetime",
"hide_from_students": false,
"editing_roles": "",
"last_edited_by": "User",
"body": "

content1

",
"published": false,
"front_page": false,
"locked_for_user": false,
"lock_info": "LockInfo",
"lock_explanation": ""
}

var createPage = canvasAPI("POST /v1/courses/112233/pages", pageData ); 

The page could be created but there is no content. So the body value is not there. Does anyone h##ave ideas about why? 

Thanks,

Chun

James

 @chun_li ,

It was interesting to see that someone linked to my script. It's a very old version, but that's probably not the issue.

 

The real problem is that your request isn't in the format that Canvas is expecting so it can't find stuff. The correct format is found in the Create page endpoint of the Pages API. 

There you'll see that everything starts with wiki_page, that's missing from your request. In JSON, you need a top-level called wiki_page and then everything else is an object that is the property for it.

Also, you're sending some stuff that doesn't make sense ... like last edited by and lock_info. Actually, most of your request isn't supported when you create a page. The only required item is the title.

Here's what should work for the value of pageData:

<SPAN class="punctuation token">{</SPAN><BR />  <SPAN class="string token">"wiki_page"</SPAN><SPAN class="punctuation token">:</SPAN> <SPAN class="punctuation token">{</SPAN><BR />    <SPAN class="string token">"title"</SPAN><SPAN class="punctuation token">:</SPAN> <SPAN class="string token">"api2"</SPAN><SPAN class="punctuation token">,</SPAN><BR />    <SPAN class="string token">"body"</SPAN><SPAN class="punctuation token">:</SPAN> <SPAN class="string token">"<p>content1</p>"</SPAN><SPAN class="punctuation token">,</SPAN><BR />    <SPAN class="string token">"published"</SPAN><SPAN class="punctuation token">:</SPAN> <SPAN class="keyword token">false</SPAN><SPAN class="punctuation token">,</SPAN><BR />    <SPAN class="string token">"front_page"</SPAN><SPAN class="punctuation token">:</SPAN> <SPAN class="keyword token">false</SPAN><BR />  <SPAN class="punctuation token">}</SPAN><BR /><SPAN class="punctuation token">}</SPAN><SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

Note that the front_page is optional and defaults to false. You could add editing_roles in there, but I think it defaults to teachers if it's blank. What you had was setting it so that no one could edit it.