5.7. API (REST)

REST API slouží pro integraci aplikace Elza s dalšími komponentami a informačními systémy. REST API je doplňkem k pokročilejšímu WSDL API.

API je popsáno pomocí OpenAPI definice.

Definice OpenAPI je dostupné na adrese: <ELZA_URL>/swagger-ui/index.html.

5.7.1. Vstupní URL

Rozhraní je dostupné na adrese: <ELZA_URL>/api/v1.

5.7.2. Definice rozhraní

Definice rozhraní REST: elza-openapi.yml

5.7.3. Funkce REST rozhraní

DELETE /accesspoint

Invalidation of access points

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

POST /accesspoint/export

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“.

Status Codes:
PUT /accesspoint/export/{queueItemId}

Decision on forced export ELZA -> CAM

Parameters:

  • queueItemId (integer) – id of queue

Query Parameters:

  • force (boolean) – force export: yes or no (Required)

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

GET /accesspoint/invalidated

Get invalidated (deleted) entities

Query Parameters:

  • page (integer) – number of the page

  • pageSize (integer) – page size

Status Codes:

  • 200 OK – The request has succeeded.

POST /accesspoint/search

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.

Status Codes:

  • 200 OK – The request has succeeded.

DELETE /accesspoint/{id}

Invalidation of access point (delete/replace)

Parameters:

  • id (string) – id of accesspoint

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

GET /accesspoint/{id}/autoitems

List of automatically generated elements of the description

Parameters:

  • id (string) – id of accesspoint

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

PUT /accesspoint/{id}/copy

Copying an archive entity

Parameters:

  • id (string) – id of accesspoint

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

GET /accesspoint/{id}/lastParticipants

Get a list of entity processors

Parameters:

  • id (integer) – id of accesspoint

Status Codes:

  • 200 OK – The request has succeeded.

POST /accesspoint/{id}/part

Create new part of ApAccessPoint

Parameters:

  • id (integer) – id of accesspoint

Query Parameters:

  • apVersion (integer) – accesspoint version

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

POST /accesspoint/{id}/part/{partId}

Update a part of ApAccessPoint

Parameters:

  • id (integer) – id of accesspoint

  • partId (integer) – id of part

Query Parameters:

  • apVersion (integer) – accesspoint version

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

DELETE /accesspoint/{id}/part/{partId}

Delete part of ApAccessPoint

Parameters:

  • id (integer) – id of accesspoint

  • partId (integer) – partId of ApAccessPoint

Query Parameters:

  • apVersion (integer) – actual version of ApAccessPoint

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

PUT /accesspoint/{id}/part/{partId}/prefer-name

Set the preferred name of ApAccessPoint

Parameters:

  • id (integer) – id of accesspoint

  • partId (integer) – partId of ApAccessPoint

Query Parameters:

  • apVersion (integer) – actual version of ApAccessPoint

Status Codes:

  • 200 OK – The request has succeeded.

PUT /accesspoint/{id}/restore

Restore deleted entity and return to original state

Parameters:

  • id (string) – id of accesspoint

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

POST /accesspoint/{id}/revision

Creating a new revision of access point

Parameters:

  • id (integer) – id of accesspoint

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

DELETE /accesspoint/{id}/revision

Deleting a revision of access point

Parameters:

  • id (integer) – id of accesspoint

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

GET /accesspoint/{id}/revision/autoitems

List of automatically generated description elements for revision

Parameters:

  • id (string) – id of accesspoint

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

POST /accesspoint/{id}/revision/merge

Merge ApRevision & ApAccessPoint

Parameters:

  • id (integer) – id of accesspoint

Query Parameters:

  • apVersion (integer) – actual version of ApAccessPoint

Status Codes:

  • 200 OK – The request has succeeded.

DELETE /accesspoint/{id}/revision/part/{partId}

Delete part of revision of ApAccessPoint

Parameters:

  • id (integer) – id of accesspoint

  • partId (integer) – partId of revision

Query Parameters:

  • apVersion (integer) – actual version of ApAccessPoint

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

PUT /accesspoint/{id}/revision/part/{partId}/prefer-name

Set the preferred name of revision of ApAccessPoint

Parameters:

  • id (integer) – id of accesspoint

  • partId (integer) – partId of revision

Query Parameters:

  • apVersion (integer) – actual version of ApAccessPoint

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

POST /accesspoint/{id}/revision/part/{revPartId}

Update a revision part of ApAccessPoint

Parameters:

  • id (integer) – id of accesspoint

  • revPartId (integer) – id of revision part

Query Parameters:

  • apVersion (integer) – accesspoint version

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

PUT /accesspoint/{id}/revision/state

Change state of revision of ApAccessPoint

Parameters:

  • id (integer) – id of accesspoint

Query Parameters:

  • apVersion (integer) – actual version of ApAccessPoint

  • assignTo (integer) – userId

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

PUT /accesspoint/{id}/state

Change state of ApAccessPoint

Parameters:

  • id (integer) – id of accesspoint

Query Parameters:

  • apVersion (integer) – actual version of ApAccessPoint

  • assignTo (integer) – userId

Status Codes:

  • 200 OK – The request has succeeded.

GET /accesspoint/{id}/validate

Validation of an archive entity

Parameters:

  • id (integer) – id of accesspoint

Query Parameters:

  • includeRevision (boolean) – include revision

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

GET /action/funds-change/{fundsChangeId}

Vrátí jednotlivé per-fond běhy patřící do jednoho vícefondového seskupení (sledování průběhu).

Parameters:

  • fundsChangeId (integer)

Status Codes:

  • 200 OK – The request has succeeded.

POST /action/funds/group

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ů).

Status Codes:

  • 200 OK – The request has succeeded.

POST /action/queue-multi

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.

Status Codes:

  • 200 OK – The request has succeeded.

GET /admin/arrangement/missing-cached-nodes

Creating missing items in arr_cached_node

Status Codes:

  • 200 OK – The request has succeeded.

GET /admin/info

Return basic statistical info

Status Codes:

  • 200 OK – The request has succeeded.

GET /admin/info/logged-users

Return list of logged users

Status Codes:

  • 200 OK – The request has succeeded.

POST /admin/user/{userId}/copy-permissions

Copy user permissions from another user

Method will append all permissions to given user

Parameters:

  • userId (integer) – ID of target user

Status Codes:

  • 200 OK – The request has succeeded.

POST /aip/bulk-connect-logic-to-jp

Bulk connect logical structure to JP

Query Parameters:

  • arrNodeId (integer) – ArrNode ID (Required)

  • daAipIdList (array) – DaAip ID list (Required)

  • daLevelViewId (integer) – DaLevelView ID (Required)

Status Codes:
POST /aip/bulk-connect-to-jp

Bulk connect to JP

Query Parameters:

  • arrNodeId (integer) – ArrNode ID (Required)

  • daAipIdList (array) – DaAip ID list (Required)

Status Codes:
POST /aip/bulk-create-from-selected

Bulk create from selected

Query Parameters:

  • arrNodeId (integer) – ArrNode ID (Required)

  • daAipIdList (array) – DaAip ID list (Required)

Status Codes:
POST /aip/bulk-create-selected-to-jp

Bulk create from selected and connect to JP

Query Parameters:

  • arrNodeId (integer) – ArrNode ID (Required)

  • daAipIdList (array) – DaAip ID list (Required)

  • daLevelViewId (integer) – DaLevelView ID (Required)

Status Codes:
POST /aip/connect-jp-from-selected

Create JP from selected

Query Parameters:

  • arrNodeId (integer) – ArrNode ID (Required)

  • daAipId (integer) – DaAip ID (Required)

  • daDaoIdList (array) – DaDao ID List (Required)

Status Codes:
POST /aip/connect-jp-link-from-selected

Create JP and link from selected

Query Parameters:

  • arrNodeId (integer) – ArrNode ID (Required)

  • daAipId (integer) – DaAip ID (Required)

  • daDaoIdList (array) – DaDao ID List (Required)

Status Codes:
POST /aip/connect-part-to-jp

Connect Part to JP

Query Parameters:

  • arrNodeId (integer) – ArrNode ID (Required)

  • daAipId (integer) – DaAip ID (Required)

  • daDaoIdList (array) – DaDao ID List (Required)

Status Codes:
POST /aip/connect-selected-to-jp

Connect selected to JP

Query Parameters:

  • arrNodeId (integer) – ArrNode ID (Required)

  • daAipId (integer) – DaAip ID (Required)

  • daDaoIdList (array) – DaDao ID List (Required)

Status Codes:
POST /aip/connect-to-jp

Connect to JP

Query Parameters:

  • arrNodeId (integer) – ArrNode ID (Required)

  • daAipId (integer) – DaAip ID (Required)

Status Codes:
POST /aip/create-dao-link

Create dao link

Query Parameters:

  • aipId (integer) – AIP ID (Required)

  • daoId (integer) – DAO ID (Required)

  • nodeId (integer) – Node ID (Required)

  • linkType (string) – Link type (Required)

Status Codes:
POST /aip/create-dao-structure

Create dao structure

Status Codes:
GET /aip/dao-links/{nodeId}

Get dao links for node by id

Parameters:

  • nodeId (integer) – Node ID

Status Codes:
POST /aip/delete-complete-aip

Delete complete AIP

Status Codes:
POST /aip/delete-dao-link

Delete dao link

Query Parameters:

  • daoLinkId (integer) – Dao link ID (Required)

Status Codes:
POST /aip/delete-dao-structure

Delete dao structure

Status Codes:
POST /aip/download-complete-aip

Download complete AIP

Status Codes:
GET /aip/download-component/{fileId}

Getting the component file by file id

Parameters:

  • fileId (integer) – File ID

Status Codes:
POST /aip/export-aip

Export AIP

Status Codes:
POST /aip/find/filter

Find aips by filters

Query Parameters:

  • from (integer) – (Required)

  • count (integer) – (Required)

Status Codes:
POST /aip/import-package

Import AIP package

Query Parameters:

  • digitalRepositoryId (integer) – Digital repository ID (Required)

  • aipType (string) – Aip package type (Required)

Status Codes:
POST /aip/levelViewTree

Get level view tree for aips with ids

Status Codes:
POST /aip/tree

Get level view tree for aips with ids

Query Parameters:

  • aipId (integer) – Aip IDs (Required)

Status Codes:
POST /aip/update-aip

Update AIP

Query Parameters:

  • type (string) – Type of update (Required)

Status Codes:
GET /aip/{aipId}

Get aip detail by id

Parameters:

  • aipId (integer) – Aip ID

Status Codes:
GET /binding/{bindingId}/history

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:

  • bindingId (integer) – id of binding

Query Parameters:

  • offset (integer)

  • limit (integer) – server caps at 100

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

GET /binding/{bindingId}/issues

List CAM-side issues attached to a binding.

Parameters:

  • bindingId (integer) – id of binding

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

GET /daorepository
Status Codes:

  • 200 OK – The request has succeeded.

GET /daos/aip/{aipId}

Získání stromu pro průzkumník aipu

Parameters:

  • aipId (integer) – Identifikátor aipu

Status Codes:
GET /daos/component/{id}

Získání informací o da dao pro view request na digital repository

Parameters:

  • id (integer) – Identifikátor da dao

Status Codes:
POST /daos/{id}/change-scenario

Changing the dao connection scenario

Parameters:

  • id (integer) – dao id

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

DELETE /descItems/{fundVersionId}

Delete attribute value

Parameters:

  • fundVersionId (integer) – id version AS

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

PUT /descItems/{fundVersionId}/create

Create attribute value

Parameters:

  • fundVersionId (integer) – id version AS

Status Codes:

  • 200 OK – The request has succeeded.

PUT /descItems/{fundVersionId}/{createNewVersion}/update

Update attribute value

Parameters:

  • fundVersionId (integer) – id version AS

  • createNewVersion (boolean) – create a new version or not?

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

GET /extsystem/property

Return list of all properties of external system

Query Parameters:

  • extSystemId (integer) – external system id

  • userId (integer) – user id

Status Codes:

  • 200 OK – The request has succeeded.

POST /extsystem/property

Store one or more property of external system

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

DELETE /extsystem/property

Delete one property of external system

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

POST /extsystem/resync/{id}

External system resync

Parameters:

  • id (string) – external system ID or CODE

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

POST /fund

Created a new archive file (AS)

Status Codes:

  • 200 OK – The request has succeeded.

  • 400 Bad Request – The server could not understand the request due to invalid syntax.

GET /fund

Search for archive files (AS)

Query Parameters:

  • fulltext (string) – vyhledávaný výraz

  • institutionIdentifier (string) – identifikátor instituce (podpora pro kód instituce i UUID přístupového bodu)

  • max (integer) – maximální počet výsledků na stránku

  • from (integer) – Od kolikátého záznamu se mají výsledky vracet (0 = žádné se nepřeskočí)

Status Codes:

  • 200 OK – The request has succeeded.

POST /fund/export

Export fonds

Status Codes:
POST /fund/search

Search for funds

Status Codes:
GET /fund/{fundId}/fsrepo/{fsrepoId}/item-data

Get file of data

Parameters:

  • fundId (integer) – Fund ID

  • fsrepoId (integer) – FileSystem repository ID

Query Parameters:

  • path (string) – file path in the repository (Required)

Status Codes:

  • 200 OK – The request has succeeded.

GET /fund/{fundId}/fsrepo/{fsrepoId}/items

Return list of filesystem items

Parameters:

  • fundId (integer) – Fund ID

  • fsrepoId (integer) – FileSystem repository ID

Query Parameters:

  • filterType (string) – Optional filter to return only folders or files. If not specified all items are returned

  • path (string) – Optional path in the repository

  • lastKey (string) – Optional parameter to return next batch of items. See FsItems for more details.

Status Codes:

  • 200 OK – The request has succeeded.

PUT /fund/{fundId}/fsrepo/{fsrepoId}/linkitem/{nodeId}

Create DAO link

Parameters:

  • fundId (integer) – Fund ID

  • fsrepoId (integer) – FileSystem repository ID

  • nodeId (integer) – Node ID

Query Parameters:

  • path (string)

Status Codes:

  • 200 OK – The request has succeeded.

GET /fund/{fundId}/fsrepos

Return list of filesystem repositories

Parameters:

  • fundId (integer) – Fund ID

Status Codes:

  • 200 OK – The request has succeeded.

POST /fund/{fundId}/node/{nodeId}/mode

Set mode (TREE/LIST) of ArrLevel

Parameters:

  • fundId (integer) – Fund ID

  • nodeId (integer) – Node ID

Query Parameters:

  • list (boolean) – TREE (-> list = false), LIST (-> list = true) (Required)

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

GET /fund/{fundId}/publication

Return the publications for a fund, newest first.

The UI must paginate — the list can grow large.

Parameters:

  • fundId (integer) – Fund ID

Query Parameters:

  • publicationTypeId (integer) – Optional filter on publication type.

  • offset (integer) – Offset for pagination.

  • limit (integer) – Page size.

Status Codes:

  • 200 OK – The request has succeeded.

POST /fund/{fundId}/publication

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:

  • fundId (integer) – Fund ID

Status Codes:

  • 200 OK – The request has succeeded.

  • 403 Forbidden – Access is forbidden.

  • 404 Not Found – The server cannot find the requested resource.

  • 409 Conflict – The request conflicts with the current state of the server.

DELETE /fund/{fundId}/publication/{publicationId}

Invalidate a publication.

The associated DMS file is deleted from disk; the {

Parameters:

  • fundId (integer) – Fund ID

  • publicationId (integer) – Publication ID (ARR_EXPORT.export_id).

Status Codes:

  • 204 No Content – There is no content to send for this request, but the headers may be useful.

  • 403 Forbidden – Access is forbidden.

  • 404 Not Found – The server cannot find the requested resource.

POST /fund/{fundId}/publication/{publicationId}/copy

Copy an existing publication into another target system.

The target publication type must have a compatible filter setting (same {

Parameters:

  • fundId (integer) – Fund ID

  • publicationId (integer) – Publication ID (ARR_EXPORT.export_id).

Status Codes:

  • 200 OK – The request has succeeded.

  • 403 Forbidden – Access is forbidden.

  • 404 Not Found – The server cannot find the requested resource.

  • 409 Conflict – The request conflicts with the current state of the server.

GET /fund/{fundId}/publication/{publicationId}/download

Download the prepared XML from the UI.

Unlike the public {

Parameters:

  • fundId (integer) – Fund ID

  • publicationId (integer) – Publication ID (ARR_EXPORT.export_id).

Status Codes:
GET /fund/{fundId}/usedItemtypes/{fundVersionId}

Return list of item type id & count

Parameters:

  • fundId (integer) – Fund ID

  • fundVersionId (integer) – Fund ID Version

Status Codes:

  • 200 OK – The request has succeeded.

GET /fund/{id}

Getting the AS detail

Parameters:

  • id (string) – fund ID. Might be ID or fund UUID

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

PUT /fund/{id}

Update of archive file (AS)

Parameters:

  • id (string) – fund ID. Might be ID or fund UUID

Status Codes:

  • 200 OK – The request has succeeded.

  • 400 Bad Request – The server could not understand the request due to invalid syntax.

  • 404 Not Found – The server cannot find the requested resource.

PUT /fund/{id}/import

Import additional data to the existing fund

Parameters:

  • id (string) – Fund ID. Might be ID or fund UUID

Status Codes:
GET /funds/sdo/type

GET Lists the possible data types that can be used in AS: findStructureTypes()

Query Parameters:

  • fundVersionId (integer) – fund version id

Status Codes:

  • 200 OK – The request has succeeded.

POST /funds/sdo/{fundId}

Creating object of the structured data type

Parameters:

  • fundId (integer) – fund id

Query Parameters:

  • value (string) – value for the structured data

Status Codes:

  • 200 OK – The request has succeeded.

DELETE /funds/sdo/{fundId}

Deleting a value(s) of a structured data type

Parameters:

  • fundId (integer) – fund id

Query Parameters:

  • fundVersionId (integer) – fund version id

Status Codes:

  • 204 No Content – There is no content to send for this request, but the headers may be useful.

  • 404 Not Found – The server cannot find the requested resource.

POST /funds/sdo/{fundId}/assignable/{assignable}

Assignability settings.

Parameters:

  • fundId (integer) – fund id

  • assignable (boolean) – assignable value

Status Codes:

  • 204 No Content – There is no content to send for this request, but the headers may be useful.

POST /funds/sdo/{fundId}/batchUpdate/{structureTypeCode}

Bulk update of items/values of a structural type

Parameters:

  • fundId (integer) – fund id

  • structureTypeCode (string) – structure type code

Status Codes:

  • 204 No Content – There is no content to send for this request, but the headers may be useful.

GET /funds/sdo/{fundId}/extension/{structureTypeCode}

GET Finds available and enabled AS extensions: findFundStructureExtension()

Parameters:

  • fundId (integer) – fund id

  • structureTypeCode (string) – structure type code

Query Parameters:

  • fundVersionId (integer) – fund version id

Status Codes:

  • 200 OK – The request has succeeded.

PUT /funds/sdo/{fundId}/extension/{structureTypeCode}

PUT Sets a specific extension on the AS: setFundStructureExtensions()

Parameters:

  • fundId (integer) – fund id

  • structureTypeCode (string) – structure type code

Status Codes:

  • 204 No Content – There is no content to send for this request, but the headers may be useful.

POST /funds/sdo/{fundId}/item/{structuredObjectId}

Create item value of a structured data type

Parameters:

  • fundId (integer) – fund id

  • structuredObjectId (integer) – structure data id

Status Codes:

  • 200 OK – The request has succeeded.

GET /funds/sdo/{fundId}/item/{structuredObjectId}

GET Getting data for a structured data type form: getFormStructureItems()

Parameters:

  • fundId (integer) – fund id

  • structuredObjectId (integer) – structured object id

Query Parameters:

  • fundVersionId (integer) – fund version id

Status Codes:

  • 200 OK – The request has succeeded.

DELETE /funds/sdo/{fundId}/item/{structuredObjectId}/by-type/{itemTypeId}

Delete items based on the value of a data type structure by attribute type

Parameters:

  • fundId (integer) – fund id

  • structuredObjectId (integer) – structured object id

  • itemTypeId (integer) – item type id

Status Codes:

  • 204 No Content – There is no content to send for this request, but the headers may be useful.

  • 404 Not Found – The server cannot find the requested resource.

PUT /funds/sdo/{fundId}/item/{structuredObjectId}/{createNewVersion}

Update item value of a structured data type

Parameters:

  • fundId (integer) – fund id

  • structuredObjectId (integer) – structure data id

  • createNewVersion (boolean) – create a new version

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

DELETE /funds/sdo/{fundId}/item/{structuredObjectId}/{itemObjectId}

Delete item value of a structured data type

Parameters:

  • fundId (integer) – fund id

  • structuredObjectId (integer) – structured object id

  • itemObjectId (integer) – item object id

Status Codes:

  • 204 No Content – There is no content to send for this request, but the headers may be useful.

  • 404 Not Found – The server cannot find the requested resource.

GET /funds/sdo/{fundId}/search/{structureTypeCode}

GET Searching for values of a structured data type: findStructObj()

Parameters:

  • fundId (integer) – fund id

  • structureTypeCode (string) – structure type code

Query Parameters:

  • search (string) – text for filtering (optional)

  • assignable (boolean) – assignable value

  • from (integer) – from default = 0

  • count (integer) – max number of items

  • fundVersionId (integer) – fund version id

Status Codes:

  • 200 OK – The request has succeeded.

GET /funds/sdo/{fundId}/{structuredObjectId}

Getting the value of a structured data type

Parameters:

  • fundId (integer) – fund id

  • structuredObjectId (integer) – structure data id

Query Parameters:

  • fundVersionId (integer) – fund version id

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

POST /funds/sdo/{fundId}/{structuredObjectId}/confirm

Confirms the value of a structured data type. Sets the value

Parameters:

  • fundId (integer) – fund id

  • structuredObjectId (integer) – structure data id

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

POST /funds/sdo/{fundId}/{structuredObjectId}/copy

Creating duplicates of a structured data type and an auto-increment field

Parameters:

  • fundId (integer) – fund id

  • structuredObjectId (integer) – structure data id

Status Codes:

  • 204 No Content – There is no content to send for this request, but the headers may be useful.

POST /io/export

Create export file of funds or access points

Status Codes:

  • 200 OK – The request has succeeded.

GET /io/export-status/{requestId}

Getting the export status by request id

Parameters:

  • requestId (integer)

Status Codes:
GET /io/file/{requestId}

Getting the generated file by request id

Parameters:

  • requestId (integer)

Status Codes:
PUT /node/copyOlderSiblingAttribute

Copies the attribute of the specified type from the node’s parent

Query Parameters:

  • versionId (integer) – version id of tree (Required)

  • descItemTypeId (integer) – id of the attribute we want to copy (Required)

Status Codes:

  • 200 OK – The request has succeeded.

GET /node/info/id/{nodeId}

Get basic information about a node by its numeric ID.

Parameters:

  • nodeId (integer) – Node ID

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

  • 409 Conflict – The request conflicts with the current state of the server.

GET /node/info/uuid/{nodeUuid}

Get basic information about a node by its UUID.

Parameters:

  • nodeUuid (string) – Node UUID (36 characters)

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

  • 409 Conflict – The request conflicts with the current state of the server.

POST /node/node-data

Get data for a unit of description (JP)

Status Codes:

  • 200 OK – The request has succeeded.

GET /node/plain-text/{fundVersionId}/{nodeId}

Get quote by fundVersionId & nodeId

Parameters:

  • fundVersionId (integer)

  • nodeId (integer)

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

POST /node/search

Search for archive files (funds)

Status Codes:
GET /node/search/{fundId}

Search for nodes in archive file (fund)

Parameters:

  • fundId (integer) – Fund ID

Status Codes:
GET /publication/types

Return all publication types, including inactive ones.

Status Codes:

  • 200 OK – The request has succeeded.

POST /publication/types

Create a new publication type.

Status Codes:

  • 200 OK – The request has succeeded.

  • 409 Conflict – The request conflicts with the current state of the server.

PUT /publication/types/{id}

Update an existing publication type.

Parameters:

  • id (integer)

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

  • 409 Conflict – The request conflicts with the current state of the server.

DELETE /publication/types/{id}

Remove a publication type.

Deactivating via {

Parameters:

  • id (integer)

Status Codes:

  • 204 No Content – There is no content to send for this request, but the headers may be useful.

  • 404 Not Found – The server cannot find the requested resource.

  • 409 Conflict – The request conflicts with the current state of the server.

GET /publications/available/{targetSystem}

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:

  • targetSystem (string) – Publication type code (ARR_EXPORT_TYPE.code), which also identifies the target system.

Query Parameters:

  • lastTransaction (string) – 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.

Status Codes:
GET /publications/download/{id}

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:

  • id (integer) – Publication identifier (ARR_EXPORT.export_id).

Status Codes:
POST /publications/status/{id}

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:

  • id (integer) – Publication identifier (ARR_EXPORT.export_id).

Status Codes:

  • 200 OK – The request has succeeded.

  • 404 Not Found – The server cannot find the requested resource.

GET /report/definitions

Getting a list of categories and report definitions

Status Codes:

  • 200 OK – The request has succeeded.

POST /report/generate/{code}

Run generating statistics

Parameters:

  • code (string) – statistický kód pro generování

Status Codes:

  • 200 OK – The request has succeeded.

GET /report/status/{requestId}

Get the status of running statistics

Parameters:

  • requestId (integer)

Status Codes:
GET /report/{requestId}

Download statistics results by request id

Parameters:

  • requestId (integer)

Query Parameters:

  • format (string) – (Required)

Status Codes:
GET /rules/itemTypes

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.

Status Codes:

  • 200 OK – The request has succeeded.

Request Headers:

  • Accept-Language – Preferred language for localized strings (e.g. „cs“, „en“).

GET /rules/partTypes

Returns all types of parts.

Public URL: GET /api/v1/rules/partTypes.

Replaces the legacy GET /api/structure/part-type.

Status Codes:

  • 200 OK – The request has succeeded.

POST /search-ap

Searches for entity

Status Codes:
POST /search-arr

Searches for array descriptions

Status Codes:
GET /tasks/my

Task list for a given user

Status Codes:

  • 200 OK – The request has succeeded.