Sign in

v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB
Role
Role

Update an existing role

Updates a role identified by externalCode in the URL.

Business rules:

  • name, similarity, and externalCode are required and must not be empty.
  • jobLevel and description must be sent on every request; use null or "" to clear optional values in EO.
  • externalCode in the body must be unique within the company (cannot match another role's code).

Errors (HTTP):

  • 404 when no role matches the URL externalCode for the company.
  • 409 when the new externalCode is already used by another role.
  • 400 for validation failures (invalid enums, missing keys, empty required strings).
put/os/v1/roles/external/{externalCode}

Path parameters

externalCodestring required
Example:ROLE-PUB-UPD-001

External code of the role to update

Request body

namestring required

role name

similarity'AUXILIARY' | 'CONSULTANT' | 'SUPERVISOR' | 'DEVELOPER' | 'DIRECTOR' | 'INTERNSHIP' | 'SPECIALIST' | 'MANAGER' | 'OPERATOR' | 'TECHNICAL' | 'TRAINEE' | 'COORDINATOR' | 'ANALYST' | 'APPRENTICE' | 'COORDINATOR_OR_SUPERVISOR' | 'ANALYST_OR_AUXILIARY' | 'EXECUTIVE' required

role similarity

jobLevel'INTERN' | 'ASSISTANT' | 'JUNIOR' | 'MID_LEVEL' | 'SENIOR' | 'SPECIALIST' | 'EXECUTIVE' nullable required

role job level; send null or empty string to clear the value in EO

externalCodestring required

role external code

descriptionstring nullable required

role description; send null or empty string to clear the value in EO

Example request

{
  "name": "Analista de Negócios",
  "similarity": "CONSULTANT",
  "jobLevel": "ASSISTANT",
  "externalCode": "RL-F98",
  "description": "Software Architect"
}

Response

The role has been successfully updated.