Skills

Gets a single skill by course code or by skill name.

Gets a single skill by course code or by skill name.

Securitybearer
Request
path Parameters
courseCodeOrName
required
string

The course code or skill name.

Responses
200

Ok

404

Resource Not Found

get/v1/skills/{courseCodeOrName}
Request samples 
Response samples 
{
  • "Name": "string",
  • "Description": "string",
  • "HasExpiration": true,
  • "ExpirationAlertThreshold": 0,
  • "ExpiresAfter": 0,
  • "ExpiresAfterUnits": "Unknown",
  • "TrainingTime": 0,
  • "EnableTrainingMeetings": true,
  • "SkillType": "string",
  • "CourseCode": "string",
  • "IsPrivate": true,
  • "LastModified": "2019-08-24T14:15:22Z",
  • "CreatedDate": "2019-08-24T14:15:22Z",
  • "Attachments": [
    ]
}
Updates an existing skill, using the course code or skill name as a unique identifier.
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.


Securitybearer 
Request 
path Parameters
courseCodeOrName
required
string
The course code or skill name.


 
Request Body schema: 
required
Name
string
Display name of the skill


 
Description
required
string
Description of the skill


 
HasExpiration
required
boolean
Boolean whether or not the skill expires


 
ExpirationAlertThreshold
integer <int32> 
Threshold of days to the set Expiration when a skill changes to expiring


 
ExpiresAfter
integer <int32> 
Quantity of time units the skill expires after


 
ExpiresAfterUnits
string
Enum for time units Days = 1, Months = 2, Years = 3


 Enum: "Unknown" "Days" "Months" "Years"  
TrainingTime
integer <int32> 
The amount of time in minutes the skill takes to complete, will be used in the Safety system as default training meeting duration if skill meetings are enabled


 
EnableTrainingMeetings
boolean
If training meetings for this skill are enabled (turns on the skill meeting integration)


 
SkillType
required
string
A type to group skills by


 
CourseCode
string
A unique string identifier for the course related to the skill, could be a course name or course number


 
IsPrivate
boolean
Boolean to determine if skill is public or private


 
LastModified
string <date-time> 
When the skill was last modified


 
CreatedDate
string <date-time> 
When the skill was created


 
Array of objects (ApiAttachment) 
Attachments to the skill


 
Responses 
200
Ok


put/v1/skills/{courseCodeOrName}
Request samples 
{
  • "Name": "string",
  • "Description": "string",
  • "HasExpiration": true,
  • "ExpirationAlertThreshold": 0,
  • "ExpiresAfter": 0,
  • "ExpiresAfterUnits": "Unknown",
  • "TrainingTime": 0,
  • "EnableTrainingMeetings": true,
  • "SkillType": "string",
  • "CourseCode": "string",
  • "IsPrivate": true,
  • "LastModified": "2019-08-24T14:15:22Z",
  • "CreatedDate": "2019-08-24T14:15:22Z",
  • "Attachments": [
    ]
}
Response samples 
{ }
Deletes a skill by course code or skill name.
Deletes a skill by course code or skill name.  This method will not dismiss (i.e., soft delete) the skill; it
is permanently removed.  The skill will also be removed from all employees.


Securitybearer 
Request 
path Parameters
courseCodeOrName
required
string
The course code or skill name.


 
Responses 
204
No Content


404
Resource Not Found


delete/v1/skills/{courseCodeOrName}
Request samples 
Response samples 
{ }
Gets a list of skills.
Gets a list of skills.


A response header called "Pagination-MorePagesAvailable" will be sent in the response with a value of "yes" or "no", indicating whether more pages are available after
this one.  That is, if the header value is "yes", the client should request the next page.


Securitybearer 
Request 
query Parameters
dateAfterUtc
string <date-time> 
Limits the results to skills that have been updated after the specified UTC time.


 
limit
integer <int32> 
The number of results returned.  Default 1000.


 
offset
integer <int32> 
The page offset.  The response header "Pagination-MorePagesAvailable" indicates whether the call should be made again with an incremented offset.


 
Responses 
200
Ok


get/v1/skills
Request samples 
Response samples 
[
  • {
    }
]
Create a new skill, using the course code or skill name as a unique identifier.
Create a new skill, using the course code or skill name as a unique identifier.  If the skill already exists,
this call will return an error.


Securitybearer 
Request 
Request Body schema: 
required
Name
string
Display name of the skill


 
Description
required
string
Description of the skill


 
HasExpiration
required
boolean
Boolean whether or not the skill expires


 
ExpirationAlertThreshold
integer <int32> 
Threshold of days to the set Expiration when a skill changes to expiring


 
ExpiresAfter
integer <int32> 
Quantity of time units the skill expires after


 
ExpiresAfterUnits
string
Enum for time units Days = 1, Months = 2, Years = 3


 Enum: "Unknown" "Days" "Months" "Years"  
TrainingTime
integer <int32> 
The amount of time in minutes the skill takes to complete, will be used in the Safety system as default training meeting duration if skill meetings are enabled


 
EnableTrainingMeetings
boolean
If training meetings for this skill are enabled (turns on the skill meeting integration)


 
SkillType
required
string
A type to group skills by


 
CourseCode
string
A unique string identifier for the course related to the skill, could be a course name or course number


 
IsPrivate
boolean
Boolean to determine if skill is public or private


 
LastModified
string <date-time> 
When the skill was last modified


 
CreatedDate
string <date-time> 
When the skill was created


 
Array of objects (ApiAttachment) 
Attachments to the skill


 
Responses 
200
Ok


post/v1/skills
Request samples 
{
  • "Name": "string",
  • "Description": "string",
  • "HasExpiration": true,
  • "ExpirationAlertThreshold": 0,
  • "ExpiresAfter": 0,
  • "ExpiresAfterUnits": "Unknown",
  • "TrainingTime": 0,
  • "EnableTrainingMeetings": true,
  • "SkillType": "string",
  • "CourseCode": "string",
  • "IsPrivate": true,
  • "LastModified": "2019-08-24T14:15:22Z",
  • "CreatedDate": "2019-08-24T14:15:22Z",
  • "Attachments": [
    ]
}
Response samples 
{ }
Imports a list of skills, using the course code or name as a unique identifier for each skill.
Imports a list of skills, using the course code or name as a unique identifier for each skill.  Blank or null names are treated as equivalent.


Securitybearer 
Request 
Request Body schema: 
required
A list of skills


 Array 
Name
string
Display name of the skill


 
Description
required
string
Description of the skill


 
HasExpiration
required
boolean
Boolean whether or not the skill expires


 
ExpirationAlertThreshold
integer <int32> 
Threshold of days to the set Expiration when a skill changes to expiring


 
ExpiresAfter
integer <int32> 
Quantity of time units the skill expires after


 
ExpiresAfterUnits
string
Enum for time units Days = 1, Months = 2, Years = 3


 Enum: "Unknown" "Days" "Months" "Years"  
TrainingTime
integer <int32> 
The amount of time in minutes the skill takes to complete, will be used in the Safety system as default training meeting duration if skill meetings are enabled


 
EnableTrainingMeetings
boolean
If training meetings for this skill are enabled (turns on the skill meeting integration)


 
SkillType
required
string
A type to group skills by


 
CourseCode
string
A unique string identifier for the course related to the skill, could be a course name or course number


 
IsPrivate
boolean
Boolean to determine if skill is public or private


 
LastModified
string <date-time> 
When the skill was last modified


 
CreatedDate
string <date-time> 
When the skill was created


 
Array of objects (ApiAttachment) 
Attachments to the skill


 
Responses 
200
Ok


202
Accepted


400
Bad Request


post/v1/skills/import
Request samples 
[
  • {
    }
]
Response samples 
[
  • {
    }
]