Updates an existing skill, using the course code or skill name as a unique identifier.

put

https://api.hcssapps.com/skills/api/v1/skills/{courseCodeOrName}

Updates an existing skill, using the course code or skill name as a unique identifier. If the skill does not already exist,
this call will return an error.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

courseCodeOrName

string

required

The course code or skill name.

Body Params

Represents a skill request data transfer object for create and update operations via the Skills API.
Contains all properties required to define a skill including expiration settings, training configuration, and attachments.

Name

string

Gets or sets the display name of the skill.

Description

string

required

Gets or sets the detailed description of the skill.

HasExpiration

boolean

required

Gets or sets a value indicating whether the skill has an expiration policy.
When true, the skill will expire based on {Skills.ExternalApi.Models.SkillRequestDto.ExpiresAfter} and {Skills.ExternalApi.Models.SkillRequestDto.ExpiresAfterUnits}.

ExpirationAlertThreshold

int32

Gets or sets the number of days before expiration when the skill status changes to "expiring".
Used to trigger alerts and notifications before a skill expires.

ExpiresAfter

int32

Gets or sets the quantity of time units after which the skill expires.
Used in conjunction with {Skills.ExternalApi.Models.SkillRequestDto.ExpiresAfterUnits} to determine the expiration period.

ExpiresAfterUnits

string

enum

Gets or sets the time unit for the expiration period.

Allowed:

TrainingTime

int32

Gets or sets the estimated time in minutes required to complete the skill training.
This value is used as the default duration for training meetings when {Skills.ExternalApi.Models.SkillRequestDto.EnableTrainingMeetings} is enabled.

EnableTrainingMeetings

boolean

Gets or sets a value indicating whether training meetings are enabled for this skill.
When true, enables the skill meeting integration in the Safety system.

SkillType

string

required

Gets or sets the skill type used to categorize and group skills.

CourseCode

string

Gets or sets the unique course code identifier for the skill.
This can be a course name, course number, or any unique identifier for the related course.

IsPrivate

boolean

Gets or sets a value indicating whether the skill is private.
When true, the skill has restricted visibility; when false, it is publicly accessible.

Attachments

array of objects

Gets or sets the collection of attachments to associate with the skill.

Attachments

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

200Ok