Skip to content

roleSchema

type: object

an experience of working in a role at an organisation

id

type: string
optional? yes

an identifier for the role

name

type: string

the job title of the role

summary

type: string
optional? yes

a short description or introduction of the role

description

type: string
optional? yes

long-form description of the role; This is used where space is not constrained.

highlights

type: array
optional? yes

a list of highlights, like responsibilities or achievements, from the role

highlights[idx]

type: string

type

type: roleTypeSchema
optional? yes

the nature of the role, in terms of length, commitment and obligations

location

type: roleLocationSchema
optional? yes

the nature of the role, in terms of place of work

period

type: periodSchema
optional? yes

the time duration for which the role was held

epicIds

type: array
optional? yes

the list of IDs for epics that were created or worked on during this role; This is a relationship to the Epic model.

epicIds[idx]

type: string

tags

type: array
optional? yes

tags to apply to this role; The use of tags is left up to the application (for example, the portfolio uses tags for PDF résumés).

tags[idx]

type: tagSchema

a string that classifies a given entity