- Download the files you will be uploading to your computer.
- Login to my.cpm.org
- Copy the URL "https://cdp-hermes.cpm.org/swagger/document-repository" and paste it to your web browser to access Swagger.
- To upload a file start by expanding the 'POST' section needed under Uploads.
- Select "Try it out" .
Each type of Upload requires different information. The following lists shows what is expected for each Assessments field.
- curriculumKey: <course name>
- displayName: <file name for display>
- file: <Choose file, select the file from step 1 above>
- chapter: <course chapter>
- version: Teacher or Student
- mode: Team Challenge, or Individual Test
- licenseType: licensed
- Fill the fields.
For generic (non-specific lesson) Resource Page, type "general" in the 'licenseType' textbox.
- Click 'Execute' to upload the file.
Check the Response section to view the status of the upload. The image below shows that the file has been successfully uploaded.
- Check in the Curriculum Digital Platform (CDP) to verify if the file has been successfully uploaded.
a. Go to my.cpm.org, then click the needed curriculum link.
b. Select the correct resource from the Resources section of the page.
The doc hub with the uploaded documents will display.
c. Verify if the Assessment test you uploaded is in the list.
d. Verify if the test you uploaded is correct by clicking the download icon on the far right.
e. Open the downloaded file from your finder and check if the file is correct.
Start by finding the documentId and field entries from the existing document.
- From Admin, expand the "GET /documents/admin/{docType}/list". Choose "Try it out", and then select the docType. Last, select Execute.
The JSON code that includes the documentId and other entries from all existing documents of the docType you selected in the previous step is now visible. See the image below.
- Use search to find the code for the existing file. Copy and paste the information to a place you can reference it later when uploading the replacement file.
- Follow the Uploading instructions in the first foldable section of this article.
This image is an expected response for the re-upload. The message states that the document has been replaced and is not an error.
If the file is replaced, you should not see new or duplicate files listed in the doc hub and the documentId should be the same.
- Use "GET /documents/admin/{docType}/list" to check the "-id" and verify that the documentId did not change.
If there is already a response in the Response body, select: Cancel --> Try it Out --> docTyp --> Execute, to update the response.
Upload the file following the instructions in the first foldable. "POST" under LessonResourcePages section.
Fill in curriculumKey, displayName, pdf file and lessonid.
Lesson ID uses the lesson number.
Closure Resource pages nameing convention is chapter#.closure. For example Chapter 1 Considering Perspectives Answer Resource Page lessonid would be 1.closure.
Find the Doc Id to use in the CDP Link
You can copy the Doc ID from an Asana sheet in the Accessibility project.
Or you can copy the Doc ID from Hermes
From Documents, expand "Get /documents/{docType}", choose "docType description" LessonResourcePages.
Click "Execute".
Copy the "documentId" to use in the CDP link
Paste documentId to CDP link:
Example:
Use this link in CDP as the URL.
Make sure you search the lesson for all the Resource Page links and update the link. Link Teacher facing Resource Page links (ie. LAG and AV). Do not link Resource Page links in Student facing sections (ie. problems).