Update Assessment
- 31 Oct 2020
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Update Assessment
- Updated on 31 Oct 2020
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Update Assessment
PATCH /assessment/{externalId}
Note: Using the API it possible to update an assessment even if an assessment author has opened it in the platform. The API ignores the User Lock. The last performed save action (by API or GUI) will be the final state. The user will not receive a message if the opened assessment has been updated by the API.
Header
| Name | Data Type | Description |
|---|---|---|
| Content-type: | application/json | for all requests |
| Authorization: | EAPI {token} | for all requests |
Body Parameters
Parameters indicated with a * are mandatory
| Name | Data Type | Description |
|---|---|---|
| Title | string (100) | Assessment title |
| Code | string (64) | Assessment code |
| Owner | string (64) | Owner’s User Name. This value comes from ExternalApi settings by default. |
| Taxonomies | Array | List of Taxonomies connected to collection. If empty or null: all taxonomies would be available within the collection |
| Taxonomy.ExternalId | String | Taxonomy ExternalId |
| Taxonomy.Title | String | Taxonomy Title |
| LoRepositoryExternalIds | Array | Contains information on LO repositories connected to collection. If empty: all LO repositories are available within the collection |
| ObjectiveRepositories.ExternalId | String | Learning objective repository ExternalId |
| ObjectiveRepositories.Title | String | Learning objective repository Title |
Sample Request URL
https://api.cirrusplatform.com/api/v1/integrations/assessment/codetest1
Sample Request
{
"Title": "assessment2018_test11_new",
"Code": "assessment2018_test11_newcode"
}
Sample Response
{
"Success": true,
"Errors": null
}
Response codes
| Code | Description |
|---|---|
| 200 | Successful operation |
| 403 | Not allowed to use external API |
| 400 | Possible error codes: Assessment hasn't been found by external id externalId Can't update published assessment (External id: externalId)settings 'Title' should not be empty 'Code' should not be empty. Update fields have not been specified |
| 500 | Internal server error |
Was this article helpful?