ePortfolios

Welcome to Our New API Docs! This is the new home for all things API (previously at Canvas LMS REST API Documentation).

ePortfolios API

An ePortfolio object looks like:

{
  // The database ID of the ePortfolio
  "id": 1,
  // The user ID to which the ePortfolio belongs
  "user_id": 1,
  // The name of the ePortfolio
  "name": "My Academic Journey",
  // Whether or not the ePortfolio is visible without authentication
  "public": true,
  // The creation timestamp for the ePortfolio
  "created_at": "2021-09-20T18:59:37Z",
  // The timestamp of the last time any of the ePortfolio attributes changed
  "updated_at": "2021-09-20T18:59:37Z",
  // The state of the ePortfolio. Either 'active' or 'deleted'
  "workflow_state": "active",
  // The timestamp when the ePortfolio was deleted, or else null
  "deleted_at": "2021-09-20T18:59:37Z",
  // A flag indicating whether the ePortfolio has been
  // flagged or moderated as spam. One of 'flagged_as_possible_spam',
  // 'marked_as_safe', 'marked_as_spam', or null
  "spam_status": null
}

An ePortfolioPage object looks like:

{
  // The database ID of the ePortfolio
  "id": 1,
  // The ePortfolio ID to which the entry belongs
  "eportfolio_id": 1,
  // The positional order of the entry in the list
  "position": 1,
  // The name of the ePortfolio
  "name": "My Academic Journey",
  // The user entered content of the entry
  "content": "A long time ago...",
  // The creation timestamp for the ePortfolio
  "created_at": "2021-09-20T18:59:37Z",
  // The timestamp of the last time any of the ePortfolio attributes changed
  "updated_at": "2021-09-20T18:59:37Z"
}

Get all ePortfolios for a User

EportfoliosApiController#index

GET /api/v1/users/:user_id/eportfolios

Scope: url:GET|/api/v1/users/:user_id/eportfolios

Get a list of all ePortfolios for the specified user.

Request Parameters:

Parameter	Type	Description
include[]	string	deleted Include deleted ePortfolios. Only available to admins who can moderate_user_content. Allowed values: deleted

Returns a list of ePortfolio objects.

Get an ePortfolio

EportfoliosApiController#show

GET /api/v1/eportfolios/:id

Scope: url:GET|/api/v1/eportfolios/:id

Get details for a single ePortfolio.

Returns an ePortfolio object.

Delete an ePortfolio

EportfoliosApiController#delete

DELETE /api/v1/eportfolios/:id

Scope: url:DELETE|/api/v1/eportfolios/:id

Mark an ePortfolio as deleted.

Returns an ePortfolio object.

Get ePortfolio Pages

EportfoliosApiController#pages

GET /api/v1/eportfolios/:eportfolio_id/pages

Scope: url:GET|/api/v1/eportfolios/:eportfolio_id/pages

Get details for the pages of an ePortfolio

Returns a list of ePortfolioPage objects.

Moderate an ePortfolio

EportfoliosApiController#moderate

PUT /api/v1/eportfolios/:eportfolio_id/moderate

Scope: url:PUT|/api/v1/eportfolios/:eportfolio_id/moderate

Update the spam_status of an eportfolio. Only available to admins who can moderate_user_content.

Request Parameters:

Parameter	Type	Description
spam_status	string	The spam status for the ePortfolio Allowed values: marked_as_spam, marked_as_safe

Returns an ePortfolio object.

Moderate all ePortfolios for a User

EportfoliosApiController#moderate_all

PUT /api/v1/users/:user_id/eportfolios

Scope: url:PUT|/api/v1/users/:user_id/eportfolios

Update the spam_status for all active eportfolios of a user. Only available to admins who can moderate_user_content.

Request Parameters:

Parameter	Type	Description
spam_status	string	The spam status for all the ePortfolios Allowed values: marked_as_spam, marked_as_safe

Restore a deleted ePortfolio

EportfoliosApiController#restore

PUT /api/v1/eportfolios/:eportfolio_id/restore

Scope: url:PUT|/api/v1/eportfolios/:eportfolio_id/restore

Restore an ePortfolio back to active that was previously deleted. Only available to admins who can moderate_user_content.

Returns an ePortfolio object.

---

This documentation is generated directly from the Canvas LMS source code, available on Github.