{"openapi":"3.0.3","info":{"title":"Alveno HR Public API","description":"\nThe Alveno HR System API provides a robust interface for seamless integration with the Alveno HR System.\n\nAPI systému Alveno HR poskytuje robustní rozhraní pro bezproblémovou integraci se systémem Alveno HR.\n\n
\n\n
\nDocumentation in English\n\n
\n\n\n### Description\n\nThis API service utilizes the REST API architecture and uses the JSON format for communication. \nIt is available at the following URLs:\n\n- For Czech instances: `https://hr.alveno.cz/api/external/v1/{tenant}/`\n- For Slovak instances: `https://hr.alveno.sk/api/external/v1/{tenant}/`\n\nThe API provides multiple endpoints to manage and synchronize employee data, records and more with your own information system.\n\n---\n\n### Authentication\n\nTo access the API, you need an access token. You can generate your token in the Alveno HR System web application in the **Settings** / **Instance** section. This feature is only available for the administrator of the instance.\n\nWhen creating an access token, you can:\n- Set an expiration date.\n- Provide a descriptive name for the token.\n- Add meaningful notes about its usage.\n- Create multiple tokens for an instance to use separately in different integrations.\n- Limit some tokens to read-only or temporarily deactivate them.\n\nTo authenticate your API requests, include your access token in the `X-API-Key` header as shown below:\n\n```http\nX-API-Key: YOUR_ACCESS_TOKEN\n```\n\nReplace YOUR_ACCESS_TOKEN with your actual access token.\n\n---\n\n### Generating an Access Token\n\nFollow these steps to generate an access token:\n\n1. Log in to the Alveno HR System web application as an administrator.\n2. Navigate to the instance settings section.\n3. Locate the Alveno HR system API subsection.\n4. Click Add API key and configure the following:\n - Name / Description: Add a descriptive name for your token.\n - Expiration Date: (Optional) Specify when the token should expire.\n - Permissions: Choose either full access or read-only access.\n5. Save your token. Copy the generated token immediately, as it will not be displayed again.\n\nWhen creating a token, you need to specify the user to whom the token will be linked. All changes made using this token will be recorded as being performed by this user. However, access via the token does not respect the user's permissions settings. If you want to differentiate operations performed through the API, we recommend creating a dedicated universal user for this purpose.\n\nUse this token in the `X-API-Key` header for all subsequent API requests.\n\n---\n\n### Finding out Tenant ID\n\nTenant ID or `{tenant}` is typically your company's Business ID (company registration number), e.g. `26288613`. You can find the specific instance ID directly in the application in the Instance section.\n\n---\n\n### Example Usage\n\n| URL | Endpoint |\n| ----------------------- | ------------------------------------------ |\n| `GET /v1/{tenant}/echo` | Check whether your access token is working |\n\n##### Request Example\n```http\nGET /v1//echo?message=Example%2520message\nHost: https://hr.alveno.cz/api/external\nX-API-Key: YOUR_ACCESS_TOKEN\n```\n\n##### Response Example\n```json\n{\n \"message\": \"Example message\"\n}\n```\n\n---\n\n### Error Handling\n\nThe API uses HTTP status codes to indicate success or failure. Below are common responses:\n\n| Status Code | Description |\n| ----------- | -------------------------------------------------------------------------------- |\n| 400 | Bad Request, e.g. instance does not exist. |\n| 401 | Unauthorized. Invalid authentication credentials or token expired. |\n| 402 | Payment Required. Indicates a subscription or payment issue. |\n| 403 | Forbidden. Access denied due to lack of permissions. |\n| 404 | Not Found. The requested resource does not exist. |\n| 409 | Conflict. Request validation conflict occurred. |\n| 422 | Unprocessable Entity. Includes e.g. sorting errors, invalid or duplicate values. |\n| 500 | Internal Server Error. Please contact our support. |\n\n**Full list** of error responses is available here: ***[Errors](#/Errors/errors)***\n\n##### Example Error Response:\n```json\n{\n \"detail\": \"Access token is not valid\"\n}\n```\n\n---\n\n### Rate Limiting\nThe API is designed for a rate of at most 100 requests per minute. Stay within it and you will never hit a limit. The enforced limits are set higher and guard both short bursts and the total hourly volume. Requests over the limit are rejected with status code 429 until the limit resets.\n\n---\n\n### Support\n\nFor further assistance or to report issues, please contact Alveno HR System support at [podpora@alveno.cz](mailto:podpora@alveno.cz).\n\n\n
\n\n
\n\n
\nDokumentace v češtině\n\n
\n\n\n### Popis\n\nTato API služba využívá architekturu REST API a komunikuje ve formátu JSON.\nJe dostupná na následujících adresách:\n\n- Pro české instance: `https://hr.alveno.cz/api/external/v1/{tenant}/`\n- Pro slovenské instance: `https://hr.alveno.sk/api/external/v1/{tenant}/`\n\nAPI poskytuje různé endpointy pro správu a synchronizaci údajů o zaměstnancích, záznamů a dalších informací s vaším vlastním informačním systémem.\n\n---\n\n### Autentizace\n\nPro přístup k API je potřeba přístupový token. Token si můžete vygenerovat ve webovém rozhraní systému Alveno HR v sekci **Nastavení** / **Instance**. Tato funkce je dostupná pouze pro administrátory instance.\n\nPři vytváření přístupového tokenu můžete:\n- Nastavit datum vypršení platnosti.\n- Přidat popisný název tokenu.\n- Přidat poznámky o jeho použití.\n- Vytvořit více tokenů pro jednu instanci a používat je odděleně v různých integracích.\n- Omezit některé tokeny pouze ke čtení nebo je dočasně deaktivovat.\n\nPro ověření všech API požadavků prosím zahrňte svůj přístupový token do headeru `X-API-Key`, jak je ukázáno níže:\n\n```http\nX-API-Key: YOUR_ACCESS_TOKEN\n```\n\nNahraďte YOUR_ACCESS_TOKEN svým skutečným přístupovým tokenem.\n\n---\n\n### Generování přístupového tokenu\n\nPostupujte podle těchto kroků pro generování přístupového tokenu:\n\n1. Přihlaste se do webového rozhraní systému Alveno HR jako administrátor.\n2. Otevřete sekci pro nastavení instance.\n3. Najděte podsekci API HR systému Alveno.\n4. Klikněte na Přidat API klíč a nastavte následující:\n - Název / Popis: Přidejte popisný název pro váš token.\n - Datum vypršení: (Volitelné) Zadejte, kdy má token vypršet.\n - Oprávnění: Vyberte buď plný přístup, nebo pouze pro čtení.\n5. Uložte formulář. Vygenerovaný token si ihned zkopírujte, protože se později již nezobrazí.\n\nPři vytváření tokenu je nutné určit uživatele, s nímž bude token spojen. Všechny úpravy provedené prostřednictvím tohoto tokenu se budou zaznamenávat jménem tohoto uživatele. Přístup přes token však nebere v úvahu uživatelská oprávnění. Pokud potřebujete odlišit operace prováděné přes API, doporučujeme vytvořit univerzálního uživatele určeného výhradně pro tento účel.\n\nTento token používejte v headeru `X-API-Key` pro všechny následné požadavky k API.\n\n---\n\n### Zjištění ID instance\n\nID instance aplikace, tedy `{tenant}`, je typicky IČO Vaší společnosti, např. `26288613`. Konkrétní ID instance najdete přímo v aplikaci v sekci Instance.\n\n---\n\n### Příklad použití\n\n| URL | Endpoint |\n| ----------------------- | ------------------------------------------ |\n| `GET /v1/{tenant}/echo` | Ověření, zda váš přístupový token funguje |\n\n##### Příklad dotazu\n```http\nGET /v1//echo?message=Example%2520message\nHost: https://hr.alveno.cz/api/external\nX-API-Key: YOUR_ACCESS_TOKEN\n```\n\n##### Příklad odpovědi\n```json\n{\n \"message\": \"Example message\"\n}\n```\n\n---\n\n### Zpracování chyb\n\nAPI používá HTTP status kódy k označení úspěchu nebo neúspěchu požadavku. Níže uvádíme běžné odpovědi:\n\n| Status kód | Popis |\n| ---------- | ----------------------------------------------------------------------------------------- |\n| 400 | Chybný požadavek, např. neexistující instance. |\n| 401 | Neautorizováno. Neplatný nebo expirovaný přístupový token. |\n| 402 | Vyžadována platba. Indikuje problém s předplatným nebo platbou. |\n| 403 | Zakázáno. Přístup byl odepřen z důvodu nedostatečných oprávnění. |\n| 404 | Nenalezeno. Požadovaný zdroj neexistuje. |\n| 409 | Konflikt. Došlo ke konfliktu při validaci dotazu. |\n| 422 | Nezpracovatelný požadavek. Jedná se např. o chyby řazení, chybné nebo duplicitní hodnoty. |\n| 500 | Interní chyba serveru. Prosím obraťte se na podporu. |\n\n**Kompletní seznam** chybových odpovědí je dostupný zde: ***[Errors](#/Errors/errors)***\n\n##### Příklad chybové odpovědi:\n```json\n{\n \"detail\": \"Access token is not valid\"\n}\n```\n\n---\n\n### Limit frekvence dotazování\nRozhraní API je určeno pro frekvenci nejvýše 100 požadavků za minutu. Při jejím dodržení na limity nikdy nenarazíte. Skutečné limity jsou nastaveny výše a hlídají krátkodobé nárazy i celkový objem za hodinu. Požadavky nad limit jsou odmítnuty se stavovým kódem 429, dokud se limit neobnoví.\n\n---\n\n### Podpora\n\nPro další pomoc nebo nahlášení problémů kontaktujte podporu systému Alveno HR na adrese [podpora@alveno.cz](mailto:podpora@alveno.cz).\n\n\n
\n\n
\n","version":"1.1.0"},"servers":[{"url":"https://hr.alveno.cz/api/external","description":"CZ instances"},{"url":"https://hr.alveno.sk/api/external","description":"SK instances"}],"paths":{"/v1/{tenant}/echo":{"get":{"tags":["echo"],"summary":"Echo Read Access Check","operationId":"echo_read_access_check_v1__tenant__echo_get","parameters":[{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"},{"required":true,"schema":{"type":"string","title":"Message"},"name":"message","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EchoCheckSchema"}}}},"401":{"description":"Access token is expired \n OR Access token is not valid \n OR API usage is not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]},"post":{"tags":["echo"],"summary":"Echo Write Access Check","operationId":"echo_write_access_check_v1__tenant__echo_post","parameters":[{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EchoCheckSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EchoCheckSchema"}}}},"401":{"description":"Access token is expired \n OR Access token is not valid \n OR API usage is not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"403":{"description":"Missing permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralError"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]}},"/v1/{tenant}/employees":{"get":{"tags":["employees"],"summary":"List Employees","description":"Have to be paged. Can be filtered or sorted. \n There's even fulltext searching provided. \n Returns only active employees by default (unless id or personal number specified).","operationId":"List_employees_v1__tenant__employees_get","parameters":[{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"},{"description":"Paging offset","required":false,"schema":{"type":"integer","minimum":0.0,"title":"Offset","description":"Paging offset","default":0},"name":"offset","in":"query"},{"description":"Paging limit","required":false,"schema":{"type":"integer","minimum":1.0,"title":"Limit","description":"Paging limit","default":10},"name":"limit","in":"query"},{"description":"Entity attributes to sort results by","required":false,"schema":{"items":{"type":"string"},"type":"array","title":"Sort[]","description":"Entity attributes to sort results by","default":["id"]},"name":"sort[]","in":"query"},{"description":"Fulltext-like search for main entity textual attributes \n (e.g. name, email, ...). If set, complex filters and sort will be ignored.","required":false,"schema":{"type":"string","maxLength":50,"minLength":1,"title":"Fulltext search","description":"Fulltext-like search for main entity textual attributes \n (e.g. name, email, ...). If set, complex filters and sort will be ignored."},"name":"q","in":"query"},{"description":"Filter for specific entities based on ther id","required":false,"schema":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Id[In]","description":"Filter for specific entities based on ther id"},"name":"id[in]","in":"query"},{"description":"Filter for entity attributes in form 'attribute|operator|value', \n see regex for allowed operators","required":false,"schema":{"items":{"type":"string","pattern":".*\\|(eq|ne|gt|ge|lt|le|in|ct|nc|sw|nu|ov|pf|mt|em)\\|.*"},"type":"array","pattern":".*\\|(eq|ne|gt|ge|lt|le|in|ct|nc|sw|nu|ov|pf|mt|em)\\|.*","title":"F[]","description":"Filter for entity attributes in form 'attribute|operator|value', \n see regex for allowed operators"},"example":"createdAt|ge|2021-11-04","name":"f[]","in":"query"},{"description":"How to compose filters, default 'and'","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/FiltersComposition"}],"description":"How to compose filters, default 'and'"},"name":"fop","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeePaged"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]},"post":{"tags":["employees"],"summary":"Create Employee","description":"Creates new employee. Allowed only for standalone HR (not connected \n with attendance system).","operationId":"Create_employee_v1__tenant__employees_post","parameters":[{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnhancedEmployeeSchemaCreate"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employee"}}}},"402":{"description":"Method is not allowed in readonly mode"},"403":{"description":"Missing permissions"},"404":{"description":"Entity not found"},"418":{"description":"Operation denied. Allowed only for standalone HR \n (not connected with attendance system).\n OR Instance tier mismatch"},"409":{"description":"Employee with duplicate relation to user already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]}},"/v1/{tenant}/employees/{employee_id}":{"get":{"tags":["employees"],"summary":"Get Employee Detail","description":"Employee is always provided, though, with limited permissions, \n can be censored.","operationId":"Get_employee_detail_v1__tenant__employees__employee_id__get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Employee Id"},"name":"employee_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employee"}}}},"404":{"description":"Entity not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]},"put":{"tags":["employees"],"summary":"Update Employee","description":"In case of HR connected with attendance system, \n change of some employee attributes is not allowed.","operationId":"Update_employee_v1__tenant__employees__employee_id__put","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Employee Id"},"name":"employee_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"},{"description":"If true, all values of enhanced employee fields with history will be replaced.","required":false,"schema":{"type":"boolean","title":"Fullpatch","description":"If true, all values of enhanced employee fields with history will be replaced.","default":true},"name":"fullPatch","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnhancedEmployeeSchemaUpdate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employee"}}}},"402":{"description":"Method is not allowed in readonly mode"},"404":{"description":"Entity not found"},"418":{"description":"Instance tier mismatch"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]},"delete":{"tags":["employees"],"summary":"Delete Employee","description":"Deletes employee. Allowed only for standalone HR (not connected \n with attendance system) and for employee without relations (mentions in records\n or bound documents).","operationId":"Delete_employee_v1__tenant__employees__employee_id__delete","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Employee Id"},"name":"employee_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"}],"responses":{"204":{"description":"Successful Response"},"402":{"description":"Method is not allowed in readonly mode"},"404":{"description":"Entity not found"},"418":{"description":"Operation denied. Allowed only for standalone HR \n (not connected with attendance system)."},"409":{"description":"Employee is already mentioned in other entities"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]}},"/v1/{tenant}/employees/record-definition":{"get":{"tags":["employees"],"summary":"Get Employee Enhanced Data Fields Definition (Configured Structure)","description":"Internally, record definition, tightly bound with employees, \n is used for this purpose.","operationId":"Get_employee_enhanced_data_fields_definition__configured_structure__v1__tenant__employees_record_definition_get","parameters":[{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordDefinition"}}}},"403":{"description":"Forbidden"},"404":{"description":"Entity not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]}},"/v1/{tenant}/employees/{employee_id}/disable":{"post":{"tags":["employees"],"summary":"Disable Employee","description":"Disables employee manually. Allowed only for standalone HR \n (not connected with attendance system).","operationId":"Disable_employee_v1__tenant__employees__employee_id__disable_post","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Employee Id"},"name":"employee_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employee"}}}},"402":{"description":"Method is not allowed in readonly mode"},"404":{"description":"Entity not found"},"418":{"description":"Operation denied. Allowed only for standalone HR \n (not connected with attendance system)."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]}},"/v1/{tenant}/employees/{employee_id}/enable":{"post":{"tags":["employees"],"summary":"Enable Employee","description":"Enables manually disabled employee. Allowed only for standalone HR \n (not connected with attendance system).","operationId":"Enable_employee_v1__tenant__employees__employee_id__enable_post","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Employee Id"},"name":"employee_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employee"}}}},"402":{"description":"Method is not allowed in readonly mode"},"404":{"description":"Entity not found"},"418":{"description":"Operation denied. Allowed only for standalone HR \n (not connected with attendance system)."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]}},"/v1/{tenant}/records":{"get":{"tags":["records"],"summary":"List All Records","description":"Have to be paged. Can be filtered or sorted.\n Returns only active records by default (without archived ones).\n If filtered for specific employee, record state is ignored, i.e. archived records \n are also returned.","operationId":"List_all_records_v1__tenant__records_get","parameters":[{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"},{"description":"'True' to return classic records only, \n without employee enhanced data records (tightly bound with employees)","required":false,"schema":{"type":"boolean","title":"Inrecords[Eq]","description":"'True' to return classic records only, \n without employee enhanced data records (tightly bound with employees)"},"name":"inRecords[eq]","in":"query"},{"description":"Entity attributes to sort results by","required":false,"schema":{"items":{"type":"string"},"type":"array","title":"Sort[]","description":"Entity attributes to sort results by","default":["id"]},"name":"sort[]","in":"query"},{"description":"Paging offset","required":false,"schema":{"type":"integer","minimum":0.0,"title":"Offset","description":"Paging offset","default":0},"name":"offset","in":"query"},{"description":"Paging limit","required":false,"schema":{"type":"integer","minimum":1.0,"title":"Limit","description":"Paging limit","default":10},"name":"limit","in":"query"},{"description":"Option to return only records with somehow\n mentioned specified employee (directly linked or just mentioned).\n If specified, record state is ignored, i.e. archived records \n are also returned.","required":false,"schema":{"type":"string","format":"uuid","title":"Foremployee[Eq]","description":"Option to return only records with somehow\n mentioned specified employee (directly linked or just mentioned).\n If specified, record state is ignored, i.e. archived records \n are also returned."},"name":"forEmployee[eq]","in":"query"},{"description":"Option to return only records directly linked to specified \n employee, i.e. with 'employees' field type defined as direct employee link.\n If specified, record state is ignored, i.e. archived records \n are also returned.","required":false,"schema":{"type":"string","format":"uuid","title":"Inemployeesdetail[Eq]","description":"Option to return only records directly linked to specified \n employee, i.e. with 'employees' field type defined as direct employee link.\n If specified, record state is ignored, i.e. archived records \n are also returned."},"name":"inEmployeesDetail[eq]","in":"query"},{"description":"Option to specify record employee relation,\n i.e. return only records directly linked to employee ('True') \n or only records with just mentioned (not directly linked) employee ('False').\n Have to be used in conjunction with forEmployee option.","required":false,"schema":{"type":"boolean","title":"Issubjectemployee[Eq]","description":"Option to specify record employee relation,\n i.e. return only records directly linked to employee ('True') \n or only records with just mentioned (not directly linked) employee ('False').\n Have to be used in conjunction with forEmployee option."},"name":"isSubjectEmployee[eq]","in":"query"},{"description":"Alias for 'for_employee' query param","required":false,"deprecated":true,"schema":{"type":"string","format":"uuid","title":"Inemployeesdocuments[Eq]","description":"Alias for 'for_employee' query param"},"name":"inEmployeesDocuments[eq]","in":"query"},{"description":"Option to return only records present in specified \n employee's personnel file.\n If specified, record state is ignored, i.e. archived records \n are also returned.","required":false,"schema":{"type":"string","format":"uuid","title":"Inpersonnelfile[Eq]","description":"Option to return only records present in specified \n employee's personnel file.\n If specified, record state is ignored, i.e. archived records \n are also returned."},"name":"inPersonnelFile[eq]","in":"query"},{"description":"Option to return only records directly linked\n to specified category id. If 'others' is passed instead of UUID,\n only records without category are returned.","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","enum":["others"]}],"title":"Recordcategory[Eq]","description":"Option to return only records directly linked\n to specified category id. If 'others' is passed instead of UUID,\n only records without category are returned."},"name":"recordCategory[eq]","in":"query"},{"description":"Filter for entity attributes in form 'attribute|operator|value', \n see regex for allowed operators","required":false,"schema":{"items":{"type":"string","pattern":".*\\|(eq|ne|gt|ge|lt|le|in|ct|nc|sw|nu|ov|pf|mt|em)\\|.*"},"type":"array","pattern":".*\\|(eq|ne|gt|ge|lt|le|in|ct|nc|sw|nu|ov|pf|mt|em)\\|.*","title":"F[]","description":"Filter for entity attributes in form 'attribute|operator|value', \n see regex for allowed operators"},"example":"createdAt|ge|2021-11-04","name":"f[]","in":"query"},{"description":"How to compose filters, default 'and'","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/FiltersComposition"}],"description":"How to compose filters, default 'and'"},"name":"fop","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordListItemPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]},"post":{"tags":["records"],"summary":"Create Record","description":"Data fields should correspond to configured structure\n for the parent record definition","operationId":"Create_record_v1__tenant__records_post","parameters":[{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordCreateSchema"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}}},"402":{"description":"Method is not allowed in readonly mode"},"403":{"description":"Forbidden"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]}},"/v1/{tenant}/records/{record_id}":{"get":{"tags":["records"],"summary":"Get Record Detail","operationId":"Get_record_detail_v1__tenant__records__record_id__get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Record Id"},"name":"record_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Record"}}}},"403":{"description":"Forbidden"},"404":{"description":"Záznam nenalezen"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]},"put":{"tags":["records"],"summary":"Update Record","description":"Data fields should correspond to configured structure \n for the parent record definition. Missing fields will be removed.","operationId":"Update_record_v1__tenant__records__record_id__put","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Record Id"},"name":"record_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"},{"description":"If true, all values of fields with history will be replaced.","required":false,"schema":{"type":"boolean","title":"Fullpatch","description":"If true, all values of fields with history will be replaced.","default":true},"name":"fullPatch","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordUpdateSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordUpdated"}}}},"402":{"description":"Method is not allowed in readonly mode"},"403":{"description":"Forbidden"},"404":{"description":"Entity not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]},"delete":{"tags":["records"],"summary":"Delete Record","description":"Deletes record together with all bound files and related documents. \n This action is irreversible, so there's also archive operation provided.","operationId":"Delete_record_v1__tenant__records__record_id__delete","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Record Id"},"name":"record_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"}],"responses":{"204":{"description":"Successful Response"},"402":{"description":"Method is not allowed in readonly mode"},"403":{"description":"Forbidden"},"404":{"description":"Entity not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]}},"/v1/{tenant}/records/bulk/{action}":{"put":{"tags":["records"],"summary":"Archive/Activate Records In Bulk","description":"Option to just archive records (filtered by default) instead of \n full deletion (e.g. in case of bound documents) and option to revert it back.","operationId":"Archive_activate_records_in_bulk_v1__tenant__records_bulk__action__put","parameters":[{"required":true,"schema":{"$ref":"#/components/schemas/BulkRecordAction"},"name":"action","in":"path"},{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"},{"description":"Record id","required":true,"schema":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Ids[]","description":"Record id"},"example":"12345678-90ab-cdef-1234-567890abcdef","name":"ids[]","in":"query"}],"responses":{"204":{"description":"No Content"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]}},"/v1/{tenant}/record_definitions":{"get":{"tags":["records"],"summary":"List Record Definitions (Without Data Structure)","description":"Have to be paged. Can be filtered or sorted.","operationId":"List_record_definitions__without_data_structure__v1__tenant__record_definitions_get","parameters":[{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"},{"description":"Fulltext search for main entity textual attributes\n (name, description, code)","required":false,"schema":{"type":"string","title":"Search","description":"Fulltext search for main entity textual attributes\n (name, description, code)"},"name":"search","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Editableonly"},"name":"editableOnly","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Withpermissions"},"name":"withPermissions","in":"query"},{"description":"Include sections visible for permission admin","required":false,"schema":{"type":"boolean","title":"Forpermissions","description":"Include sections visible for permission admin","default":false},"name":"forPermissions","in":"query"},{"description":"Paging offset","required":false,"schema":{"type":"integer","minimum":0.0,"title":"Offset","description":"Paging offset","default":0},"name":"offset","in":"query"},{"description":"Paging limit","required":false,"schema":{"type":"integer","minimum":1.0,"title":"Limit","description":"Paging limit","default":10},"name":"limit","in":"query"},{"description":"Entity attributes to sort results by","required":false,"schema":{"items":{"type":"string"},"type":"array","title":"Sort[]","description":"Entity attributes to sort results by","default":["id"]},"name":"sort[]","in":"query"},{"description":"Filter for entity attributes in form 'attribute|operator|value', \n see regex for allowed operators","required":false,"schema":{"items":{"type":"string","pattern":".*\\|(eq|ne|gt|ge|lt|le|in|ct|nc|sw|nu|ov|pf|mt|em)\\|.*"},"type":"array","pattern":".*\\|(eq|ne|gt|ge|lt|le|in|ct|nc|sw|nu|ov|pf|mt|em)\\|.*","title":"F[]","description":"Filter for entity attributes in form 'attribute|operator|value', \n see regex for allowed operators"},"example":"createdAt|ge|2021-11-04","name":"f[]","in":"query"},{"description":"How to compose filters, default 'and'","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/FiltersComposition"}],"description":"How to compose filters, default 'and'"},"name":"fop","in":"query"},{"description":"Option to return deleted entities. \n By default only active record definitions are provided.","required":false,"schema":{"type":"boolean","title":"Isdeleted[Eq]","description":"Option to return deleted entities. \n By default only active record definitions are provided."},"name":"isDeleted[eq]","in":"query"},{"description":"Option to return only entities that can hold records \n directly linked to employee, \n i.e. with 'employees' field type defined as direct employee link.","required":false,"schema":{"type":"boolean","title":"Issubjectemployee[Eq]","description":"Option to return only entities that can hold records \n directly linked to employee, \n i.e. with 'employees' field type defined as direct employee link."},"name":"isSubjectEmployee[eq]","in":"query"},{"description":"Option to return only entities with records present \n in employee personnel file.","required":false,"schema":{"type":"boolean","title":"Inpersonnelfile[Eq]","description":"Option to return only entities with records present \n in employee personnel file."},"name":"inPersonnelFile[eq]","in":"query"},{"description":"Option to return only entities holding records with somehow\n mentioned specified employee (directly linked or just mentioned).","required":false,"schema":{"type":"string","format":"uuid","title":"Foremployee[Eq]","description":"Option to return only entities holding records with somehow\n mentioned specified employee (directly linked or just mentioned)."},"name":"forEmployee[eq]","in":"query"},{"description":"Option to return only entities holding records with some somehow\n mentioned employee (directly linked or just mentioned).","required":false,"schema":{"type":"boolean","title":"Foremployees[Eq]","description":"Option to return only entities holding records with some somehow\n mentioned employee (directly linked or just mentioned)."},"name":"forEmployees[eq]","in":"query"},{"description":"Option to return only entities holding records \n with generated or uploaded documents.\n Have to be used in conjunction with forEmployee/forEmployees option.","required":false,"schema":{"type":"boolean","title":"Withdocumentsonly","description":"Option to return only entities holding records \n with generated or uploaded documents.\n Have to be used in conjunction with forEmployee/forEmployees option."},"name":"withDocumentsOnly","in":"query"},{"description":"Filter for specific entities based on ther id","required":false,"schema":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Id[In]","description":"Filter for specific entities based on ther id"},"name":"id[in]","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordDefinitionListItemPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]}},"/v1/{tenant}/record_definitions/details":{"get":{"tags":["records"],"summary":"List Record Definitions' Details (With Data Structure)","description":"Have to be paged. Can be filtered or sorted.","operationId":"List_record_definitions__details__with_data_structure__v1__tenant__record_definitions_details_get","parameters":[{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"},{"description":"Paging offset","required":false,"schema":{"type":"integer","minimum":0.0,"title":"Offset","description":"Paging offset","default":0},"name":"offset","in":"query"},{"description":"Paging limit","required":false,"schema":{"type":"integer","minimum":1.0,"title":"Limit","description":"Paging limit","default":10},"name":"limit","in":"query"},{"description":"Entity attributes to sort results by","required":false,"schema":{"items":{"type":"string"},"type":"array","title":"Sort[]","description":"Entity attributes to sort results by","default":["id"]},"name":"sort[]","in":"query"},{"description":"Filter for entity attributes in form 'attribute|operator|value', \n see regex for allowed operators","required":false,"schema":{"items":{"type":"string","pattern":".*\\|(eq|ne|gt|ge|lt|le|in|ct|nc|sw|nu|ov|pf|mt|em)\\|.*"},"type":"array","pattern":".*\\|(eq|ne|gt|ge|lt|le|in|ct|nc|sw|nu|ov|pf|mt|em)\\|.*","title":"F[]","description":"Filter for entity attributes in form 'attribute|operator|value', \n see regex for allowed operators"},"example":"createdAt|ge|2021-11-04","name":"f[]","in":"query"},{"description":"How to compose filters, default 'and'","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/FiltersComposition"}],"description":"How to compose filters, default 'and'"},"name":"fop","in":"query"},{"description":"Option to return deleted entities. \n By default only active record definitions are provided.","required":false,"schema":{"type":"boolean","title":"Isdeleted[Eq]","description":"Option to return deleted entities. \n By default only active record definitions are provided."},"name":"isDeleted[eq]","in":"query"},{"description":"Option to return only entities that can hold records \n directly linked to employee, \n i.e. with 'employees' field type defined as direct employee link.","required":false,"schema":{"type":"boolean","title":"Issubjectemployee[Eq]","description":"Option to return only entities that can hold records \n directly linked to employee, \n i.e. with 'employees' field type defined as direct employee link."},"name":"isSubjectEmployee[eq]","in":"query"},{"description":"Option to return only entities with records present \n in employee personnel file.","required":false,"schema":{"type":"boolean","title":"Inpersonnelfile[Eq]","description":"Option to return only entities with records present \n in employee personnel file."},"name":"inPersonnelFile[eq]","in":"query"},{"description":"Option to return only entities holding records with somehow\n mentioned specified employee (directly linked or just mentioned).","required":false,"schema":{"type":"string","format":"uuid","title":"Foremployee[Eq]","description":"Option to return only entities holding records with somehow\n mentioned specified employee (directly linked or just mentioned)."},"name":"forEmployee[eq]","in":"query"},{"description":"Option to return only entities holding records with some somehow\n mentioned employee (directly linked or just mentioned).","required":false,"schema":{"type":"boolean","title":"Foremployees[Eq]","description":"Option to return only entities holding records with some somehow\n mentioned employee (directly linked or just mentioned)."},"name":"forEmployees[eq]","in":"query"},{"description":"Option to return only entities holding records \n with generated or uploaded documents.\n Have to be used in conjunction with forEmployee/forEmployees option.","required":false,"schema":{"type":"boolean","title":"Withdocumentsonly","description":"Option to return only entities holding records \n with generated or uploaded documents.\n Have to be used in conjunction with forEmployee/forEmployees option."},"name":"withDocumentsOnly","in":"query"},{"description":"Filter for specific entities based on ther id","required":false,"schema":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Id[In]","description":"Filter for specific entities based on ther id"},"name":"id[in]","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordDefinitionPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]}},"/v1/{tenant}/record_definitions/{record_definition_id}":{"get":{"tags":["records"],"summary":"Get Record Definitions Detail (With Data Structure)","operationId":"Get_record_definitions_detail__with_data_structure__v1__tenant__record_definitions__record_definition_id__get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Record Definition Id"},"name":"record_definition_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"},{"description":"Option to return also deleted data structure fields.\n By default only active fields are provided.","required":false,"schema":{"type":"boolean","title":"Show Deleted","description":"Option to return also deleted data structure fields.\n By default only active fields are provided.","default":false},"name":"show_deleted","in":"query"},{"description":"Option to hide section RD if missing explicit read permission","required":false,"schema":{"type":"boolean","title":"Forstructure","description":"Option to hide section RD if missing explicit read permission","default":true},"name":"forStructure","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordDefinition"}}}},"403":{"description":"Forbidden"},"404":{"description":"Entity not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]}},"/v1/{tenant}/record_definitions/{record_definition_id}/records":{"get":{"tags":["records"],"summary":"List Records From One Record Definition","operationId":"List_records_from_one_record_definition_v1__tenant__record_definitions__record_definition_id__records_get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Record Definition Id"},"name":"record_definition_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"},{"description":"Option to return only records present in specified \n employee's personnel file.\n If specified, record state is ignored, i.e. archived records \n are also returned.","required":false,"schema":{"type":"string","format":"uuid","title":"Inpersonnelfile[Eq]","description":"Option to return only records present in specified \n employee's personnel file.\n If specified, record state is ignored, i.e. archived records \n are also returned."},"name":"inPersonnelFile[eq]","in":"query"},{"description":"Entity attributes to sort results by","required":false,"schema":{"items":{"type":"string"},"type":"array","title":"Sort[]","description":"Entity attributes to sort results by","default":["id"]},"name":"sort[]","in":"query"},{"description":"Paging offset","required":false,"schema":{"type":"integer","minimum":0.0,"title":"Offset","description":"Paging offset","default":0},"name":"offset","in":"query"},{"description":"Paging limit","required":false,"schema":{"type":"integer","minimum":1.0,"title":"Limit","description":"Paging limit","default":10},"name":"limit","in":"query"},{"description":"Option to return only records with somehow\n mentioned specified employee (directly linked or just mentioned).\n If specified, record state is ignored, i.e. archived records \n are also returned.","required":false,"schema":{"type":"string","format":"uuid","title":"Foremployee[Eq]","description":"Option to return only records with somehow\n mentioned specified employee (directly linked or just mentioned).\n If specified, record state is ignored, i.e. archived records \n are also returned."},"name":"forEmployee[eq]","in":"query"},{"description":"Option to return only records directly linked to specified \n employee, i.e. with 'employees' field type defined as direct employee link.\n If specified, record state is ignored, i.e. archived records \n are also returned.","required":false,"schema":{"type":"string","format":"uuid","title":"Inemployeesdetail[Eq]","description":"Option to return only records directly linked to specified \n employee, i.e. with 'employees' field type defined as direct employee link.\n If specified, record state is ignored, i.e. archived records \n are also returned."},"name":"inEmployeesDetail[eq]","in":"query"},{"description":"Option to specify record employee relation,\n i.e. return only records directly linked to employee ('True') \n or only records with just mentioned (not directly linked) employee ('False').\n Have to be used in conjunction with forEmployee option.","required":false,"schema":{"type":"boolean","title":"Issubjectemployee[Eq]","description":"Option to specify record employee relation,\n i.e. return only records directly linked to employee ('True') \n or only records with just mentioned (not directly linked) employee ('False').\n Have to be used in conjunction with forEmployee option."},"name":"isSubjectEmployee[eq]","in":"query"},{"description":"Alias for 'for_employee' query param","required":false,"deprecated":true,"schema":{"type":"string","format":"uuid","title":"Inemployeesdocuments[Eq]","description":"Alias for 'for_employee' query param"},"name":"inEmployeesDocuments[eq]","in":"query"},{"description":"Option to return only records directly linked\n to specified category id. If 'others' is passed instead of UUID,\n only records without category are returned.","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","enum":["others"]}],"title":"Recordcategory[Eq]","description":"Option to return only records directly linked\n to specified category id. If 'others' is passed instead of UUID,\n only records without category are returned."},"name":"recordCategory[eq]","in":"query"},{"description":"Filter for entity attributes in form 'attribute|operator|value', \n see regex for allowed operators","required":false,"schema":{"items":{"type":"string","pattern":".*\\|(eq|ne|gt|ge|lt|le|in|ct|nc|sw|nu|ov|pf|mt|em)\\|.*"},"type":"array","pattern":".*\\|(eq|ne|gt|ge|lt|le|in|ct|nc|sw|nu|ov|pf|mt|em)\\|.*","title":"F[]","description":"Filter for entity attributes in form 'attribute|operator|value', \n see regex for allowed operators"},"example":"createdAt|ge|2021-11-04","name":"f[]","in":"query"},{"description":"How to compose filters, default 'and'","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/FiltersComposition"}],"description":"How to compose filters, default 'and'"},"name":"fop","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordListItemPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]}},"/v1/{tenant}/status":{"get":{"tags":["instance"],"summary":"Instance Status","operationId":"Instance_status_v1__tenant__status_get","parameters":[{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"}],"responses":{"200":{"description":"Instance status ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Status"}}}},"404":{"description":"Instance not found"},"409":{"description":"Instance elsewhere (bad tier)"},"422":{"description":"Invalid instance identification"},"425":{"description":"Instance is being created"}},"security":[{"APIKeyAuth":[]}]}},"/v1/{tenant}/files":{"get":{"tags":["files"],"summary":"List Files","description":"List files by e.g. id from record's file fields.\n Files can be listed only by their IDs,\n Maximum number of file ids per request is 100.","operationId":"List_files_v1__tenant__files_get","parameters":[{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"},{"required":false,"schema":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Id[In]"},"name":"id[in]","in":"query"},{"description":"Paging offset","required":false,"schema":{"type":"integer","minimum":0.0,"title":"Offset","description":"Paging offset","default":0},"name":"offset","in":"query"},{"description":"Paging limit","required":false,"schema":{"type":"integer","minimum":1.0,"title":"Limit","description":"Paging limit","default":10},"name":"limit","in":"query"},{"description":"Filter for entity attributes in form 'attribute|operator|value', \n see regex for allowed operators","required":false,"schema":{"items":{"type":"string","pattern":".*\\|(eq|ne|gt|ge|lt|le|in|ct|nc|sw|nu|ov|pf|mt|em)\\|.*"},"type":"array","pattern":".*\\|(eq|ne|gt|ge|lt|le|in|ct|nc|sw|nu|ov|pf|mt|em)\\|.*","title":"F[]","description":"Filter for entity attributes in form 'attribute|operator|value', \n see regex for allowed operators"},"example":"createdAt|ge|2021-11-04","name":"f[]","in":"query"},{"description":"How to compose filters, default 'and'","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/FiltersComposition"}],"description":"How to compose filters, default 'and'"},"name":"fop","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilePage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]}},"/v1/{tenant}/operations":{"get":{"tags":["operations"],"summary":"List Operations","description":"Paginate over all operations or filter by IDs. Disabled operations are always included.","operationId":"List_operations_v1__tenant__operations_get","parameters":[{"required":true,"schema":{"type":"string","title":"Tenant"},"name":"tenant","in":"path"},{"required":false,"schema":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Id[In]"},"name":"id[in]","in":"query"},{"description":"Paging offset","required":false,"schema":{"type":"integer","minimum":0.0,"title":"Offset","description":"Paging offset","default":0},"name":"offset","in":"query"},{"description":"Paging limit","required":false,"schema":{"type":"integer","minimum":1.0,"title":"Limit","description":"Paging limit","default":10},"name":"limit","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyAuth":[]}]}},"":{"options":{"tags":["Errors"],"operationId":"errors","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/EchoCheckSchema"},{"$ref":"#/components/schemas/EmployeePaged"},{"$ref":"#/components/schemas/Employee"},{"$ref":"#/components/schemas/RecordDefinition"},{"$ref":"#/components/schemas/RecordListItemPage"},{"$ref":"#/components/schemas/Record"},{"$ref":"#/components/schemas/RecordUpdated"},{"$ref":"#/components/schemas/RecordDefinitionListItemPage"},{"$ref":"#/components/schemas/RecordDefinitionPage"},{"$ref":"#/components/schemas/Status"},{"$ref":"#/components/schemas/FilePage"},{"$ref":"#/components/schemas/OperationPage"}]}}}},"401":{"description":"Access token is expired \n OR Access token is not valid \n OR API usage is not allowed","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/GeneralError"}]}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/RateLimitError"}]}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/HTTPValidationError"}]}}}},"403":{"description":"Missing permissions","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/GeneralError"}]}}}},"201":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Employee"},{"$ref":"#/components/schemas/Record"}]}}}},"402":{"description":"Method is not allowed in readonly mode"},"404":{"description":"Entity not found"},"418":{"description":"Operation denied. Allowed only for standalone HR \n (not connected with attendance system).\n OR Instance tier mismatch"},"409":{"description":"Employee with duplicate relation to user already exists","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/HTTPValidationError"}]}}}},"204":{"description":"Successful Response"},"425":{"description":"Instance is being created"}}}}},"components":{"schemas":{"AdditionalEmailDict":{"properties":{"name":{"type":"string","title":"Name"},"email":{"type":"string","title":"Email"},"isDeleted":{"type":"boolean","title":"Isdeleted"}},"type":"object","required":["name","email"],"title":"Employee"},"BoundValuesInputSchema":{"properties":{"recordDefinitionId":{"type":"string","format":"uuid","title":"Recorddefinitionid"},"recordId":{"type":"string","format":"uuid","title":"Recordid"},"values":{"items":{"oneOf":[{"$ref":"#/components/schemas/RecordValueTextInputSchema"},{"$ref":"#/components/schemas/RecordValueRichTextInputSchema"},{"$ref":"#/components/schemas/RecordValueUrlInputSchema"},{"$ref":"#/components/schemas/RecordValueEmailInputSchema"},{"$ref":"#/components/schemas/RecordValueDatetimeInputSchema"},{"$ref":"#/components/schemas/RecordValueDecimalInputSchema"},{"$ref":"#/components/schemas/RecordValueIntegerInputSchema"},{"$ref":"#/components/schemas/RecordValueSelectInputSchema"},{"$ref":"#/components/schemas/RecordValueSelectManyInputSchema"},{"$ref":"#/components/schemas/RecordValueCheckboxInputSchema"},{"$ref":"#/components/schemas/RecordValueRadioInputSchema"},{"$ref":"#/components/schemas/RecordValueUserInputSchema"},{"$ref":"#/components/schemas/RecordValueEmployeesInputSchema"},{"$ref":"#/components/schemas/RecordValueFilesInputSchema"},{"$ref":"#/components/schemas/RecordValueDateInputSchema"},{"$ref":"#/components/schemas/RecordValueDecimalHistoryInputSchema"},{"$ref":"#/components/schemas/RecordValueTextHistoryInputSchema"},{"$ref":"#/components/schemas/RecordValueSelectHistoryInputSchema"},{"$ref":"#/components/schemas/RecordValueCodeListInputSchema"}],"discriminator":{"propertyName":"fieldType","mapping":{"text":"#/components/schemas/RecordValueTextInputSchema","richtext":"#/components/schemas/RecordValueRichTextInputSchema","url":"#/components/schemas/RecordValueUrlInputSchema","email":"#/components/schemas/RecordValueEmailInputSchema","datetime":"#/components/schemas/RecordValueDatetimeInputSchema","decimal":"#/components/schemas/RecordValueDecimalInputSchema","integer":"#/components/schemas/RecordValueIntegerInputSchema","select":"#/components/schemas/RecordValueSelectInputSchema","select_many":"#/components/schemas/RecordValueSelectManyInputSchema","checkbox":"#/components/schemas/RecordValueCheckboxInputSchema","radio":"#/components/schemas/RecordValueRadioInputSchema","user":"#/components/schemas/RecordValueUserInputSchema","employees":"#/components/schemas/RecordValueEmployeesInputSchema","files":"#/components/schemas/RecordValueFilesInputSchema","date":"#/components/schemas/RecordValueDateInputSchema","decimal_history":"#/components/schemas/RecordValueDecimalHistoryInputSchema","text_history":"#/components/schemas/RecordValueTextHistoryInputSchema","select_history":"#/components/schemas/RecordValueSelectHistoryInputSchema","code_list_pair":"#/components/schemas/RecordValueCodeListInputSchema"}}},"type":"array","title":"Values","description":"Values of fields from this record definition bound to employee"}},"type":"object","title":"BoundValuesInputSchema"},"BoundValuesSchema":{"properties":{"recordDefinitionId":{"type":"string","format":"uuid","title":"Recorddefinitionid"},"recordDefinitionName":{"type":"string","title":"Recorddefinitionname","description":"Name of bound record definition"},"recordId":{"type":"string","format":"uuid","title":"Recordid"},"canEdit":{"type":"boolean","title":"Canedit","default":true},"values":{"items":{"$ref":"#/components/schemas/RecordValueGeneralSchema"},"type":"array","title":"Values","description":"Values of fields from this record definition bound to employee"}},"type":"object","required":["recordDefinitionId","recordId"],"title":"BoundValuesSchema"},"BulkRecordAction":{"type":"string","enum":["activate","archive"],"title":"BulkRecordAction","description":"An enumeration."},"CodeListPairInputSchema":{"properties":{"itemKey":{"type":"string","format":"uuid","title":"Itemkey"},"itemValue":{"type":"string","format":"uuid","title":"Itemvalue"}},"type":"object","required":["itemKey"],"title":"CodeListPairInputSchema"},"CodeListPairSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Reference to the record_value_data row holding the pair","example":"12345678-90ab-cdef-1234-567890abcdef"},"itemKey":{"type":"string","format":"uuid","title":"Itemkey"},"itemKeyName":{"type":"string","title":"Itemkeyname"},"itemValue":{"type":"string","format":"uuid","title":"Itemvalue"},"itemValueName":{"type":"string","title":"Itemvaluename"},"isDeleted":{"type":"boolean","title":"Isdeleted","description":"True if the key or value item was deleted from its code list","default":false}},"type":"object","required":["id","itemKey"],"title":"CodeListPairSchema"},"EchoCheckSchema":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"EchoCheckSchema"},"Employee":{"properties":{"boundValues":{"additionalProperties":{"$ref":"#/components/schemas/BoundValuesSchema"},"type":"object","title":"Boundvalues","description":"Blound fileds values grouped by record definition id."},"id":{"type":"string","format":"uuid","title":"Id","example":"12345678-90ab-cdef-1234-567890abcdef"},"isActive":{"type":"boolean","title":"Isactive","description":"Flag meaning employee is returned in lists by default \n (without filters). 'True' when not terminated yet ('terminationDate') \n and not manually deactivated (not 'isDisabled')."},"startDate":{"type":"string","format":"date","title":"Startdate","description":"Date of employment","example":"2021-06-01"},"probationEndDate":{"type":"string","format":"date","title":"Probationenddate","description":"Not synced with attendance system","example":"2021-08-31"},"terminationDate":{"type":"string","format":"date","title":"Terminationdate","example":"2023-12-31"},"avatarId":{"type":"string","format":"uuid","title":"Avatarid","description":"Employee's photo. Not synced with attendance system."},"preNominal":{"type":"string","title":"Prenominal","example":"doc."},"postNominal":{"type":"string","title":"Postnominal","example":"PhD"},"firstName":{"type":"string","title":"Firstname","example":"Thorin"},"lastName":{"type":"string","title":"Lastname","example":"Oakenshield"},"email":{"type":"string","title":"Email","description":"Main email for employee's app notifications"},"emailForSignatures":{"type":"string","title":"Emailforsignatures","description":"Private email for electronic communication with employee"},"additionalEmails":{"items":{"$ref":"#/components/schemas/AdditionalEmailDict"},"type":"array","maxItems":5,"title":"Additionalemails"},"personalNumber":{"type":"string","title":"Personalnumber","description":"Unique internal identifier of the employee","example":"10"},"externalId":{"type":"string","title":"Externalid","description":"Optional unique identifier for use with other systems"},"gender":{"type":"string","title":"Gender","example":["male","female"]},"birthday":{"type":"string","format":"date","title":"Birthday","description":"Not synced with attendance system","example":"1980-05-20"},"isDisabled":{"type":"boolean","title":"Isdisabled","description":"'True' when employee is manually deactivated","default":false},"operationId":{"type":"string","format":"uuid","title":"Operationid"},"workgroupId":{"type":"string","format":"uuid","title":"Workgroupid"},"jobTitle":{"type":"string","title":"Jobtitle","example":"Office desk manager"},"localization":{"allOf":[{"$ref":"#/components/schemas/SupportedLanguageEnum"}],"description":"ISO 639-1 language code. Not synced with attendance system."},"userId":{"type":"string","format":"uuid","title":"Userid","description":"Bound user"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","example":"2023-11-16T14:30:03.277526+00:00"},"createdById":{"type":"string","format":"uuid","title":"Createdbyid","description":"User"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","example":"2024-11-28T10:40:48.449542+00:00"},"updatedById":{"type":"string","format":"uuid","title":"Updatedbyid","description":"User"},"values":{"items":{"$ref":"#/components/schemas/RecordValue"},"type":"array","title":"Values","description":"Employee's enhanced data fields (with configured structure)"},"recordId":{"type":"string","format":"uuid","title":"Recordid","description":"Bound record with enhanced employee data"},"unsignedDocsCount":{"type":"integer","title":"Unsigneddocscount","description":"Number of not yet signed documents that were requested \n to be signed by employee. Defined only for employee detail endpoint."}},"type":"object","required":["id","isActive","lastName","values"],"title":"Employee"},"EmployeePaged":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Employee"},"type":"array","title":"Items"},"offset":{"type":"integer","title":"Offset"},"limit":{"type":"integer","title":"Limit"},"totalCount":{"type":"integer","title":"Totalcount"}},"type":"object","required":["items","offset","limit","totalCount"],"title":"EmployeePaged"},"EnhancedEmployeeSchemaCreate":{"properties":{"boundValues":{"additionalProperties":{"$ref":"#/components/schemas/BoundValuesInputSchema"},"type":"object","title":"Boundvalues","description":"Blound fileds values grouped by record definition id."},"startDate":{"type":"string","format":"date","title":"Startdate","description":"Date of employment","example":"2021-06-01"},"probationEndDate":{"type":"string","format":"date","title":"Probationenddate","description":"Not synced with attendance system","example":"2021-08-31"},"terminationDate":{"type":"string","format":"date","title":"Terminationdate","example":"2023-12-31"},"avatarId":{"type":"string","format":"uuid","title":"Avatarid","description":"Employee's photo. Not synced with attendance system."},"preNominal":{"type":"string","title":"Prenominal","example":"doc."},"postNominal":{"type":"string","title":"Postnominal","example":"PhD"},"firstName":{"type":"string","title":"Firstname","example":"Thorin"},"lastName":{"type":"string","title":"Lastname","example":"Oakenshield"},"email":{"type":"string","title":"Email","description":"Main email for employee's app notifications"},"emailForSignatures":{"type":"string","title":"Emailforsignatures","description":"Private email for electronic communication with employee"},"additionalEmails":{"items":{"$ref":"#/components/schemas/AdditionalEmailDict"},"type":"array","maxItems":5,"title":"Additionalemails"},"personalNumber":{"type":"string","title":"Personalnumber","description":"Unique internal identifier of the employee","example":"10"},"externalId":{"type":"string","title":"Externalid","description":"Optional unique identifier for use with other systems"},"gender":{"type":"string","title":"Gender","example":["male","female"]},"birthday":{"type":"string","format":"date","title":"Birthday","description":"Not synced with attendance system","example":"1980-05-20"},"isDisabled":{"type":"boolean","title":"Isdisabled","description":"'True' when employee is manually deactivated","default":false},"operationId":{"type":"string","format":"uuid","title":"Operationid"},"workgroupId":{"type":"string","format":"uuid","title":"Workgroupid"},"jobTitle":{"type":"string","title":"Jobtitle","example":"Office desk manager"},"localization":{"type":"string","title":"Localization","description":"ISO 639-1 language code. Not synced with attendance system.","example":["sk","cs","en"]},"values":{"items":{"oneOf":[{"$ref":"#/components/schemas/RecordValueTextInputSchema"},{"$ref":"#/components/schemas/RecordValueRichTextInputSchema"},{"$ref":"#/components/schemas/RecordValueUrlInputSchema"},{"$ref":"#/components/schemas/RecordValueEmailInputSchema"},{"$ref":"#/components/schemas/RecordValueDatetimeInputSchema"},{"$ref":"#/components/schemas/RecordValueDecimalInputSchema"},{"$ref":"#/components/schemas/RecordValueIntegerInputSchema"},{"$ref":"#/components/schemas/RecordValueSelectInputSchema"},{"$ref":"#/components/schemas/RecordValueSelectManyInputSchema"},{"$ref":"#/components/schemas/RecordValueCheckboxInputSchema"},{"$ref":"#/components/schemas/RecordValueRadioInputSchema"},{"$ref":"#/components/schemas/RecordValueUserInputSchema"},{"$ref":"#/components/schemas/RecordValueEmployeesInputSchema"},{"$ref":"#/components/schemas/RecordValueFilesInputSchema"},{"$ref":"#/components/schemas/RecordValueDateInputSchema"},{"$ref":"#/components/schemas/RecordValueDecimalHistoryInputSchema"},{"$ref":"#/components/schemas/RecordValueTextHistoryInputSchema"},{"$ref":"#/components/schemas/RecordValueSelectHistoryInputSchema"},{"$ref":"#/components/schemas/RecordValueCodeListInputSchema"}],"discriminator":{"propertyName":"fieldType","mapping":{"text":"#/components/schemas/RecordValueTextInputSchema","richtext":"#/components/schemas/RecordValueRichTextInputSchema","url":"#/components/schemas/RecordValueUrlInputSchema","email":"#/components/schemas/RecordValueEmailInputSchema","datetime":"#/components/schemas/RecordValueDatetimeInputSchema","decimal":"#/components/schemas/RecordValueDecimalInputSchema","integer":"#/components/schemas/RecordValueIntegerInputSchema","select":"#/components/schemas/RecordValueSelectInputSchema","select_many":"#/components/schemas/RecordValueSelectManyInputSchema","checkbox":"#/components/schemas/RecordValueCheckboxInputSchema","radio":"#/components/schemas/RecordValueRadioInputSchema","user":"#/components/schemas/RecordValueUserInputSchema","employees":"#/components/schemas/RecordValueEmployeesInputSchema","files":"#/components/schemas/RecordValueFilesInputSchema","date":"#/components/schemas/RecordValueDateInputSchema","decimal_history":"#/components/schemas/RecordValueDecimalHistoryInputSchema","text_history":"#/components/schemas/RecordValueTextHistoryInputSchema","select_history":"#/components/schemas/RecordValueSelectHistoryInputSchema","code_list_pair":"#/components/schemas/RecordValueCodeListInputSchema"}}},"type":"array","title":"Values","description":"Employee's enhanced data fields (with configured structure)"},"userId":{"type":"string","format":"uuid","title":"Userid","description":"Bound user","example":"12345678-90ab-cdef-1234-567890abcdef"}},"type":"object","required":["lastName","personalNumber"],"title":"EmployeeCreate"},"EnhancedEmployeeSchemaUpdate":{"properties":{"boundValues":{"additionalProperties":{"$ref":"#/components/schemas/BoundValuesInputSchema"},"type":"object","title":"Boundvalues","description":"Blound fileds values grouped by record definition id."},"startDate":{"type":"string","format":"date","title":"Startdate","description":"Date of employment","example":"2021-06-01"},"probationEndDate":{"type":"string","format":"date","title":"Probationenddate","description":"Not synced with attendance system","example":"2021-08-31"},"terminationDate":{"type":"string","format":"date","title":"Terminationdate","example":"2023-12-31"},"avatarId":{"type":"string","format":"uuid","title":"Avatarid","description":"Employee's photo. Not synced with attendance system."},"preNominal":{"type":"string","title":"Prenominal","example":"doc."},"postNominal":{"type":"string","title":"Postnominal","example":"PhD"},"firstName":{"type":"string","title":"Firstname","example":"Thorin"},"lastName":{"type":"string","title":"Lastname","example":"Oakenshield"},"email":{"type":"string","title":"Email","description":"Main email for employee's app notifications"},"emailForSignatures":{"type":"string","title":"Emailforsignatures","description":"Private email for electronic communication with employee"},"additionalEmails":{"items":{"$ref":"#/components/schemas/AdditionalEmailDict"},"type":"array","maxItems":5,"title":"Additionalemails"},"personalNumber":{"type":"string","title":"Personalnumber","description":"Unique internal identifier of the employee","example":"10"},"externalId":{"type":"string","title":"Externalid","description":"Optional unique identifier for use with other systems"},"gender":{"type":"string","title":"Gender","example":["male","female"]},"birthday":{"type":"string","format":"date","title":"Birthday","description":"Not synced with attendance system","example":"1980-05-20"},"isDisabled":{"type":"boolean","title":"Isdisabled","description":"'True' when employee is manually deactivated","default":false},"operationId":{"type":"string","format":"uuid","title":"Operationid"},"workgroupId":{"type":"string","format":"uuid","title":"Workgroupid"},"jobTitle":{"type":"string","title":"Jobtitle","example":"Office desk manager"},"localization":{"type":"string","title":"Localization","description":"ISO 639-1 language code. Not synced with attendance system.","example":["sk","cs","en"]},"values":{"items":{"oneOf":[{"$ref":"#/components/schemas/RecordValueTextInputSchema"},{"$ref":"#/components/schemas/RecordValueRichTextInputSchema"},{"$ref":"#/components/schemas/RecordValueUrlInputSchema"},{"$ref":"#/components/schemas/RecordValueEmailInputSchema"},{"$ref":"#/components/schemas/RecordValueDatetimeInputSchema"},{"$ref":"#/components/schemas/RecordValueDecimalInputSchema"},{"$ref":"#/components/schemas/RecordValueIntegerInputSchema"},{"$ref":"#/components/schemas/RecordValueSelectInputSchema"},{"$ref":"#/components/schemas/RecordValueSelectManyInputSchema"},{"$ref":"#/components/schemas/RecordValueCheckboxInputSchema"},{"$ref":"#/components/schemas/RecordValueRadioInputSchema"},{"$ref":"#/components/schemas/RecordValueUserInputSchema"},{"$ref":"#/components/schemas/RecordValueEmployeesInputSchema"},{"$ref":"#/components/schemas/RecordValueFilesInputSchema"},{"$ref":"#/components/schemas/RecordValueDateInputSchema"},{"$ref":"#/components/schemas/RecordValueDecimalHistoryInputSchema"},{"$ref":"#/components/schemas/RecordValueTextHistoryInputSchema"},{"$ref":"#/components/schemas/RecordValueSelectHistoryInputSchema"},{"$ref":"#/components/schemas/RecordValueCodeListInputSchema"}],"discriminator":{"propertyName":"fieldType","mapping":{"text":"#/components/schemas/RecordValueTextInputSchema","richtext":"#/components/schemas/RecordValueRichTextInputSchema","url":"#/components/schemas/RecordValueUrlInputSchema","email":"#/components/schemas/RecordValueEmailInputSchema","datetime":"#/components/schemas/RecordValueDatetimeInputSchema","decimal":"#/components/schemas/RecordValueDecimalInputSchema","integer":"#/components/schemas/RecordValueIntegerInputSchema","select":"#/components/schemas/RecordValueSelectInputSchema","select_many":"#/components/schemas/RecordValueSelectManyInputSchema","checkbox":"#/components/schemas/RecordValueCheckboxInputSchema","radio":"#/components/schemas/RecordValueRadioInputSchema","user":"#/components/schemas/RecordValueUserInputSchema","employees":"#/components/schemas/RecordValueEmployeesInputSchema","files":"#/components/schemas/RecordValueFilesInputSchema","date":"#/components/schemas/RecordValueDateInputSchema","decimal_history":"#/components/schemas/RecordValueDecimalHistoryInputSchema","text_history":"#/components/schemas/RecordValueTextHistoryInputSchema","select_history":"#/components/schemas/RecordValueSelectHistoryInputSchema","code_list_pair":"#/components/schemas/RecordValueCodeListInputSchema"}}},"type":"array","title":"Values"}},"type":"object","required":["lastName"],"title":"EmployeeUpdate"},"FieldAuxCodeListPairDefaultValueDict":{"properties":{"itemKey":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}],"title":"Itemkey"},"itemValue":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}],"title":"Itemvalue"}},"type":"object","title":"Field"},"FieldAuxDict":{"properties":{"type":{"type":"string","title":"Type"},"placeholder":{"type":"string","title":"Placeholder"},"defaultValue":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"},{"$ref":"#/components/schemas/FieldAuxCodeListPairDefaultValueDict"}],"title":"Defaultvalue"},"helperText":{"type":"string","title":"Helpertext"},"isRequired":{"type":"boolean","title":"Isrequired"},"options":{"items":{"$ref":"#/components/schemas/FieldAuxOptionsDict"},"type":"array","title":"Options"},"enableNone":{"type":"boolean","title":"Enablenone"},"preselectedOption":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}],"title":"Preselectedoption"},"preselectedOptionEdit":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}],"title":"Preselectedoptionedit"},"multiple":{"type":"boolean","title":"Multiple"},"defaultInPersonnelFile":{"type":"boolean","title":"Defaultinpersonnelfile"},"minDate":{"type":"string","format":"date-time","title":"Mindate"},"maxDate":{"type":"string","format":"date-time","title":"Maxdate"},"allowWeekends":{"type":"boolean","title":"Allowweekends"},"limitFiles":{"type":"boolean","title":"Limitfiles"},"limitCount":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Limitcount"},"copyOf":{"type":"string","format":"uuid","title":"Copyof"},"granularity":{"$ref":"#/components/schemas/RecordValueDataGranularity"},"keyCodeListId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}],"title":"Keycodelistid"},"valueCodeListId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}],"title":"Valuecodelistid"},"limitItems":{"type":"boolean","title":"Limititems"},"allowDuplicateKeys":{"type":"boolean","title":"Allowduplicatekeys"},"isSensitive":{"type":"boolean","title":"Issensitive"}},"type":"object","title":"Field"},"FieldAuxOptionsDict":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"defaultChecked":{"type":"boolean","title":"Defaultchecked"}},"type":"object","required":["id","name"],"title":"Field"},"FieldSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","example":"12345678-90ab-cdef-1234-567890abcdef"},"name":{"type":"string","title":"Name","description":"Field title","example":"Brand"},"fieldType":{"allOf":[{"$ref":"#/components/schemas/FieldType"}],"description":"Type of the field, with defined behavior"},"config":{"allOf":[{"$ref":"#/components/schemas/FieldAuxDict"}],"title":"Config","description":"Additional configuration for the field. \n Keys/attributes based on field type."},"isSubjectEmployee":{"type":"boolean","title":"Issubjectemployee","description":"'True' for field used as direct employee link. \n Defined only for 'employees' field type."},"inPersonnelFile":{"type":"boolean","title":"Inpersonnelfile","description":"'True' for ability to show the field in employee personnel file.\n Defined only for 'employees' field type."}},"type":"object","required":["id","name","fieldType","config"],"title":"Field"},"FieldType":{"type":"string","enum":["text","richtext","email","url","datetime","date","decimal","integer","select","select_many","checkbox","radio","boolean","user","employees","files","code_list_pair","decimal_history","select_history","text_history"],"title":"FieldType","description":"An enumeration."},"Fieldset":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","example":"12345678-90ab-cdef-1234-567890abcdef"},"name":{"type":"string","title":"Name","description":"Title of the section","example":"General information"},"fields":{"items":{"$ref":"#/components/schemas/FieldSchema"},"type":"array","title":"Fields","description":"Section fields"}},"type":"object","required":["id","name","fields"],"title":"Fieldset"},"FilePage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/FileSchema"},"type":"array","title":"Items"},"offset":{"type":"integer","title":"Offset"},"limit":{"type":"integer","title":"Limit"},"totalCount":{"type":"integer","title":"Totalcount"}},"type":"object","required":["items","offset","limit","totalCount"],"title":"FilePage"},"FileSchema":{"properties":{"name":{"type":"string","title":"Name"},"contentType":{"type":"string","title":"Contenttype"},"size":{"type":"integer","title":"Size"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","example":"2023-11-16T14:30:03.277526+00:00"},"createdById":{"type":"string","format":"uuid","title":"Createdbyid","description":"User"},"deletedAt":{"type":"string","format":"date-time","title":"Deletedat"},"isDeleted":{"type":"boolean","title":"Isdeleted"},"editedByEmployeeId":{"type":"string","format":"uuid","title":"Editedbyemployeeid"},"id":{"type":"string","format":"uuid","title":"Id"},"downloadUrl":{"type":"string","title":"Downloadurl"}},"type":"object","required":["name","contentType","size","id"],"title":"File"},"FiltersComposition":{"type":"string","enum":["and","or"],"title":"FiltersComposition","description":"An enumeration."},"GeneralError":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"GeneralError"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"IconEnum":{"type":"string","enum":["","accessTime","accessibilityNew","group","phoneIphone","directionsCar","shoppingCart","euro","attachMoney","savings","creditCard","myLocation","flare","acUnit","bolt","favorite","star","barChart","showChart","park","localCafe","bakeryDining","cake","attachFile","mode","build","handyMan","menuBook","listAlt","assignment","contactPage","recentActorsIcon","work","weekend","tableRestaurant","school","print","power","mouse","medicalServices","localSee","localLibrary","localAirport","laptop","key","insertInvitation","homeRepairService","home","fingerprint","filterAlt","emojiEvents","email","checkroom","sportsTennis","localFireDepartment"],"title":"IconEnum","description":"An enumeration."},"OperationPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/OperationSchema"},"type":"array","title":"Items"},"offset":{"type":"integer","title":"Offset"},"limit":{"type":"integer","title":"Limit"},"totalCount":{"type":"integer","title":"Totalcount"}},"type":"object","required":["items","offset","limit","totalCount"],"title":"OperationPage"},"OperationSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"isDisabled":{"type":"boolean","title":"Isdisabled"}},"type":"object","required":["id","name","isDisabled"],"title":"Operation"},"RateLimitError":{"properties":{"error":{"type":"string","title":"Error"}},"type":"object","required":["error"],"title":"RateLimitError"},"Record":{"properties":{"recordDefinitionId":{"type":"string","format":"uuid","title":"Recorddefinitionid","description":"Parent entity","example":"12345678-90ab-cdef-1234-567890abcdef"},"state":{"allOf":[{"$ref":"#/components/schemas/RecordState"}],"description":"By default only active records are returned. \n Used only for read operations."},"documentsCount":{"type":"integer","title":"Documentscount","description":"Number of bound generated or uploaded documents. \n Used only for read operations.","default":0},"createdAt":{"type":"string","format":"date-time","title":"Createdat","example":"2023-11-16T14:30:03.277526+00:00"},"createdById":{"type":"string","format":"uuid","title":"Createdbyid","description":"User"},"deletedAt":{"type":"string","format":"date-time","title":"Deletedat"},"isDeleted":{"type":"boolean","title":"Isdeleted"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","example":"2024-11-28T10:40:48.449542+00:00"},"updatedById":{"type":"string","format":"uuid","title":"Updatedbyid","description":"User"},"id":{"type":"string","format":"uuid","title":"Id","example":"12345678-90ab-cdef-1234-567890abcdef"},"name":{"type":"string","title":"Name","description":"Record title, automatically generated as configured\n in record definition"},"subjectEmployeeId":{"type":"string","format":"uuid","title":"Subjectemployeeid","description":"Employee the record is directly bound to. Populated by a DB\n trigger from the record's `is_subject_employee` (\"direct employee link\" /\n \"pevná vazba\") field when it holds exactly one employee — i.e. for\n `employee_section` records and for regular records defining a direct\n employee link. NOT set for enhanced employee records (`employee_records`),\n whose subject is linked via the reverse FK `employee.record_id`."},"operationIds":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Operationids","description":"List of unique operation ids associated with this record."},"canBeActivated":{"type":"boolean","title":"Canbeactivated","description":"Indication that record state can be set back\n from 'archived' to 'active'"},"values":{"items":{"$ref":"#/components/schemas/RecordValue"},"type":"array","title":"Values","description":"Employee's enhanced data fields (with configured structure)"},"employeeId":{"type":"string","format":"uuid","title":"Employeeid","description":"Employee ID, only set for specific record definition"}},"type":"object","required":["recordDefinitionId","id","name","values"],"title":"Record"},"RecordCreateSchema":{"properties":{"recordDefinitionId":{"type":"string","format":"uuid","title":"Recorddefinitionid","description":"Parent entity","example":"12345678-90ab-cdef-1234-567890abcdef"},"state":{"allOf":[{"$ref":"#/components/schemas/RecordState"}],"description":"By default only active records are returned. \n Used only for read operations."},"documentsCount":{"type":"integer","title":"Documentscount","description":"Number of bound generated or uploaded documents. \n Used only for read operations.","default":0},"values":{"items":{"oneOf":[{"$ref":"#/components/schemas/RecordValueTextInputSchema"},{"$ref":"#/components/schemas/RecordValueRichTextInputSchema"},{"$ref":"#/components/schemas/RecordValueUrlInputSchema"},{"$ref":"#/components/schemas/RecordValueEmailInputSchema"},{"$ref":"#/components/schemas/RecordValueDatetimeInputSchema"},{"$ref":"#/components/schemas/RecordValueDecimalInputSchema"},{"$ref":"#/components/schemas/RecordValueIntegerInputSchema"},{"$ref":"#/components/schemas/RecordValueSelectInputSchema"},{"$ref":"#/components/schemas/RecordValueSelectManyInputSchema"},{"$ref":"#/components/schemas/RecordValueCheckboxInputSchema"},{"$ref":"#/components/schemas/RecordValueRadioInputSchema"},{"$ref":"#/components/schemas/RecordValueUserInputSchema"},{"$ref":"#/components/schemas/RecordValueEmployeesInputSchema"},{"$ref":"#/components/schemas/RecordValueFilesInputSchema"},{"$ref":"#/components/schemas/RecordValueDateInputSchema"},{"$ref":"#/components/schemas/RecordValueDecimalHistoryInputSchema"},{"$ref":"#/components/schemas/RecordValueTextHistoryInputSchema"},{"$ref":"#/components/schemas/RecordValueSelectHistoryInputSchema"},{"$ref":"#/components/schemas/RecordValueCodeListInputSchema"}],"discriminator":{"propertyName":"fieldType","mapping":{"text":"#/components/schemas/RecordValueTextInputSchema","richtext":"#/components/schemas/RecordValueRichTextInputSchema","url":"#/components/schemas/RecordValueUrlInputSchema","email":"#/components/schemas/RecordValueEmailInputSchema","datetime":"#/components/schemas/RecordValueDatetimeInputSchema","decimal":"#/components/schemas/RecordValueDecimalInputSchema","integer":"#/components/schemas/RecordValueIntegerInputSchema","select":"#/components/schemas/RecordValueSelectInputSchema","select_many":"#/components/schemas/RecordValueSelectManyInputSchema","checkbox":"#/components/schemas/RecordValueCheckboxInputSchema","radio":"#/components/schemas/RecordValueRadioInputSchema","user":"#/components/schemas/RecordValueUserInputSchema","employees":"#/components/schemas/RecordValueEmployeesInputSchema","files":"#/components/schemas/RecordValueFilesInputSchema","date":"#/components/schemas/RecordValueDateInputSchema","decimal_history":"#/components/schemas/RecordValueDecimalHistoryInputSchema","text_history":"#/components/schemas/RecordValueTextHistoryInputSchema","select_history":"#/components/schemas/RecordValueSelectHistoryInputSchema","code_list_pair":"#/components/schemas/RecordValueCodeListInputSchema"}}},"type":"array","title":"Values","description":"Record data fields (with configured structure)"}},"type":"object","required":["recordDefinitionId","values"],"title":"RecordCreateSchema"},"RecordDefinition":{"properties":{"name":{"type":"string","title":"Name","example":"Cars"},"description":{"type":"string","title":"Description","example":"Records for company cars for every employee that has keys"},"icon":{"allOf":[{"$ref":"#/components/schemas/IconEnum"}],"description":"Icon as visual representation of the record definition"},"code":{"type":"string","title":"Code","description":"Unique code for the record definition. \n Will be used for record naming by default if not set otherwise.","example":"CAR"},"config":{"allOf":[{"$ref":"#/components/schemas/RecordDefinitionAuxDict"}],"title":"Config","description":"Additional configuration:\n\n - recordNameFieldIds - List of structure field references. \n Record field values will be used for record naming.\n ","default":{"recordNameFieldIds":[]},"example":"{\"recordNameFieldIds\": [\"12345678-90ab-cdef-1234-567890abcdef\"]}"},"categoryId":{"type":"string","format":"uuid","title":"Categoryid","description":"Optional category tag","example":"12345678-90ab-cdef-1234-567890abcdef"},"specialized":{"type":"string","title":"Specialized"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","example":"2023-11-16T14:30:03.277526+00:00"},"createdById":{"type":"string","format":"uuid","title":"Createdbyid","description":"User"},"deletedAt":{"type":"string","format":"date-time","title":"Deletedat"},"isDeleted":{"type":"boolean","title":"Isdeleted"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","example":"2024-11-28T10:40:48.449542+00:00"},"updatedById":{"type":"string","format":"uuid","title":"Updatedbyid","description":"User"},"id":{"type":"string","format":"uuid","title":"Id","example":"12345678-90ab-cdef-1234-567890abcdef"},"categoryName":{"type":"string","title":"Categoryname","description":"Optional category tag name","example":"Stranger things"},"categoryColor":{"type":"string","title":"Categorycolor","description":"Optional category tag color - RGB hex code with hash","example":"#3a5fe5"},"fieldsets":{"items":{"$ref":"#/components/schemas/Fieldset"},"type":"array","title":"Fieldsets","description":"Employee's enhanced data fields structure"}},"type":"object","required":["name","description","code","id","fieldsets"],"title":"RecordDefinition"},"RecordDefinitionAuxDict":{"properties":{"recordNameFieldIds":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Recordnamefieldids"}},"type":"object","title":"RecordDefinition"},"RecordDefinitionListItem":{"properties":{"name":{"type":"string","title":"Name","example":"Cars"},"description":{"type":"string","title":"Description","example":"Records for company cars for every employee that has keys"},"icon":{"allOf":[{"$ref":"#/components/schemas/IconEnum"}],"description":"Icon as visual representation of the record definition"},"code":{"type":"string","title":"Code","description":"Unique code for the record definition. \n Will be used for record naming by default if not set otherwise.","example":"CAR"},"config":{"allOf":[{"$ref":"#/components/schemas/RecordDefinitionAuxDict"}],"title":"Config","description":"Additional configuration:\n\n - recordNameFieldIds - List of structure field references. \n Record field values will be used for record naming.\n ","default":{"recordNameFieldIds":[]},"example":"{\"recordNameFieldIds\": [\"12345678-90ab-cdef-1234-567890abcdef\"]}"},"categoryId":{"type":"string","format":"uuid","title":"Categoryid","description":"Optional category tag","example":"12345678-90ab-cdef-1234-567890abcdef"},"specialized":{"type":"string","title":"Specialized"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","example":"2023-11-16T14:30:03.277526+00:00"},"createdById":{"type":"string","format":"uuid","title":"Createdbyid","description":"User"},"deletedAt":{"type":"string","format":"date-time","title":"Deletedat"},"isDeleted":{"type":"boolean","title":"Isdeleted"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","example":"2024-11-28T10:40:48.449542+00:00"},"updatedById":{"type":"string","format":"uuid","title":"Updatedbyid","description":"User"},"id":{"type":"string","format":"uuid","title":"Id","example":"12345678-90ab-cdef-1234-567890abcdef"},"categoryName":{"type":"string","title":"Categoryname","description":"Optional category tag name","example":"Stranger things"},"categoryColor":{"type":"string","title":"Categorycolor","description":"Optional category tag color - RGB hex code with hash","example":"#3a5fe5"}},"type":"object","required":["name","description","code","id"],"title":"RecordDefinitionListItem"},"RecordDefinitionListItemPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/RecordDefinitionListItem"},"type":"array","title":"Items"},"offset":{"type":"integer","title":"Offset"},"limit":{"type":"integer","title":"Limit"},"totalCount":{"type":"integer","title":"Totalcount"}},"type":"object","required":["items","offset","limit","totalCount"],"title":"RecordDefinitionListItemPage"},"RecordDefinitionPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/RecordDefinition"},"type":"array","title":"Items"},"offset":{"type":"integer","title":"Offset"},"limit":{"type":"integer","title":"Limit"},"totalCount":{"type":"integer","title":"Totalcount"}},"type":"object","required":["items","offset","limit","totalCount"],"title":"RecordDefinitionPage"},"RecordListItem":{"properties":{"recordDefinitionId":{"type":"string","format":"uuid","title":"Recorddefinitionid","description":"Parent entity","example":"12345678-90ab-cdef-1234-567890abcdef"},"state":{"allOf":[{"$ref":"#/components/schemas/RecordState"}],"description":"By default only active records are returned. \n Used only for read operations."},"documentsCount":{"type":"integer","title":"Documentscount","description":"Number of bound generated or uploaded documents. \n Used only for read operations.","default":0},"createdAt":{"type":"string","format":"date-time","title":"Createdat","example":"2023-11-16T14:30:03.277526+00:00"},"createdById":{"type":"string","format":"uuid","title":"Createdbyid","description":"User"},"deletedAt":{"type":"string","format":"date-time","title":"Deletedat"},"isDeleted":{"type":"boolean","title":"Isdeleted"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","example":"2024-11-28T10:40:48.449542+00:00"},"updatedById":{"type":"string","format":"uuid","title":"Updatedbyid","description":"User"},"id":{"type":"string","format":"uuid","title":"Id","example":"12345678-90ab-cdef-1234-567890abcdef"},"name":{"type":"string","title":"Name","description":"Record title, automatically generated as configured\n in record definition"},"subjectEmployeeId":{"type":"string","format":"uuid","title":"Subjectemployeeid","description":"Employee the record is directly bound to. Populated by a DB\n trigger from the record's `is_subject_employee` (\"direct employee link\" /\n \"pevná vazba\") field when it holds exactly one employee — i.e. for\n `employee_section` records and for regular records defining a direct\n employee link. NOT set for enhanced employee records (`employee_records`),\n whose subject is linked via the reverse FK `employee.record_id`."},"operationIds":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Operationids","description":"List of unique operation ids associated with this record."},"canBeActivated":{"type":"boolean","title":"Canbeactivated","description":"Indication that record state can be set back\n from 'archived' to 'active'"},"values":{"items":{"$ref":"#/components/schemas/RecordValueWithEmployees"},"type":"array","title":"Values","description":"Employee's enhanced data fields (with configured structure)"}},"type":"object","required":["recordDefinitionId","id","name"],"title":"RecordListItem"},"RecordListItemPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/RecordListItem"},"type":"array","title":"Items"},"offset":{"type":"integer","title":"Offset"},"limit":{"type":"integer","title":"Limit"},"totalCount":{"type":"integer","title":"Totalcount"}},"type":"object","required":["items","offset","limit","totalCount"],"title":"RecordListItemPage"},"RecordState":{"type":"string","enum":["active","archived"],"title":"RecordState","description":"An enumeration."},"RecordUpdateSchema":{"properties":{"recordDefinitionId":{"type":"string","format":"uuid","title":"Recorddefinitionid","description":"Parent entity","example":"12345678-90ab-cdef-1234-567890abcdef"},"state":{"allOf":[{"$ref":"#/components/schemas/RecordState"}],"description":"By default only active records are returned. \n Used only for read operations."},"documentsCount":{"type":"integer","title":"Documentscount","description":"Number of bound generated or uploaded documents. \n Used only for read operations.","default":0},"id":{"type":"string","format":"uuid","title":"Id"},"values":{"items":{"oneOf":[{"$ref":"#/components/schemas/RecordValueTextInputSchema"},{"$ref":"#/components/schemas/RecordValueRichTextInputSchema"},{"$ref":"#/components/schemas/RecordValueUrlInputSchema"},{"$ref":"#/components/schemas/RecordValueEmailInputSchema"},{"$ref":"#/components/schemas/RecordValueDatetimeInputSchema"},{"$ref":"#/components/schemas/RecordValueDecimalInputSchema"},{"$ref":"#/components/schemas/RecordValueIntegerInputSchema"},{"$ref":"#/components/schemas/RecordValueSelectInputSchema"},{"$ref":"#/components/schemas/RecordValueSelectManyInputSchema"},{"$ref":"#/components/schemas/RecordValueCheckboxInputSchema"},{"$ref":"#/components/schemas/RecordValueRadioInputSchema"},{"$ref":"#/components/schemas/RecordValueUserInputSchema"},{"$ref":"#/components/schemas/RecordValueEmployeesInputSchema"},{"$ref":"#/components/schemas/RecordValueFilesInputSchema"},{"$ref":"#/components/schemas/RecordValueDateInputSchema"},{"$ref":"#/components/schemas/RecordValueDecimalHistoryInputSchema"},{"$ref":"#/components/schemas/RecordValueTextHistoryInputSchema"},{"$ref":"#/components/schemas/RecordValueSelectHistoryInputSchema"},{"$ref":"#/components/schemas/RecordValueCodeListInputSchema"}],"discriminator":{"propertyName":"fieldType","mapping":{"text":"#/components/schemas/RecordValueTextInputSchema","richtext":"#/components/schemas/RecordValueRichTextInputSchema","url":"#/components/schemas/RecordValueUrlInputSchema","email":"#/components/schemas/RecordValueEmailInputSchema","datetime":"#/components/schemas/RecordValueDatetimeInputSchema","decimal":"#/components/schemas/RecordValueDecimalInputSchema","integer":"#/components/schemas/RecordValueIntegerInputSchema","select":"#/components/schemas/RecordValueSelectInputSchema","select_many":"#/components/schemas/RecordValueSelectManyInputSchema","checkbox":"#/components/schemas/RecordValueCheckboxInputSchema","radio":"#/components/schemas/RecordValueRadioInputSchema","user":"#/components/schemas/RecordValueUserInputSchema","employees":"#/components/schemas/RecordValueEmployeesInputSchema","files":"#/components/schemas/RecordValueFilesInputSchema","date":"#/components/schemas/RecordValueDateInputSchema","decimal_history":"#/components/schemas/RecordValueDecimalHistoryInputSchema","text_history":"#/components/schemas/RecordValueTextHistoryInputSchema","select_history":"#/components/schemas/RecordValueSelectHistoryInputSchema","code_list_pair":"#/components/schemas/RecordValueCodeListInputSchema"}}},"type":"array","title":"Values","description":"Record data fields (with configured structure)"}},"type":"object","required":["recordDefinitionId","values"],"title":"RecordUpdateSchema"},"RecordUpdated":{"properties":{"recordDefinitionId":{"type":"string","format":"uuid","title":"Recorddefinitionid","description":"Parent entity","example":"12345678-90ab-cdef-1234-567890abcdef"},"state":{"allOf":[{"$ref":"#/components/schemas/RecordState"}],"description":"By default only active records are returned. \n Used only for read operations."},"documentsCount":{"type":"integer","title":"Documentscount","description":"Number of bound generated or uploaded documents. \n Used only for read operations.","default":0},"createdAt":{"type":"string","format":"date-time","title":"Createdat","example":"2023-11-16T14:30:03.277526+00:00"},"createdById":{"type":"string","format":"uuid","title":"Createdbyid","description":"User"},"deletedAt":{"type":"string","format":"date-time","title":"Deletedat"},"isDeleted":{"type":"boolean","title":"Isdeleted"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","example":"2024-11-28T10:40:48.449542+00:00"},"updatedById":{"type":"string","format":"uuid","title":"Updatedbyid","description":"User"},"id":{"type":"string","format":"uuid","title":"Id","example":"12345678-90ab-cdef-1234-567890abcdef"},"name":{"type":"string","title":"Name","description":"Record title, automatically generated as configured\n in record definition"},"subjectEmployeeId":{"type":"string","format":"uuid","title":"Subjectemployeeid","description":"Employee the record is directly bound to. Populated by a DB\n trigger from the record's `is_subject_employee` (\"direct employee link\" /\n \"pevná vazba\") field when it holds exactly one employee — i.e. for\n `employee_section` records and for regular records defining a direct\n employee link. NOT set for enhanced employee records (`employee_records`),\n whose subject is linked via the reverse FK `employee.record_id`."},"operationIds":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Operationids","description":"List of unique operation ids associated with this record."},"canBeActivated":{"type":"boolean","title":"Canbeactivated","description":"Indication that record state can be set back\n from 'archived' to 'active'"}},"type":"object","required":["recordDefinitionId","id","name"],"title":"RecordUpdated"},"RecordValue":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"string","format":"date"},{"type":"string","format":"date-time"},{"items":{"$ref":"#/components/schemas/CodeListPairSchema"},"type":"array"},{"items":{"type":"string"},"type":"array"},{"items":{"type":"string","format":"uuid"},"type":"array"}],"title":"Value","example":["text","12345678901234.56789","2024-10-30","optionNone","12345678-90ab-cdef-1234-567890abcdef","[\"12345678-90ab-cdef-1234-567890abcdef\"]"]},"fieldType":{"$ref":"#/components/schemas/FieldType"},"inPersonnelFile":{"type":"boolean","title":"Inpersonnelfile","description":"'True' for displaying of the whole record in personnel files of\n the mentioned employees (specified in value). \n Defined only for 'employees' field type. This option is active only if the field\n is set to be used as direct employee link, i.e in conjunction \n with `isSubjectEmployee` field setting in record definition data structure."},"createdAt":{"type":"string","format":"date-time","title":"Createdat","example":"2023-11-16T14:30:03.277526+00:00"},"createdById":{"type":"string","format":"uuid","title":"Createdbyid","description":"User"},"config":{"allOf":[{"$ref":"#/components/schemas/RecordValueAuxDict"}],"title":"Config","description":"Additional configuration for the field content. \n Keys/attributes based on field type. Currently only for 'url' field type."},"hasHistory":{"type":"boolean","title":"Hashistory","default":false},"nextTimestamp":{"type":"string","format":"date-time","title":"Nexttimestamp"},"id":{"type":"string","format":"uuid","title":"Id","description":"Reference to value of the configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"isLatest":{"type":"boolean","title":"Islatest","description":"'True' for the current value of the field (not historical value)"}},"type":"object","required":["fieldId","fieldType","config","id","isLatest"],"title":"RecordValue"},"RecordValueAuxDict":{"properties":{"url":{"type":"string","title":"Url"},"title":{"type":"string","title":"Title"},"description":{"type":"string","title":"Description"},"thumbnail":{"type":"string","title":"Thumbnail"}},"type":"object","title":"RecordValueAuxDict"},"RecordValueCheckboxInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"items":{"type":"string"},"type":"array","title":"Value","example":"[\"12345678-90ab-cdef-1234-567890abcdef\"]"},"fieldType":{"type":"string","enum":["checkbox"],"title":"Fieldtype"}},"type":"object","required":["fieldId","value","fieldType"],"title":"RecordValueCheckboxInputSchema"},"RecordValueCodeListInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"items":{"$ref":"#/components/schemas/CodeListPairInputSchema"},"type":"array","title":"Value"},"fieldType":{"type":"string","enum":["code_list_pair"],"title":"Fieldtype"}},"type":"object","required":["fieldId","value","fieldType"],"title":"RecordValueCodeListInputSchema"},"RecordValueDataGranularity":{"type":"string","enum":["second","day"],"title":"RecordValueDataGranularity","description":"An enumeration."},"RecordValueDateInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"type":"string","format":"date","title":"Value","example":"2024-10-30"},"fieldType":{"type":"string","enum":["date"],"title":"Fieldtype"}},"type":"object","required":["fieldId","fieldType"],"title":"RecordValueDateInputSchema"},"RecordValueDatetimeInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"type":"string","format":"date-time","title":"Value","example":"2024-10-24T09:03:55.557526+02:00"},"fieldType":{"type":"string","enum":["datetime"],"title":"Fieldtype"}},"type":"object","required":["fieldId","fieldType"],"title":"RecordValueDatetimeInputSchema"},"RecordValueDecimalDataSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"value":{"type":"number","title":"Value"}},"type":"object","required":["timestamp"],"title":"RecordValueDecimalDataSchema"},"RecordValueDecimalHistoryInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"items":{"$ref":"#/components/schemas/RecordValueDecimalDataSchema"},"type":"array","title":"Value"},"fieldType":{"type":"string","enum":["decimal_history"],"title":"Fieldtype"}},"type":"object","required":["fieldId","value","fieldType"],"title":"RecordValueDecimalHistoryInputSchema"},"RecordValueDecimalInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"type":"number","title":"Value","description":"Also for longer number-like values, e.g. SIM card number \n with 20 digits.","example":"12345.6789"},"fieldType":{"type":"string","enum":["decimal"],"title":"Fieldtype"}},"type":"object","required":["fieldId","fieldType"],"title":"RecordValueDecimalInputSchema"},"RecordValueEmailInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"type":"string","title":"Value","example":"podpora@alveno.cz"},"fieldType":{"type":"string","enum":["email"],"title":"Fieldtype"}},"type":"object","required":["fieldId","fieldType"],"title":"RecordValueEmailInputSchema"},"RecordValueEmployeesInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Value","description":"Reference to employee entities","example":"[\"12345678-90ab-cdef-1234-567890abcdef\"]"},"fieldType":{"type":"string","enum":["employees"],"title":"Fieldtype"},"inPersonnelFile":{"type":"boolean","title":"Inpersonnelfile","description":"'True' for displaying of the whole record in personnel files of\n the mentioned employees (specified in value).\n This option is active only if the field is set to be used as direct\n employee link, i.e in conjunction with `isSubjectEmployee` field setting\n in record definition data structure."}},"type":"object","required":["fieldId","value","fieldType"],"title":"RecordValueEmployeesInputSchema"},"RecordValueFilesInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Value","description":"References to uploaded file entities. \n Files have to be uploaded beforehand.","example":"[\"12345678-90ab-cdef-1234-567890abcdef\"]"},"fieldType":{"type":"string","enum":["files"],"title":"Fieldtype"},"deleteFiles":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Deletefiles"}},"type":"object","required":["fieldId","value","fieldType"],"title":"RecordValueFilesInputSchema"},"RecordValueGeneralSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"string","format":"date"},{"type":"string","format":"date-time"},{"items":{"$ref":"#/components/schemas/CodeListPairSchema"},"type":"array"},{"items":{"type":"string"},"type":"array"},{"items":{"type":"string","format":"uuid"},"type":"array"}],"title":"Value","example":["text","12345678901234.56789","2024-10-30","optionNone","12345678-90ab-cdef-1234-567890abcdef","[\"12345678-90ab-cdef-1234-567890abcdef\"]"]},"fieldType":{"$ref":"#/components/schemas/FieldType"},"inPersonnelFile":{"type":"boolean","title":"Inpersonnelfile","description":"'True' for displaying of the whole record in personnel files of\n the mentioned employees (specified in value). \n Defined only for 'employees' field type. This option is active only if the field\n is set to be used as direct employee link, i.e in conjunction \n with `isSubjectEmployee` field setting in record definition data structure."},"createdAt":{"type":"string","format":"date-time","title":"Createdat","example":"2023-11-16T14:30:03.277526+00:00"},"createdById":{"type":"string","format":"uuid","title":"Createdbyid","description":"User"},"deletedAt":{"type":"string","format":"date-time","title":"Deletedat"},"isDeleted":{"type":"boolean","title":"Isdeleted"},"editedByEmployeeId":{"type":"string","format":"uuid","title":"Editedbyemployeeid"},"aux":{"type":"object","title":"Aux","default":{}},"hasHistory":{"type":"boolean","title":"Hashistory","default":false},"nextTimestamp":{"type":"string","format":"date-time","title":"Nexttimestamp"},"id":{"type":"string","format":"uuid","title":"Id","description":"Reference to value of the configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"isLatest":{"type":"boolean","title":"Islatest","description":"'True' for the current value of the field (not historical value)"}},"type":"object","required":["fieldId","fieldType","id","isLatest"],"title":"RecordValueGeneralSchema"},"RecordValueIntegerInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"type":"integer","maximum":2147483647.0,"minimum":-2147483648.0,"title":"Value"},"fieldType":{"type":"string","enum":["integer"],"title":"Fieldtype"}},"type":"object","required":["fieldId","fieldType"],"title":"RecordValueIntegerInputSchema"},"RecordValueRadioInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"type":"string","title":"Value","example":["optionNone","[\"12345678-90ab-cdef-1234-567890abcdef\"]"]},"fieldType":{"type":"string","enum":["radio"],"title":"Fieldtype"}},"type":"object","required":["fieldId","fieldType"],"title":"RecordValueRadioInputSchema"},"RecordValueRichTextInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"type":"string","title":"Value","example":"

text

"},"fieldType":{"type":"string","enum":["richtext"],"title":"Fieldtype"}},"type":"object","required":["fieldId","fieldType"],"title":"RecordValueRichTextInputSchema"},"RecordValueSelectHistoryInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"items":{"$ref":"#/components/schemas/RecordValueTextDataSchema"},"type":"array","title":"Value"},"fieldType":{"type":"string","enum":["select_history"],"title":"Fieldtype"}},"type":"object","required":["fieldId","value","fieldType"],"title":"RecordValueSelectHistoryInputSchema"},"RecordValueSelectInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"type":"string","title":"Value","example":["optionNone","[\"12345678-90ab-cdef-1234-567890abcdef\"]"]},"fieldType":{"type":"string","enum":["select"],"title":"Fieldtype"}},"type":"object","required":["fieldId","fieldType"],"title":"RecordValueSelectInputSchema"},"RecordValueSelectManyInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"items":{"type":"string"},"type":"array","title":"Value","description":"Alias for 'checkbox' field type"},"fieldType":{"type":"string","enum":["select_many"],"title":"Fieldtype"}},"type":"object","required":["fieldId","value","fieldType"],"title":"RecordValueSelectManyInputSchema"},"RecordValueTextDataSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"value":{"type":"string","title":"Value"}},"type":"object","required":["timestamp"],"title":"RecordValueTextDataSchema"},"RecordValueTextHistoryInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"items":{"$ref":"#/components/schemas/RecordValueTextDataSchema"},"type":"array","title":"Value"},"fieldType":{"type":"string","enum":["text_history"],"title":"Fieldtype"}},"type":"object","required":["fieldId","value","fieldType"],"title":"RecordValueTextHistoryInputSchema"},"RecordValueTextInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"type":"string","title":"Value","example":"text"},"fieldType":{"type":"string","enum":["text"],"title":"Fieldtype"}},"type":"object","required":["fieldId","fieldType"],"title":"RecordValueTextInputSchema"},"RecordValueUrlInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"type":"string","title":"Value","example":"https://hr.alveno.cz"},"fieldType":{"type":"string","enum":["url"],"title":"Fieldtype"}},"type":"object","required":["fieldId","fieldType"],"title":"RecordValueUrlInputSchema"},"RecordValueUserInputSchema":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"type":"string","format":"uuid","title":"Value","description":"Reference to user entity","example":"12345678-90ab-cdef-1234-567890abcdef"},"fieldType":{"type":"string","enum":["user"],"title":"Fieldtype"}},"type":"object","required":["fieldId","fieldType"],"title":"RecordValueUserInputSchema"},"RecordValueWithEmployees":{"properties":{"fieldId":{"type":"string","format":"uuid","title":"Fieldid","description":"Configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"lastTimestamp":{"type":"string","format":"date-time","title":"Lasttimestamp"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"string","format":"date"},{"type":"string","format":"date-time"},{"items":{"$ref":"#/components/schemas/CodeListPairSchema"},"type":"array"},{"items":{"type":"string"},"type":"array"},{"items":{"type":"string","format":"uuid"},"type":"array"}],"title":"Value","example":["text","12345678901234.56789","2024-10-30","optionNone","12345678-90ab-cdef-1234-567890abcdef","[\"12345678-90ab-cdef-1234-567890abcdef\"]"]},"fieldType":{"$ref":"#/components/schemas/FieldType"},"inPersonnelFile":{"type":"boolean","title":"Inpersonnelfile","description":"'True' for displaying of the whole record in personnel files of\n the mentioned employees (specified in value). \n Defined only for 'employees' field type. This option is active only if the field\n is set to be used as direct employee link, i.e in conjunction \n with `isSubjectEmployee` field setting in record definition data structure."},"createdAt":{"type":"string","format":"date-time","title":"Createdat","example":"2023-11-16T14:30:03.277526+00:00"},"createdById":{"type":"string","format":"uuid","title":"Createdbyid","description":"User"},"config":{"allOf":[{"$ref":"#/components/schemas/RecordValueAuxDict"}],"title":"Config","description":"Additional configuration for the field content. \n Keys/attributes based on field type. Currently only for 'url' field type."},"hasHistory":{"type":"boolean","title":"Hashistory","default":false},"nextTimestamp":{"type":"string","format":"date-time","title":"Nexttimestamp"},"id":{"type":"string","format":"uuid","title":"Id","description":"Reference to value of the configured field in the structure","example":"12345678-90ab-cdef-1234-567890abcdef"},"isLatest":{"type":"boolean","title":"Islatest","description":"'True' for the current value of the field (not historical value)"}},"type":"object","required":["fieldId","fieldType","config","id","isLatest"],"title":"RecordValueWithEmployees"},"Status":{"properties":{"detail":{"$ref":"#/components/schemas/StatusDetail"}},"type":"object","required":["detail"],"title":"Status"},"StatusDetail":{"properties":{"storageCapacity":{"type":"integer","title":"Storagecapacity","description":"Total storage space for client files and documents (in bytes)","example":"1073741824"},"standalone":{"type":"boolean","title":"Standalone","description":"'True' in case of standalone HR (not connected \n with attendance system"},"syncTimestamp":{"type":"string","format":"date-time","title":"Synctimestamp","description":"Last successful run of partial synchronization \n with attendance system. Applied only for changes to active data. \n Runs every couple of minutes.","example":"2024-12-06T14:13:19.763000+01:00"},"fullSyncTimestamp":{"type":"string","format":"date-time","title":"Fullsynctimestamp","description":"Last successful nightly run of full synchronization \n with attendance system","example":"2024-12-06T12:13:19.763000+01:00"},"failedSyncTimestamp":{"type":"string","format":"date-time","title":"Failedsynctimestamp","description":"Last attempt for partial synchronization \n with attendance system that ended in error","example":"2024-12-06T12:13:19.763000+01:00"},"settingsSyncTimestamp":{"type":"string","format":"date-time","title":"Settingssynctimestamp","description":"Last successful run of synchronization of instance settings \n with attendance system.","example":"2024-12-06T12:13:19.763000+01:00"},"locale":{"allOf":[{"$ref":"#/components/schemas/SupportedLanguageEnum"}],"description":"Default instance language"},"externalApiEnabled":{"type":"boolean","title":"Externalapienabled","default":true},"permissionsSyncAllowed":{"type":"boolean","title":"Permissionssyncallowed","default":true}},"type":"object","required":["standalone"],"title":"StatusDetail"},"SupportedLanguageEnum":{"type":"string","enum":["cs","en","sk"],"title":"SupportedLanguageEnum","description":"An enumeration."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"APIKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key"}}},"tags":[{"name":"echo","description":"Check whether your access token is working"},{"name":"employees","description":"Entities that can be linked in ***records***. \n By default without access to HR (can be bound with user to achieve this)."},{"name":"records","description":"All the ***records*** you can handle. \n Records of the same type (data structure) are grouped in one record definition \n (representing folder or binder)."},{"name":"files","description":"File metadata. Listing requires an explicit `id[in]` filter."},{"name":"operations","description":"Operations (\"provozy\") configured in the instance."},{"name":"instance","description":"General instance details."},{"name":"Errors","description":"List of all error status codes"}]}