EIeightfold
Upskill Plan Template

Get Upskill Plan Template by External Id

Changed on

Fetch an upskilling plan template by the caller's externalId.

get/api/v2/careerhub/upskill-plan-templates/ext/{externalId}

Request

Path parameters

externalIdstring required

The caller's own id for the template, unique per tenant

Query parameters

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

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

Response

OK

statusstring nullable

Template status: draft | published

idinteger nullable

Template plan id

createdAtinteger nullable

Created timestamp (epoch seconds)

planSubtypestring nullable

Plan subtype

namestring nullable

Plan title

externalIdstring nullable

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

userIdstring nullable

Plan creator user id

planDurationDaysinteger nullable

Plan duration in days

publishedAtinteger nullable

Publish timestamp (epoch seconds)

skillsstring[] nullable

Skill names

groupIdstring nullable

Tenant group id

updatedAtinteger nullable

Updated timestamp (epoch seconds)

descriptionstring nullable

Plan description

associatedRoleIdsstring[] nullable

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

Changes