openapi: 3.0.2 info: title: ELZA API version: 1.0.0 tags: - name: rules description: Pravidla popisu archiválií (typy atributů, datové typy, …) - name: accesspoint-internal description: Access-point API used by the Elza UI - name: publication-internal description: Publication API used by the Elza UI - name: publication description: Public API for the publication system - name: tasks description: Úkoly - name: search description: Vyhledávání - name: structure description: structure - name: node description: Práce s úrovněmi a uzly - name: report description: Statistické zprávy - name: aips description: aips - name: io description: Vstup a výstup informací - name: accesspoints description: Přístupové body a archivní entity - name: descitems description: Záznamy v archivních fondech - name: funds description: Archivní soubory - name: externalsystems description: Externí systémy - name: daos description: Digitální archivní objekty - name: admin description: Administrativní funkce servers: - url: http://localhost description: Výchozí server - url: http://localhost:8080 description: Devel server paths: /accesspoint: delete: operationId: AccessPoint_deleteAccessPoints description: Invalidation of access points parameters: [] responses: '200': description: The request has succeeded. '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoints requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteAccessPointsDetail' description: seznam ID nebo UUID, které chceme smazat /accesspoint/export: post: operationId: AccessPoint_batchExport description: |- Asynchronously export access points matching the given filter to CSV. Returns the request id; poll /io/export-status/{id} and download the result via /io/file/{id}. Results are ordered by accessPointId ascending. Empty body / null fields means "all access points visible to the user". parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: type: integer '400': description: The server could not understand the request due to invalid syntax. content: application/json: schema: $ref: '#/components/schemas/BaseException' '401': description: Access is unauthorized. content: application/json: schema: $ref: '#/components/schemas/BaseException' '403': description: Access is forbidden. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoints requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessPointBatchExportParams' description: filter selecting the access points to export /accesspoint/export/{queueItemId}: put: operationId: AccessPoint_exportForceOrNo description: Decision on forced export ELZA -> CAM parameters: - name: queueItemId in: path required: true description: id of queue schema: type: integer - name: force in: query required: true description: 'force export: yes or no' schema: type: boolean explode: false responses: '200': description: The request has succeeded. '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoints /accesspoint/invalidated: get: operationId: AccessPoint_getInvalidatedEntities description: Get invalidated (deleted) entities parameters: - name: page in: query required: false description: number of the page schema: type: integer default: 0 explode: false - name: pageSize in: query required: false description: page size schema: type: integer default: 10 explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/InvalidatedEntities' tags: - accesspoints /accesspoint/search: post: operationId: AccessPoint_search description: |- Search for access points. Accepts the same filter inputs as /accesspoint/export (scalar fields + ApAdvanceSearchFilter) plus pagination (from, count) and the criteria-query SearchType selectors. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ApAccessPointSearchResult' tags: - accesspoints requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccessPointSearchParams' description: filter selecting the access points to search for /accesspoint/{id}: delete: operationId: AccessPoint_deleteAccessPoint description: Invalidation of access point (delete/replace) parameters: - name: id in: path required: true description: id of accesspoint schema: type: string responses: '200': description: The request has succeeded. '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoints requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/DeleteAccessPointDetail' description: addition for method of invalidation /accesspoint/{id}/autoitems: get: operationId: AccessPoint_getAutoitems description: List of automatically generated elements of the description parameters: - name: id in: path required: true description: id of accesspoint schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ResultAutoItems' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoints /accesspoint/{id}/copy: put: operationId: AccessPoint_copyAccessPoint description: Copying an archive entity parameters: - name: id in: path required: true description: id of accesspoint schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/EntityRef' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoints requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CopyAccessPointDetail' description: additional copy options /accesspoint/{id}/lastParticipants: get: operationId: AccessPoint_getLastParticipants description: Get a list of entity processors parameters: - name: id in: path required: true description: id of accesspoint schema: type: integer responses: '200': description: The request has succeeded. content: application/json: schema: type: array items: $ref: '#/components/schemas/Participant' tags: - accesspoints /accesspoint/{id}/part: post: operationId: AccessPoint_createPart description: Create new part of ApAccessPoint parameters: - name: id in: path required: true description: id of accesspoint schema: type: integer - name: apVersion in: query required: false description: accesspoint version schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CreatedPart' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoints requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApPartFormVO' description: data for creating a part /accesspoint/{id}/part/{partId}: post: operationId: AccessPoint_updatePart description: Update a part of ApAccessPoint parameters: - name: id in: path required: true description: id of accesspoint schema: type: integer - name: partId in: path required: true description: id of part schema: type: integer - name: apVersion in: query required: false description: accesspoint version schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: type: integer '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoints requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApPartFormVO' description: data for updating a part delete: operationId: AccessPoint_deletePart description: Delete part of ApAccessPoint parameters: - name: id in: path required: true description: id of accesspoint schema: type: integer - name: partId in: path required: true description: partId of ApAccessPoint schema: type: integer - name: apVersion in: query required: false description: actual version of ApAccessPoint schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: type: integer '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoints /accesspoint/{id}/part/{partId}/prefer-name: put: operationId: AccessPoint_setPreferName description: Set the preferred name of ApAccessPoint parameters: - name: id in: path required: true description: id of accesspoint schema: type: integer - name: partId in: path required: true description: partId of ApAccessPoint schema: type: integer - name: apVersion in: query required: false description: actual version of ApAccessPoint schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: type: integer tags: - accesspoints /accesspoint/{id}/restore: put: operationId: AccessPoint_restoreAccessPoint description: Restore deleted entity and return to original state parameters: - name: id in: path required: true description: id of accesspoint schema: type: string responses: '200': description: The request has succeeded. '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoints /accesspoint/{id}/revision: post: operationId: AccessPoint_createRevision description: Creating a new revision of access point parameters: - name: id in: path required: true description: id of accesspoint schema: type: integer responses: '200': description: The request has succeeded. '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoints delete: operationId: AccessPoint_deleteRevision description: Deleting a revision of access point parameters: - name: id in: path required: true description: id of accesspoint schema: type: integer responses: '200': description: The request has succeeded. '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoints /accesspoint/{id}/revision/autoitems: get: operationId: AccessPoint_getRevAutoitems description: List of automatically generated description elements for revision parameters: - name: id in: path required: true description: id of accesspoint schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ResultAutoItems' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoints /accesspoint/{id}/revision/merge: post: operationId: AccessPoint_mergeRevision description: Merge ApRevision & ApAccessPoint parameters: - name: id in: path required: true description: id of accesspoint schema: type: integer - name: apVersion in: query required: false description: actual version of ApAccessPoint schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: type: integer tags: - accesspoints requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApStateUpdate' description: data for change ApState /accesspoint/{id}/revision/part/{partId}: delete: operationId: AccessPoint_deleteRevisionPart description: Delete part of revision of ApAccessPoint parameters: - name: id in: path required: true description: id of accesspoint schema: type: integer - name: partId in: path required: true description: partId of revision schema: type: integer - name: apVersion in: query required: false description: actual version of ApAccessPoint schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: type: integer '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoints /accesspoint/{id}/revision/part/{partId}/prefer-name: put: operationId: AccessPoint_setPreferNameRevision description: Set the preferred name of revision of ApAccessPoint parameters: - name: id in: path required: true description: id of accesspoint schema: type: integer - name: partId in: path required: true description: partId of revision schema: type: integer - name: apVersion in: query required: false description: actual version of ApAccessPoint schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: type: integer '404': description: The server cannot find the requested resource. tags: - accesspoints /accesspoint/{id}/revision/part/{revPartId}: post: operationId: AccessPoint_updateRevisionPart description: Update a revision part of ApAccessPoint parameters: - name: id in: path required: true description: id of accesspoint schema: type: integer - name: revPartId in: path required: true description: id of revision part schema: type: integer - name: apVersion in: query required: false description: accesspoint version schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: type: integer '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoints requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApPartFormVO' description: data for updating a part /accesspoint/{id}/revision/state: put: operationId: AccessPoint_changeStateRevision description: Change state of revision of ApAccessPoint parameters: - name: id in: path required: true description: id of accesspoint schema: type: integer - name: apVersion in: query required: false description: actual version of ApAccessPoint schema: type: integer explode: false - name: assignTo in: query required: false description: userId schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: type: integer '404': description: The server cannot find the requested resource. tags: - accesspoints requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RevStateChange' description: data for change state of revision of ApAccessPoint /accesspoint/{id}/state: put: operationId: AccessPoint_changeState description: Change state of ApAccessPoint parameters: - name: id in: path required: true description: id of accesspoint schema: type: integer - name: apVersion in: query required: false description: actual version of ApAccessPoint schema: type: integer explode: false - name: assignTo in: query required: false description: userId schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: type: integer tags: - accesspoints requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApStateUpdate' description: data for change ApState /accesspoint/{id}/validate: get: operationId: AccessPoint_validateAccessPoint description: Validation of an archive entity parameters: - name: id in: path required: true description: id of accesspoint schema: type: integer - name: includeRevision in: query required: false description: include revision schema: type: boolean default: false explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ApValidationIssues' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoints /action/funds-change/{fundsChangeId}: get: operationId: BulkAction_getFundsChangeRuns description: Vrátí jednotlivé per-fond běhy patřící do jednoho vícefondového seskupení (sledování průběhu). parameters: - name: fundsChangeId in: path required: true schema: type: integer responses: '200': description: The request has succeeded. content: application/json: schema: type: array items: $ref: '#/components/schemas/FundsChangeRun' tags: - funds /action/funds/group: post: operationId: BulkAction_groupFundsByRuleSet description: |- Rozdělí vybrané fondy podle pravidel a vrátí dostupné hromadné akce pro každou skupinu. Vstupem je buď explicitní seznam fondů, nebo filtr (výběr všech odpovídajících fondů). parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/FundsActionGroupResult' tags: - funds requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FundsActionGroupRequest' /action/queue-multi: post: operationId: BulkAction_queueMultiFundAction description: |- Spustí hromadnou akci nad více fondy najednou. Pro každý platný fond naplánuje samostatný běh; fondy mimo daná pravidla jsou přeskočeny a vráceny ve výsledku. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/MultiFundActionResult' tags: - funds requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MultiFundActionRequest' /admin/arrangement/missing-cached-nodes: get: operationId: Admin_syncNodeCache description: Creating missing items in arr_cached_node parameters: [] responses: '200': description: The request has succeeded. tags: - admin /admin/info: get: operationId: Admin_info description: Return basic statistical info parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/AdminInfo' tags: - admin /admin/info/logged-users: get: operationId: Admin_loggedUsers description: Return list of logged users parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/LoggedUsers' tags: - admin /admin/user/{userId}/copy-permissions: post: operationId: Admin_copyPermissions description: |- Copy user permissions from another user Method will append all permissions to given user parameters: - name: userId in: path required: true description: ID of target user schema: type: integer responses: '200': description: The request has succeeded. tags: - admin requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Admin.CopyPermissionParams' /aip/bulk-connect-logic-to-jp: post: operationId: Aip_bulkConnectLogicToJp description: Bulk connect logical structure to JP parameters: - name: arrNodeId in: query required: true description: ArrNode ID schema: type: integer explode: false - name: daAipIdList in: query required: true description: DaAip ID list schema: type: array items: type: integer explode: false - name: daLevelViewId in: query required: true description: DaLevelView ID schema: type: integer explode: false responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips /aip/bulk-connect-to-jp: post: operationId: Aip_bulkConnectToJp description: Bulk connect to JP parameters: - name: arrNodeId in: query required: true description: ArrNode ID schema: type: integer explode: false - name: daAipIdList in: query required: true description: DaAip ID list schema: type: array items: type: integer explode: false responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips /aip/bulk-create-from-selected: post: operationId: Aip_bulkCreateFromSelected description: Bulk create from selected parameters: - name: arrNodeId in: query required: true description: ArrNode ID schema: type: integer explode: false - name: daAipIdList in: query required: true description: DaAip ID list schema: type: array items: type: integer explode: false responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips /aip/bulk-create-selected-to-jp: post: operationId: Aip_bulkCreateSelectedToJp description: Bulk create from selected and connect to JP parameters: - name: arrNodeId in: query required: true description: ArrNode ID schema: type: integer explode: false - name: daAipIdList in: query required: true description: DaAip ID list schema: type: array items: type: integer explode: false - name: daLevelViewId in: query required: true description: DaLevelView ID schema: type: integer explode: false responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips /aip/connect-jp-from-selected: post: operationId: Aip_connectJpFromSelected description: Create JP from selected parameters: - name: arrNodeId in: query required: true description: ArrNode ID schema: type: integer explode: false - name: daAipId in: query required: true description: DaAip ID schema: type: integer explode: false - name: daDaoIdList in: query required: true description: DaDao ID List schema: type: array items: type: integer explode: false responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips /aip/connect-jp-link-from-selected: post: operationId: Aip_connectJpLinkFromSelected description: Create JP and link from selected parameters: - name: arrNodeId in: query required: true description: ArrNode ID schema: type: integer explode: false - name: daAipId in: query required: true description: DaAip ID schema: type: integer explode: false - name: daDaoIdList in: query required: true description: DaDao ID List schema: type: array items: type: integer explode: false responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips /aip/connect-part-to-jp: post: operationId: Aip_connectPartToJp description: Connect Part to JP parameters: - name: arrNodeId in: query required: true description: ArrNode ID schema: type: integer explode: false - name: daAipId in: query required: true description: DaAip ID schema: type: integer explode: false - name: daDaoIdList in: query required: true description: DaDao ID List schema: type: array items: type: integer explode: false responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips /aip/connect-selected-to-jp: post: operationId: Aip_connectSelectedToJp description: Connect selected to JP parameters: - name: arrNodeId in: query required: true description: ArrNode ID schema: type: integer explode: false - name: daAipId in: query required: true description: DaAip ID schema: type: integer explode: false - name: daDaoIdList in: query required: true description: DaDao ID List schema: type: array items: type: integer explode: false responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips /aip/connect-to-jp: post: operationId: Aip_connectToJp description: Connect to JP parameters: - name: arrNodeId in: query required: true description: ArrNode ID schema: type: integer explode: false - name: daAipId in: query required: true description: DaAip ID schema: type: integer explode: false responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips /aip/create-dao-link: post: operationId: Aip_createDaoLink description: Create dao link parameters: - name: aipId in: query required: true description: AIP ID schema: type: integer explode: false - name: daoId in: query required: true description: DAO ID schema: type: integer explode: false - name: nodeId in: query required: true description: Node ID schema: type: integer explode: false - name: linkType in: query required: true description: Link type schema: $ref: '#/components/schemas/LinkType' explode: false responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips /aip/create-dao-structure: post: operationId: Aip_createDaoStructure description: Create dao structure parameters: [] responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips requestBody: required: true content: application/json: schema: type: array items: type: integer description: Aip IDs /aip/dao-links/{nodeId}: get: operationId: Aip_getDaoLinks description: Get dao links for node by id parameters: - name: nodeId in: path required: true description: Node ID schema: type: integer responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/DaoLinksResult' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips /aip/delete-complete-aip: post: operationId: Aip_deleteCompleteAip description: Delete complete AIP parameters: [] responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips requestBody: required: true content: application/json: schema: type: array items: type: integer description: Aip IDs /aip/delete-dao-link: post: operationId: Aip_deleteDaoLink description: Delete dao link parameters: - name: daoLinkId in: query required: true description: Dao link ID schema: type: integer explode: false responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips /aip/delete-dao-structure: post: operationId: Aip_deleteDaoStructure description: Delete dao structure parameters: [] responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips requestBody: required: true content: application/json: schema: type: array items: type: integer description: Aip IDs /aip/download-complete-aip: post: operationId: Aip_downloadCompleteAip description: Download complete AIP parameters: [] responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips requestBody: required: true content: application/json: schema: type: array items: type: integer description: Aip IDs /aip/download-component/{fileId}: get: operationId: Aip_downloadComponent description: Getting the component file by file id parameters: - name: fileId in: path required: true description: File ID schema: type: integer responses: '102': description: Informational '200': description: The request has succeeded. content: '*/*': schema: type: string format: binary '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips /aip/export-aip: post: operationId: Aip_exportAip description: Export AIP parameters: [] responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips requestBody: required: true content: application/json: schema: type: array items: type: integer description: Aip IDs /aip/find/filter: post: operationId: Aip_findByFilter description: Find aips by filters parameters: - name: from in: query required: true schema: type: integer explode: false - name: count in: query required: true schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/AipDetailFilteredResult' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/AipFilterGen' description: Array of filters /aip/import-package: post: operationId: Aip_importPackage description: Import AIP package parameters: - name: digitalRepositoryId in: query required: true description: Digital repository ID schema: type: integer explode: false - name: aipType in: query required: true description: Aip package type schema: $ref: '#/components/schemas/AipType' explode: false responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips requestBody: required: true content: application/zip: schema: type: string format: binary /aip/levelViewTree: post: operationId: Aip_levelViewTree description: Get level view tree for aips with ids parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/TreeDataCustomGen' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips requestBody: required: true content: application/json: schema: type: array items: type: integer description: Aip IDs /aip/tree: post: operationId: Aip_tree description: Get level view tree for aips with ids parameters: - name: aipId in: query required: true description: Aip IDs schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/TreeDataCustomGen' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips /aip/update-aip: post: operationId: Aip_updateAip description: Update AIP parameters: - name: type in: query required: true description: Type of update schema: $ref: '#/components/schemas/AipUpdateType' explode: false responses: '200': description: The request has succeeded. '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips requestBody: required: true content: application/json: schema: type: array items: type: integer description: Aip IDs /aip/{aipId}: get: operationId: Aip_getAip description: Get aip detail by id parameters: - $ref: '#/components/parameters/AipIdParameter' responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/AipDetailVO' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - aips /binding/{bindingId}/history: get: operationId: AccessPointBinding_getBindingHistory description: |- Paginated history of binding revisions, newest first, built from ap_binding_state and ap_binding_participant. Participants within each revision are ordered by lastChange (ascending). parameters: - name: bindingId in: path required: true description: id of binding schema: type: integer - name: offset in: query required: false schema: type: integer default: 0 explode: false - name: limit in: query required: false description: server caps at 100 schema: type: integer default: 100 explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ExtHistory' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoint-internal /binding/{bindingId}/issues: get: operationId: AccessPointBinding_getBindingIssues description: List CAM-side issues attached to a binding. parameters: - name: bindingId in: path required: true description: id of binding schema: type: integer responses: '200': description: The request has succeeded. content: application/json: schema: type: array items: $ref: '#/components/schemas/ExtIssue' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - accesspoint-internal /daorepository: get: operationId: DaoRepository_fsRepos parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: type: array items: $ref: '#/components/schemas/FsRepo' /daos/aip/{aipId}: get: operationId: Dao_findByAipIdAndTypeAndDeleteChangeIsNull description: Získání stromu pro průzkumník aipu parameters: - name: aipId in: path required: true description: Identifikátor aipu schema: type: integer responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ExplorerTreeNode' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - daos /daos/component/{id}: get: operationId: Dao_getDaoViewRequestInfo description: Získání informací o da dao pro view request na digital repository parameters: - name: id in: path required: true description: Identifikátor da dao schema: type: integer responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/DaoViewRequestVO' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - daos /daos/{id}/change-scenario: post: operationId: Dao_changeLinkScenario description: Changing the dao connection scenario parameters: - name: id in: path required: true description: dao id schema: type: integer responses: '200': description: The request has succeeded. '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - daos requestBody: required: true content: application/json: schema: type: string description: new scenario /descItems/{fundVersionId}: delete: operationId: DescItem_deleteDescItem description: Delete attribute value parameters: - name: fundVersionId in: path required: true description: id version AS schema: type: integer responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ItemDataResult' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - descitems requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/NodeItem' description: attribute value /descItems/{fundVersionId}/create: put: operationId: DescItem_createDescItem description: Create attribute value parameters: - name: fundVersionId in: path required: true description: id version AS schema: type: integer responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ItemDataResult' tags: - descitems requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/NodeItem' description: new attribute value /descItems/{fundVersionId}/{createNewVersion}/update: put: operationId: DescItem_updateDescItem description: Update attribute value parameters: - name: fundVersionId in: path required: true description: id version AS schema: type: integer - name: createNewVersion in: path required: true description: create a new version or not? schema: type: boolean responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ItemDataResult' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - descitems requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/NodeItem' description: new attribute value /extsystem/property: get: operationId: ExternalSystem_allProperties description: Return list of all properties of external system parameters: - name: extSystemId in: query required: false description: external system id schema: type: integer explode: false - name: userId in: query required: false description: user id schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: type: array items: $ref: '#/components/schemas/ExtSystemProperty' tags: - externalsystems post: operationId: ExternalSystem_storeProperties description: Store one or more property of external system parameters: [] responses: '200': description: The request has succeeded. '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - externalsystems requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/ExtSystemProperty' description: request body delete: operationId: ExternalSystem_deleteProperties description: Delete one property of external system parameters: [] responses: '200': description: The request has succeeded. '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - externalsystems requestBody: required: true content: application/json: schema: type: array items: type: integer description: external system property id /extsystem/resync/{id}: post: operationId: ExternalSystem_externalSystemResync description: External system resync parameters: - name: id in: path required: true description: external system ID or CODE schema: type: string responses: '200': description: The request has succeeded. '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - externalsystems /fund: post: operationId: fund_createFund description: Created a new archive file (AS) parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Fund' '400': description: The server could not understand the request due to invalid syntax. tags: - funds requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateFund' get: operationId: fund_findFunds description: Search for archive files (AS) parameters: - name: fulltext in: query required: false description: vyhledávaný výraz schema: type: string explode: false - name: institutionIdentifier in: query required: false description: identifikátor instituce (podpora pro kód instituce i UUID přístupového bodu) schema: type: string explode: false - name: max in: query required: false description: maximální počet výsledků na stránku schema: type: integer default: 200 explode: false - name: from in: query required: false description: Od kolikátého záznamu se mají výsledky vracet (0 = žádné se nepřeskočí) schema: type: integer default: 0 explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/FindFundsResult' tags: - funds deprecated: true /fund/export: post: operationId: fund_exportFunds description: Export fonds parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: type: integer '400': description: The server could not understand the request due to invalid syntax. content: application/json: schema: $ref: '#/components/schemas/BaseException' '401': description: Access is unauthorized. content: application/json: schema: $ref: '#/components/schemas/BaseException' '403': description: Access is forbidden. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - funds requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchParams' description: search parameters /fund/search: post: operationId: fund_searchFunds description: Search for funds parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/FindFundsResult' '400': description: The server could not understand the request due to invalid syntax. content: application/json: schema: $ref: '#/components/schemas/BaseException' '401': description: Access is unauthorized. content: application/json: schema: $ref: '#/components/schemas/BaseException' '403': description: Access is forbidden. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - funds requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchParams' description: search parameters /fund/{fundId}/fsrepo/{fsrepoId}/item-data: get: operationId: fund_fsRepoItemData description: Get file of data parameters: - $ref: '#/components/parameters/FundIdParameter' - $ref: '#/components/parameters/FsRepoIdParameter' - name: path in: query required: true description: file path in the repository schema: type: string explode: false responses: '200': description: The request has succeeded. content: '*/*': schema: type: string format: binary tags: - funds /fund/{fundId}/fsrepo/{fsrepoId}/items: get: operationId: fund_fsRepoItems description: Return list of filesystem items parameters: - $ref: '#/components/parameters/FundIdParameter' - $ref: '#/components/parameters/FsRepoIdParameter' - name: filterType in: query required: false description: Optional filter to return only folders or files. If not specified all items are returned schema: $ref: '#/components/schemas/FsItemType' explode: false - name: path in: query required: false description: Optional path in the repository schema: type: string explode: false - name: lastKey in: query required: false description: Optional parameter to return next batch of items. See FsItems for more details. schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/FsItems' tags: - funds /fund/{fundId}/fsrepo/{fsrepoId}/linkitem/{nodeId}: put: operationId: fund_fsCreateDAOLink description: Create DAO link parameters: - $ref: '#/components/parameters/FundIdParameter' - $ref: '#/components/parameters/FsRepoIdParameter' - $ref: '#/components/parameters/NodeIdParameter' - name: path in: query required: false schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: type: integer tags: - funds /fund/{fundId}/fsrepos: get: operationId: fund_fsRepos description: Return list of filesystem repositories parameters: - $ref: '#/components/parameters/FundIdParameter' responses: '200': description: The request has succeeded. content: application/json: schema: type: array items: $ref: '#/components/schemas/FsRepo' tags: - funds /fund/{fundId}/node/{nodeId}/mode: post: operationId: fund_setLevelMode description: Set mode (TREE/LIST) of ArrLevel parameters: - $ref: '#/components/parameters/FundIdParameter' - $ref: '#/components/parameters/NodeIdParameter' - name: list in: query required: true description: TREE (-> list = false), LIST (-> list = true) schema: type: boolean explode: false responses: '200': description: The request has succeeded. '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - funds /fund/{fundId}/publication: get: operationId: FundPublication_listFundPublications description: |- Return the publications for a fund, newest first. The UI must paginate — the list can grow large. parameters: - $ref: '#/components/parameters/FundIdParameter' - name: publicationTypeId in: query required: false description: Optional filter on publication type. schema: type: integer explode: false - name: offset in: query required: false description: Offset for pagination. schema: type: integer default: 0 explode: false - name: limit in: query required: false description: Page size. schema: type: integer minimum: 1 maximum: 200 default: 50 explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/PublicationList' tags: - publication-internal post: operationId: FundPublication_createFundPublication description: |- Enqueue a new publication for the current open version of the fund. Rejected with 409 if the current fund version already has a publication of the same type in { parameters: - $ref: '#/components/parameters/FundIdParameter' responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/PublicationDetail' '403': description: Access is forbidden. content: application/json: schema: $ref: '#/components/schemas/BaseException' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' '409': description: The request conflicts with the current state of the server. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - publication-internal requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePublication' /fund/{fundId}/publication/{publicationId}: delete: operationId: FundPublication_invalidateFundPublication description: |- Invalidate a publication. The associated DMS file is deleted from disk; the { parameters: - $ref: '#/components/parameters/FundIdParameter' - $ref: '#/components/parameters/PublicationIdParameter' responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' '403': description: Access is forbidden. content: application/json: schema: $ref: '#/components/schemas/BaseException' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - publication-internal /fund/{fundId}/publication/{publicationId}/copy: post: operationId: FundPublication_copyFundPublication description: |- Copy an existing publication into another target system. The target publication type must have a compatible filter setting (same { parameters: - $ref: '#/components/parameters/FundIdParameter' - $ref: '#/components/parameters/PublicationIdParameter' responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/PublicationDetail' '403': description: Access is forbidden. content: application/json: schema: $ref: '#/components/schemas/BaseException' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' '409': description: The request conflicts with the current state of the server. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - publication-internal requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CopyPublication' /fund/{fundId}/publication/{publicationId}/download: get: operationId: FundPublication_downloadFundPublication description: |- Download the prepared XML from the UI. Unlike the public { parameters: - $ref: '#/components/parameters/FundIdParameter' - $ref: '#/components/parameters/PublicationIdParameter' responses: '200': description: The request has succeeded. content: application/xml: schema: type: string format: binary '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' '410': description: Client error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - publication-internal /fund/{fundId}/usedItemtypes/{fundVersionId}: get: operationId: fund_usedItemTypes description: Return list of item type id & count parameters: - $ref: '#/components/parameters/FundIdParameter' - $ref: '#/components/parameters/FundVersionIdParameter' responses: '200': description: The request has succeeded. content: application/json: schema: type: array items: $ref: '#/components/schemas/UsedItemType' tags: - funds /fund/{id}: get: operationId: fund_getFund description: Getting the AS detail parameters: - name: id in: path required: true description: fund ID. Might be ID or fund UUID schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/FundDetail' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - funds put: operationId: fund_updateFund description: Update of archive file (AS) parameters: - name: id in: path required: true description: fund ID. Might be ID or fund UUID schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/FundDetail' '400': description: The server could not understand the request due to invalid syntax. '404': description: The server cannot find the requested resource. tags: - funds requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateFund' /fund/{id}/import: put: operationId: fund_importFundData description: Import additional data to the existing fund parameters: - name: id in: path required: true description: Fund ID. Might be ID or fund UUID schema: type: string responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' '400': description: The server could not understand the request due to invalid syntax. '406': description: Client error tags: - funds requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/ImportFundData' description: Doplnění způsobu importu /funds/sdo/type: get: operationId: Sdo_findStructureTypes description: 'GET Lists the possible data types that can be used in AS: findStructureTypes()' parameters: - name: fundVersionId in: query required: false description: fund version id schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: type: array items: $ref: '#/components/schemas/Sdo.Type' tags: - structure /funds/sdo/{fundId}: post: operationId: Sdo_createObject description: Creating object of the structured data type parameters: - name: fundId in: path required: true description: fund id schema: type: integer - name: value in: query required: false description: value for the structured data schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/StructuredObject' tags: - structure requestBody: required: true content: text/plain: schema: type: string description: structured data type code delete: operationId: Sdo_deleteObjects description: Deleting a value(s) of a structured data type parameters: - name: fundId in: path required: true description: fund id schema: type: integer - name: fundVersionId in: query required: false description: fund version id schema: type: integer explode: false responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - structure requestBody: required: true content: application/json: schema: type: array items: type: integer description: list of id value(s) of structured data type /funds/sdo/{fundId}/assignable/{assignable}: post: operationId: Sdo_setDataAssignable description: Assignability settings. parameters: - name: fundId in: path required: true description: fund id schema: type: integer - name: assignable in: path required: true description: assignable value schema: type: boolean responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' tags: - structure requestBody: required: true content: application/json: schema: type: array items: type: integer description: value ids for a structured data type /funds/sdo/{fundId}/batchUpdate/{structureTypeCode}: post: operationId: Sdo_updateObjects description: Bulk update of items/values of a structural type parameters: - name: fundId in: path required: true description: fund id schema: type: integer - name: structureTypeCode in: path required: true description: structure type code schema: type: string responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' tags: - structure requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Sdo.BatchUpdateParam' description: batch of data to update /funds/sdo/{fundId}/extension/{structureTypeCode}: get: operationId: Sdo_findFundStructureExtension description: 'GET Finds available and enabled AS extensions: findFundStructureExtension()' parameters: - name: fundId in: path required: true description: fund id schema: type: integer - name: structureTypeCode in: path required: true description: structure type code schema: type: string - name: fundVersionId in: query required: false description: fund version id schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: type: array items: $ref: '#/components/schemas/Sdo.ExtensionFund' tags: - structure put: operationId: Sdo_setFundStructureExtensions description: 'PUT Sets a specific extension on the AS: setFundStructureExtensions()' parameters: - name: fundId in: path required: true description: fund id schema: type: integer - name: structureTypeCode in: path required: true description: structure type code schema: type: string responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' tags: - structure requestBody: required: true content: application/json: schema: type: array items: type: string description: structure ext codes /funds/sdo/{fundId}/item/{structuredObjectId}: post: operationId: Sdo_createItem description: Create item value of a structured data type parameters: - name: fundId in: path required: true description: fund id schema: type: integer - name: structuredObjectId in: path required: true description: structure data id schema: type: integer responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Sdo.ItemResult' tags: - structure requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StructuredObjectItem' description: node item get: operationId: Sdo_getFormStructureItems description: 'GET Getting data for a structured data type form: getFormStructureItems()' parameters: - name: fundId in: path required: true description: fund id schema: type: integer - name: structuredObjectId in: path required: true description: structured object id schema: type: integer - name: fundVersionId in: query required: false description: fund version id schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/StructuredObjectItems' tags: - structure /funds/sdo/{fundId}/item/{structuredObjectId}/by-type/{itemTypeId}: delete: operationId: Sdo_deleteItemsByType description: Delete items based on the value of a data type structure by attribute type parameters: - name: fundId in: path required: true description: fund id schema: type: integer - name: structuredObjectId in: path required: true description: structured object id schema: type: integer - name: itemTypeId in: path required: true description: item type id schema: type: integer responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - structure /funds/sdo/{fundId}/item/{structuredObjectId}/{createNewVersion}: put: operationId: Sdo_updateItem description: Update item value of a structured data type parameters: - name: fundId in: path required: true description: fund id schema: type: integer - name: structuredObjectId in: path required: true description: structure data id schema: type: integer - name: createNewVersion in: path required: true description: create a new version schema: type: boolean responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Sdo.ItemResult' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - structure requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StructuredObjectItem' description: node item /funds/sdo/{fundId}/item/{structuredObjectId}/{itemObjectId}: delete: operationId: Sdo_deleteItem description: Delete item value of a structured data type parameters: - name: fundId in: path required: true description: fund id schema: type: integer - name: structuredObjectId in: path required: true description: structured object id schema: type: integer - name: itemObjectId in: path required: true description: item object id schema: type: integer responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - structure /funds/sdo/{fundId}/search/{structureTypeCode}: get: operationId: Sdo_findStructObj description: 'GET Searching for values of a structured data type: findStructObj()' parameters: - name: fundId in: path required: true description: fund id schema: type: integer - name: structureTypeCode in: path required: true description: structure type code schema: type: string - name: search in: query required: false description: text for filtering (optional) schema: type: string explode: false - name: assignable in: query required: false description: assignable value schema: type: boolean explode: false - name: from in: query required: false description: from default = 0 schema: type: integer default: 0 explode: false - name: count in: query required: false description: max number of items schema: type: integer default: 200 explode: false - name: fundVersionId in: query required: false description: fund version id schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Sdo.FindResult' tags: - structure /funds/sdo/{fundId}/{structuredObjectId}: get: operationId: Sdo_getObject description: Getting the value of a structured data type parameters: - name: fundId in: path required: true description: fund id schema: type: integer - name: structuredObjectId in: path required: true description: structure data id schema: type: integer - name: fundVersionId in: query required: false description: fund version id schema: type: integer explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/StructuredObject' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - structure /funds/sdo/{fundId}/{structuredObjectId}/confirm: post: operationId: Sdo_confirm description: Confirms the value of a structured data type. Sets the value parameters: - name: fundId in: path required: true description: fund id schema: type: integer - name: structuredObjectId in: path required: true description: structure data id schema: type: integer responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/StructuredObject' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - structure /funds/sdo/{fundId}/{structuredObjectId}/copy: post: operationId: Sdo_copyObject description: Creating duplicates of a structured data type and an auto-increment field parameters: - name: fundId in: path required: true description: fund id schema: type: integer - name: structuredObjectId in: path required: true description: structure data id schema: type: integer responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' tags: - structure requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Sdo.CopyObjectParam' description: batch of data to create /io/export: post: operationId: Io_exportRequest description: Create export file of funds or access points parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: type: integer tags: - io requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExportParams' description: Export request parameters /io/export-status/{requestId}: get: operationId: Io_getExportStatus description: Getting the export status by request id parameters: - name: requestId in: path required: true schema: type: integer responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ExportRequestStatus' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - io /io/file/{requestId}: get: operationId: Io_getExportFile description: Getting the generated file by request id parameters: - name: requestId in: path required: true schema: type: integer responses: '102': description: Informational '200': description: The request has succeeded. content: '*/*': schema: type: string format: binary '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - io /node/copyOlderSiblingAttribute: put: operationId: Node_copyOlderSiblingAttribute description: Copies the attribute of the specified type from the node's parent parameters: - name: versionId in: query required: true description: version id of tree schema: type: integer explode: false - name: descItemTypeId in: query required: true description: id of the attribute we want to copy schema: type: integer explode: false responses: '200': description: The request has succeeded. tags: - node requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/NodeBase' description: node to assign values from the older brother /node/info/id/{nodeId}: get: operationId: Node_getNodeInfoById description: Get basic information about a node by its numeric ID. parameters: - $ref: '#/components/parameters/NodeIdParameter' responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/NodeInfo' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' '409': description: The request conflicts with the current state of the server. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - node /node/info/uuid/{nodeUuid}: get: operationId: Node_getNodeInfoByUuid description: Get basic information about a node by its UUID. parameters: - name: nodeUuid in: path required: true description: Node UUID (36 characters) schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/NodeInfo' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' '409': description: The request conflicts with the current state of the server. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - node /node/node-data: post: operationId: Node_getNodeData description: Get data for a unit of description (JP) parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/NodeData' tags: - node requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/NodeDataParam' /node/plain-text/{fundVersionId}/{nodeId}: get: operationId: Node_getPlainText description: Get quote by fundVersionId & nodeId parameters: - name: fundVersionId in: path required: true schema: type: integer - name: nodeId in: path required: true schema: type: integer responses: '200': description: The request has succeeded. content: application/json: schema: type: array items: $ref: '#/components/schemas/Node.PlainTextRepresentation' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - node /node/search: post: operationId: Node_search description: Search for archive files (funds) parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/NodeSearchResult' '400': description: The server could not understand the request due to invalid syntax. content: application/json: schema: $ref: '#/components/schemas/BaseException' '401': description: Access is unauthorized. content: application/json: schema: $ref: '#/components/schemas/BaseException' '403': description: Access is forbidden. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - node requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchParams' description: search parameters /node/search/{fundId}: get: operationId: Node_getSearchResult description: Search for nodes in archive file (fund) parameters: - $ref: '#/components/parameters/FundIdParameter' responses: '200': description: The request has succeeded. content: application/json: schema: type: array items: $ref: '#/components/schemas/NodeTreeData' '400': description: The server could not understand the request due to invalid syntax. content: application/json: schema: $ref: '#/components/schemas/BaseException' '401': description: Access is unauthorized. content: application/json: schema: $ref: '#/components/schemas/BaseException' '403': description: Access is forbidden. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - node /publication/types: get: operationId: PublicationTypeAdmin_listPublicationTypes description: Return all publication types, including inactive ones. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: type: array items: $ref: '#/components/schemas/PublicationType' tags: - publication-internal post: operationId: PublicationTypeAdmin_createPublicationType description: Create a new publication type. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/PublicationType' '409': description: The request conflicts with the current state of the server. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - publication-internal requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PublicationType' /publication/types/{id}: put: operationId: PublicationTypeAdmin_updatePublicationType description: Update an existing publication type. parameters: - name: id in: path required: true schema: type: integer responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/PublicationType' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' '409': description: The request conflicts with the current state of the server. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - publication-internal requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PublicationType' delete: operationId: PublicationTypeAdmin_deletePublicationType description: |- Remove a publication type. Deactivating via { parameters: - name: id in: path required: true schema: type: integer responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' '409': description: The request conflicts with the current state of the server. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - publication-internal /publications/available/{targetSystem}: get: operationId: Publication_getAvailablePublications description: |- Get the list of prepared XML exports for a given target system. On the first call `lastTransaction` is omitted. The response carries `nextTransaction`, which the caller stores and sends in the next request as `lastTransaction`. This way only new exports since the previous call are returned. At most 100 records are returned. If multiple prepared exports exist for the same fund, only the most recent one is included. If the publication type (target system) is inactive, the call returns 403 — information about prepared exports is not exposed in that case. parameters: - name: targetSystem in: path required: true description: |- Publication type code (ARR_EXPORT_TYPE.code), which also identifies the target system. schema: type: string - name: lastTransaction in: query required: false description: |- Opaque key of the last already-processed transaction. Omitted on the first call. The caller must not parse the key — Elza reserves the right to change its format in the future. schema: type: string explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/AvailablePublications' '403': description: Access is forbidden. content: application/json: schema: $ref: '#/components/schemas/BaseException' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - publication /publications/download/{id}: get: operationId: Publication_downloadPublication description: |- Download the prepared XML. The client should only call this with an ID it received from `/available`. The download succeeds as long as the XML file is physically present on the server; each successful download updates the internal audit trail of the last fetch. The file is returned as `application/xml` with header `Content-Disposition: attachment; filename="{mark}-{fundNumber}-{publicationId}.xml"`. If the fund has neither `mark` nor `fundNumber` set, the fallback `fundId-{fundId}-{publicationId}.xml` is used. HTTP responses: - 200 + XML — the file is available - 403 — the publication type has been deactivated - 404 — unknown ID, or an ID in an internal state that is not exposed to the client (e.g. preparation in progress — such IDs are never returned by `/available` and the client should not encounter them) - 410 — the file is permanently unavailable to the client (publication invalidated by the user, or retention expired) parameters: - name: id in: path required: true description: Publication identifier (ARR_EXPORT.export_id). schema: type: integer responses: '200': description: The request has succeeded. content: application/xml: schema: type: string format: binary '403': description: Access is forbidden. content: application/json: schema: $ref: '#/components/schemas/BaseException' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' '410': description: Client error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - publication /publications/status/{id}: post: operationId: Publication_reportPublicationStatus description: |- Report the publication outcome from the publication system. The client reports the outcome of a publication it has been working with — typically after a successful `/download/{id}`, but a report from a publication that was prepared and not yet marked as fetched is also accepted (e.g. when the download response was lost in transit but the publication system still processed the file). - status OK — publication succeeded - status ERROR — publication failed The call is last-writer-wins: a publication system that gets resynchronised may report the same publication any number of times — identical replays are no-ops, new values silently overwrite. Rate-limiting / conflict detection may be added in a later revision. parameters: - name: id in: path required: true description: Publication identifier (ARR_EXPORT.export_id). schema: type: integer responses: '200': description: The request has succeeded. '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - publication requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PublicationStatusReport' /report/definitions: get: operationId: Report_getDefinitions description: |- Getting a list of categories and report definitions parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: type: array items: $ref: '#/components/schemas/Report.ReportCategory' tags: - report /report/generate/{code}: post: operationId: Report_generateReport description: Run generating statistics parameters: - name: code in: path required: true description: statistický kód pro generování schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: type: integer tags: - report requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Report.ReportParameters' description: hodnoty zadaných parametrů /report/status/{requestId}: get: operationId: Report_getReportStatus description: Get the status of running statistics parameters: - name: requestId in: path required: true schema: type: integer responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/RequestProcessState' '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - report /report/{requestId}: get: operationId: Report_getReport description: Download statistics results by request id parameters: - name: requestId in: path required: true schema: type: integer - name: format in: query required: true schema: $ref: '#/components/schemas/Report.ReportFormat' explode: false responses: '102': description: Informational '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/Report.ReportData' text/csv: schema: type: string format: binary '404': description: The server cannot find the requested resource. content: application/json: schema: $ref: '#/components/schemas/BaseException' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - report /rules/itemTypes: get: operationId: Rules_listItemTypes description: |- Returns all item types defined across loaded rule sets, together with their specifications and rendering hints. Public URL: `GET /api/v1/rules/itemTypes`. Localized strings (`name`, `shortcut`, `description` on `ItemType` and `ItemTypeSpec`, plus `name` on `ItemTableColumn`) honour the `Accept-Language` request header when provided; otherwise the server default language is used. Replaces the legacy `GET /api/rule/descItemTypes`. parameters: - name: Accept-Language in: header required: false description: Preferred language for localized strings (e.g. "cs", "en"). schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ItemTypeList' tags: - rules /rules/partTypes: get: operationId: Rules_listPartTypes description: |- Returns all types of parts. Public URL: `GET /api/v1/rules/partTypes`. Replaces the legacy `GET /api/structure/part-type`. parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: type: array items: $ref: '#/components/schemas/PartType' tags: - rules /search-ap: post: operationId: Search_entity description: Searches for entity parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ResultEntityRef' '400': description: The server could not understand the request due to invalid syntax. content: application/json: schema: $ref: '#/components/schemas/BaseException' '401': description: Access is unauthorized. content: application/json: schema: $ref: '#/components/schemas/BaseException' '403': description: Access is forbidden. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - search requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchParams' description: search parameters /search-arr: post: operationId: Search_archDesc description: Searches for array descriptions parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ResultEntityRef' '400': description: The server could not understand the request due to invalid syntax. content: application/json: schema: $ref: '#/components/schemas/BaseException' '401': description: Access is unauthorized. content: application/json: schema: $ref: '#/components/schemas/BaseException' '403': description: Access is forbidden. content: application/json: schema: $ref: '#/components/schemas/BaseException' tags: - search requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchParams' description: search parameters /tasks/my: get: operationId: Tasks_getMyTasks description: Task list for a given user parameters: [] responses: '200': description: The request has succeeded. content: application/json: schema: type: array items: $ref: '#/components/schemas/Tasks.ViewDetail' tags: - tasks components: parameters: AipIdParameter: name: aipId in: path required: true description: Aip ID schema: type: integer FsRepoIdParameter: name: fsrepoId in: path required: true description: FileSystem repository ID schema: type: integer FundIdParameter: name: fundId in: path required: true description: Fund ID schema: type: integer FundVersionIdParameter: name: fundVersionId in: path required: true description: Fund ID Version schema: type: integer NodeIdParameter: name: nodeId in: path required: true description: Node ID schema: type: integer PublicationIdParameter: name: publicationId in: path required: true description: Publication ID (ARR_EXPORT.export_id). schema: type: integer schemas: AbstractField: type: object required: - fieldType properties: fieldType: $ref: '#/components/schemas/FieldType' discriminator: propertyName: fieldType mapping: FONDS_FIELD: '#/components/schemas/FondsField' NODE_FIELD: '#/components/schemas/NodeField' DESC_ITEM: '#/components/schemas/DescItemField' description: Used as a parent for filter fields AbstractFilter: type: object required: - filterType properties: filterType: $ref: '#/components/schemas/FilterType' discriminator: propertyName: filterType mapping: fieldValue: '#/components/schemas/FieldValueFilter' contains: '#/components/schemas/MultimatchContainsFilter' logical: '#/components/schemas/LogicalFilter' description: Used as a parent for all other filters AccessPointBatchExportParams: type: object properties: search: type: string description: Full-text search apTypeId: type: integer description: Single AP-type id; subtree-expanded on the backend to include descendant types versionId: type: integer description: Fund version id (used to resolve scope context, optional) scopeId: type: integer description: Scope id; expanded on the backend for the resolved fund + user-visible scopes itemTypeId: type: integer description: Restrict to AP types referenced from this item type itemSpecId: type: integer description: Restrict to AP types referenced from this item specification state: allOf: - $ref: '#/components/schemas/ApStateApproval' description: Filter by access-point state revState: allOf: - $ref: '#/components/schemas/RevisionState' description: Filter by revision state searchFilter: allOf: - $ref: '#/components/schemas/ApAdvanceSearchFilter' description: Advanced filter (mirrors the body of /accesspoint/search) description: |- Body of POST /accesspoint/export. Mirrors the scalar parameters of /accesspoint/search and accepts the same advanced filter via { AccessPointSearchParams: type: object properties: search: type: string description: Full-text search from: type: integer description: Offset (zero-based) of the first result to return count: type: integer description: Maximum number of rows to return apTypeId: type: integer description: Single AP-type id; subtree-expanded on the backend versionId: type: integer description: Fund version id (used to resolve scope context, optional) scopeId: type: integer description: Scope id; expanded on the backend itemTypeId: type: integer description: Restrict to AP types referenced from this item type itemSpecId: type: integer description: Restrict to AP types referenced from this item specification state: allOf: - $ref: '#/components/schemas/ApStateApproval' description: Filter by access-point state revState: allOf: - $ref: '#/components/schemas/RevisionState' description: Filter by revision state searchTypeName: allOf: - $ref: '#/components/schemas/ApSearchType' description: Search strategy applied to access-point name (criteria-query path) searchTypeUsername: allOf: - $ref: '#/components/schemas/ApSearchType' description: Search strategy applied to user / username (criteria-query path) searchFilter: allOf: - $ref: '#/components/schemas/ApAdvanceSearchFilter' description: Advanced filter; same precedence rule as AccessPointBatchExportParams description: Body of POST /accesspoint/search. Admin.CopyPermissionParams: type: object required: - fromUserId properties: fromUserId: type: integer AdminInfo: type: object required: - funds - levels - accessPoints - users - loggedUsers properties: funds: type: integer format: int32 description: Number of funds levels: type: integer format: int32 description: Number of valid levels accessPoints: type: integer format: int32 description: Number of valid access points users: type: integer format: int32 description: Number of users loggedUsers: type: integer format: int32 description: Number of logged users description: Basic statistics about Elza instance AipDetailFilteredResult: type: object required: - count - rows properties: count: type: integer description: Počet výsledků rows: type: array items: $ref: '#/components/schemas/AipDetailVO' description: Seznam objektů AipDetailVO: type: object required: - aipId - code - digitalRepositoryId - aipVersion - fund - fundCode - institution - originatorInstitution - originator - unitdateFrom - unitdateTo - institutionCode - ingestionCode - referenceNumber - nadChangeCode - aipSize - metadataLoad - completeAipLoad - metadataError - metadataErrorException - aipVersionMetadata - importState - exportState - linkedNodes properties: aipId: type: integer description: Id AIPu code: type: string description: Kód AIPu digitalRepositoryId: type: integer description: Id digitálního repozitáře aipVersion: type: string description: Verze AIPu fund: allOf: - $ref: '#/components/schemas/ArrFundGen' description: Archivní soubor fundCode: type: string description: Kód archivního souboru institution: allOf: - $ref: '#/components/schemas/ParInstitutionGen' description: Instituce originatorInstitution: allOf: - $ref: '#/components/schemas/ParInstitutionGen' description: Instituce původce originator: type: string description: Původce unitdateFrom: type: string description: Datace od unitdateTo: type: string description: Datace do institutionCode: type: string description: Kód instituce ingestionCode: type: string description: Číslo příjemky referenceNumber: type: string description: Číslo jednací příjemky ve spisovce nadChangeCode: type: string description: Identifikátor vnější změny NAD v PEvA aipSize: type: integer description: Velikost AIPu v bytech metadataLoad: type: boolean description: Příznak načtených metadat completeAipLoad: type: boolean description: Příznak načteného kompletního AIPu metadataError: type: boolean description: Příznak chyby při načítání metadat metadataErrorException: type: string description: Chyby při načítání metadat aipVersionMetadata: type: string description: Verze AIPu s načtenými metadaty importState: allOf: - $ref: '#/components/schemas/QueueItemState' description: Stav importu exportState: allOf: - $ref: '#/components/schemas/QueueItemState' description: Stav exportu linkedNodes: type: array items: $ref: '#/components/schemas/LinkedNodeVO' description: Seznam napojených nodes description: Vo pro detail AIPu AipFilterCriteriaGen: type: string enum: - IS_NULL - IS_NOT_NULL - CONTAINS - DOES_NOT_CONTAIN - EQUALS - BETWEEN description: Způsob porovnání hodnot filtru AipFilterGen: type: object required: - attr - criteria - path properties: id: type: string description: UUID filtru attr: type: string description: Atribut, podle kterého chceme filtrovat value: type: string description: filtrovaná hodnota criteria: allOf: - $ref: '#/components/schemas/AipFilterCriteriaGen' description: Způsob porovnání from: type: string description: Hodnota od to: type: string description: Hodnota do path: type: string description: Cesta description: Filter aipu AipType: type: string enum: - PACKAGE_INFO - ARCHDESC - METADATA_BASE - AIP_BASE - AIP_RAW description: Aip package type AipUpdateType: type: string enum: - DB_UPDATE - DOWNLOAD_UPDATE - FORCE_UPDATE description: AIP update type ApAccessPointSearchResult: type: object required: - count - rows properties: count: type: integer format: int64 description: Total number of matches (before pagination) rows: type: array items: $ref: '#/components/schemas/ApAccessPointVO' description: One page of results description: Paginated access-point search result returned by /accesspoint/search. ApAccessPointVO: type: object description: |- Access-point view object returned by /accesspoint/search. Externally provided (see cz.tacr.elza.controller.vo.ApAccessPointVO) — kept opaque in the contract (the canonical yml emits `format: ap-access-point-vo` so the OpenAPI generator maps it to the hand-coded Java + TS class). ApAdvanceSearchFilter: type: object properties: search: type: string area: $ref: '#/components/schemas/ApSearchArea' onlyMainPart: type: boolean aeTypeIds: type: array items: type: integer code: type: string description: Identifier of a concrete access point user: type: string assignedTo: type: integer description: Id of user the access point is assigned to validationResult: type: string description: 'Validation result: ok | error' creation: type: string extinction: type: string relFilters: type: array items: $ref: '#/components/schemas/ApSearchByRelation' extFilters: type: array items: $ref: '#/components/schemas/ApSearchByItemWithValue' syncState: $ref: '#/components/schemas/SyncState' excludeAps: type: array items: type: integer description: List of access-point ids to exclude from the result description: Advanced filter for access-point search; used as the request body of /accesspoint/search. ApPartFormVO: type: object format: partform description: Data for create/update a part (external) ApSearchArea: type: string enum: - PREFER_NAMES - ALL_NAMES - ALL_PARTS - ENTITY_CODE description: Area in which the access-point search runs. ApSearchByItemWithValue: type: object properties: partTypeCode: type: string itemTypeId: type: integer itemSpecId: type: integer value: {} description: |- Filter for searching by an item with a specific value. The { ApSearchByRelation: type: object properties: relTypeId: type: integer relSpecId: type: integer code: type: integer description: Access-point id the relation must point to description: Filter for searching by a relation (item type, specification, target AP id). ApSearchType: type: string enum: - DISABLED - JOIN - FULLTEXT - RIGHT_SIDE_LIKE description: Search strategy for criteria-based access-point queries (name / username fields). ApStateApproval: type: string enum: - NEW - TO_APPROVE - APPROVED - TO_AMEND description: States of ApState ApStateUpdate: type: object required: - stateApproval properties: typeId: type: integer description: id of type scopeId: type: integer description: id of scope comment: type: string description: comment stateApproval: allOf: - $ref: '#/components/schemas/ApStateApproval' description: state of ApState description: Data for changing state of ApAccessPoint ApValidationIssues: type: object required: - errors - partErrors properties: errors: type: array items: type: string partErrors: type: array items: $ref: '#/components/schemas/PartValidationIssues' description: Entity validation issues/errors ArrFundGen: type: object required: - id - name - internalCode - fundNumber - mark - createDate - institutionId - unitdate properties: id: type: integer description: Identifikátor name: type: string description: Název internalCode: type: string description: Kód fundNumber: type: integer description: Číslo mark: type: string description: Značka createDate: type: string description: Datum vytvoření institutionId: type: integer description: ID instituce archivního souboru unitdate: type: string description: Unitdate description: Archivní soubor AutoValue: type: object properties: itemTypeId: type: integer description: identifier of the type of the description element itemSpecId: type: integer description: identifier of the specification of the description element value: type: string description: value of the element description: Automatically generated elements of the description AvailablePublication: type: object required: - publicationId - fundId - fundVersionId - createdTime - publicationType properties: publicationId: type: integer description: Publication identifier (ARR_EXPORT.export_id). fundId: type: integer description: Archival fund identifier. fundVersionId: type: integer description: Identifier of the fund version the export was created from. createdTime: type: string format: date-time description: Time the publication request was created. lastChangeId: type: integer description: |- ID of the last fund change included in the export (reference to arr_change). May be null if the originating change has been removed from arr_change — the XML content itself is not affected. publicationType: type: string description: |- Export data format expressed as the URI of the target XSD namespace. The client should pick the schema to parse the XML with according to this value; unknown values should be ignored. Known values: - `http://elza.tacr.cz/schema/v2` — Elza native XML schema, version 2. The field is intentionally typed as a free-form string (not an enum) so that new formats can be introduced without a TypeSpec change. description: |- Entry in the list of prepared exports. The archival institution code and NAD are not part of this header — they are contained in the XML. AvailablePublications: type: object required: - nextTransaction - items properties: nextTransaction: type: string description: |- Transaction identifier the caller should send in the next request as `lastTransaction`. When `items` is empty, the same value as the input is returned. items: type: array items: $ref: '#/components/schemas/AvailablePublication' description: |- List of prepared exports after `lastTransaction` (exclusive), ordered ascending by internal transaction. At most 100 records are returned. If multiple prepared exports exist for the same fund with the same export parameters (target system and filter), only the most recent one is returned — superseded entries are suppressed so the recipient does not have to download already-obsolete versions. Records that do not currently have a downloadable file (e.g. removed by retention or invalidated) are not returned. description: |- Page of prepared exports for a given target system. The caller remembers the `nextTransaction` value from the response and sends it back in the next request as `lastTransaction`. The value is an opaque key from the caller's perspective — its internal structure may change in the future and must not be parsed by the caller. BaseCode: type: object required: - id - code - name properties: id: type: integer description: Identifikátor code: type: string description: Kód name: type: string description: Název description: Souhrný model pro enumy BaseException: type: object required: - type - code properties: type: type: string code: type: string message: type: string level: type: string properties: type: object stackTrace: type: string description: Error specification for the client BaseItem: type: object properties: id: type: integer description: id of item itemObjectId: type: integer description: id value of item position: type: integer description: pozition undefined: type: boolean description: no value itemTypeId: type: integer description: id type of item itemSpecId: type: integer description: id spec of item readOnly: type: boolean description: value cannot be changed data: allOf: - $ref: '#/components/schemas/ItemData' description: item data BulkAction: type: object required: - code - name - fastAction properties: code: type: string description: Kód akce name: type: string description: Název akce description: type: string description: Popis akce fastAction: type: boolean description: Příznak rychlé akce description: Hromadná akce, kterou lze spustit nad fondem. BulkActionRunState: type: string enum: - WAITING - PLANNED - RUNNING - FINISHED - ERROR - INTERRUPTED - OUTDATED description: Stav běhu hromadné akce. ConnectionType: type: string enum: - DEVELOPMENT - TEST - PRODUCTION description: Kind of target environment a publication type connects to. CopyAccessPointDetail: type: object required: - scope properties: scope: type: string description: code of scope or id replace: type: boolean description: if the original AP should be replaced skipItems: type: array items: type: integer description: list of description element IDs not to copy description: Additional copy options CopyPublication: type: object required: - targetPublicationTypeId properties: targetPublicationTypeId: type: integer description: Identifier of the publication type to copy the export into. description: |- Body of POST /fund/{fundId}/publication/{publicationId}/copy — copy an existing prepared export into another target system. The target type must have a compatible filter setting. CreateFund: type: object required: - name - ruleSetCode - institutionIdentifier - scopes properties: name: type: string description: Název ruleSetCode: type: string description: Kód pravidel institutionIdentifier: type: string description: Identifikátor instituce (podpora pro kód instituce i UUID přístupového bodu) internalCode: type: string description: Interní kód uuid: type: string description: UUID - identifikátor AS (pokud není vyplněno, bude vygenerováno) fundNumber: type: integer description: Číslo archivního souboru unitdate: type: string description: Datace mark: type: string description: Značka archivního souboru adminUsers: type: array items: type: integer description: Seznam uživatelů, kteří mají administrátorská oprávnění pro zakládaný AS adminGroups: type: array items: type: integer description: Seznam skupin, kteří mají administrátorská oprávnění pro zakládaný AS scopes: type: array items: type: string minItems: 1 description: Seznam oblastí entit description: Zakládaný archivní souboru CreatePublication: type: object required: - publicationTypeId properties: publicationTypeId: type: integer description: Identifier of the publication type to publish into. description: |- Body of POST /fund/{fundId}/publication — request to enqueue a new publication for the current open version of the fund. CreatedPart: type: object required: - partId - apVersion properties: partId: type: integer apVersion: type: integer description: Result of creating a part DaDaoType: type: string enum: - REPRESENTATION - LOGICAL - FILE - METAAMD - METADMDINHERENT - METADMDCONTEXTUAL description: Dao type DaoLink: type: object required: - daoLinkUuid - aipId - name properties: daoLinkId: type: integer description: Dao link ID daoLinkUuid: type: string description: Dao link UUID aipId: type: integer description: Aip ID daoId: type: integer description: Dao ID daoCode: type: string description: Dao code daoType: allOf: - $ref: '#/components/schemas/DaDaoType' description: Dao type name: type: string description: Komponent name path: type: string description: Cesta k dao childrenCount: type: integer description: Number of children components children: description: Link on children components type: array items: $ref: '#/components/schemas/DaoLink' description: Dao link DaoLinksResult: type: object properties: items: type: array items: $ref: '#/components/schemas/DaoLink' description: List of dao links DaoViewRequestVO: type: object required: - daoId - entityRef - viewUrl properties: daoId: type: string description: Identifikátor aipu - aip.code entityRef: type: string description: Identifikátor dao - dao.code viewUrl: type: string description: Url pro zobratení komponenty description: Model DaoVireRequest DataBit: type: object required: - bitValue properties: bitValue: type: boolean allOf: - $ref: '#/components/schemas/ItemData' description: ItemData classes extensions DataCoordinates: type: object required: - value properties: value: type: string allOf: - $ref: '#/components/schemas/ItemData' DataDate: type: object required: - value properties: value: type: string format: date allOf: - $ref: '#/components/schemas/ItemData' DataDecimal: type: object required: - value properties: value: type: number format: decimal allOf: - $ref: '#/components/schemas/ItemData' DataEnum: type: object allOf: - $ref: '#/components/schemas/ItemData' DataFileRef: type: object required: - fileId properties: fileId: type: integer allOf: - $ref: '#/components/schemas/ItemData' DataFormattedText: type: object required: - value properties: value: type: string allOf: - $ref: '#/components/schemas/ItemData' DataInteger: type: object required: - integerValue properties: integerValue: type: integer allOf: - $ref: '#/components/schemas/ItemData' DataJsonTable: type: object required: - value properties: value: type: string allOf: - $ref: '#/components/schemas/ItemData' DataRecordRef: type: object required: - value properties: value: type: integer allOf: - $ref: '#/components/schemas/ItemData' DataString: type: object required: - stringValue properties: stringValue: type: string allOf: - $ref: '#/components/schemas/ItemData' DataStructureRef: type: object required: - structuredObjectId properties: structuredObjectId: type: integer allOf: - $ref: '#/components/schemas/ItemData' DataText: type: object required: - textValue properties: textValue: type: string allOf: - $ref: '#/components/schemas/ItemData' DataType: type: string enum: - INT - STRING - TEXT - UNITDATE - UNITID - FORMATTED_TEXT - COORDINATES - RECORD_REF - DECIMAL - STRUCTURED - ENUM - FILE_REF - JSON_TABLE - DATE - URI_REF - BIT description: Data types for ItemData classes DataUnitdate: type: object required: - value properties: value: type: string allOf: - $ref: '#/components/schemas/ItemData' DataUnitid: type: object required: - unitId properties: unitId: type: string allOf: - $ref: '#/components/schemas/ItemData' DataUriRef: type: object required: - value properties: nodeId: type: integer value: type: string description: type: string refTemplateId: type: integer allOf: - $ref: '#/components/schemas/ItemData' DeleteAccessPointDetail: type: object properties: replacedBy: type: string description: Id of the entity being replaced replaceType: allOf: - $ref: '#/components/schemas/ReplaceType' description: method of replacing description: Data for detele/replace ApAccessPoint DeleteAccessPointsDetail: type: object required: - ids properties: ids: type: array items: type: string description: list of id or uuid description: Access point list DeletedEntity: type: object required: - accessPointId - name - apTypeId - deleteChangeId - deleteDate properties: accessPointId: type: integer description: id of access point name: type: string description: name of access point description: type: string description: pt_body + brief_desc apTypeId: type: integer description: id type of acces point bindingValue: type: string description: id in external system extSystemId: type: integer description: id external system deleteChangeId: type: integer description: id of deleteChange deleteDate: type: string format: date-time description: date of deletion replacedBy: type: integer description: id replaced access point description: Deleted archive entity DescItemField: type: object required: - typeCode properties: typeCode: type: string specCode: type: string allOf: - $ref: '#/components/schemas/AbstractField' description: Node (descItem) field names for filter DigitizationRequest: type: object required: - description - digitizationFrontdeskId - nodesCount - nodes properties: description: type: string digitizationFrontdeskId: type: integer nodesCount: type: integer nodes: type: array items: $ref: '#/components/schemas/NodeTreeData' allOf: - $ref: '#/components/schemas/Request' description: Náhrada `ArrDigitizationRequestVO` EntityRef: type: object required: - id - label properties: id: type: string description: id of entity label: type: string description: visible name of entity note: type: string description: optional description of entity description: Return value when copying ApAccessPoint ExplorerTreeNode: type: object required: - uuid - daoId - label - childFolders - childFiles - parentFolder - parentFolderLogical - linkedNodes properties: uuid: type: string description: Identifikátor nodu daoId: type: integer format: int32 description: Identifikátor da dao label: type: string description: Popisek nodu childFolders: type: array items: $ref: '#/components/schemas/ExplorerTreeNode' description: Seznam podsložek childFiles: type: array items: $ref: '#/components/schemas/ExplorerTreeNodeFile' description: Seznam podsouborů parentFolder: allOf: - $ref: '#/components/schemas/ExplorerTreeNode' description: Rodičovská složka parentFolderLogical: allOf: - $ref: '#/components/schemas/ExplorerTreeNode' description: Rodičovská složka v logické struktuře linkedNodes: type: array items: $ref: '#/components/schemas/LinkedNodeVO' description: Seznam připojených nodů description: Model ExplorerTreeNode ExplorerTreeNodeFile: type: object required: - daoFileId - checksum - checksumType - mimeType - size - filename - uuid - daoId - label - childFolders - childFiles - parentFolder - parentFolderLogical - linkedNodes - daoFileFolderId properties: daoFileId: type: integer checksum: type: string checksumType: type: string mimeType: type: string size: type: integer format: int32 imageHeight: type: integer imageWidth: type: integer sourceXDimensionUnit: type: string sourceXDimensionValue: type: integer sourceYDimensionUnit: type: string sourceYDimensionValue: type: integer duration: type: string description: type: string filename: type: string uuid: type: string description: Identifikátor nodu daoId: type: integer format: int32 description: Identifikátor da dao label: type: string description: Popisek nodu childFolders: type: array items: $ref: '#/components/schemas/ExplorerTreeNode' description: Seznam podsložek childFiles: description: Seznam podsouborů type: array items: $ref: '#/components/schemas/ExplorerTreeNodeFile' parentFolder: allOf: - $ref: '#/components/schemas/ExplorerTreeNode' description: Rodičovská složka parentFolderLogical: allOf: - $ref: '#/components/schemas/ExplorerTreeNode' description: Rodičovská složka v logické struktuře linkedNodes: type: array items: $ref: '#/components/schemas/LinkedNodeVO' description: Seznam připojených nodů daoFileFolderId: type: integer format: int32 isLogical: type: boolean description: Příznak logické struktury description: Model ExplorerTreeNodeFile ExportParams: type: object properties: apIds: type: array items: type: integer fundsSections: type: array items: $ref: '#/components/schemas/FundSections' exportFilter: type: string description: kód nebo ID filtru includeUUID: type: boolean default: true includeAccessPoints: type: boolean default: true includeDaos: type: boolean default: true description: zahrnout do exportu připojené digitální archivní objekty (DAO) description: Parameters of archive file export ExportRequestStatus: type: object required: - state properties: state: $ref: '#/components/schemas/RequestProcessState' progress: type: integer description: Status of request ExtEntityBinding: type: object required: - id - externalSystemId - externalSystemCode - value properties: id: type: integer externalSystemId: type: integer externalSystemCode: type: string description: |- Code of the external system. Marked deprecated on the Java VO, but still load-bearing for several action calls — kept until the callers migrate to externalSystemId. value: type: string description: Identifier of the entity in the external system. extState: type: string extRevision: type: string extUser: type: string extReplacedBy: type: string detailUrlExtReplacedBy: type: string syncState: $ref: '#/components/schemas/SyncState' syncProgress: $ref: '#/components/schemas/SyncProgress' bindingItemList: type: array items: $ref: '#/components/schemas/ExtItemBinding' extMetadataRevision: type: string extPrevRevision: type: string extCreatedAt: type: string format: date-time description: Creation time of this revision in the external system. issueSummary: allOf: - $ref: '#/components/schemas/ExtIssueSummary' description: Pre-computed badge for the warning icon. Absent = no issues. description: |- One binding of an access point to an external system. Represents the entity's identity in that system together with sync/state metadata and (since CAMv2) per-revision metadata and issue summary. ExtHistory: type: object required: - revisions - totalCount - incomplete properties: revisions: type: array items: $ref: '#/components/schemas/ExtRevision' totalCount: type: integer description: total number of revisions known to Elza for this binding incomplete: type: boolean description: |- True when the chain has gaps (some extPrevRevision points to a revision Elza does not have). The UI then suggests consulting the source system. description: Paginated history of a binding, newest revision first. ExtIssue: type: object required: - id - severity properties: id: type: integer description: binding_issue_id uuid: type: string description: stable identifier from CAM, when provided severity: $ref: '#/components/schemas/ExtIssueSeverity' status: $ref: '#/components/schemas/ExtIssueStatus' ruleCode: type: string issueCode: type: string message: type: string source: type: string detail: type: string note: type: string issueFrom: type: string format: date-time description: valid-from timestamp from CAM extFromRev: type: string description: external revision in which the issue first appeared partId: type: integer description: referenced part of the AP, when applicable itemId: type: integer description: referenced item of the AP, when applicable relatedBindingId: type: integer description: related binding within the same external system, when applicable relatedBindingExtValue: type: string description: value of the related binding in the external system description: |- One issue/finding reported by CAM about an entity binding. Issues are not versioned in Elza — only the current state synced from CAM is kept. Issue references never cross external systems: relatedBindingId always points to a binding within the same external system as this entity. ExtIssueIconState: type: string enum: - NONE - NEUTRAL - NEW - ATTENTION description: |- Aggregated badge state computed by the server from all issues on a binding. NONE no issues NEUTRAL only WARNING issues with status IR_ALL_REVISIONS_OK / IR_REVISION_OK NEW at least one WARNING with status absent ATTENTION any ERROR, or any status = IR_FIX_NEEDED — single most prominent icon ExtIssueSeverity: type: string enum: - WARNING - ERROR description: Severity of a CAM-side issue attached to an entity binding. ExtIssueStatus: type: string enum: - IR_ALL_REVISIONS_OK - IR_FIX_NEEDED - IR_REVISION_OK description: |- Resolution state of an issue. Absent on the wire = new issue not yet evaluated by the user. ExtIssueSummary: type: object required: - count - iconState properties: count: type: integer description: total number of issues attached to the binding iconState: $ref: '#/components/schemas/ExtIssueIconState' description: |- Pre-computed badge for a binding, embedded in ExtEntityBinding so the client renders the warning icon without a second round-trip. ExtItemBinding: type: object required: - sync properties: partId: type: integer itemId: type: integer sync: type: boolean description: Binding of one part or item of an access point to an external entity. ExtParticipant: type: object required: - id - role - name - lastChange properties: id: type: integer description: binding_participant_id role: $ref: '#/components/schemas/ExtParticipantRole' name: type: string institutionCode: type: string lastChange: type: string format: date-time description: One person who participated on a binding revision. ExtParticipantRole: type: string enum: - AUTHOR - APPROVAL description: Role of a participant on an entity revision. ExtRevision: type: object required: - bindingStateId - participants properties: bindingStateId: type: integer description: binding_state_id extRevision: type: string extPrevRevision: type: string extMetadataRevision: type: string extCreatedAt: type: string format: date-time description: time of revision creation in the external system createChangeAt: type: string format: date-time description: fallback timestamp from arr_change when extCreatedAt is missing sender: type: string description: sender of the revision — value of ApBindingState.extUser participants: type: array items: $ref: '#/components/schemas/ExtParticipant' description: |- One revision in the binding's history, assembled from ap_binding_state with embedded participants from ap_binding_participant. Participants are returned ordered by lastChange (ascending). ExtSystemProperty: type: object required: - extSystemId - name - value properties: id: type: integer description: ext system property id userId: type: integer description: user id extSystemId: type: integer description: external system id name: type: string description: name of property value: type: string description: value of property description: Pairs name-value for external system and user FieldType: type: string enum: - FONDS_FIELD - NODE_FIELD - DESC_ITEM description: Type of field for FieldValueFilter FieldValueFilter: type: object required: - field - operation properties: field: allOf: - $ref: '#/components/schemas/AbstractField' description: searched field value: type: string description: searched value operation: allOf: - $ref: '#/components/schemas/OperationCompareType' description: operation type allOf: - $ref: '#/components/schemas/AbstractFilter' description: Compares specified attribute of the entity with specified value using specified operation FilterType: type: string enum: - fieldValue - contains - logical description: Types of filters FindFundsResult: type: object required: - funds - totalCount properties: funds: type: array items: $ref: '#/components/schemas/Fund' totalCount: type: integer description: Výsledek vyhledávání AS FondsField: type: object required: - fieldName properties: fieldName: $ref: '#/components/schemas/FondsFieldName' allOf: - $ref: '#/components/schemas/AbstractField' description: Fund field names for filter FondsFieldName: type: string enum: - fondsId - name - createDate - internalCode - fondsNumber - unitdate - mark - institutionId - institutionCode description: |- Funds specific field names Fields are used for FundsFilterField. FormItemSpec: type: object required: - itemSpecId - type - repeatable properties: itemSpecId: type: integer type: $ref: '#/components/schemas/MandatoryType' repeatable: type: boolean description: Náhrada `DescItemSpecLiteVO` FormItemType: type: object required: - itemTypeId - type - repeatable - undefinable - favoriteSpecIds properties: itemTypeId: type: integer description: identifikator typu type: allOf: - $ref: '#/components/schemas/MandatoryType' description: typ repeatable: type: boolean description: opakovatelnost undefinable: type: boolean description: 'počítanýstav počítanýho atributu: 0/1 vypnutý/zapnutýatribut se může nastavit jako nedefinovaný 0/1 - nemůže/může' specs: type: array items: $ref: '#/components/schemas/FormItemSpec' description: seznam specifikací atributu favoriteSpecIds: type: array items: type: integer description: seznam identifikátorů oblíbených specifikací u typu description: |- Odlehčená verze specifikace hodnoty atributu Náhrada `ItemTypeLiteVO` FsItem: type: object required: - itemType - name - lastChange properties: itemType: allOf: - $ref: '#/components/schemas/FsItemType' description: 'Type of item: file or folder' name: type: string description: File or folder name size: type: integer description: File size lastChange: type: string format: date-time description: Time of last change description: Single file system item FsItemType: type: string enum: - FOLDER - FILE description: File system item type FsItems: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/FsItem' lastKey: type: string description: Optional string to request next items. It is used if there are more items. description: Collection of file system items FsRepo: type: object required: - fsRepoId - name - path properties: fsRepoId: type: integer format: int32 description: Repository ID code: type: string description: Optional code of repository name: type: string description: Repository name path: type: string description: Repository path Fund: type: object required: - id - uuid - name - institutionIdentifier properties: id: type: integer description: Fonds identifier uuid: type: string description: Fonds UUID name: type: string description: Fonds name institutionIdentifier: type: string description: Archival institution identifier internalCode: type: string description: Internal organization fonds code createDate: type: string format: date-time description: Creation fonds date fundNumber: type: integer description: Archival fonds number unitdate: type: string description: Date range for the fonds mark: type: string description: Fonds mark description: Archival fonds described by basic information FundDetail: type: object required: - scopes - fundVersionId properties: scopes: type: array items: type: string description: Seznam oblastí entit fundVersionId: type: integer description: Active funds version allOf: - $ref: '#/components/schemas/Fund' description: Details about archival funds FundSearchResult: type: object required: - count - fundVersionId properties: count: type: integer description: počet JP nalezených v AS fundVersionId: type: integer description: identifikátor otevřené verze AS allOf: - $ref: '#/components/schemas/Fund' description: Archivní soubor pro výsledky vyhledávání FundSections: type: object required: - fundVersionId properties: fundVersionId: type: integer mergeSections: type: boolean default: false rootNodeIds: type: array items: type: integer description: Specifies multiple sections for fund version FundsActionGroup: type: object required: - ruleSetId - ruleSetCode - ruleSetName - fundCount - fundVersionIds - actions properties: ruleSetId: type: integer description: Identifikátor pravidel ruleSetCode: type: string description: Kód pravidel ruleSetName: type: string description: Název pravidel fundCount: type: integer description: Počet fondů ve skupině fundVersionIds: type: array items: type: integer description: Identifikátory otevřených verzí fondů ve skupině actions: type: array items: $ref: '#/components/schemas/BulkAction' description: Hromadné akce dostupné pro tato pravidla ve vícefondovém režimu description: Skupina fondů sdílejících stejná pravidla spolu s dostupnými hromadnými akcemi. FundsActionGroupRequest: type: object properties: fundIds: type: array items: type: integer description: Identifikátory vybraných fondů search: type: string description: Filtr pro výběr všech odpovídajících fondů description: |- Požadavek na seskupení vybraných fondů podle pravidel pro spuštění hromadné akce nad více fondy. Vyplní se buď `fundIds` (explicitní výběr, má přednost), nebo `search` (všechny fondy odpovídající filtru). FundsActionGroupResult: type: object required: - groups - skipped properties: groups: type: array items: $ref: '#/components/schemas/FundsActionGroup' description: Skupiny fondů podle pravidel skipped: type: array items: $ref: '#/components/schemas/FundsActionSkipped' description: Přeskočené fondy description: Výsledek seskupení vybraných fondů pro spuštění hromadné akce nad více fondy. FundsActionSkipped: type: object required: - id - reason properties: id: type: integer description: Identifikátor fondu (při seskupení) nebo verze fondu (při spuštění) reason: type: string description: Důvod přeskočení (např. NO_OPEN_VERSION, ACTION_NOT_IN_RULESET) description: Přeskočený fond při přípravě nebo spuštění hromadné akce nad více fondy. FundsChangeRun: type: object required: - id - fundVersionId - code - state properties: id: type: integer description: Identifikátor běhu fundVersionId: type: integer description: Identifikátor verze fondu code: type: string description: Kód hromadné akce state: allOf: - $ref: '#/components/schemas/BulkActionRunState' description: Stav běhu datePlanned: type: string format: date-time description: Čas naplánování dateStarted: type: string format: date-time description: Čas zahájení dateFinished: type: string format: date-time description: Čas dokončení error: type: string description: Chybové hlášení description: Stav jednoho per-fond běhu v rámci vícefondového seskupení (pro sledování průběhu). ImportFundData: type: object properties: importType: type: string description: Import type. Only 'CSV' is supported dataFile: type: string format: binary description: File to upload required: - importType - dataFile IntViewDefinition: type: object required: - displayType properties: displayType: $ref: '#/components/schemas/ItemDisplayType' allOf: - $ref: '#/components/schemas/ItemViewDefinition' description: 'Display hint for INT items: numeric vs. duration formatting.' InvalidatedEntities: type: object required: - totalCount - page properties: totalCount: type: integer page: type: array items: $ref: '#/components/schemas/DeletedEntity' description: Deleted archive entities ItemData: type: object required: - dataType properties: dataId: type: integer description: data id dataType: allOf: - $ref: '#/components/schemas/DataType' description: data type discriminator: propertyName: dataType mapping: BIT: '#/components/schemas/DataBit' COORDINATES: '#/components/schemas/DataCoordinates' DATE: '#/components/schemas/DataDate' DECIMAL: '#/components/schemas/DataDecimal' FILE_REF: '#/components/schemas/DataFileRef' INT: '#/components/schemas/DataInteger' JSON_TABLE: '#/components/schemas/DataJsonTable' ENUM: '#/components/schemas/DataEnum' RECORD_REF: '#/components/schemas/DataRecordRef' STRING: '#/components/schemas/DataString' STRUCTURED: '#/components/schemas/DataStructureRef' TEXT: '#/components/schemas/DataText' FORMATTED_TEXT: '#/components/schemas/DataFormattedText' UNITDATE: '#/components/schemas/DataUnitdate' UNITID: '#/components/schemas/DataUnitid' URI_REF: '#/components/schemas/DataUriRef' description: Item data parent ItemDataResult: type: object properties: parent: allOf: - $ref: '#/components/schemas/NodeBase' description: parent node item: allOf: - $ref: '#/components/schemas/NodeItem' description: item description: Výsledek vytvoření nebo aktualizace ArrDescItem ItemDisplayType: type: string enum: - NUMBER - DURATION description: Display hint for items of `dataType == INT`. ItemTableColumn: type: object required: - code - name - dataType properties: code: type: string description: Column code. name: type: string description: Human-readable column name (localized). dataType: type: string description: Column data type — limited subset; see ELZA package XSD. width: type: integer description: Suggested column width. description: Column definition for items of `dataType == JSON_TABLE`. ItemType: type: object required: - id - code - name - shortcut - dataType - sortable properties: id: type: integer description: Database identifier of the underlying `rul_item_type` row. Not stable across deployments — use `code` for cross-system references. code: type: string description: Stable public code (e.g. "ZP2015_UNIT_ID"). name: type: string description: Human-readable name (localized). shortcut: type: string description: Short label for compact UI such as column headers (localized). description: type: string description: Longer description (localized). dataType: allOf: - $ref: '#/components/schemas/DataType' description: Underlying value type. sortable: type: boolean description: Whether items of this type can be used as a sort key. structureTypeCode: type: string description: |- For `dataType == STRUCTURED` only: code of the structure type whose template defines this item's nested fields. viewDefinition: allOf: - $ref: '#/components/schemas/ItemViewDefinition' description: Optional rendering hints; variant determined by `dataType`. specs: type: array items: $ref: '#/components/schemas/ItemTypeSpec' description: Available specifications, in display order. Empty/omitted ⇒ no specifications. description: |- Definition of one item type registered in the rules. Replaces the legacy `RulDescItemTypeExtVO` exposed via `GET /api/rule/descItemTypes`. Display order is given by the order of the response `itemTypes[]` array. Per-form behaviour (whether the item is required/recommended, whether it is repeatable in a given context, etc.) is **not** part of this registry — that information lives in `FormItemType` / `FormItemSpec`, returned by the node-form endpoints. ItemTypeGroup: type: object required: - code - name properties: code: type: string name: type: string types: type: array items: $ref: '#/components/schemas/FormItemType' description: |- Skupina zapouzdrující typy hodnot atributů pro UI Náhrada `ItemTypeGroupVO` ItemTypeList: type: object required: - itemTypes properties: itemTypes: type: array items: $ref: '#/components/schemas/ItemType' description: Item types defined across all loaded rule sets, in display order. description: Response payload for `GET /itemTypes`. ItemTypeSpec: type: object required: - id - code - name - shortcut properties: id: type: integer description: Database identifier of the underlying `rul_item_spec` row. Not stable across deployments — use `code` for cross-system references. code: type: string description: Stable public code. name: type: string description: Human-readable name (localized). shortcut: type: string description: Short label for compact UI (localized). description: type: string description: Longer description (localized). description: |- A specification (enumerated value) of an item type. Display order is given by the order of the parent `specs[]` array. ItemViewDefinition: type: object required: - dataType properties: dataType: $ref: '#/components/schemas/DataType' discriminator: propertyName: dataType mapping: INT: '#/components/schemas/IntViewDefinition' STRING: '#/components/schemas/StringViewDefinition' JSON_TABLE: '#/components/schemas/JsonTableViewDefinition' description: |- Optional rendering hints for an `ItemType`. Discriminated by `dataType`. Item types whose data type has no rendering hint (DATE, COORDINATES, RECORD_REF, …) simply omit `viewDefinition` on `ItemType`. JsonTableViewDefinition: type: object required: - tableColumns properties: tableColumns: type: array items: $ref: '#/components/schemas/ItemTableColumn' allOf: - $ref: '#/components/schemas/ItemViewDefinition' description: Column definitions for JSON_TABLE items. LinkType: type: string enum: - AIP - PART_AIP - COMPONENT_AIP description: Link type LinkedNodeVO: type: object required: - id - nodeId - name properties: id: type: integer description: Identifikátor linku nodeId: type: integer description: Identifikátor node name: type: string description: Jméno node LoggedUser: type: object required: - userId - user - remoteAddr properties: userId: type: integer description: User ID user: type: string description: username remoteAddr: type: string description: Remote address description: Logged user LoggedUsers: type: object required: - users - totalCount properties: users: type: array items: $ref: '#/components/schemas/LoggedUser' description: User list totalCount: type: integer format: int32 description: Total number of logged users description: List of logged users LogicalFilter: type: object required: - filters - operation properties: filters: description: collection of filters type: array items: $ref: '#/components/schemas/AbstractFilter' operation: allOf: - $ref: '#/components/schemas/OperationLogicalType' description: operation type allOf: - $ref: '#/components/schemas/AbstractFilter' description: Join subfilters using logical operator, result may be used in other LogicalFilter as one of subfilter MandatoryType: type: string enum: - REQUIRED - RECOMMENDED - POSSIBLE - IMPOSSIBLE description: Item mandatory type MultiFundActionRequest: type: object required: - fundVersionIds - code properties: fundVersionIds: type: array items: type: integer description: Identifikátory otevřených verzí fondů code: type: string description: Kód hromadné akce description: Požadavek na spuštění hromadné akce nad více fondy najednou. MultiFundActionResult: type: object required: - queuedCount - skipped properties: fundsChangeId: type: integer description: Identifikátor seskupení (arr_funds_change); chybí, pokud nebyl spuštěn žádný běh queuedCount: type: integer description: Počet naplánovaných běhů skipped: type: array items: $ref: '#/components/schemas/FundsActionSkipped' description: Přeskočené fondy description: Výsledek spuštění hromadné akce nad více fondy. MultimatchContainsFilter: type: object required: - value properties: value: type: string description: searched value allOf: - $ref: '#/components/schemas/AbstractFilter' description: Performs fulltext search over the whole entity Node.PlainTextRepresentation: type: object required: - name - code - value properties: name: type: string description: název generátoru pro uživatel code: type: string description: interní kód generátoru value: type: string description: vytvořená citace description: Received quote NodeBase: type: object required: - id - version - uuid properties: id: type: integer description: id of node version: type: integer description: node version uuid: type: string description: node uuid description: Node information without item values, used for parent and sibling nodes in NodeData NodeBrief: type: object required: - id - accordionLeft - accordionRight - referenceMark - version properties: id: type: integer description: nodeid uzlu accordionLeft: type: string description: popis levé části accordionu accordionRight: type: string description: popis pravé části accordionu referenceMark: type: array items: type: string description: označení JP nodeConformity: allOf: - $ref: '#/components/schemas/NodeConformity' description: Informace o stavu JP digitizationRequests: type: array items: $ref: '#/components/schemas/DigitizationRequest' description: seznam otevřených požadavků na digitalizaci version: type: integer description: db verze JP issues: type: array items: $ref: '#/components/schemas/WfSimpleIssue' description: seznam otevřených připomínek description: |- Brief view of a description unit — id, version, accordion-row presentation fields, and per-node status indicators. Used wherever a list of nodes is presented (e.g. siblings). Náhrada `AccordionNodeVO` NodeConformity: type: object required: - state - date - missingList - errorList - viewPolicyTypeIds properties: state: $ref: '#/components/schemas/NodeConformityState' date: type: string format: date description: datum validace missingList: type: array items: $ref: '#/components/schemas/NodeConformityMissing' description: seznam chybějících hodnot errorList: type: array items: $ref: '#/components/schemas/NodeConformityError' description: seznam chybných hodnot viewPolicyTypeIds: type: array items: type: integer description: seznam uplatnenych politik pro zobrazeni description: |- Pro validace JP Náhrada `NodeConformityVO` NodeConformityError: type: object required: - descItemObjectId - description - policyTypeId properties: descItemObjectId: type: integer description: identifikátor hodnoty atributu description: type: string description: popis chyby policyTypeId: type: integer description: identifikátor typu oprávnění description: Náhrada `NodeConformityErrorVO` NodeConformityMissing: type: object required: - descItemTypeId - descItemSpecId - description - policyTypeId properties: descItemTypeId: type: integer description: identifikátor typu descItemSpecId: type: integer description: identifikátor specifikace description: type: string description: popis chybějící položky policyTypeId: type: integer description: identifikátor typu oprávnění description: Náhrada `NodeConformityMissingVO` NodeConformityState: type: string enum: - OK - ERR description: Stav JP NodeData: type: object required: - formData - nodeIndex - nodeCount properties: formData: allOf: - $ref: '#/components/schemas/NodeFormData' description: data formuláře požadované JP node: allOf: - $ref: '#/components/schemas/NodeStatus' description: Status of the focus node. Returned only when request.nodeStatus is true. parents: type: array items: $ref: '#/components/schemas/NodeTreeData' description: Parents chain up to the root. Returned only when request.parents is true. children: type: array items: $ref: '#/components/schemas/NodeTreeData' description: Direct children. Returned only when request.children is true. siblings: type: array items: $ref: '#/components/schemas/NodeBrief' description: Siblings window. Returned only when request.siblingsFrom is set. nodeIndex: type: integer description: index požadované JP nodeCount: type: integer description: celkový počet JP v úrovni požadované JP description: |- Received data of the unit of description Náhrada `NodeDataVO` NodeDataParam: type: object required: - fundVersionId - nodeId - formData - siblingsMaxCount - parents - children properties: fundVersionId: type: integer description: version fund nodeId: type: integer description: id of node formData: type: boolean description: load description unit form data as well? siblingsFrom: type: integer description: load (if not null) siblings of the description unit? siblingsMaxCount: type: integer description: max number of siblings returned siblingsFilter: type: string description: full-text filtering in siblings parents: type: boolean description: Load parents description units to root? children: type: boolean description: Load children description units? nodeStatus: type: boolean description: Load focus-node status (response.node)? Default false. description: Parameters for get information about the description unit and its "surroundings" NodeField: type: object required: - fieldName properties: fieldName: allOf: - $ref: '#/components/schemas/NodeFieldName' description: Name of field (from enum NodeFieldName) allOf: - $ref: '#/components/schemas/AbstractField' description: Node specifici search field NodeFieldName: type: string enum: - conformityError - conformityMissing - uuid description: |- Node specific field names Node fields are used for FieldValueFilter. NodeFormData: type: object required: - parent - descItems - itemTypes - arrPerm properties: parent: allOf: - $ref: '#/components/schemas/NodeBase' description: rodič descItems: type: array items: $ref: '#/components/schemas/NodeItem' description: seznam hodnot atributu itemTypes: type: array items: $ref: '#/components/schemas/FormItemType' description: typy atributů arrPerm: type: boolean description: oprávnění pořádat v dané JP description: Náhrada `DescFormDataNewVO` NodeInfo: type: object required: - id - version - uuid - fundId - fundVersionId properties: id: type: integer description: Node ID version: type: integer description: Node DB row version (for optimistic concurrency on subsequent writes) uuid: type: string description: Node UUID fundId: type: integer description: Fund ID the node belongs to fundVersionId: type: integer description: |- ID of the most recent fund version in which the node was available (i.e. had an active level). Not necessarily the open version — if the node has been deleted in the open version, this points to the latest version that still contained it. deleteChangeId: type: integer description: |- ID of the ArrChange that deleted the node's level after `fundVersionId` was locked. Absent if the node's level is still active in `fundVersionId` (i.e. the node is still reachable in that version). description: |- Basic information about a node — its identifiers, fund placement, and deletion state relative to the most recent version that contained it. Lightweight alternative to the full node-data load for clients that only need to resolve a node identifier to fund/version context. NodeItem: type: object properties: nodeId: type: integer description: id node nodeVersion: type: integer description: node version inhibited: type: boolean description: if inheritance is prohibited - true allOf: - $ref: '#/components/schemas/BaseItem' description: Náhrada za třídu `ArrItemVO` NodeSearchResult: type: object required: - fonds - totalCount - partialResult properties: fonds: type: array items: $ref: '#/components/schemas/FundSearchResult' description: seznam archivních souborů totalCount: type: integer format: int64 description: celkový počet partialResult: type: boolean description: znak částečného výsledku description: Seznam archivních souborů jako výsledek vyhledávání NodeStatus: type: object required: - id - version properties: id: type: integer description: Node identifier — echoes request.nodeId for self-describing responses. version: type: integer description: DB version of the node, for optimistic concurrency on subsequent writes. nodeConformity: allOf: - $ref: '#/components/schemas/NodeConformity' description: Validation conformity (errors, missing items, visible policy types). Absent if no conformity record exists for this node. description: |- Status information about a single description unit (the node referenced by request.nodeId). Returned in response.node when the request flag `nodeStatus` is true. Designed to be additive-only: new optional fields may be appended without breaking clients. NodeTreeData: type: object required: - id - depth - name - hasChildren - referenceMark - version properties: id: type: integer description: node id depth: type: integer description: hloubka zanoření ve stromu name: type: string description: název uzlu icon: type: string description: ikonka hasChildren: type: boolean description: true - uzel má další potomky, false - uzel nemá další potomky referenceMark: type: array items: type: string description: referenční označení. Od kořene k uzlu version: type: integer description: verze uzlu arrPerm: type: boolean description: oprávnění pořádat v dané JP description: |- Data uzlu stromu odesílané klientovi pro strom fa. Náhrada `TreeNodeVO` NodeUpdateItem: type: object required: - updateOp - item properties: updateOp: allOf: - $ref: '#/components/schemas/UpdateOp' description: operation item: allOf: - $ref: '#/components/schemas/NodeItem' description: item to update description: Náhrada za třídu `ArrUpdateItemVO` OperationCompareType: type: string enum: - EQ - NEQ - GT - LT - GTE - LTE - STARTWITH - ENDWITH - CONTAINS - INTERSECT - IS_IN - IS_NULL - NOT_NULL description: Operation type for FieldValueFilter OperationLogicalType: type: string enum: - AND - OR description: Operation type for LogicalFilter ParInstitutionGen: type: object required: - id - institutionType - accessPointId - name - code properties: id: type: integer description: Id instituce institutionType: allOf: - $ref: '#/components/schemas/BaseCode' description: Typ instituce accessPointId: type: integer description: Id ApAccessPoint name: type: string description: Název instituce code: type: string description: Kód instituce description: VO pro instituce PartType: type: object required: - childPartId - repeatable properties: childPartId: type: integer repeatable: type: boolean allOf: - $ref: '#/components/schemas/BaseCode' PartValidationIssues: type: object required: - id - errors properties: id: type: integer errors: type: array items: type: string description: Part validation issues/errors Participant: type: object required: - canWrite - canConfirm - canEditConfirmed properties: canWrite: type: boolean description: if user has ability to save and modify new entity canConfirm: type: boolean description: if user has ability to approve entity canEditConfirmed: type: boolean description: if user has ability to change approved entity allOf: - $ref: '#/components/schemas/UserRef' description: Entity processor (user) PublicationDetail: type: object required: - id - typeId - typeCode - typeName - fundVersionId - state - createdBy - createdAt - hasDownloadableFile properties: id: type: integer description: Publication identifier (ARR_EXPORT.export_id). typeId: type: integer description: Publication type ID. typeCode: type: string description: Publication type code (target system). typeName: type: string description: Publication type name (display). fundVersionId: type: integer description: Fund version the export was created from. state: allOf: - $ref: '#/components/schemas/PublicationStateInternal' description: Current life-cycle state. createdBy: allOf: - $ref: '#/components/schemas/UserRef' description: User who created the publication request. createdAt: type: string format: date-time description: Time the publication request was created. preparedAt: type: string format: date-time description: Time XML preparation finished. Null until PREPARED. lastFetchedAt: type: string format: date-time description: Time of the last fetch by the publication system. publishedAt: type: string format: date-time description: Time the publication reported completion. errorAt: type: string format: date-time description: Time the record entered an error state. invalidatedAt: type: string format: date-time description: Time the record was invalidated by a user. lastChangeId: type: integer description: |- ID of the last fund change included in the export snapshot. Null when the originating change has been purged (the XML itself is not affected). errorMessage: type: string description: Error description for PREPARE_ERROR / PUBLISH_ERROR. hasDownloadableFile: type: boolean description: Whether a downloadable XML file is currently available on the server. description: One publication record as shown in the UI. PublicationList: type: object required: - items - totalCount properties: items: type: array items: $ref: '#/components/schemas/PublicationDetail' totalCount: type: integer description: Total number of publications matching the query, not just on this page. description: Paginated list of publications for a fund. PublicationReportStatus: type: string enum: - OK - ERROR description: Outcome reported back to Elza by the publication system. PublicationStateInternal: type: string enum: - NEW - PREPARED - FETCHED - PUBLISHED - PREPARE_ERROR - PUBLISH_ERROR - INVALIDATED description: |- Internal-only view of a publication's life-cycle state. Mirrors { PublicationStatusReport: type: object required: - status - publishedAt properties: status: allOf: - $ref: '#/components/schemas/PublicationReportStatus' description: Publication outcome. publishedAt: type: string format: date-time description: |- Time at which publication succeeded or failed, as reported by the publication system. errorMessage: type: string description: Error message. Filled only when status = ERROR. description: Body of `POST /publications/status/{id}`. PublicationType: type: object required: - name - code - allowPermExport - allowPermPublication - connectionType properties: id: type: integer description: Server-assigned identifier. Absent on create / update request bodies. name: type: string description: Human-readable name shown in the UI. code: type: string description: |- Stable code identifying the target system; also used as { active: type: boolean description: When false, the type accepts neither new publications nor downloads. default: true exportFilterCode: type: string description: Code of { retentionCount: type: integer minimum: 0 description: |- Number of most recent exports retained on disk per type. 0 means unlimited; 1 keeps only the latest; default is 5. default: 5 allowPermExport: type: boolean description: Users holding the FUND_EXPORT permission may publish into this type. allowPermPublication: type: boolean description: Users holding the FUND_PUBLISH permission may publish into this type. connectionType: allOf: - $ref: '#/components/schemas/ConnectionType' description: Target environment kind (development / test / production). description: |- Publication type — target-system configuration. Used as both the read shape (responses) and the write shape (create / update request bodies). The `id` is server-assigned and is absent on create or update requests — on `PUT /{id}` the path parameter is authoritative; any `id` carried in the body is ignored. Changing `code` on an existing type is permitted by the API but will break the cursor for any publication system bound to the old code. The UI surfaces a warning (or disables the field) to prevent accidental changes. QueueItemState: type: string enum: - UPDATE - IMPORT_NEW - IMPORT_OK - IMPORT_ERROR - EXPORT_NEW - EXPORT_OK - EXPORT_ERROR description: Výčet stavů aktualizace AIPu ReplaceType: type: string enum: - SIMPLE - COPY_ALL description: Method of replacing ApAccessPoint Report.ReportCategory: type: object required: - code - name - reportDefinitions properties: code: type: string description: Category code name: type: string description: Category name reportDefinitions: type: array items: $ref: '#/components/schemas/Report.ReportDefinition' description: List of definitions description: Category witl report definitions Report.ReportData: type: object required: - header - rows - sourceDataDate properties: header: type: array items: type: string rows: type: array items: $ref: '#/components/schemas/Report.ReportRow' sourceDataDate: type: string format: date-time description: Report in json format Report.ReportDefinition: type: object required: - code - name properties: code: type: string description: statistics code name: type: string description: statistics name description: type: string description: description of statistics params: type: array items: $ref: '#/components/schemas/Report.ReportParamDefinition' description: statistics parameters description: Element from the statistics list Report.ReportFormat: type: string enum: - JSON - CSV description: Types of report output formats Report.ReportParamDefinition: type: object required: - code - name - paramType - required - repeatable properties: code: type: string description: parameter code name: type: string description: parameter name paramType: allOf: - $ref: '#/components/schemas/Report.ValueType' description: parameter type required: type: boolean description: parameter required or not repeatable: type: boolean description: parameter repeatable or not values: type: array items: $ref: '#/components/schemas/Report.Value' description: parameter default value(s) description: Statistical report parameter Report.ReportParamValue: type: object required: - code - values properties: code: type: string description: parameter code values: type: array items: $ref: '#/components/schemas/Report.Value' description: parameter values description: List of values ​​for the parameter Report.ReportParameters: type: object properties: params: type: array items: $ref: '#/components/schemas/Report.ReportParamValue' description: param values description: Statistics parameters Report.ReportRow: type: object required: - cols properties: cols: type: array items: $ref: '#/components/schemas/Report.Value' description: Row of report in json format Report.Value: type: object required: - valueType properties: valueType: $ref: '#/components/schemas/Report.ValueType' discriminator: propertyName: valueType mapping: INT: '#/components/schemas/Report.ValueInteger' STRING: '#/components/schemas/Report.ValueString' DATE: '#/components/schemas/Report.ValueDate' AP_ID: '#/components/schemas/Report.ValueAccesspointId' FUND_ID: '#/components/schemas/Report.ValueFondId' description: Report value Report.ValueAccesspointId: type: object required: - accesspointId properties: accesspointId: type: integer allOf: - $ref: '#/components/schemas/Report.Value' description: Report ACCESSPOINT_ID value Report.ValueDate: type: object required: - dateValue properties: dateValue: type: string format: date-time allOf: - $ref: '#/components/schemas/Report.Value' description: Report DATE value Report.ValueFondId: type: object required: - fondId properties: fondId: type: integer allOf: - $ref: '#/components/schemas/Report.Value' description: Report data FOND_ID value Report.ValueInteger: type: object required: - intValue properties: intValue: type: integer allOf: - $ref: '#/components/schemas/Report.Value' description: Report INTEGER value Report.ValueString: type: object required: - textValue properties: textValue: type: string allOf: - $ref: '#/components/schemas/Report.Value' description: Report STRING value Report.ValueType: type: string enum: - INT - STRING - BOOLEAN - DATE - USER_ID - GROUP_ID - FUND_ID - AP_ID - ITEM_TYPE_ID - ITEM_SPEC_ID - SCOPE_ID - AP_TYPE_ID description: Types of statistics values Request: type: object required: - id - code - state - rejectReason - username - create - send - responseExternalSystem - externalSystemCode properties: id: type: integer code: type: string state: $ref: '#/components/schemas/RequestState' rejectReason: type: string username: type: string create: type: string format: date send: type: string format: date responseExternalSystem: type: string format: date externalSystemCode: type: string description: Náhrada `ArrRequestVO` RequestProcessState: type: string enum: - PENDING - PROCESSING - FINISHED - ERROR description: Status of async request RequestState: type: string enum: - OPEN - QUEUED - SENT - PROCESSED - REJECTED description: Request state ResultAutoItems: type: object properties: items: type: array items: $ref: '#/components/schemas/AutoValue' description: List of automatically generated items ResultEntityRef: type: object required: - count properties: count: type: integer format: int64 items: type: array items: $ref: '#/components/schemas/EntityRef' description: Search result RevStateChange: type: object required: - state properties: typeId: type: integer description: id of type comment: type: string description: comment state: allOf: - $ref: '#/components/schemas/RevisionState' description: state of ApRevision description: Data for changing revision state of ApAccessPoint RevisionState: type: string enum: - ACTIVE - TO_APPROVE - TO_AMEND description: States of ApRevState Sdo.BatchUpdateParam: type: object required: - ids - autoincrementItemTypeIds - deleteItemTypeIds - items properties: ids: type: array items: type: integer autoincrementItemTypeIds: type: array items: type: integer deleteItemTypeIds: type: array items: type: integer items: type: array items: $ref: '#/components/schemas/StructuredObjectItem' description: Data for bulk value update Sdo.CopyObjectParam: type: object required: - count - incrementedTypeIds properties: count: type: integer incrementedTypeIds: type: array items: type: integer description: Data for bulk value creation Sdo.ExtensionFund: type: object required: - id - name - code - active properties: id: type: integer name: type: string code: type: string active: type: boolean description: Extention fund Sdo.FindResult: type: object required: - count - rows properties: count: type: integer format: int64 rows: type: array items: $ref: '#/components/schemas/StructuredObject' description: Result found Sdo.ItemResult: type: object required: - parent - item properties: parent: $ref: '#/components/schemas/StructuredObject' item: $ref: '#/components/schemas/StructuredObjectItem' description: Status of a structured data type Sdo.Type: type: object required: - id - name - code - anonymous properties: id: type: integer name: type: string code: type: string anonymous: type: boolean description: Structure type SearchParams: type: object properties: filters: type: array items: $ref: '#/components/schemas/AbstractFilter' description: array of conditions, joined by AND operator offset: type: integer description: page offset size: type: integer description: page size sort: type: array items: $ref: '#/components/schemas/Sorting' description: array of sort conditions description: Search parameters Sorting: type: object required: - field properties: field: type: string description: attribute name to sort on order: allOf: - $ref: '#/components/schemas/SortingOrder' description: order of sorting description: Allows to define sorting SortingOrder: type: string enum: - asc - desc description: Order of sorting StringViewDefinition: type: object required: - mask properties: mask: type: string allOf: - $ref: '#/components/schemas/ItemViewDefinition' description: |- Input mask for STRING items (e.g. "###-##"). `#` denotes a value character, `*` denotes a variable-length run, other characters are literals automatically inserted by the UI. StructuredObject: type: object required: - id - value - typeCode - complement - state - assignable properties: id: type: integer value: type: string typeCode: type: string complement: type: string state: type: string enum: - OK - ERROR - TEMP assignable: type: boolean errorDescription: type: string description: Value of a structured type StructuredObjectItem: type: object allOf: - $ref: '#/components/schemas/BaseItem' StructuredObjectItems: type: object required: - parent - items - itemTypes properties: parent: $ref: '#/components/schemas/StructuredObject' items: type: array items: $ref: '#/components/schemas/StructuredObjectItem' itemTypes: type: array items: $ref: '#/components/schemas/FormItemType' description: Form data SyncProgress: type: string enum: - UPLOAD_PENDING - UPLOAD_STARTED description: Progres synchronizace SyncState: type: string enum: - SYNC_OK - NOT_SYNCED - LOCAL_CHANGE description: Stav synchronizace Tasks.EntityType: type: string enum: - AP - AP_REV description: Entity type for task Tasks.Status: type: string enum: - NEW - CANCELLED - FINISHED description: Task status Tasks.ViewDetail: type: object required: - taskId - created - assigneeId - assigneeName - status - taskTypeId - taskTypeCode - taskTypeName - description - primaryEntityId - primaryEntityName - primaryEntityType properties: taskId: type: integer created: type: string format: date-time closed: type: string format: date-time assigneeId: type: integer assigneeName: type: string creatorId: type: integer creatorName: type: string closedById: type: integer closedByName: type: string status: $ref: '#/components/schemas/Tasks.Status' taskTypeId: type: integer taskTypeCode: type: string taskTypeName: type: string description: type: string primaryEntityId: type: integer primaryEntityName: type: string primaryEntityType: $ref: '#/components/schemas/Tasks.EntityType' description: Task detail TreeDataCustomGen: type: object required: - nodes - expandedIdsExtension properties: nodes: type: array items: $ref: '#/components/schemas/TreeNodeCustomGen' description: Seznam uzlů stromu expandedIdsExtension: type: array items: type: string description: Seznam uuid již expandovaných uzlů description: Custom strom TreeNodeCustomGen: type: object required: - UUID - name - value - depth - hasChildren - parent properties: UUID: type: string description: Unikátní identifikátor uzlu name: type: string description: Název value: type: array items: type: integer description: Hodnota depth: type: integer description: Hloubka daLeveViewId: type: integer hasChildren: type: boolean description: Příznak, zda udel má potomky parent: type: string description: Unikátení identifikátor rodičovského uzlu description: Custom uzel stromu UpdateFund: type: object properties: name: type: string description: Název ruleSetCode: type: string description: Kód pravidel institutionIdentifier: type: string description: Identifikátor instituce (podpora pro kód instituce i UUID přístupového bodu) internalCode: type: string description: Interní kód fundNumber: type: integer description: Číslo archivního souboru unitdate: type: string description: Datace mark: type: string description: Značka archivního souboru scopes: type: array items: type: string description: Seznam oblastí entit managed: type: boolean description: Zákaz změny vlastností description: Změny archivního souboru UpdateOp: type: string enum: - CREATE - UPDATE - DELETE description: Type of update Item UsedItemType: type: object required: - rulItemTypeId - count properties: rulItemTypeId: type: integer count: type: integer description: Fund node item type id and quantity UserRef: type: object required: - userId - name - username properties: userId: type: integer description: User identifier name: type: string description: Full display name username: type: string description: Username (login) description: |- Reference to a user account. Carries enough information for the client to display the user (name, username) without an extra lookup, while still keeping the stable identifier. WfSimpleIssue: type: object required: - id - number - description properties: id: type: integer description: indentifikátor připomínky number: type: integer description: číslo připomínky v rámci protokolu description: type: string description: text připomínky description: Náhrada `WfSimpleIssueVO`