hris
taxonomy

Create a taxonomy

Changed on
post/hris/{connection_id}/taxonomy

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/hris/{connection_id}/taxonomy
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

type'SKILL' | 'KNOWLEDGE' | 'COMPETENCE' | 'ABILITY' | 'CERTIFICATION' | 'ROLE' | 'HOLIDAY' | 'LEAVE'

the kind of taxonomy item: skill, knowledge, competence, ability, certification or role/occupation

namestring

the preferred label of the skill/role

descriptionstring
domainstring

1st-level grouping (broadest)

categorystring

2nd-level grouping

subcategorystring

3rd-level grouping

parent_idstring

id of the parent taxonomy item, for providers exposing arbitrary-depth trees

alternative_namesstring[]

synonyms / alternative labels

urlstring

external reference URL for this item

role_idsstring[]

ids of hris_taxonomy items of type ROLE that this skill relates to

is_activeboolean
rawobject

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

type'SKILL' | 'KNOWLEDGE' | 'COMPETENCE' | 'ABILITY' | 'CERTIFICATION' | 'ROLE' | 'HOLIDAY' | 'LEAVE'

the kind of taxonomy item: skill, knowledge, competence, ability, certification or role/occupation

namestring

the preferred label of the skill/role

descriptionstring
domainstring

1st-level grouping (broadest)

categorystring

2nd-level grouping

subcategorystring

3rd-level grouping

parent_idstring

id of the parent taxonomy item, for providers exposing arbitrary-depth trees

alternative_namesstring[]

synonyms / alternative labels

urlstring

external reference URL for this item

role_idsstring[]

ids of hris_taxonomy items of type ROLE that this skill relates to

is_activeboolean
rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the new optional request property

    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status

  • 45664a7696acRevision changes
    • info

      endpoint added