Skip to main content
POST
Create a new external knowledge

Authorizations

Authorization
string
header
required

Your organisation's API key, sent as Authorization: my_api_key. The key can also be passed as an api_key query parameter. See Authentication.

Body

application/json
user_name
string
required

User name of the person this knowledge belongs to (case-insensitive)

title
string
required

Title of external knowledge. Set automatically to Development Plan for Development Plans

provider
string
required

Provider

date_obtained
string
required

The date you obtained this knowledge. Formats: 'yyyy-mm-dd', 'dd/mm/yyyy' or 'dd/mm/yy'. date is accepted as an alternative name

knowledge_type
enum<integer>

Required, unless type is given. 1 = Training, 2 = Certificate, 3 = Qualification, 4 = License, 5 = Document, 6 = Development Plan. Can also be sent as a string, eg "1". Or use type

Available options:
1,
2,
3,
4,
5,
6
type
string

Alternative to knowledge_type, as text: Training, Certificate, Qualification, License, Document or Development Plan (case-insensitive). Required to use document_type or the Development Plan fields

document_type
string

For type Document only. The type of Document, eg General, Employment, Financial, Medical, Performance, Policy, Travel, Registration, Membership. Stored in code

code
string

Optional code for the external knowledge

certificate_number
string

Certificate Number

country_obtained
string

Country in code form (eg 'AU' for Australia)

state_obtained
string

State or Region in code form (eg 'NSW'). region_obtained is accepted as an alternative name

expires
string

Date the knowledge expires. Same formats as date_obtained

qualification_level
string

Qualification level, eg Certificate IV, Diploma, Bachelor Degree

assessment_score
number

Assessment score as a decimal, eg 1.2

total_time
integer

Time in minutes, as a whole number

notes
string

Notes

klass
string

Class of knowledge. class is accepted as an alternative name

reviewer
string

For type Development Plan only. Stored in provider

date_signed
string

For type Development Plan only. Stored in date_obtained

next_review_date
string

For type Development Plan only. Stored in expires

stage
enum<string>

For type Development Plan only. Initial, Mid Review or End Review. Stored in code

Available options:
Initial,
Mid Review,
End Review
development_focus
enum<string>

For Development Plans: At Level, Transition or Progression

Available options:
At Level,
Transition,
Progression
skills_attained
string

Skill names attained by this knowledge. Separate multiple skills with ;. Unknown skills are ignored

category_1
string

Category name attained in the knowledge. Unknown categories return 400

category_1_points
number

Points for category 1, eg 10 or 12.5. Stored to 2 decimal places. Can also be sent as a numeric string, eg "10"

category_1_time
number

Time in minutes for category 1, eg 60 or 90.5. Can also be sent as a numeric string, eg "60"

category_2
string

Category name attained in the knowledge. Unknown categories return 400

category_2_points
number

Points for category 2, eg 10 or 12.5. Stored to 2 decimal places. Can also be sent as a numeric string, eg "10"

category_2_time
number

Time in minutes for category 2, eg 60 or 90.5. Can also be sent as a numeric string, eg "60"

category_3
string

Category name attained in the knowledge. Unknown categories return 400

category_3_points
number

Points for category 3, eg 10 or 12.5. Stored to 2 decimal places. Can also be sent as a numeric string, eg "10"

category_3_time
number

Time in minutes for category 3, eg 60 or 90.5. Can also be sent as a numeric string, eg "60"

Response

The external knowledge record was created

id
integer

Unique identifier of the external knowledge record, used with show and update

knowledge_type
enum<integer>

1 = Training, 2 = Certificate, 3 = Qualification, 4 = License, 5 = Document, 6 = Development Plan

Available options:
1,
2,
3,
4,
5,
6
title
string
code
string | null

Code for the knowledge. For Documents this holds the document type, and for Development Plans the stage

provider
string
date_obtained
string

Date in the form 'yyyy-mm-dd'

certificate_number
string | null
country_obtained
string | null
state_obtained
string | null

State or region code

expires
string | null

Date in the form 'yyyy-mm-dd'

qualification_level
string | null
assessment_score
number | null
total_time
integer | null
notes
string | null
klass
string | null

Class of knowledge

created_at
string<date-time>
updated_at
string<date-time>
development_focus
string | null