SkillDefinitions

Operations for 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

bearerToken

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

/skillDefinitions

HTTPcURLJavaScriptPython

GET /skillDefinitions HTTP/1.1
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "code": "text",
      "createdAt": "2026-02-26T01:13:28.872Z",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "description": {
        "en_us": "English text",
        "nl_nl": "Nederlandse tekst"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lastModifiedAt": "2026-02-26T01:13:28.872Z",
      "name": {
        "en_us": "English text",
        "nl_nl": "Nederlandse tekst"
      },
      "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "tagIDs": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "typeID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Get SkillDefinition

get

Get a single SkillDefinition by ID

Authorizations

bearerToken

Path parameters

idstringRequired

SkillDefinition ID

Responses

200

Successful response

application/json

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

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

codestringOptional

createdAtstring · date-timeRequired

idstring · uuidRequired

lastModifiedAtstring · date-timeRequired

ratingScaleIDstring · uuidRequired

repositoryIDstring · uuidRequired

tagIDsstring · uuid[]Required

typeIDstring · uuidOptional

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/skillDefinitions/{id}

HTTPcURLJavaScriptPython

GET /skillDefinitions/{id} HTTP/1.1
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "code": "text",
  "createdAt": "2026-02-26T01:13:28.872Z",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "description": {
    "en_us": "English text",
    "nl_nl": "Nederlandse tekst"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedAt": "2026-02-26T01:13:28.872Z",
  "name": {
    "en_us": "English text",
    "nl_nl": "Nederlandse tekst"
  },
  "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "tagIDs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "typeID": "123e4567-e89b-12d3-a456-426614174000"
}

Upload document for SkillDefinition

post

Upload a binary document that will be attached to the specified resource via a proposal.

Authorizations

bearerToken

Path parameters

idstringRequired

SkillDefinition ID

Body

multipart/form-data

filestring · binaryRequired

Responses

202

Upload accepted

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

/skillDefinitions/{id}/uploadDocument

HTTPcURLJavaScriptPython

POST /skillDefinitions/{id}/uploadDocument HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

No content

List documents for SkillDefinition

get

List documents for the SkillDefinition resource

Authorizations

bearerToken

Path parameters

idstringRequired

SkillDefinition ID

Responses

200

Successful response

application/json

contentTypestringOptional

MIME type of the file

downloadUrlstringOptional

filenamestringOptional

Name of the file

sizeintegerOptional

Size of the file in bytes

401

Unauthorized

application/json

500

Internal server error

application/json

get

/skillDefinitions/{id}/documents

HTTPcURLJavaScriptPython

GET /skillDefinitions/{id}/documents HTTP/1.1
Accept: */*

[
  {
    "contentType": "text",
    "downloadUrl": "text",
    "filename": "text",
    "size": 1
  }
]

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

bearerToken

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

/createSkillDefinitions

HTTPcURLJavaScriptPython

GET /createSkillDefinitions HTTP/1.1
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "code": "text",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "description": {
        "en_us": "English text",
        "nl_nl": "Nederlandse tekst"
      },
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "name": {
        "en_us": "English text",
        "nl_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",
      "tagIDs": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "typeID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "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

bearerToken

Bodyobject[]

application/json

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

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

codestringOptional

ratingScaleIDstring · uuidRequired

repositoryIDstring · uuidRequired

tagIDsstring · uuid[]Required

typeIDstring · uuidOptional

Responses

201

Created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

/createSkillDefinitions

HTTPcURLJavaScriptPython

POST /createSkillDefinitions HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 484

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "code": "text",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "description": {
      "en_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "name": {
      "en_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "tagIDs": [
      "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_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "name": {
      "en_us": "English text",
      "nl_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",
    "tagIDs": [
      "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

bearerToken

Path parameters

idstringRequired

CreateSkillDefinitionProposal ID

Responses

200

Successful response

application/json

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

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

codestringOptional

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

proposalExecutionErrorTextstringRead-onlyOptional

ratingScaleIDstring · uuidRequired

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

subjectIDstring · uuidRead-onlyRequired

tagIDsstring · uuid[]Required

typeIDstring · uuidOptional

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/createSkillDefinitions/{id}

HTTPcURLJavaScriptPython

GET /createSkillDefinitions/{id} HTTP/1.1
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "code": "text",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "description": {
    "en_us": "English text",
    "nl_nl": "Nederlandse tekst"
  },
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "name": {
    "en_us": "English text",
    "nl_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",
  "tagIDs": [
    "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

bearerToken

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

/deleteSkillDefinitions

HTTPcURLJavaScriptPython

GET /deleteSkillDefinitions HTTP/1.1
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": {
    "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

bearerToken

Bodyobject[]

application/json

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

/deleteSkillDefinitions

HTTPcURLJavaScriptPython

POST /deleteSkillDefinitions HTTP/1.1
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

bearerToken

Path parameters

idstringRequired

DeleteSkillDefinitionProposal ID

Responses

200

Successful response

application/json

idstring · uuidRequired

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

proposalExecutionErrorTextstringRead-onlyOptional

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/deleteSkillDefinitions/{id}

HTTPcURLJavaScriptPython

GET /deleteSkillDefinitions/{id} HTTP/1.1
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

bearerToken

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

/updateSkillDefinitions

HTTPcURLJavaScriptPython

GET /updateSkillDefinitions HTTP/1.1
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "code": "text",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "description": {
        "en_us": "English text",
        "nl_nl": "Nederlandse tekst"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "name": {
        "en_us": "English text",
        "nl_nl": "Nederlandse tekst"
      },
      "proposalExecutionErrorText": "text",
      "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000",
      "tagIDs": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "typeID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "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

bearerToken

Bodyobject[]

application/json

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

tagIDsstring · uuid[]Optional

Omit this field to keep current value

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

/updateSkillDefinitions

HTTPcURLJavaScriptPython

POST /updateSkillDefinitions HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 528

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "code": "text",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "description": {
      "en_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": {
      "en_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "tagIDs": [
      "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_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "name": {
      "en_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "proposalExecutionErrorText": "text",
    "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "requestID": "123e4567-e89b-12d3-a456-426614174000",
    "tagIDs": [
      "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

bearerToken

Path parameters

idstringRequired

UpdateSkillDefinitionProposal ID

Responses

200

Successful response

application/json

activePeriodstringOptional

Date range in PostgreSQL format [start,end)

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

codestringOptional

idstring · uuidRequired

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

proposalExecutionErrorTextstringRead-onlyOptional

ratingScaleIDstring · uuidOptional

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

tagIDsstring · uuid[]Optional

typeIDstring · uuidOptional

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/updateSkillDefinitions/{id}

HTTPcURLJavaScriptPython

GET /updateSkillDefinitions/{id} HTTP/1.1
Accept: */*

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