SkillDefinitions

List skillDefinitions

get

List skillDefinitions

Filter Syntax:

Filters use exact match only
Multiple filters are combined with AND logic
Filterable fields: ratingScaleID, typeID
Example: ?ratingScaleID=123e4567-e89b-12d3-a456-426614174000&typeID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Query parameters

ratingScaleIDstringOptional

Filter by ratingScaleID (exact match)

typeIDstringOptional

Filter by typeID (exact match)

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10

cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get

GET /skillDefinitions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "code": "text",
      "createdAt": "2025-09-13T18:43:57.486Z",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "description": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lastModifiedAt": "2025-09-13T18:43:57.486Z",
      "name": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "typeID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "count": 1,
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Get SkillDefinition

get

Get a single SkillDefinition by ID

Authorizations

Path parameters

idstringRequired

SkillDefinition ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

GET /skillDefinitions/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "code": "text",
  "createdAt": "2025-09-13T18:43:57.486Z",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "description": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedAt": "2025-09-13T18:43:57.486Z",
  "name": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "typeID": "123e4567-e89b-12d3-a456-426614174000"
}

List SkillDefinition creation proposals

get

List all createSkillDefinitions proposals. These are proposed changes to create new SkillDefinition records that may be automatically approved or require manual approval depending on system configuration.

Filter Syntax:

Filters use exact match only
Multiple filters are combined with AND logic
Filterable fields: ratingScaleID, typeID
Example: ?ratingScaleID=123e4567-e89b-12d3-a456-426614174000&typeID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Query parameters

ratingScaleIDstringOptional

Filter by ratingScaleID (exact match)

typeIDstringOptional

Filter by typeID (exact match)

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10

cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get

GET /createSkillDefinitions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "code": "text",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "description": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "name": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "proposalExecutionErrorText": "text",
      "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000",
      "subjectID": "123e4567-e89b-12d3-a456-426614174000",
      "typeID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "count": 1,
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose creation of SkillDefinitions

post

Create new proposals to add SkillDefinition records. The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.

Authorizations

Bodyobject[]

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)

codestringOptional

ratingScaleIDstring · uuidRequired

repositoryIDstring · uuidRequired

typeIDstring · uuidOptional

Responses

201

Created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

POST /createSkillDefinitions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 422

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "code": "text",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "description": {
      "en": "English text",
      "nl": "Nederlandse tekst"
    },
    "name": {
      "en": "English text",
      "nl": "Nederlandse tekst"
    },
    "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "typeID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "code": "text",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "description": {
      "en": "English text",
      "nl": "Nederlandse tekst"
    },
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "name": {
      "en": "English text",
      "nl": "Nederlandse tekst"
    },
    "proposalExecutionErrorText": "text",
    "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "requestID": "123e4567-e89b-12d3-a456-426614174000",
    "subjectID": "123e4567-e89b-12d3-a456-426614174000",
    "typeID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Get SkillDefinition creation proposal

get

Get details of a specific SkillDefinition creation proposal by ID

Authorizations

Path parameters

idstringRequired

CreateSkillDefinitionProposal ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

GET /createSkillDefinitions/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "code": "text",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "description": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "name": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "proposalExecutionErrorText": "text",
  "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000",
  "subjectID": "123e4567-e89b-12d3-a456-426614174000",
  "typeID": "123e4567-e89b-12d3-a456-426614174000"
}

List SkillDefinition deletion proposals

get

List all deleteSkillDefinitions proposals. These are proposed changes to delete SkillDefinition records that may be automatically approved or require manual approval depending on system configuration.

Authorizations

Query parameters

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10

cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get

GET /deleteSkillDefinitions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "proposalExecutionErrorText": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "count": 1,
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose deletion of SkillDefinitions

post

Create new proposals to delete SkillDefinition records. The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.

Authorizations

Bodyobject[]

idstring · uuidRequired

repositoryIDstring · uuidRequired

Responses

201

Created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

POST /deleteSkillDefinitions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 101

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "proposalExecutionErrorText": "text",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "requestID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Get SkillDefinition deletion proposal

get

Get details of a specific SkillDefinition deletion proposal by ID

Authorizations

Path parameters

idstringRequired

DeleteSkillDefinitionProposal ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

GET /deleteSkillDefinitions/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000"
}

List SkillDefinition update proposals

get

List all updateSkillDefinitions proposals. These are proposed changes to update existing SkillDefinition records that may be automatically approved or require manual approval depending on system configuration.

Filter Syntax:

Filters use exact match only
Multiple filters are combined with AND logic
Filterable fields: ratingScaleID, typeID
Example: ?ratingScaleID=123e4567-e89b-12d3-a456-426614174000&typeID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Query parameters

ratingScaleIDstringOptional

Filter by ratingScaleID (exact match)

typeIDstringOptional

Filter by typeID (exact match)

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10

cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get

GET /updateSkillDefinitions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "code": "text",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "description": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "name": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "proposalExecutionErrorText": "text",
      "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000",
      "typeID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "count": 1,
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose update of SkillDefinitions

post

Create new proposals to update SkillDefinition records. All fields are optional - omitted fields will not be changed. Only include fields you want to update. Setting a field to null will clear its value (where applicable). The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.

Authorizations

Bodyobject[]

activePeriodstringOptional

Date range in PostgreSQL format [start,end) (omit to keep current value)

Example: [2023-01-01,2023-12-31)

codestringOptional

Omit this field to keep current value

idstring · uuidRequired

ratingScaleIDstring · uuidOptional

Omit this field to keep current value

repositoryIDstring · uuidRequired

typeIDstring · uuidOptional

Omit this field to keep current value

Responses

201

Created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

POST /updateSkillDefinitions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 466

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "code": "text",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "description": {
      "en": "English text",
      "nl": "Nederlandse tekst"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": {
      "en": "English text",
      "nl": "Nederlandse tekst"
    },
    "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "typeID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "code": "text",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "description": {
      "en": "English text",
      "nl": "Nederlandse tekst"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "name": {
      "en": "English text",
      "nl": "Nederlandse tekst"
    },
    "proposalExecutionErrorText": "text",
    "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "requestID": "123e4567-e89b-12d3-a456-426614174000",
    "typeID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Get SkillDefinition update proposal

get

Get details of a specific SkillDefinition update proposal by ID

Authorizations

Path parameters

idstringRequired

UpdateSkillDefinitionProposal ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

GET /updateSkillDefinitions/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "code": "text",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "description": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "name": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "proposalExecutionErrorText": "text",
  "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000",
  "typeID": "123e4567-e89b-12d3-a456-426614174000"
}