AnsweredAssumed Answered

Assignments API external_tool_tag_attributes - can you pass arbitrary custom variables

Question asked by Carol Shergold on Jul 27, 2018

We're working with assignments that are being submitted to Turnitin via an LTI external tool

 

We want to be able to update the data within an individual Turnitin assignment from API calls.

 

I can see that in the assignments API, there is the possibility of passing data into an external tool via the ExternalToolTagAttributes object:

 

Assignments - Canvas LMS REST API Documentation 

 

 

The documentation states:

// (Optional) assignment's settings for external tools if submission_types include  // 'external_tool'. Only url and new_tab are included (new_tab defaults to false).   // Use the 'External Tools' API if you need more information about an external  // tool.

 

Bearing in mind that the External Tools API allows a range of around 20 custom parameters to be passed into Turnitin, I was hoping that this was an indication that we could use this external_tool_tag_attributes object to pass in arbitrary custom parameters into an individual assignment within Turnitin

 

In particular, I'm trying to set custom_feedbackreleasedate.

 

However, I have not yet found a way of doing this. This is one of the calls I have attempted (I'm using the tool postman to handle the API calls)

 

PUT https://oursitehere:443/api/v1/courses/:course/assignments/:assignment?assignment[external_tool_tag_attributes[new_tab]]=false&

assignment[description]=Assignment-test-attempt-99&

assignment[external_tool_tag_attributes[custom_feedbackreleasedate]]=2018-08-01T10:00:00Z

 

When I run this with appropriate authentication and correct id values, my attempt to toggle the new_tab field and to set the assignment description succeed

 

However, I'm not able to set the release date.

 

Is there a way of passing key-value pairs through to an individual assignment via this object?

 

If not, is there another way of setting values in individual Turnitin assignments?

 

We are migrating from Moodle, where we were able to handle this via the LTI tool to automate our assessment process, so it does seem as though it could be feasible.

Outcomes