Jump to

• Request
• Response

Updates a group mapped item

patch

/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/mappedItems

Request

Supported Media Types

• application/json

Path Parameters

• groupId(required): number
  Unique identifier of a Group.
• learnCenterId(required): number
  Unique identifier of LearnCenter.

Body ()

Group mapped item object that needs to be updated.

Root Schema : GroupMappedItemRequest

Type: object

Request object to Group Map an item

Show Source

• itemid(required): string
  Maximum Length: 50

  Unique identifier of the mapped item(learning plan/job profile/skill).
• itemtype(required): string
  Allowed Values: [ "learningplan", "jobprofile", "skill" ]

  The item type of a Group mapped Item.
• retainMapping: boolean
  Allowed Values: [ true, false ]

  Flag to retain mapping.

{
    "description":"Request object to Group Map an item",
    "type":"object",
    "required":[
        "itemid",
        "itemtype"
    ],
    "properties":{
        "itemid":{
            "maxLength":50,
            "type":"string",
            "description":"Unique identifier of the mapped item(learning plan/job profile/skill)."
        },
        "itemtype":{
            "type":"string",
            "description":"The item type of a Group mapped Item.",
            "enum":[
                "learningplan",
                "jobprofile",
                "skill"
            ]
        },
        "retainMapping":{
            "type":"boolean",
            "description":"Flag to retain mapping.",
            "enum":[
                true,
                false
            ]
        }
    },
    "example":{
        "itemid":"83767656-81b2-422d-85c8-c0a4f7972620",
        "itemtype":"learningplan",
        "retainmapping":true
    }
}

Example:

{
    "itemid":"83767656-81b2-422d-85c8-c0a4f7972620",
    "itemtype":"learningplan",
    "retainmapping":true
}

Security

• auth: basic
  Type: basic

  Description: Basic Authentication

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Updated mapping of a group to an item.

400 Response

Request has incorrect syntax or does not contain a field that is required.

409 Response

Another resource with the same identifier already exists.

500 Response

Internal server error.

Back to Top