Showcase Portfolio Evidence

Create Showcase Evidence

post

Create a new evidence for a showcase portfolio

Path parameters

showcasePortfolioIdstringRequired

Showcase Portfolio UUID

Body

application/json

titlestring · min: 1Required

Title of the evidence.

descriptionstringOptional

Description of the evidence.

reflectionstringOptional

Personal reflection on the evidence.

typestring · enumRequiredPossible values:

linksstring[]Optional

Associated links for the evidence.

tagsstring[]Optional

Tags for the evidence.

Responses

201

Showcase Evidence created successfully

application/json

400

Invalid request data

403

User is not authorized to add evidence to this portfolio

404

Portfolio not found

500

Internal server error

post

HTTPcURLJavaScriptPython

POST /v1/showcase-portfolios/{showcasePortfolioId}/showcase-evidences HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 187

{
  "title": "text",
  "description": "text",
  "reflection": "text",
  "type": "project",
  "attachments": [
    {
      "url": "text",
      "mimeType": "text",
      "fileSize": 1,
      "fileName": "text"
    }
  ],
  "links": [
    "text"
  ],
  "tags": [
    "text"
  ]
}

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "title": "text",
  "description": "text",
  "order": 1,
  "reflection": "text",
  "links": [
    "text"
  ],
  "attachments": [
    {
      "url": "text",
      "mimeType": "text",
      "fileSize": 1,
      "fileName": "text"
    }
  ],
  "tags": [
    "text"
  ],
  "createdAt": "2025-10-13T20:24:50.465Z",
  "updatedAt": "2025-10-13T20:24:50.465Z",
  "type": "project",
  "canvasAssignmentId": 1,
  "courseId": 1,
  "courseName": "text",
  "gradingType": "text",
  "htmlUrl": "text",
  "pointsPossible": 1,
  "submissionTypes": [
    "text"
  ],
  "assignmentSubmissionBody": "text"
}

Update Showcase Evidence

patch

Update an existing evidence for a showcase portfolio

Path parameters

showcaseEvidenceIdstringRequired

Showcase Evidence UUID

showcasePortfolioIdstringRequired

Showcase Portfolio UUID

Body

application/json

uuidstring · uuidRequired

The UUID of the evidence to be updated.

titlestringRequired

The new title for the evidence.

descriptionstring | nullableOptional

The new description for the evidence.

reflectionstringOptional

The new personal reflection on the evidence.

linksstring[]Optional

The updated list of associated links for the evidence. This typically replaces the existing list.

tagsstring[]Optional

The updated list of tags for the evidence. This typically replaces the existing list.

ordernumberRequired

The updated order of the evidence

typestring · enumRequiredPossible values:

Responses

200

Showcase Evidence updated successfully

application/json

400

Invalid request data

403

User is not authorized to update this evidence

404

Evidence or portfolio not found

500

Internal server error

patch

HTTPcURLJavaScriptPython

PATCH /v1/showcase-portfolios/{showcasePortfolioId}/showcase-evidences/{showcaseEvidenceId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 243

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "title": "text",
  "description": "text",
  "reflection": "text",
  "attachments": [
    {
      "url": "text",
      "mimeType": "text",
      "fileSize": 1,
      "fileName": "text"
    }
  ],
  "links": [
    "text"
  ],
  "tags": [
    "text"
  ],
  "order": 1,
  "type": "project"
}

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "title": "text",
  "description": "text",
  "order": 1,
  "reflection": "text",
  "links": [
    "text"
  ],
  "attachments": [
    {
      "url": "text",
      "mimeType": "text",
      "fileSize": 1,
      "fileName": "text"
    }
  ],
  "tags": [
    "text"
  ],
  "createdAt": "2025-10-13T20:24:50.465Z",
  "updatedAt": "2025-10-13T20:24:50.465Z",
  "type": "project",
  "canvasAssignmentId": 1,
  "courseId": 1,
  "courseName": "text",
  "gradingType": "text",
  "htmlUrl": "text",
  "pointsPossible": 1,
  "submissionTypes": [
    "text"
  ],
  "assignmentSubmissionBody": "text"
}

Get Showcase Evidence

get

Retrieve a specific evidence by its UUID

Path parameters

showcaseEvidenceIdstringRequired

Showcase Evidence UUID

showcasePortfolioIdstringRequired

Showcase Portfolio UUID

Responses

200

Showcase Evidence retrieved successfully

application/json

403

User is not authorized to view this evidence

404

Evidence not found

500

Internal server error

get

HTTPcURLJavaScriptPython

GET /v1/showcase-portfolios/{showcasePortfolioId}/showcase-evidences/{showcaseEvidenceId} HTTP/1.1
Host: 
Accept: */*

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "title": "text",
  "description": "text",
  "order": 1,
  "reflection": "text",
  "links": [
    "text"
  ],
  "attachments": [
    {
      "url": "text",
      "mimeType": "text",
      "fileSize": 1,
      "fileName": "text"
    }
  ],
  "tags": [
    "text"
  ],
  "createdAt": "2025-10-13T20:24:50.465Z",
  "updatedAt": "2025-10-13T20:24:50.465Z",
  "type": "project",
  "canvasAssignmentId": 1,
  "courseId": 1,
  "courseName": "text",
  "gradingType": "text",
  "htmlUrl": "text",
  "pointsPossible": 1,
  "submissionTypes": [
    "text"
  ],
  "assignmentSubmissionBody": "text"
}

Delete Showcase Evidence

delete

Delete a specific evidence by its UUID

Path parameters

showcaseEvidenceIdstringRequired

Showcase Evidence UUID

showcasePortfolioIdstringRequired

Showcase Portfolio UUID

Responses

200

Showcase Evidence deleted successfully

No content

400

Evidence does not belong to the specified portfolio

403

User is not authorized to delete this evidence

404

Evidence not found

500

Internal server error

delete

HTTPcURLJavaScriptPython

DELETE /v1/showcase-portfolios/{showcasePortfolioId}/showcase-evidences/{showcaseEvidenceId} HTTP/1.1
Host: 
Accept: */*

No content