RatingScaleLevelDescriptors

Operations for RatingScaleLevelDescriptors

List ratingScaleLevelDescriptors

get

List ratingScaleLevelDescriptors

Filter Syntax:

  • Filters use exact match only

  • Multiple filters are combined with AND logic

  • Filterable fields: ratingScaleLevelID, skillDefinitionID

  • Example: ?ratingScaleLevelID=123e4567-e89b-12d3-a456-426614174000&skillDefinitionID=123e4567-e89b-12d3-a456-426614174000

Authorizations
Query parameters
ratingScaleLevelIDstringOptional

Filter by ratingScaleLevelID (exact match)

skillDefinitionIDstringOptional

Filter by skillDefinitionID (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
get
GET /ratingScaleLevelDescriptors HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "data": [
    {
      "createdAt": "2025-09-13T20:56:12.841Z",
      "description": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lastModifiedAt": "2025-09-13T20:56:12.841Z",
      "ratingScaleLevelID": "123e4567-e89b-12d3-a456-426614174000",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "count": 1,
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Get RatingScaleLevelDescriptor

get

Get a single RatingScaleLevelDescriptor by ID

Authorizations
Path parameters
idstringRequired

RatingScaleLevelDescriptor ID

Responses
200

Successful response

application/json
get
GET /ratingScaleLevelDescriptors/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "createdAt": "2025-09-13T20:56:12.841Z",
  "description": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedAt": "2025-09-13T20:56:12.841Z",
  "ratingScaleLevelID": "123e4567-e89b-12d3-a456-426614174000",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000"
}

List RatingScaleLevelDescriptor creation proposals

get

List all createRatingScaleLevelDescriptors proposals. These are proposed changes to create new RatingScaleLevelDescriptor 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: ratingScaleLevelID, skillDefinitionID

  • Example: ?ratingScaleLevelID=123e4567-e89b-12d3-a456-426614174000&skillDefinitionID=123e4567-e89b-12d3-a456-426614174000

Authorizations
Query parameters
ratingScaleLevelIDstringOptional

Filter by ratingScaleLevelID (exact match)

skillDefinitionIDstringOptional

Filter by skillDefinitionID (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
get
GET /createRatingScaleLevelDescriptors HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "data": [
    {
      "description": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "proposalExecutionErrorText": "text",
      "ratingScaleLevelID": "123e4567-e89b-12d3-a456-426614174000",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000",
      "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
      "subjectID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "count": 1,
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose creation of RatingScaleLevelDescriptors

post

Create new proposals to add RatingScaleLevelDescriptor 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[]
ratingScaleLevelIDstring · uuidRequired
repositoryIDstring · uuidRequired
skillDefinitionIDstring · uuidRequired
Responses
201

Created successfully

application/json
post
POST /createRatingScaleLevelDescriptors HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 237

[
  {
    "description": {
      "en": "English text",
      "nl": "Nederlandse tekst"
    },
    "ratingScaleLevelID": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000"
  }
]
[
  {
    "description": {
      "en": "English text",
      "nl": "Nederlandse tekst"
    },
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "proposalExecutionErrorText": "text",
    "ratingScaleLevelID": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "requestID": "123e4567-e89b-12d3-a456-426614174000",
    "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
    "subjectID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Get RatingScaleLevelDescriptor creation proposal

get

Get details of a specific RatingScaleLevelDescriptor creation proposal by ID

Authorizations
Path parameters
idstringRequired

CreateRatingScaleLevelDescriptorProposal ID

Responses
200

Successful response

application/json
get
GET /createRatingScaleLevelDescriptors/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "description": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "proposalExecutionErrorText": "text",
  "ratingScaleLevelID": "123e4567-e89b-12d3-a456-426614174000",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000",
  "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
  "subjectID": "123e4567-e89b-12d3-a456-426614174000"
}

List RatingScaleLevelDescriptor deletion proposals

get

List all deleteRatingScaleLevelDescriptors proposals. These are proposed changes to delete RatingScaleLevelDescriptor 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
get
GET /deleteRatingScaleLevelDescriptors 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 RatingScaleLevelDescriptors

post

Create new proposals to delete RatingScaleLevelDescriptor 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
post
POST /deleteRatingScaleLevelDescriptors 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 RatingScaleLevelDescriptor deletion proposal

get

Get details of a specific RatingScaleLevelDescriptor deletion proposal by ID

Authorizations
Path parameters
idstringRequired

DeleteRatingScaleLevelDescriptorProposal ID

Responses
200

Successful response

application/json
get
GET /deleteRatingScaleLevelDescriptors/{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 RatingScaleLevelDescriptor update proposals

get

List all updateRatingScaleLevelDescriptors proposals. These are proposed changes to update existing RatingScaleLevelDescriptor 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
get
GET /updateRatingScaleLevelDescriptors HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "data": [
    {
      "description": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "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 update of RatingScaleLevelDescriptors

post

Create new proposals to update RatingScaleLevelDescriptor 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[]
idstring · uuidRequired
repositoryIDstring · uuidRequired
Responses
201

Created successfully

application/json
post
POST /updateRatingScaleLevelDescriptors HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 162

[
  {
    "description": {
      "en": "English text",
      "nl": "Nederlandse tekst"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000"
  }
]
[
  {
    "description": {
      "en": "English text",
      "nl": "Nederlandse tekst"
    },
    "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 RatingScaleLevelDescriptor update proposal

get

Get details of a specific RatingScaleLevelDescriptor update proposal by ID

Authorizations
Path parameters
idstringRequired

UpdateRatingScaleLevelDescriptorProposal ID

Responses
200

Successful response

application/json
get
GET /updateRatingScaleLevelDescriptors/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "description": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000"
}

Was this helpful?