Onboard an employee in Kolay İK

arazzo: 1.0.1
info:
  title: Onboard an employee in Kolay İK
  version: 1.0.0
  summary: Discover the tenant's custom person fields and org tree, create the person, verify the stored record, and assign onboarding training.
  description: >-
    Every operationId below exists verbatim in openapi/kolayik-public-api-openapi.yml,
    which is a faithful conversion of the official Kolay Public API Postman collection.
    Kolay publishes no sandbox — running this workflow against a real token creates a
    real employee record.
sourceDescriptions:
- name: personApi
  url: ../openapi/kolayik-person-api-openapi.yml
  type: openapi
- name: trainingApi
  url: ../openapi/kolayik-training-api-openapi.yml
  type: openapi
- name: unitApi
  url: ../openapi/kolayik-unit-api-openapi.yml
  type: openapi
workflows:
- workflowId: onboardEmployee
  summary: Create an employee and complete onboarding basics.
  inputs:
    type: object
    required: [firstName, lastName]
    properties:
      firstName:
        type: string
      lastName:
        type: string
      workEmail:
        type: string
      employmentStartDate:
        type: string
        description: YYYY-MM-DD
      contractType:
        type: string
        enum: [definite, indefinite]
      trainingSearch:
        type: string
        description: Title fragment used to find the onboarding training.
  steps:
  - stepId: discoverDataFields
    description: List the custom person data field tokens configured for this tenant.
    operationId: personShowAvailableDataFields
    successCriteria:
    - condition: $statusCode == 200
  - stepId: readUnitTree
    description: Read the organizational tree so the new hire can be assigned to real unit items.
    operationId: unitShowUnitTree
    successCriteria:
    - condition: $statusCode == 200
  - stepId: createPerson
    description: Create the employee record.
    operationId: personCreate
    requestBody:
      contentType: application/json
      payload:
        person:
          firstName: $inputs.firstName
          lastName: $inputs.lastName
          workEmail: $inputs.workEmail
          employmentStartDate: $inputs.employmentStartDate
          contractType: $inputs.contractType
        options:
          sendWelcomeEmail: false
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      personId: $response.body#/data/person/id
  - stepId: verifyPerson
    description: Read the stored record back.
    operationId: personView
    parameters:
    - name: id
      in: path
      value: $steps.createPerson.outputs.personId
    successCriteria:
    - condition: $statusCode == 200
  - stepId: findTraining
    description: Find the onboarding training in the catalogue.
    operationId: trainingList
    parameters:
    - name: search
      in: query
      value: $inputs.trainingSearch
    - name: limit
      in: query
      value: '10'
    successCriteria:
    - condition: $statusCode == 200
  - stepId: assignTraining
    description: Assign the onboarding training to the new employee.
    operationId: personAssignTraining
    successCriteria:
    - condition: $statusCode == 200
  - stepId: confirmTrainings
    description: Confirm the assignment landed on the person.
    operationId: personListTrainings
    parameters:
    - name: id
      in: path
      value: $steps.createPerson.outputs.personId
    successCriteria:
    - condition: $statusCode == 200
  outputs:
    personId: $steps.createPerson.outputs.personId