RatingScales
Operations for RatingScales
List ratingScales
Maximum number of items to return (1-1000)
10
Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.
Successful response
Bad request
Unauthorized
Internal server error
GET /ratingScales HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Accept: */*
{
"data": [
{
"code": "text",
"createdAt": "2025-09-12T14:28:24.057Z",
"customValues": {
"department": "Engineering",
"employeeId": "EMP-12345",
"location": "Amsterdam"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"lastModifiedAt": "2025-09-12T14:28:24.057Z",
"name": {
"en": "English text",
"nl": "Nederlandse tekst"
},
"repositoryID": "123e4567-e89b-12d3-a456-426614174000"
}
],
"pagination": {
"count": 1,
"hasMore": true,
"limit": 1,
"nextCursor": "text",
"total": 1
}
}
Get a single RatingScale by ID
RatingScale ID
Successful response
Unauthorized
Not found
Internal server error
GET /ratingScales/{id} HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Accept: */*
{
"code": "text",
"createdAt": "2025-09-12T14:28:24.057Z",
"customValues": {
"department": "Engineering",
"employeeId": "EMP-12345",
"location": "Amsterdam"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"lastModifiedAt": "2025-09-12T14:28:24.057Z",
"name": {
"en": "English text",
"nl": "Nederlandse tekst"
},
"repositoryID": "123e4567-e89b-12d3-a456-426614174000"
}
List all createRatingScales proposals. These are proposed changes to create new RatingScale records that may be automatically approved or require manual approval depending on system configuration.
Maximum number of items to return (1-1000)
10
Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.
Successful response
Bad request
Unauthorized
Internal server error
GET /createRatingScales HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Accept: */*
{
"data": [
{
"code": "text",
"customValues": {
"department": "Engineering",
"employeeId": "EMP-12345",
"location": "Amsterdam"
},
"isProposalExecutionFailed": true,
"isProposalResolved": false,
"name": {
"en": "English text",
"nl": "Nederlandse tekst"
},
"proposalExecutionErrorText": "text",
"repositoryID": "123e4567-e89b-12d3-a456-426614174000",
"requestID": "123e4567-e89b-12d3-a456-426614174000",
"subjectID": "123e4567-e89b-12d3-a456-426614174000"
}
],
"pagination": {
"count": 1,
"hasMore": true,
"limit": 1,
"nextCursor": "text",
"total": 1
}
}
Create new proposals to add RatingScale records. The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.
Created successfully
Bad request
Unauthorized
Internal server error
POST /createRatingScales HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 217
[
{
"code": "text",
"customValues": {
"department": "Engineering",
"employeeId": "EMP-12345",
"location": "Amsterdam"
},
"name": {
"en": "English text",
"nl": "Nederlandse tekst"
},
"repositoryID": "123e4567-e89b-12d3-a456-426614174000"
}
]
[
{
"code": "text",
"customValues": {
"department": "Engineering",
"employeeId": "EMP-12345",
"location": "Amsterdam"
},
"isProposalExecutionFailed": true,
"isProposalResolved": false,
"name": {
"en": "English text",
"nl": "Nederlandse tekst"
},
"proposalExecutionErrorText": "text",
"repositoryID": "123e4567-e89b-12d3-a456-426614174000",
"requestID": "123e4567-e89b-12d3-a456-426614174000",
"subjectID": "123e4567-e89b-12d3-a456-426614174000"
}
]
Get details of a specific RatingScale creation proposal by ID
CreateRatingScaleProposal ID
Successful response
Unauthorized
Not found
Internal server error
GET /createRatingScales/{id} HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Accept: */*
{
"code": "text",
"customValues": {
"department": "Engineering",
"employeeId": "EMP-12345",
"location": "Amsterdam"
},
"isProposalExecutionFailed": true,
"isProposalResolved": false,
"name": {
"en": "English text",
"nl": "Nederlandse tekst"
},
"proposalExecutionErrorText": "text",
"repositoryID": "123e4567-e89b-12d3-a456-426614174000",
"requestID": "123e4567-e89b-12d3-a456-426614174000",
"subjectID": "123e4567-e89b-12d3-a456-426614174000"
}
List all deleteRatingScales proposals. These are proposed changes to delete RatingScale records that may be automatically approved or require manual approval depending on system configuration.
Maximum number of items to return (1-1000)
10
Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.
Successful response
Bad request
Unauthorized
Internal server error
GET /deleteRatingScales 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
}
}
Create new proposals to delete RatingScale records. The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.
Created successfully
Bad request
Unauthorized
Internal server error
POST /deleteRatingScales 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 details of a specific RatingScale deletion proposal by ID
DeleteRatingScaleProposal ID
Successful response
Unauthorized
Not found
Internal server error
GET /deleteRatingScales/{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 all updateRatingScales proposals. These are proposed changes to update existing RatingScale records that may be automatically approved or require manual approval depending on system configuration.
Maximum number of items to return (1-1000)
10
Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.
Successful response
Bad request
Unauthorized
Internal server error
GET /updateRatingScales HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Accept: */*
{
"data": [
{
"code": "text",
"customValues": {
"department": "Engineering",
"employeeId": "EMP-12345",
"location": "Amsterdam"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"isProposalExecutionFailed": true,
"isProposalResolved": false,
"name": {
"en": "English text",
"nl": "Nederlandse tekst"
},
"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
}
}
Create new proposals to update RatingScale 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.
Omit this field to keep current value
Created successfully
Bad request
Unauthorized
Internal server error
POST /updateRatingScales HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 261
[
{
"code": "text",
"customValues": {
"department": "Engineering",
"employeeId": "EMP-12345",
"location": "Amsterdam"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": {
"en": "English text",
"nl": "Nederlandse tekst"
},
"repositoryID": "123e4567-e89b-12d3-a456-426614174000"
}
]
[
{
"code": "text",
"customValues": {
"department": "Engineering",
"employeeId": "EMP-12345",
"location": "Amsterdam"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"isProposalExecutionFailed": true,
"isProposalResolved": false,
"name": {
"en": "English text",
"nl": "Nederlandse tekst"
},
"proposalExecutionErrorText": "text",
"repositoryID": "123e4567-e89b-12d3-a456-426614174000",
"requestID": "123e4567-e89b-12d3-a456-426614174000"
}
]
Get details of a specific RatingScale update proposal by ID
UpdateRatingScaleProposal ID
Successful response
Unauthorized
Not found
Internal server error
GET /updateRatingScales/{id} HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Accept: */*
{
"code": "text",
"customValues": {
"department": "Engineering",
"employeeId": "EMP-12345",
"location": "Amsterdam"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"isProposalExecutionFailed": true,
"isProposalResolved": false,
"name": {
"en": "English text",
"nl": "Nederlandse tekst"
},
"proposalExecutionErrorText": "text",
"repositoryID": "123e4567-e89b-12d3-a456-426614174000",
"requestID": "123e4567-e89b-12d3-a456-426614174000"
}
Was this helpful?