EIeightfold
Upskill Plan Assignment

Update Upskill Plan Assignment by External Id

Changed on

Update the assigned plan of this profile that has the external Id. Fields in the body replace the stored ones; absent fields are left unchanged. sections is optional. When it is omitted, the plan's sections are unchanged. When it is sent, it replaces all of the plan's sections: afterwards the plan has exactly the sections, courses and tasks in the body. Send [] to remove every section.

patch/api/v2/careerhub/{profileEncId}/upskill-plan-assignment/ext/{externalId}

Request

Path parameters

profileEncIdstring required

Encoded profile id: id from GET /api/v2/core/employees

externalIdstring required

The caller's own id for the plan, unique per profile

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Request body

planSubtypestring nullable

Plan subtype, one of the subtypes configured for your account. Defaults to general.

namestring nullable required

Plan title

planDurationDaysinteger nullable

Plan duration in days. Rounded down to whole weeks, at most 693; values under 7 leave it unset.

skillsstring[]

Skill names the plan develops. A task's skills must come from this list.

targetDateinteger nullable

Target completion date (epoch seconds)

descriptionstring nullable

Plan description

associatedRoleIdsstring[]

Role ids, as returned by GET /api/v2/JIE/roles.

Response

OK

createdAtinteger nullable

Created timestamp (epoch seconds)

idinteger nullable

Assignment id (profile_data primary key)

planStatusstring nullable

invited | in_progress | completed | archived

externalIdstring nullable

Your external record id, unique per assignee. Addresses the plan in the /ext/<externalId> paths.

namestring nullable required

Plan display name

userIdstring nullable

Plan creator user id

completionPercentageinteger nullable

Completion percentage 0-100 (derived)

profileIdinteger nullable

Assignee profile id

startDateinteger nullable

Start date (epoch seconds)

lastProgressTsinteger nullable

Last progress timestamp (epoch seconds, system-set)

groupIdstring nullable

Tenant group id

updatedAtinteger nullable

Updated timestamp (epoch seconds)

lastNotifiedTsinteger nullable

Last notification timestamp (epoch seconds, system-set)

targetDateinteger nullable

Target completion date (epoch seconds)

parentPlanIdinteger nullable

Template plan id this assignment was cloned from

Changes