RatingScaleLevels

Operations for RatingScaleLevels

List ratingScaleLevels

get

List ratingScaleLevels

Filter Syntax:

  • Filters use exact match only

  • Multiple filters are combined with AND logic

  • Filterable fields: ratingScaleID

  • Example: ?ratingScaleID=123e4567-e89b-12d3-a456-426614174000

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

Query parameters
ratingScaleIDstringOptional

Filter by ratingScaleID (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 /api/orgkeep/v4/{orgkeepID}/ratingScaleLevels HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "data": [
    {
      "code": "text",
      "createdAt": "2025-07-18T20:01:45.971Z",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "description": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lastModifiedAt": "2025-07-18T20:01:45.971Z",
      "name": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "scoreOrder": 1
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Get RatingScaleLevel

get

Get a single ratingScaleLevel by ID

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

idstringRequired

RatingScaleLevel ID

Responses
200
Successful response
application/json
get
GET /api/orgkeep/v4/{orgkeepID}/ratingScaleLevels/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "code": "text",
  "createdAt": "2025-07-18T20:01:45.971Z",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "description": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedAt": "2025-07-18T20:01:45.971Z",
  "name": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "ratingScaleID": "123e4567-e89b-12d3-a456-426614174000",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "scoreOrder": 1
}

List RatingScaleLevel creation proposals

get

List all createRatingScaleLevels proposals. These are proposed changes to create new RatingScaleLevel 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

  • Example: ?ratingScaleID=123e4567-e89b-12d3-a456-426614174000

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

Query parameters
ratingScaleIDstringOptional

Filter by ratingScaleID (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 /api/orgkeep/v4/{orgkeepID}/createRatingScaleLevels HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "data": [
    {
      "code": "text",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "description": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "isProposalExecutionFailed": true,
      "isProposalResolved": true,
      "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",
      "scoreOrder": 1,
      "subjectID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose creation of RatingScaleLevel

post

Create a new proposal to add a RatingScaleLevel record. The proposal may be automatically approved or require manual approval depending on system configuration.

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

Body
codestringRequired
ratingScaleIDstring · uuidRequired
repositoryIDstring · uuidRequired
scoreOrderinteger · int32Required
Responses
201
Created successfully
application/json
post
POST /api/orgkeep/v4/{orgkeepID}/createRatingScaleLevels HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 346

{
  "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",
  "scoreOrder": 1
}
{
  "code": "text",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "description": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "isProposalExecutionFailed": true,
  "isProposalResolved": true,
  "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",
  "scoreOrder": 1,
  "subjectID": "123e4567-e89b-12d3-a456-426614174000"
}

Get RatingScaleLevel creation proposal

get

Get details of a specific RatingScaleLevel creation proposal by ID

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

idstringRequired

CreateRatingScaleLevel ID

Responses
200
Successful response
application/json
get
GET /api/orgkeep/v4/{orgkeepID}/createRatingScaleLevels/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "code": "text",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "description": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "isProposalExecutionFailed": true,
  "isProposalResolved": true,
  "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",
  "scoreOrder": 1,
  "subjectID": "123e4567-e89b-12d3-a456-426614174000"
}

List RatingScaleLevel deletion proposals

get

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

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

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 /api/orgkeep/v4/{orgkeepID}/deleteRatingScaleLevels HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": true,
      "proposalExecutionErrorText": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose creation of RatingScaleLevel

post

Create a new proposal to add a RatingScaleLevel record. The proposal may be automatically approved or require manual approval depending on system configuration.

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

Body
idstring · uuidRequired
repositoryIDstring · uuidRequired
Responses
201
Created successfully
application/json
post
POST /api/orgkeep/v4/{orgkeepID}/deleteRatingScaleLevels HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 99

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

Get RatingScaleLevel deletion proposal

get

Get details of a specific RatingScaleLevel deletion proposal by ID

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

idstringRequired

DeleteRatingScaleLevel ID

Responses
200
Successful response
application/json
get
GET /api/orgkeep/v4/{orgkeepID}/deleteRatingScaleLevels/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": true,
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000"
}

List RatingScaleLevel update proposals

get

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

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

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 /api/orgkeep/v4/{orgkeepID}/updateRatingScaleLevels HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "data": [
    {
      "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": true,
      "name": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "proposalExecutionErrorText": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose creation of RatingScaleLevel

post

Create a new proposal to add a RatingScaleLevel record. The proposal may be automatically approved or require manual approval depending on system configuration.

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

Body
codestringRequired
idstring · uuidRequired
repositoryIDstring · uuidRequired
Responses
201
Created successfully
application/json
post
POST /api/orgkeep/v4/{orgkeepID}/updateRatingScaleLevels HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 320

{
  "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"
  },
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "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": true,
  "name": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000"
}

Get RatingScaleLevel update proposal

get

Get details of a specific RatingScaleLevel update proposal by ID

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

idstringRequired

UpdateRatingScaleLevel ID

Responses
200
Successful response
application/json
get
GET /api/orgkeep/v4/{orgkeepID}/updateRatingScaleLevels/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "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": true,
  "name": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000"
}

Was this helpful?