v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB
Position

Create multiple identical positions with employee assignment

Creates multiple identical positions and assigns each one to a specific employee. All positions will have the same base data (role, area, etc.) but each will be linked to a different employee. Provide either an array of employee emails or taxpayer registries (CPF), but not both. Maximum 10 employees per request. External codes are auto-generated for each position.

post/os/v1/positions/replication/with-employees

Request body

namestring required

Human-readable name for the position

externalCodeRolestring required

External code of the role to associate with this position

externalCodeAreastring required

External code of the area to associate with this position

descriptionstring nullable

Optional detailed description of the position responsibilities and requirements

externalCodeCostCenterstring

Optional external code of the cost center to associate with this position

externalCodeParentstring required

External code of the parent position in the organizational hierarchy (required)

externalCodeOperationUnitstring

Optional external code of the operation unit to associate with this position

employeeEmailsstring[]

Array of employee emails to create positions for. Must provide either employeeEmails or employeeTaxpayerRegistries, but not both. Maximum 10 items.

employeeTaxpayerRegistriesstring[]

Array of employee taxpayer registries (CPF) to create positions for. Must provide either employeeEmails or employeeTaxpayerRegistries, but not both. Maximum 10 items.

Example request

{
  "name": "Software Engineer",
  "externalCodeRole": "SE_ROLE",
  "externalCodeArea": "TECH_AREA",
  "description": "Senior software engineer responsible for backend development and architecture decisions",
  "externalCodeCostCenter": "CC_TECH",
  "externalCodeParent": "TECH_LEAD",
  "externalCodeOperationUnit": "OP_UNIT_01",
  "employeeEmails": [
    "john.doe@company.com",
    "jane.smith@company.com"
  ],
  "employeeTaxpayerRegistries": [
    "123.456.789-00",
    "987.654.321-00"
  ]
}

Response

All positions were created successfully. Returns array of created positions.

Example response

{
  "successes": [
    {
      "uuid": "cc2339c3-bf5a-406b-bafa-3bf8c0acbf23",
      "name": "Software Engineer",
      "externalCode": "SE123",
      "description": "Posição de desenvolvedor time ABC",
      "role": {
        "name": "Desenvolvedor",
        "similarity": "CONSULTANT",
        "externalCode": "RR-001"
      },
      "employee": {
        "uuid": "d20dc017-80c6-4706-bbfe-549c1cc4d2c1",
        "internalCompanyNumber": "132AT41"
      },
      "area": {
        "uuid": "cab41475-caa7-47a7-9b28-eecae80c1ae3",
        "name": "Produto",
        "similarity": "ACCOUNTING",
        "externalCode": "AA-001"
      },
      "costCenter": {
        "name": "CC-001",
        "externalCode": "CC-001"
      },
      "operationUnit": {
        "name": "Operation Unit 1",
        "externalCode": "OU-001"
      },
      "parent": {
        "uuid": "0372fc1b-35e0-42c5-bbe7-98dc7c218da1",
        "name": "Software Engineer",
        "externalCode": "SE123",
        "employee": {
          "uuid": "d20dc017-80c6-4706-bbfe-549c1cc4d2c1",
          "internalCompanyNumber": "132AT41"
        }
      },
      "additionalParents": [
        {
          "uuid": "0372fc1b-35e0-42c5-bbe7-98dc7c218da1",
          "name": "Software Engineer",
          "externalCode": "SE123",
          "employee": {
            "uuid": "d20dc017-80c6-4706-bbfe-549c1cc4d2c1",
            "internalCompanyNumber": "132AT41"
          }
        }
      ],
      "status": "OPEN"
    }
  ],
  "errors": [
    {
      "identifier": "fantasma@cliente.com",
      "message": "Employee not found"
    }
  ]
}