v1

latestOpenAPI 3.0.12026-07-24283883639.5 KB
Recommended Learning

Update a Specific Recommended Learning Item

This endpoint updates supplied fields for a specific recommended learning. <h3>Required Scope</h3>recommended_learning:write

patch/api/v2/recommended-learning/{id}

Path parameters

idstring required
Example:Yxjak6

The ID of the recommended learning item to update.

Request body

Example request

{
  "data": {
    "type": "recommended-learning",
    "id": "Yxjak6"
  }
}

Response

Success

Example response

{
  "data": {
    "type": "recommended-learning",
    "id": "Yxjak6",
    "attributes": {
      "employee-id": "info@example.com",
      "assignment-type": "RecommendedLearning",
      "status": "Pending",
      "assigner-employee-id": "info@example.com"
    },
    "links": {
      "self": "/recommended-learning/Yxjak6"
    },
    "relationships": [
      {
        "user": {
          "data": {
            "id": "yj9kj",
            "type": "users"
          }
        },
        "content": {
          "data": {
            "id": "nNmwVAgd",
            "type": "content"
          }
        },
        "provider": {
          "data": {
            "id": "degreedopenlibrary",
            "type": "providers"
          }
        },
        "assigner": {
          "data": {
            "id": "yj9kj",
            "type": "users"
          }
        }
      }
    ],
    "included": [
      {
        "type": "content",
        "id": "nNmwVAgd",
        "attributes": {
          "content-type": "Video",
          "url": "https://www.youtube.com/watch?v=D33PakstpjI",
          "title": "The Learning Algorithm Using AI to Expand Workforce Learning",
          "provider": "degreedopenlibrary"
        },
        "links": {
          "self": "/content/nNmwVAgd"
        }
      }
    ]
  }
}